Skip to main content

Choose your starting path

Start with browser chat if you are new to IOSignal. You only need one computer. To learn the protocol through small scripts, use the five-minute quickstart.

GoalRequirementsSuccess
Browser chatNode.js, npm, browserA message appears in the other tab
ESP32 controlESP32, LED, resistor, Wi-Fi, Arduino IDELED output and reported state agree
Your own serverNode.js, npm, three terminalsTwo clients exchange messages through your server

Browser chat​

  1. Download the Vanilla app from runnable examples.
  2. Run npm ci and npm run dev in its folder. This starts the web server and IOSignal server together.
  3. Open http://localhost:5175 in two tabs. Wait for ready and a CID in both.
  4. Send a message and check that it appears in the other tab. Then explore the React or Svelte example.

If it fails, check installation, connection, then delivery.

Control an ESP32​

The hardware tutorials include wiring, message formats, and physical verification steps.

  1. Check the board and pins in board examples.
  2. Follow CID LED control for wiring and uploading.
  3. Wait for READY CID: in the serial monitor. Connect the web workbench and board to the same server.
  4. Send on and off. Check both the LED and the deviceCID@$state report.
  5. Continue with group control.

Use the sketch named in the hardware tutorial. The browser chat bundle does not contain ESP32 sketches. See device troubleshooting.

Run your own server​

  1. Follow create a Node.js server.
  2. Run the receiver and sender from the quickstart.
  3. Confirm hello#message arrives at the receiver.
  4. For other devices, use the server's reachable address, not their own localhost.
  5. Before exposing the server, read the connection and authentication guides.

Local delivery does not verify external connectivity or TLS. Start with connection troubleshooting if needed.