Class DMXController

High-level API for managing universes and sending protocol frames.

Index

Constructors

Methods

addUniverse close flush setChannel setFrame universe

Constructors

constructor

new DMXController(options?: ControllerOptions): DMXController
Create a controller that owns universes and network senders.
Parameters
- options: ControllerOptions = {}
  Protocol and network settings.
Returns DMXController
- Defined in src/core/DMXController.ts:66

Methods

addUniverse

addUniverse(id: number): Universe
Create a universe if it does not already exist.
Parameters
- id: number
Returns Universe
- Defined in src/core/DMXController.ts:80

close

close(): void
Returns void
- Defined in src/core/DMXController.ts:145

flush

flush(universeId?: number, force?: boolean): Promise<void>
Flush a single universe or all universes to the network.
Parameters
- OptionaluniverseId: number
- force: boolean = false
Returns Promise<void>
- Defined in src/core/DMXController.ts:115

setChannel

setChannel(universeId: number, address: number, value: number): Universe
Convenience method to set one channel in a specific universe.
Parameters
- universeId: number
  Universe id.
- address: number
  Channel address (1-512).
- value: number
  Channel value (0-255).
Returns Universe
The target universe instance.
- Defined in src/core/DMXController.ts:97

setFrame

setFrame(
universeId: number,
frame: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
): Universe
Replace the entire universe frame (max 512 bytes).
Parameters
- universeId: number
- frame: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
Returns Universe
- Defined in src/core/DMXController.ts:106

universe

universe(id: number): Universe
Get (or create) a universe by id.
Parameters
- id: number
Returns Universe
- Defined in src/core/DMXController.ts:73