Bitfocus Companion module

From Cosmostreamer Wiki
Jump to navigation Jump to search

What is Companion

Bitfocus Companion is a software for expanding capabilities for Elgato Stream Deck devices.
Streamdeck.jpg

https://bitfocus.io/companion
https://www.elgato.com/us/en/p/stream-deck-mk2-black
https://www.elgato.com/us/en/p/stream-deck-plus-black
https://www.elgato.com/us/en/p/stream-deck-xl



Supported version

This module works with Bitfocus Companion 3.xx versions only!
For older Companion versions use this Bitfocus Companion module (old)

Demo video

... add video ...

How to install module

Mac/Windows

1. Download Cosmostreamer module for Companion by this link https://cosmostreamer.com/apps/cosmostreamer-ng/download/companion3/companion3-module.tar.gz

2. Extract it into any directory on your Mac or Windows.

3. Download Bitfocus Companion on downloads page https://user.bitfocus.io/download click on "Companion" stable version button and download installer.

Companion-manual-1.png



4. Install it as the usual application and run.
Companion-manual-2.png

5. Click "Select" button on Companion app window, under "Developer module path" label and choose directory where you extracted the module on step 2.

6. Now click button "Launch GUI". Companion main screen will be opened in a web browser. It will show a prompt for the initial configuration, you can follow this or skip.


Raspberry Pi

Prepared MicroSD image




Manual adding

1. Download a MicroSD image with Companion for Raspberry Pi here https://user.bitfocus.io/download

2. Plug any HDMI display and USB keyboard to the Raspberry Pi runned with Bitfocus Companion MicroSD image.

3. Download Cosmostreamer module for Companion by this link https://cosmostreamer.com/apps/cosmostreamer-ng/download/companion/companion3-module.tar.gz and extract into /opt/companion-module-dev directory

cd /opt/companion-module-dev
wget https://cosmostreamer.com/apps/cosmostreamer-ng/download/companion3/companion3-module.tar.gz
tar zxvf companion3-module.tar.gz

4. Restart service with command "service companion restart" or just reboot Raspberry Pi.

5. Open Companion's web interface in web browser http://<raspberry_pi_ip>:8000

Creating connection for Cosmostreamer

All next steps should be in web interface, doesn't matter where Companion is installed, on Mac/PC or on Raspberry Pi.

1. At first need to create connection for Cosmostreamer. Do a search for "cosmostreamer" in "Add connection" tab and click red button "Add".
Companion-manual-3.png

2. Connection settings with default values
Companion-manual-4.png

3. Here you can see a default connection values.

"Target IP" - IP address of Cosmostreamer device. Leave this value empty if you want to use auto discovery.
"Target Port" - use default value 6262
"Use auto discovery" - find Cosmostreamer device in local network automatically


4. Connection done!

Bitfocus Companion for Raspberry Pi download

MicroSD image with Cosmostreamer module added. Version 2.4.1+70
https://cosmostreamer.com/apps/cosmostreamer-ng/download/companion/companion-pi-stable-v2.4.1-05-12-22.img.zip

Downloads

Cosmostreamer module https://cosmostreamer.com/apps/cosmostreamer-ng/download/companion3/companion3-module.tar.gz