Control livematrix with hardware panels (StreamDeck, X-Keys, ...) with Bitfocus Companion
To control livematrix with a hardware panel like a StreamDeck or an X-Keys panel the Bitfoucs Companion module can be used.
Installation of Bitfocus Companion
Section titled “Installation of Bitfocus Companion”Get started by downloading Bitfocus Companion from bitfocus.io. A free bitfocus account is needed for that. Then follow the standard installation on the device you plan to connect your USB devices to. Open then the Companion application and press “Launch GUI” to open the configuration of Companion.
// TODO AI add launch GUI screenshot.
Connect
Section titled “Connect”Then continue by connecting your hardware panels to bitfocus companion.
// TODO AI add explanation how to connect via USB. Also create a remark not to install the stream deck app, or how to use stream deck app with companion module.
Install the livematrix Module
Section titled “Install the livematrix Module”// TODO add AI description
Connect Companion to livematrix
Section titled “Connect Companion to livematrix”There are two ways to connect Companion to livematrix. Either the module logs in directly in the matrix with a specific user, which allows running companion on another machine than the actual client, or livematrix uses the local livematrix client to connect.
The advantage of using the local livematrix client to connect is, that whenever the user logs in with another username, Companion is automatically also connected with the same username.
// TODO AI add steps to connect
Configure buttons
Section titled “Configure buttons”No under Buttons the individual buttons of the panel can be configured. The easiest way is to use Presets tab in the right part of the screen. There keys can be dragged onto the surface for the different functionality.
There are different type of button presets:
| Key type | Description |
|---|---|
| Intercom keys | Combined talk and listen keys. A short press on the button will toggle the talk state (latch), a long press will trigger a momentary talk action of this key and a double press will toggle the talk state |
| Talk keys | A short press on a talk key will toggle the talk state (latch), a long press will trigger a momentary talk action |
| Listen keys | Pressing the key toggles the state of the listen key. |
For every key type there is the option to select keys by index or by target. By index will link a button to the key position. So when an administrator changes a profile (adds, moves, deletes keys) that will reflect on the panel. By target will fixed select this target, no matter if the administator changes the profile.
Additionaly to keys, a few more presets are available, affecting the selected key. The selected key is the last used key, marked with a thicker border aroudn the volume bar.
| Preset | Description |
|---|---|
| Selected key listen knob | Preset for knob buttons (e.g. on Stream Deck Plus), to change the selected key. |
| Selected key volume up knob | Changes to listen volume of the selected key one dB up. |
| Selected key volume down knob | Changes to listen volume of the selected key one dB down. |
Mute your microphone
Section titled “Mute your microphone”The Microphone mute preset (in the Microphone and Selection section) mutes and unmutes your microphone. It shows the name of the device that holds your mic, and turns red while the mic is muted or while no device holds it.
You have one microphone state, whichever device you use. Muting from Companion silences you everywhere: on talk keys, on party lines and for anyone listening to you. Muting in the app shows up on the Companion button, and the other way round. Unmuting from Companion turns the mic on in the app without anything to do there.
Companion never holds the mic itself. It mutes and unmutes the device that does. If that device is gone, unmuting gives the mic to the device of yours that held it most recently. If none of your devices can take it, nothing changes, and the $(livematrix:mic_error) variable says why until the mic state changes next.
The module offers three actions for your own buttons:
| Action | Description |
|---|---|
| Mute microphone | Mutes the mic. |
| Unmute microphone | Unmutes the mic. |
| Toggle microphone mute | Mutes a live mic, or unmutes a muted one. The preset uses this. |
For a cough button, put Mute microphone on the button’s press and Unmute microphone on its release.
The feedbacks Microphone muted and Microphone live, and the variables mic_muted, mic_device, mic_holder_online and mic_error, show the same state on any button.
Different pages
Section titled “Different pages”// TODO AI explain pages concept of companion
Update the livematrix Module
Section titled “Update the livematrix Module”// TODO AI