A small application to allow for connecting a streamdeck to Bitfocus Companion over a network.
Companion 2.2.0 and newer are supported
Each device will appear in companion as its own 'satellite' device, and can be configured as if they are local.
Note: This connects over the satellite device api which uses port TCP 16622.
You can find installers on the releases page
A prebuilt image is provided for recent releases. Check the releases tab for the latest image.
After writing the image to an sd card, edit the satellite-config file in the boot partition to point to your companion instance.
This application can be built with electron to provide a minimal ui and to allow for minimising to the system tray. You can right click the tray icon to:
- Set the ip address of the companion instance to connect to
- Force a manual scan for devices. This is done automatically when a new device is detected, but it can sometimes miss some
To manually build the latest version for your machine:
yarn installyarn dist- Locate the output under
electron-output/
It can be built and run as a systemd service on a pi or other linux machine
To prepare the application, after cloning:
yarn installyarn build
An example systemd unit (make sure to update the paths and companion ip as appropriate):
[Unit]
Description=Bitfocus Companion Satellite
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=pi
WorkingDirectory=/home/pi/companion-satellite
ExecStart=node /home/pi/companion-satellite/dist/main.js 192.168.0.1
Restart=on-failure
KillSignal=SIGINT
TimeoutStopSec=60
[Install]
WantedBy=multi-user.target
NodeJS 16 is required
- Install the dependencies
yarn install - Ensure the electron dependencies are installed
yarn electron-rebuild - Run it
yarn dev-electron
You can package for electron with yarn dist.
Building for another platform has not been tested.
- If you are running this after either running in electron, or packaging for electron, it is best to remove the node_modules folder and rerun
yarn install - Run it
yarn dev 127.0.0.1substituting in your companion instance ip address