node-enttec-open-dmx-usb/README.md

node-enttec-open-dmx-usb 🔌

A Node.js library for interacting with the Enttec Open DMX USB Interface

As it uses serialport under the hood, it should also work in these environments.

Install

Minimum required Node.js version is v14.0.0.

yarn add enttec-open-dmx-usb
# or
npm install enttec-open-dmx-usb

Usage

View documentation on jsdocs.io

import { EnttecOpenDMXUSBDevice as DMXDevice } from "enttec-open-dmx-usb";

(async () => {
  const device = new DMXDevice(await DMXDevice.getFirstAvailableDevice())

  device.setChannels({
    1: 0xFF,
    2: 0x44
  })

  // same as
  device.setChannels([0xFF, 0x44])

  // same as
  device.setChannels(Buffer.from([0xFF, 0x44]))
})()

Events

ready - startSending can be called.

error - An error occurred. error events from serialport are passed through.