Help

Set up CyberDeck with Companion

1. Install and prepare Bitfocus Companion 4.3+ on your control computer. Click Launch GUI, open Protocols in the left menu (click the ^ next to Settings if you don't see it), and turn on Enable Button Subscriptions API. Note the Satellite Websocket Listen Port; it's 16623 by default.
2. Install CyberDeck on your phone or tablet and add a connection: enter your Companion computer's hostname (companion.local) or IP address, and the Satellite port from step 1 (16623).
3. Open the surface. It's already configured by Companion.

Networking

CyberDeck is LAN-only. Your phone or tablet and the Companion computer have to be on the same network, usually the same Wi-Fi or VLAN.

• Hostnames: companion.local works if your network passes mDNS. CyberDeck doesn't scan the network for servers, so if .local won't resolve, enter the computer's IP address instead.
• VPN: Fine as long as the VPN routes traffic to the Companion machine. If the name doesn't resolve over the VPN, use the IP.
• Firewall: Companion's Satellite API listens on port 16623 (WebSocket); CyberDeck falls back to port 16622 (TCP). If a firewall sits in front of the control computer, allow inbound on both from your client subnet.

Multiple connections and dashboards

These are CyberDeck Pro features. The free version manages a single connection.

• Multiple connections: save more than one Companion server and switch between them from the status bar at the top of the screen. One connection is live at a time.
• Custom dashboards: build a screen that pulls buttons from across your Companion pages, handy for a one-screen show-control layout that doesn't fit a single Companion page grid. This uses Companion's Button Subscriptions API, so it has to be enabled (see Troubleshooting).
• Encoders: turn on Bottom Row as Encoders in Settings, then drag vertically on a bottom-row button to send rotary turns. Match this to your Companion configuration.

Quick Buttons: Shortcuts, Siri, and the Action button

A Quick Button is a named binding to one Companion button. Once you've made one, it's an action in the Shortcuts app and a Siri phrase, and on iPhone 15 Pro and later it can be bound to the Action button. The press goes to Companion over your LAN with CyberDeck closed. iPhone and iPad, CyberDeck 2.4 or newer. One Quick Button is free; CyberDeck Pro removes the limit.

1. Create one. In CyberDeck, open Settings → Quick Buttons → Add, name it, and tap the button you want on the live grid. Page through with the surface's own page keys.
2. Run it. From the Shortcuts app, by speaking its name to Siri, or from the Action button once you've assigned it in the iPhone's own Settings → Action Button.

Quick Buttons go through Companion's HTTP API, not the Satellite connection. It's on by default in Companion's Protocols settings and shares the web interface's port, 8000. This is the one place the web port is the right one. If Companion serves its web interface on another port, set the matching port under the connection's Advanced → HTTP port in CyberDeck.

Deleting a connection deletes its Quick Buttons with it; the delete alert counts them. For a Lock Screen trigger, use the Shortcuts app's own widget. Control Center and Lock Screen controls are planned for a later release.

Troubleshooting

CyberDeck names the problem on screen. Find that wording below.

"Couldn't reach Companion"

CyberDeck can't open a Satellite connection to the host you entered. The usual causes, most common first:

• Wrong port. This is the common one. Use the Satellite port (16623), not Companion's web port (8000). See Setup. The web page loading in a browser doesn't mean the port is right.
• Wrong host. If companion.local won't resolve on your network, enter the computer's IP address instead.
• Not the same network. The phone or tablet and the Companion computer have to share the LAN or VLAN.
• Companion isn't running, or the computer is asleep. "Companion isn't accepting connections. Make sure Companion is running" means the host is reachable but nothing is listening on that port, which is usually the port again, or Companion is closed.
• Firewall blocking port 16623 (or 16622, the TCP fallback).

"Companion version too old"

CyberDeck v2 speaks Satellite API 1.10 and needs Companion 4.3+. Older builds are refused, with no fallback. Update Companion and connect again.

Buttons are blank, or "Subscriptions disabled"

Custom dashboards use Companion's Button Subscriptions API. If a dashboard is empty or shows "Subscriptions disabled," open Companion's Protocols settings and enable Button Subscriptions API (the satellite_subscriptions_enabled setting). If Companion reports it doesn't support subscriptions at all, update to 4.3+.

A Quick Button does nothing

The Shortcut runs, Siri says done, and Companion doesn't fire. Three causes, most common first:

• Companion's HTTP API is off. Open Companion's Protocols settings and turn it on. It's on by default, so this usually means someone turned it off or a config import reset it.
• Wrong HTTP port. Quick Buttons use the web interface's port (8000 by default), the opposite of the Satellite rule above. If Companion's web interface is on another port, set it under the connection's Advanced → HTTP port.
• Not on Companion's network. Same rule as the surface: the device has to share the LAN or VLAN with the control computer. Cellular won't reach it.

Surface looks frozen or dimmed

If the connection drops, CyberDeck keeps the last screen visible but dimmed and reconnects on its own, showing "Reconnecting" with an attempt count in the status bar. Tap Retry to reconnect now. If it won't recover, confirm Companion is still running and still on the same network.

Reading the status bar

The bar at the top of CyberDeck always shows the connection state: Live, Connecting…, Reconnecting, Not connected, or Disconnected. Disconnect is sticky: if you disconnect from Settings, CyberDeck won't redial on its own. Tap Connect again.

Still stuck? Send diagnostics

CyberDeck can package up everything needed to help. In the app, open Settings → Diagnostics, tap the ••• menu, and choose Email Support. It pre-fills your app and iOS versions, device, the connection you're using, your Companion version, and recent logs, with IP addresses redacted. Send it and I'll take a look. Share Logs in the same menu saves the report as a file if you'd rather attach it yourself.

DeckHand (the operator app)

DeckHand for CyberDeck is our operator-only iPad app, $4.99 one-time: a tech lead publishes a role from CyberDeck (Pro), and the operator runs just those buttons and variables. See the DeckHand page for what it is and how pairing works.

Most DeckHand problems are prerequisites on the tech lead's side:

• Companion 4.3+ on the control computer. Older versions are refused, and DeckHand names the problem on screen.
• Button Subscriptions API enabled in Companion's Protocols settings. Importing a Companion config silently turns it back off; re-check after any import.
• HTTP API enabled (on by default in Companion). DeckHand's variable editing uses it.
• Same network. Pairing and the running surface are LAN-only, like CyberDeck.

The contact form below covers DeckHand too; mention DeckHand in the report. Or email dh-support@cyberdeckapp.com directly.

FAQ

Does it work over the internet?

No. CyberDeck is LAN-only. If you need remote control, route it through a VPN to your Companion machine.

Does it sync between devices?

No. Saved connections and dashboards live on each device. By design: no accounts, no cloud.

I used to import a config file. Where did that go?

Gone, on purpose. CyberDeck v2 connects to Companion directly over the network, so there's no file to export and import. Just add a connection with your host and the Satellite port.

Is there an Android version?

Yes: on Google Play, for Android 10+. It runs one surface at a time; the iPad version is the one that runs several at once. See Android for the details.

Can my organization deploy CyberDeck via MDM / Apple Business Manager / Managed Google Play?

Not yet, on either platform. Email me if this is a blocker. I'll prioritize based on what I hear.

Contact

If the answer isn't here, send the details: