Skip to content

Commit

Permalink
chore: update docs about supported surfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
Julusian committed Sep 11, 2024
1 parent 6c78922 commit 1f5e70f
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 11 deletions.
9 changes: 9 additions & 0 deletions docs/7_surfaces/blackmagic_controllers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
It is possible to use the Blackmagic ATEM Micro Panel with Companion since v3.4.0

Enable support for it in the Companion settings, and rescan for USB devices.
This works over both usb and bluetooth. You must make sure to not be running the ATEM software at the same time, or both bits of software will be listening to presses and updating the colours.

The layout matches the natural grid of the device, if you were to squash everything together to remove the blank spaces.
However, the tbar occupies a column in this.

To use the tbar, go to the surface settings and you can select a custom-variable to pipe the value to. You can also provide an expression to control how the tbar leds are lit.
26 changes: 18 additions & 8 deletions docs/7_surfaces/elgato_streamdeck.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
Companion is primarily intended to be used with the various models of [Elgato Stream Deck](https://www.elgato.com/en/stream-deck).

We currently support the following models:
- Stream deck (15 key)
- Stream deck Mini
- Stream deck XL
- Stream deck Mk2
- Stream deck Pedal
- Stream deck +
- Stream Deck (15 key)
- Stream Deck Mini
- Stream Deck XL
- Stream Deck Mk2
- Stream Deck Pedal
- Stream Deck +
- Stream Deck Studio

Occasionally Elgato will release new revisions of these products without notice, so we have to play catch up which results in new devices not working for a few weeks.

We recommend connecting to your Streamdecks without using the Elgato software, but there is a plugin in the Elgato software for those who wish to do this. If going via the Elgato software, then all your Streamdecks will display the same buttons, if done directly they can all be different. There is a [setting](#3_config/settings/surfaces.md) to choose between these modes.

##### Stream deck +
##### Stream Deck +

The Stream deck + is unusual, in that it has rotary encoders and a touch strip.
The Stream Deck + is unusual, in that it has rotary encoders and a touch strip.

The touch strip is a bit limited, and can only provide press events to companion. This means that when you press it, both the down and up actions will be fired with a short delay in between.

To utilise the rotary encoders, enable the `Enable Rotary Actions` checkbox on the button which wants to support the encoder. This will provide additional action groups which will be used when rotating the encoder.


##### Stream Deck Studio

The layout of the studio means the left encoder is at position 0/0, with the buttons starting at 0/1 and continuing across, and the right encoder at 0/17

You can select a custom-variable to write nfc values to in the surface settings.

The led rings around the encoders are not yet supported, we are still figuring out how they should translate across.
7 changes: 4 additions & 3 deletions docs/7_surfaces/xkeys.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Many of the [XKeys](https://xkeys.com/xkeys.html) products can be used with Companion.

Due to Companion being limited to 32 buttons per page (we are looking into improving this [Github issue](https://github.com/bitfocus/companion/issues/1607)), many of the xkeys devices do not translate across nicely.
Since Companion v3.2, xkeys will by default run in their natural layout which is often larger than the default grid size. In the settings you can opt into the old layout until you can update your configs. This option will go away in some future release of Companion

Instead, Companion will map the buttons through in order (working across in rows) to buttons in Companion, using as many pages as needed.
In this old layout mode, Companion will map the buttons through in order (working across in rows) to buttons in Companion, using as many pages as needed.

There is some limited support for T-bars and shuttle/jog wheels, which write their values to some hardcoded internal variables.

There is some limited support for T-bars and shuttle/jog wheels, only supported by a couple of modules.
4 changes: 4 additions & 0 deletions docs/structure.json
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,10 @@
"label": "VEC Footpedal",
"file": "7_surfaces/vec_footpedal.md"
},
{
"label": "Blackmagic ATEM Micro Panel",
"file": "7_surfaces/blackmagic_controllers.md"
},
{
"label": "203 Systems Mystrix",
"file": "7_surfaces/mystrix.md"
Expand Down

0 comments on commit 1f5e70f

Please sign in to comment.