Docs: new robots connect through OpenVibe.Bot and the Node, not the stream-key socket (#99)

OP OpenVibers committed 11 Oct 2026 · 7aceb2f550 · 1 file, +1 −0

A robot builder (the Generic LOOI driver's authors) asked whether to build on Live's stream-key hardware socket. They read it here as the way to connect a robot. The control-socket tab of the API docs now says first that new robots use OpenVibe.Bot and the OpenVibe Node:

- a one-time pairing code, not a stream key;
- a driver plugin;
- a profile-built panel with roles, a queue, limits and a latched e-stop;
- the robot's panel under the stream once it is bound on the dashboard.

The socket keeps working for existing setups until they have moved (plan T15 deletes it after that). OpenVibe.Extensions' hardware guide says the same. Docs only.

Changes

ddiff --git a/public/fragments/documentation.html b/public/fragments/documentation.html
iindex 0398a767..f09d1b44 100644
---- a/public/fragments/documentation.html
++++ b/public/fragments/documentation.html
@@@ -698,6 +698,7 @@ while True:
  <!-- ═══════════════════════════════════════════════════════════ -->
  <div class="doc-tab-content" data-doc-tab="controlws" style="display:none">
  <h2>6. CONTROL WEBSOCKET — HARDWARE BRIDGE</h2>
++<p><strong>Connecting a new robot? Use <a href="https://openvibe.bot" target="_blank" rel="noopener">OpenVibe.Bot</a> and the <a href="https://github.com/OpenVibers/OpenVibe.Node" target="_blank" rel="noopener">OpenVibe Node</a> instead.</strong> The Node pairs with a one-time code (no stream key), runs your driver as a plugin (<a href="https://openvibe.bot/docs/drivers" target="_blank" rel="noopener">write a driver</a>), and Bot gives the robot a panel built from its profile, roles, a queue, limits and a latched e-stop. Bind the robot to your channel on the dashboard and its panel shows under your stream. The socket below keeps working for existing setups and is retired once they have moved to Bot.</p>
  <p>This is how your code receives viewer commands. Connect as <code>mode=hardware</code> and listen for messages. Your bridge translates them into robot/hardware actions.</p>
  
  <h3>Connection URLs</h3>

diff --git a/public/fragments/documentation.html b/public/fragments/documentation.html

index 0398a767..f09d1b44 100644

--- a/public/fragments/documentation.html

+++ b/public/fragments/documentation.html

@@ -698,6 +698,7 @@ while True:

<h2>6. CONTROL WEBSOCKET — HARDWARE BRIDGE</h2>

+<p><strong>Connecting a new robot? Use <a href="https://openvibe.bot" target="_blank" rel="noopener">OpenVibe.Bot</a> and the <a href="https://github.com/OpenVibers/OpenVibe.Node" target="_blank" rel="noopener">OpenVibe Node</a> instead.</strong> The Node pairs with a one-time code (no stream key), runs your driver as a plugin (<a href="https://openvibe.bot/docs/drivers" target="_blank" rel="noopener">write a driver</a>), and Bot gives the robot a panel built from its profile, roles, a queue, limits and a latched e-stop. Bind the robot to your channel on the dashboard and its panel shows under your stream. The socket below keeps working for existing setups and is retired once they have moved to Bot.</p>

<p>This is how your code receives viewer commands. Connect as <code>mode=hardware</code> and listen for messages. Your bridge translates them into robot/hardware actions.</p>

<h3>Connection URLs</h3>