Skip to content

Latest commit

 

History

History
189 lines (134 loc) · 5.98 KB

readme.md

File metadata and controls

189 lines (134 loc) · 5.98 KB
Raw

dmx-ts

DMX-512 controller library for node.js

This is a TypeScript rewrite of dmx.

Install

npm install dmx-ts

Library API

// CommonJS style require
const { DMX } = require('dmx-ts');
// or ES import
import { DMX } from "dmx-ts";

Class DMX

new DMX()

Create a new DMX instance. This class is used to tie multiple universes together.

dmx.addUniverse(name, driver)

  • name - String
  • driver - Instance of a Driver class, see below

Add a new DMX Universe with a name and driver.

The following Drivers are available:

Development Drivers:

  • NullDriver(): a development driver that prints the universe to stdout

Network Drivers:

  • SocketIODriver(): a driver which sends out the universe via socket.IO as an array (see demo_socket_client.js as a client example)
  • ArtnetDriver(): driver for Artnet
  • SACNDriver(): driver for sACN
  • BBDMXDriver(): driver for BeagleBone-DMX

Serial Drivers (USB):

  • DMX4AllDriver(): driver for DMX4ALL devices like the "NanoDMX USB Interface"
  • EnttecUSBDMXProDriver(): a driver for devices using a Enttec USB DMX Pro chip like the "DMXKing ultraDMX Micro".
  • EnttecOpenUSBDMXDriver(): driver for "Enttec Open DMX USB". This device is NOT recommended, there are known hardware limitations and this driver is not very stable. (If possible better obtain a device with the "pro" chip)
  • DMXKingUltraDMXProDriver(): driver for the DMXKing Ultra DMX pro interface. This driver support multiple universe specify the options with Port = A or B

Each driver has its own options. Example:

const universe1 = dmx.addUniverse('demo1', new NullDriver());
const universe2 = dmx.addUniverse('demo2', new ArtnetDriver("127.0.0.1"));
const universe2 = dmx.addUniverse('demo3', new EnttecUSBDMXProDriver("COM5", { dmxSpeed: 40 }));

dmx.update(universe, channels[, extraData])

  • universe - String, name of the universe
  • channels - Object, keys are channel numbers, values the values to set that channel to
  • extraData - Object, this data will be passed unmodified to the update Event. (Optional; default value is {})

Update one or multiple channels of a universe. Also emits a update Event with the same information.

DMX.devices

A JSON Object describing some Devices and how many channels they use. Currently not many devices are in there but more can be added to the devices.js file. Pull requests welcome ;-)

The following Devices are known:

  • generic - a one channel dimmer
  • showtec-multidim2 - 4 channel dimmer with 4A per channel
  • eurolite-led-bar - Led bar with 3 RGB color segments and some programms
  • stairville-led-par-56 - RGB LED Par Can with some programms

Class Animation

new Animation([options])

Create a new DMX Animation instance. This can be chained similar to jQuery.

The options Object takes the following keys:

  • loop - Number, the number of times this animation sequence will loop when run is invoked. This value is overridden if you invoke runLoop.
  • filter - Function, allows you to read or modify the values being set to each channel during each animation step.

If you specify a filter function, it must take a single object parameter in which keys are channel numbers and values are the values to set those channels to. You may modify the values in the object to override the values in real-time, for example to scale channel brightness based on a master fader.

animation.add(to, duration, options)

  • to - Object, keys are channel numbers, values the values to set that channel to
  • duration - Number, duration in ms
  • options - Object

Add an animation Step. The options Object takes an easing key which allows to set a easing function from the following list:

  • linear (default)
  • inQuad
  • outQuad
  • inOutQuad
  • inCubic
  • outCubic
  • inOutCubic
  • inQuart
  • outQuart
  • inOutQuart
  • inQuint
  • outQuint
  • inOutQuint
  • inSine
  • outSine
  • inOutSine
  • inExpo
  • outExpo
  • inOutExpo
  • inCirc
  • outCirc
  • inOutCirc
  • inElastic
  • outElastic
  • inOutElastic
  • inBack
  • outBack
  • inOutBack
  • inBounce
  • outBounce
  • inOutBounce

Returns an Animation object with the animation step added.

animation.delay(duration)

  • duration - Number, duration in ms

Delay the next animation step for duration. Returns an Animation object with the delay step added.

animation.run(universe, onFinish)

  • universe - Object, reference to the universe driver
  • onFinish - Function, called when the animation is done

Run the Animation on the specified universe.

animation.runLoop(universe)

  • universe - Object, reference to the universe driver

Runs an animation constantly until animation.stop() is called

The example below shows a value being animated for 5 seconds:

const animation = new Animation().add({
  1: 255,
}, 100).add({
  1: 0,
}, 100).runLoop(universe)


setTimeout(() => {
  animation.stop()
}, 5000)

update Event

  • universe - String, name of the universe
  • channels - Object, keys are channel numbers, values the values to set that channel to
  • extraData - Object, data that was passed to the update method.

This event is emitted whenever update is called either by the integrating application or by an animation step.

If triggered by an animation step, extraData.origin will be the string 'animation'.

Develop

Publish to

  1. Run npm version [patch / minor / major / [custom version number]]
  2. Run git tag v[yourVersion]
  3. Push the tag to GitHub using git push --tags

License

MIT