Macro Deck Companion

The Macro Deck Companion integration connects Macro Deck to the phones and tablets that run the Macro Deck Companion app for Android, iPhone and iPad. Every device that connects gets its own configuration, so you can send commands to one specific tablet and read what it reports, next to all your other devices.

You do not enter anything to set it up. Open the Companion app on the device and connect it to your computer. The device then appears in the integration by itself, under its own name.

What you can do

The actions work on one device at a time. You choose the device in the Device field of each action:

• Set screen brightness and Set orientation (automatic, portrait or landscape) work on Android, iPhone and iPad.
• Vibrate works on Android and iPhone.
• Take screenshot captures the deck, or on Android the whole screen, and saves it as a PNG file in a folder on your computer.
• Turn screen on, Turn screen off and Bring to front work on Android, once you allow them under Device control in the app settings.

Each device also reports its state as variables: battery level, charging, orientation, screen brightness, model, platform, app version, whether Macro Deck is in front, the network type and name, and CPU and memory usage. Use them in labels, conditions and automations like any other variable.

Example setups

• A tablet that only serves as a deck: an automation on Server Stopped runs Turn screen off when Macro Deck quits, and an automation on Device Ready runs Turn screen on when the tablet is back.
• Two automations on Variable Changed for the System integration's system_locked variable turn the tablet's screen off when you lock the computer and on again when you unlock it.
• A Schedule event at 22:00 runs Set screen brightness at 20 %, another one at 08:00 sets it back.
• A label on your phone's deck shows companion_<configuration>_battery_level_percent of the tablet on the wall, so you see when it needs charging.
• A button with Take screenshot saves the deck as a PNG file, and Save path to variable puts the file's path into a variable for the next action.

An action needs the device to be connected. When it has just connected, the action waits a few seconds for it to be ready. When a device is not connected, its variables read as unavailable, except companion_<configuration>_is_connected, which reads false.