Class ArtNetRdmClient

Minimal client for ToD and single-request RDM transactions over Art-Net.

Index

Constructors

Methods

close getTod rdmTransaction

Constructors

constructor

new ArtNetRdmClient(options: ArtNetRdmClientOptions): ArtNetRdmClient
Create an Art-Net RDM client.
Parameters
- options: ArtNetRdmClientOptions
  Socket and timeout options.
Returns ArtNetRdmClient
- Defined in src/protocols/artnet/rdm/artnet-client.ts:38

Methods

close

close(): void
Close the UDP socket.

Returns void
- Defined in src/protocols/artnet/rdm/artnet-client.ts:86

getTod

getTod(universe: number, timeoutMs?: number): Promise<UID[]>
Request the Table of Devices (ToD) for a universe.
Parameters
- universe: number
- OptionaltimeoutMs: number
Returns Promise<UID[]>
- Defined in src/protocols/artnet/rdm/artnet-client.ts:49

rdmTransaction

rdmTransaction(
    universe: number,
    request: RdmRequest,
    timeoutMs?: number,
): Promise<RdmResponse | null>
Send a single RDM request and wait for a response.
Parameters
- universe: number
- request: RdmRequest
- OptionaltimeoutMs: number
Returns Promise<RdmResponse | null>
- Defined in src/protocols/artnet/rdm/artnet-client.ts:65