moritzruth/node-enttec-open-dmx-usb
1
0
Fork 0
mirror of https://github.com/moritzruth/node-enttec-open-dmx-usb.git synced 2025-04-21 07:41:22 +02:00
Code Releases Activity Actions
💡 A Node.js library for interacting with the Enttec Open DMX USB Interface
135 commits 1 branch 4 tags 520 KiB
TypeScript 100%
Find a file
Simon A. Eugster 065d48d8fe Forward SerialPort error event
2022-06-24 22:21:45 +02:00
src Forward SerialPort error event 2022-06-24 22:21:45 +02:00
.eslintrc.json No longer use @pika/pack and remove some events 2021-02-26 10:41:06 +01:00
.gitignore No longer use @pika/pack and remove some events 2021-02-26 10:41:06 +01:00
.nvmrc Rewrite using TypeScript and Pika Pack 2020-08-04 02:06:34 +02:00
LICENSE No longer use @pika/pack and remove some events 2021-02-26 10:41:06 +01:00
package.json v3.0.0 2021-02-26 10:41:37 +01:00
README.md Forward SerialPort error event 2022-06-24 22:21:45 +02:00
tsconfig.json No longer use @pika/pack and remove some events 2021-02-26 10:41:06 +01:00
yarn.lock Bump path-parse from 1.0.6 to 1.0.7 2021-08-11 20:14:52 +00:00

README.md

node-enttec-open-dmx-usb 🔌

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

Only tested on Windows, but as it uses serialport under the hood, it should also work in these environments.

Install

npm

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. The error can also originate from SerialPort.