adamflorizone / companion-satellite Goto Github PK

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 install
• yarn dist
• Locate the output under electron-output/

If using a Raspberry Pi, we recommend using the 64bit 'Raspberry Pi OS Lite' images, the non-64bit version should work too but it less tested.
If using a different brand SBC, we recommend running Armbian specifically the minimal debian images, as this provides a minimal and consistent debian environment and are typically more up to date then the manufacturer images.

It can be built and run as a systemd service on a pi or other linux machine

No images are provided for this, but the process has been written to be a single script.

As root, run the following:

curl https://raw.githubusercontent.com/bitfocus/companion-satellite/main/pi-image/install.sh | bash

After this, you can use sudo satellite-update to change the version it has installed. Note: this is currently not fully implemented.

Note: This script will create a new user called satellite, which Satellite will be run as and will own the configuration.

The default rest port is 9999 a GET request to http://Satellite-IP:9999/api/host will return the current target ip in plain text a GET request to http://Satellite-IP:9999/api/port will return the current target port in plain text a GET request to http://Satellite-IP:9999/api/config will return the current target port and ip as json

a POST request to http://Satellite-IP:9999/api/host with json body {"host": "newhostip"} or plain text newhostip will connect the satellite to that ip or hostname a POST request to http://Satellite-IP:9999/api/port with {"port": 16622} or plain text 16622 will connect the satellite to that port a POST request to http://Satellite-IP:9999/api/config with {"host": "newhostip", "port": 16622} will connect the satellite to that ip/hostname and port

NodeJS 16 is required

1. Install the dependencies yarn install
2. Ensure the electron dependencies are installed yarn electron-rebuild
3. Run it yarn dev-electron

You can package for electron with yarn dist.
Building for another platform has not been tested.

1. 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
2. Run it yarn dev 127.0.0.1 substituting in your companion instance ip address