Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@blackmagic-controller/node

Julusian2.8kMIT1.0.3TypeScript support: included

An npm module for interfacing with the Blackmagic usb/bluetooth controllers in node

blackmagic, atem, hid, usb, bluetooth, hardware, interface, controller

readme

@blackmagic-controller

Node CI codecov

@blackmagic-controller is a collection of libraries for interfacing with the various models of the usb controllers made by Blackmagic Design.

Installing & Usage

Check one of the installable packages for installation and usage instructions:

Have another hid target you wish to use?

The existing implementations are a light wrapper around the platform agnostic @blackmagic-controller/core. You can use your own HID implementation and device scanning/opening logic and reuse all the blackmagiccontroller bits.

Demo

If you are using a Chromium v89+ based browser, you can try out the webhid demo

Linux

On linux, the udev subsystem blocks access to the BlackmagicController without some special configuration. Copy one of the following files into /etc/udev/rules.d/ and reload the rules with sudo udevadm control --reload-rules

  • Use the headless server version when your software will be running as a system service, and is not related to a logged in user
  • Use the desktop user version when your software is run by a user session on a distribution using systemd

Unplug and replug the device and it should be usable

Contributing

The blackmagic-controller team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

Please refer to the Changelog for project history details, too.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.3 (2025-12-22)

Bug Fixes

  • replay editor over bluetooth on macos (hopefully) (7e50cde)
  • speed editor over bluetooth on macos (95093f3)

1.0.2 (2025-09-27)

Bug Fixes

1.0.1 (2025-09-27)

Bug Fixes

1.0.0 (2025-09-27)

⚠ BREAKING CHANGES

  • Build as ESM

Features

Bug Fixes

  • remove battery level for speed editor (1f99ef3)

0.2.2 (2025-05-30)

Bug Fixes

0.2.1 (2025-05-30)

Bug Fixes

  • tool to generate udev rules (3972a58)

0.2.0 (2025-05-11)

Features

0.1.1 (2025-02-02)

Bug Fixes

0.1.0 (2024-09-02)

Note: Version bump only for package blackmagic-controller-packages