diff options
| author | cbdev <cb@cbcdn.com> | 2019-03-31 09:00:12 +0200 |
|---|---|---|
| committer | cbdev <cb@cbcdn.com> | 2019-03-31 09:00:12 +0200 |
| commit | 0c333567f599206cb0be6b74f02e59820536e0b2 (patch) | |
| tree | 23f23e26969103948d433d41762d98e048f4b3ba /backends/artnet.md | |
| parent | a2b0728027dd8961ef84220c8c8eaf8a81154c71 (diff) | |
| download | midimonster-0c333567f599206cb0be6b74f02e59820536e0b2.tar.gz midimonster-0c333567f599206cb0be6b74f02e59820536e0b2.tar.bz2 midimonster-0c333567f599206cb0be6b74f02e59820536e0b2.zip | |
Move backend documentation out of main README
Diffstat (limited to 'backends/artnet.md')
| -rw-r--r-- | backends/artnet.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/backends/artnet.md b/backends/artnet.md new file mode 100644 index 0000000..90a7697 --- /dev/null +++ b/backends/artnet.md @@ -0,0 +1,41 @@ +### The `artnet` backend + +The ArtNet backend provides read-write access to the UDP-based ArtNet protocol for lighting +fixture control. + +#### Global configuration + +| Option | Example value | Default value | Description | +|---------------|-----------------------|-----------------------|-----------------------| +| `bind` | `127.0.0.1 6454` | none | Binds a network address to listen for data. This option may be set multiple times, with each interface being assigned an index starting from 0 to be used with the `interface` instance configuration option. At least one interface is required for transmission. | +| `net` | `0` | `0` | The default net to use | + +#### Instance configuration + +| Option | Example value | Default value | Description | +|---------------|-----------------------|-----------------------|-----------------------| +| `net` | `0` | `0` | ArtNet `net` to use | +| `universe` | `0` | `0` | Universe identifier | +| `destination` | `10.2.2.2` | none | Destination address for sent ArtNet frames. Setting this enables the universe for output | +| `interface` | `1` | `0` | The bound address to use for data input/output | + +#### Channel specification + +A channel is specified by it's universe index. Channel indices start at 1 and end at 512. + +Example mapping: +``` +net1.231 < net2.123 +``` + +A 16-bit channel (spanning any two normal 8-bit channels in the same universe, also called a wide channel) may be mapped with the syntax +``` +net1.1+2 > net2.5+123 +``` + +A normal channel that is part of a wide channel can not be mapped individually. + +#### Known bugs / problems + +The minimum inter-frame-time is disregarded, as the packet rate is determined by the rate of incoming +channel events.
\ No newline at end of file |