Add support for sending & receiving ArtNet TimeCode

README.md

@@ -13,6 +13,7 @@ or full ArtNet/DMX controllers.
 * Automatic discovery using `ArtPoll` / `ArtPollReply`
 * Low-level packet encoder/decoder which can be used as a binary protocol library without all other functionality.
 * Sending/receiving of DMX data (`ArtDmx`)
+* Sending/receiving of ArtNet TimeCode data (`ArtTimeCode`)
 
 ## Usage
 Install Node ArtNet Protocol using NPM:
@@ -32,11 +33,16 @@ controller.bind('0.0.0.0');
 // Send DMX data (Sequence 0, Physical input port 0, Universe 0.
 controller.sendBroadcastPacket(new ArtDmx(0, 0, 0, [255, 0, 0]));
 
-// Or if you want to receive DMX data
+// Receive DMX data
 controller.on('dmx', (dmx) => {
     // dmx contains an ArtDmx object
     console.log(dmx.universe, dmx.data);
 });
+
+// Receive timecode data
+controller.on('timecode', (timecode) => {
+    console.log(`ArtNet TimeCode received (running @ ${timecode.framerate} fps): ${timecode.getTimeCodeString()}`);
+});
 ```
 
 ## Reference

dist/controller.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import { ArtNetPacket } from './protocol';
-import EventEmitter = require('events');
+import { ArtNetPacket } from "./protocol";
+import EventEmitter = require("events");
 export declare class ArtNetController extends EventEmitter {
     private readonly interfacePrefixes;
     private readonly isController;

dist/protocol.d.ts

@@ -112,6 +112,22 @@ export declare class ArtDmx extends ArtNetPacket {
     static decode(data: Buffer): ArtDmx;
     encode(): Buffer;
 }
+export declare class ArtTimeCode extends ArtNetPacket {
+    opcode: number;
+    protocolVersion: number;
+    framerate: number;
+    stream: number;
+    frames: number;
+    seconds: number;
+    minutes: number;
+    hours: number;
+    constructor(hours: number, minutes: number, seconds: number, frames: number, framerate: number, stream?: number);
+    getTimeCodeString(): string;
+    static getType(framerate: number): number;
+    static getFramerate(type: number): number;
+    static decode(data: Buffer): ArtTimeCode;
+    encode(): Buffer;
+}
 export declare class ArtSync extends ArtNetPacket {
     opcode: number;
     protocolVersion: number;