Web-REPL-Relay.md

Web REPL + Secure WebSocket Relay

A Secure WebSocket Relay can be used to connect to your device over the internet (from anywhere in the world).

Warning

🚧 THIS IS EXPERIMENTAL, BEWARE OF BUGS 🚧

1. Connect ViperIDE to your device using USB

2. In the left panel: Package Manager -> install viper-tools

3. In your main.py

import wss_repl

# Setup your WiFi network
wss_repl.connect_wifi('WiFi_SSID', 'WiFi_Password')

# Connect to the WebSocket server
wss_repl.start()

On the first run, the device generates a random ID and stores it in .viper.json. Later boots reuse the same ID automatically.

You can still provide a fixed ID explicitly:

wss_repl.start(uid='YOUR-DEVICE-UID')

4. Reset your device

In the terminal, you should see something like:

IDE available on https://viper-ide.org?wss=YOUR-DEVICE-UID

5. Connect ViperIDE to your device using WebREPL

Visit the specified link to open the IDE.

---

Advanced: Running your own WebSocket relay server

If you're running a relay server, please specify the URL:

wss_repl.start(url='wss://your-server-url')

1. Use WebREPL button in ViperIDE to connect to your device
2. Your device address will look like this: wss://your-server-url/YOUR-DEVICE-UID