enttec-open-dmx-usb

  • Version 3.0.0
  • Published
  • 10.8 kB
  • 2 dependencies
  • MIT license

Install

npm i enttec-open-dmx-usb
yarn add enttec-open-dmx-usb
pnpm add enttec-open-dmx-usb

Overview

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

Index

Variables

variable PRODUCT_ID

const PRODUCT_ID: string;

    variable VENDOR_ID

    const VENDOR_ID: string;

      Classes

      class EnttecOpenDMXUSBDevice

      class EnttecOpenDMXUSBDevice extends EventEmitter<Events> {}

        constructor

        constructor(path: string, startSending?: boolean);

        method getFirstAvailableDevice

        static getFirstAvailableDevice: () => Promise<string>;
        • Gets the path of the first available device found.

          Returns

          {Promise}

          Throws

          Error when no device is found.

        method listDevices

        static listDevices: () => Promise<string[]>;
        • Lists the paths of all available devices.

          Returns

          {Promise<string[]>}

        method setChannels

        setChannels: (
        channels: Buffer | number[] | Record<number, number>,
        clear?: boolean
        ) => void;
        • Sets the channel values. If channels is an Object, the keys are the channel numbers.

          Parameter channels

          Parameter clear

          Whether all previously assigned channels should be set to 0

        method startSending

        startSending: (interval?: number) => void;
        • Starts sending.

          Parameter interval

          The time between each attempt to send.

          Throws

          Error If the device is not ready yet.

        method stopSending

        stopSending: () => void;
        • Stops sending.

        Package Files (1)

        Dependencies (2)

        Dev Dependencies (6)

        Peer Dependencies (0)

        No peer dependencies.

        Badge

        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/enttec-open-dmx-usb.

        • Markdown
          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/enttec-open-dmx-usb)
        • HTML
          <a href="https://www.jsdocs.io/package/enttec-open-dmx-usb"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>