Connect Companion
Use the deck in Bitfocus Companion over Wi-Fi or Ethernet, as a Satellite surface.
Companion connects over Satellite or as a Network Dock. Use Satellite.
Satellite: the connector opens the connection to Companion on TCP 16622, or 16623 for WebSocket. Network Dock: Companion opens the connection to the connector on TCP 5343, after it finds it over mDNS.
Satellite · The default. Works through Docker and other networks
Network Dock · Companion finds the connector in the same network
Satellite
In Bitfocus Companion, keep Settings › Satellite on. It needs Satellite API 1.9 or newer, tested with Companion 5.2.
In Companion, open Surfaces › Discover and click Setup next to the connector. Or open Sources in the web UI (demo) and click the Companion it found.
The deck shows up under Surfaces as streamdeck:<serial>, the same id as over USB. Your pages and surface settings stay.
The connector cannot find Companion in Docker without host networking. Publish port 16622 and type the address under Sources.
A wss:// address needs a certificate from a public CA. For any other certificate, paste the SHA-256 of the server's own certificate as the pin. When that certificate is renewed, enter the new pin.
openssl x509 -noout -fingerprint -sha256 -in cert.pemLayout
Companion sees two rows of keys, the touch strip as four 200 × 100 zones, then the four dials. This is the same as its own Stream Deck plugin.
- A tap presses the zone. A swipe up or down turns that zone like a dial.
- A sideways swipe changes the page. Turn on Horizontal Swipe Changes Page in the surface settings first.
- On a Stream Deck Neo, Companion also gets the two touch points and the info bar between them.
PIN lock
When Companion locks the deck, the deck shows a number pad. Type the PIN on it. While the deck is locked, its keys only enter the PIN and the menu does not open. You can also type it in the web UI, below the deck on the overview. A Stream Deck Pedal has no screen, so it needs the web UI for this.
Network Dock
Companion can also add the connector as a Network Dock under Surfaces › Discover. When its Satellite answers on the same address, the connector moves it to Satellite by itself. Satellite works through Docker and needs no discovery. To stay a dock, answer No on the deck or remove the Companion address under Sources.
Behind a proxy
The connector then sees only the proxy's address and cannot end the dock connection. Companion shows the deck twice, the second as streamdeck:<serial>-dev2.
One Companion connects over Satellite at a time. For more see Sources.