Deep Trekker BRIDGE API - v1.0.41
    Preparing search index...

    Type Alias DeviceConfigPayload<TDevicePosition>

    Shared shape for the device allocation payload. The frontend sets cmd (and deviceId where required); the backend reports progress back through state/errorCode/knownDevices/unknownCount.

    type DeviceConfigPayload<TDevicePosition extends string> = {
        cmd?: DeviceConfigCmd;
        deviceId?: TDevicePosition;
        errorCode?: DeviceConfigError;
        knownDevices?: TDevicePosition[];
        state?: DeviceConfigState;
        unknownCount?: number;
    }

    Type Parameters

    Index

    Properties

    cmd? deviceId? errorCode? knownDevices? state? unknownCount?

    Properties

    cmd?: DeviceConfigCmd

    Frontend-issued command. See DeviceConfigCmd.

    deviceId?: TDevicePosition

    The device position targeted by cmd. Required for ASSIGN and INVERT_DIRECTION.

    errorCode?: DeviceConfigError

    Backend-reported error from the most recently rejected command. See DeviceConfigError.

    knownDevices?: TDevicePosition[]

    The set of device positions that have already been assigned to a physical device.

    state?: DeviceConfigState

    Backend-reported state of the allocation state machine. See DeviceConfigState.

    unknownCount?: number

    The number of physical devices detected that have not yet been assigned a position.

    Settings

    Member Visibility

    On This Page

    Properties