node-dmx
    Preparing search index...

    Type Alias RdmResponderOptions

    type RdmResponderOptions = {
        additionalSupportedPids?: number[];
        currentPersonality?: number;
        deviceLabel?: string;
        deviceModelDescription?: string;
        deviceModelId?: number;
        dmxStartAddress?: number;
        manufacturerLabel?: string;
        onDeviceLabelChange?: (label: string) => void;
        onDmxStartAddressChange?: (address: number) => void;
        onIdentifyChange?: (identify: boolean) => void;
        onPersonalityChange?: (personality: number, footprint: number) => void;
        onUnhandledCommand?: (
            request: RdmRequest,
        ) => Buffer | RdmNackReason | undefined;
        personalities?: RdmPersonality[];
        productCategory?: number;
        softwareVersionId?: number;
        softwareVersionLabel?: string;
        uid: UID;
    }
    Index

    Properties

    additionalSupportedPids? currentPersonality? deviceLabel? deviceModelDescription? deviceModelId? dmxStartAddress? manufacturerLabel? onDeviceLabelChange? onDmxStartAddressChange? onIdentifyChange? onPersonalityChange? onUnhandledCommand? personalities? productCategory? softwareVersionId? softwareVersionLabel? uid

    Properties

    additionalSupportedPids?: number[]

    Extra manufacturer-specific PIDs to advertise via SUPPORTED_PARAMETERS; handle them via onUnhandledCommand.

    currentPersonality?: number

    1-based index into personalities. Defaults to 1.

    deviceLabel?: string
    deviceModelDescription?: string
    deviceModelId?: number
    dmxStartAddress?: number
    manufacturerLabel?: string
    onDeviceLabelChange?: (label: string) => void
    onDmxStartAddressChange?: (address: number) => void
    onIdentifyChange?: (identify: boolean) => void
    onPersonalityChange?: (personality: number, footprint: number) => void
    onUnhandledCommand?: (request: RdmRequest) => Buffer | RdmNackReason | undefined

    Called for any GET/SET this responder doesn't handle itself. Return response parameter-data bytes to ACK, an RdmNackReason to NACK, or undefined to fall back to NACK(UNKNOWN_PID) — no frame building required either way.

    personalities?: RdmPersonality[]

    Available personalities (modes). Defaults to one personality matching dmxFootprint/1.

    productCategory?: number

    Product category code (ANSI E1.20 Table A-3). Defaults to a generic fixture code.

    softwareVersionId?: number
    softwareVersionLabel?: string
    uid: UID

    This device's RDM UID.

    Settings

    Member Visibility

    On This Page

    Properties