# ajazz-companion-bridge

ajazz-companion-bridge is a self-hosted automation app. Use an Ajazz AKP05E (or compatible Mirabox) LCD button pad that is plugged into this Unraid server as a control surface for Bitfocus Companion. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/7211/ajazz-companion-bridge

## Description

Use an Ajazz AKP05E (or compatible Mirabox) LCD button pad that is plugged into this Unraid server as a control surface for Bitfocus Companion. The bridge reads the pad over USB, talks to Companion through its Satellite API, shows Companion's button pictures on the pad and sends key presses, touch-strip taps, swipes and dial turns back. It reconnects by itself if the pad is unplugged or Companion restarts. SETUP: (1) In Companion enable Settings > Satellite API (port 16622) and switch off Settings > Surfaces > "Enable connected Mirabox Stream Dock devices". (2) Set "Companion host" below to the IP of the machine running Companion. (3) Set "USB HID device" below to the pad's /dev/hidrawN node. The pad appears as two hidraw entries; you need the one whose HID_PHYS ends in /input0. In the Unraid terminal run: for d in /sys/class/hidraw/hidraw*; do grep -q 00000300:00003004 $d/device/uevent

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

44/100 (Fair), based on 3 of 4 factors.
- Maintained: 72 (last commit 3 days ago)
- Popular: 17 (6 GitHub stars)
- Easy to install: 20 (1 install platform, Docker image)

## Links

- Unraid: https://ca.unraid.net/apps/app_4e61ae64bbaf8e39
- GitHub: https://github.com/dvortsis/ajazz-companion-bridge

## Common questions

### Which Companion settings must be changed so the bridge can use the pad?

Enable Companion's Satellite API on port 16622. Also disable Settings > Surfaces > "Enable connected Mirabox Stream Dock devices" so Companion does not grab the pad itself.

### Can Bitfocus Companion run on a different computer from the pad?

Yes. Companion can run on the same computer as the pad or on any other computer on your network.

### Is the Ajazz AKP05E the only supported pad?

The AKP05E is the only pad stated as tested on real hardware. Other Ajazz and Mirabox pads are experimental and may or may not work.

### Do I need to install Node.js to run the bridge?

If you run the project from source, Node.js 20 or newer is required. The ready-to-run release downloads include the runtime, so Node.js is not needed for those.

### Does the bridge recover if the pad is unplugged or Companion restarts?

Yes. It reconnects on its own if the pad is unplugged or Companion restarts.

---
Source: Our Local Host (https://ourlocalhost.com/app/7211/ajazz-companion-bridge), the self-hosted and open-source app directory.