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

    Type Alias SerialDevice

    Handler for serial-over-ip. Allows for the topside controller to transmit data to/from the vehicle/peripheral to/from another system. (i.e. Side-scan sonar, topside GPS)

    type SerialDevice = {
        baudRate?: number;
        connectionId?: string;
        connectionName?: string;
        deviceType?: SerialDeviceType;
        isConfigurable?: boolean;
        name: string;
    }
    Index

    Properties

    baudRate? connectionId? connectionName? deviceType? isConfigurable? name

    Properties

    baudRate?: number

    The baud rate for the serial device. This value is meaningless with deviceType::Web

    connectionId?: string

    The id of the device that this device is connected to. If null then this device is not connected to anything

    connectionName?: string

    The name of the device that this device is connected to. if null then this device is not connected to anything. This is purely provided for convenience. If a name change is required send an update to the actual device.

    deviceType?: SerialDeviceType

    Indicates the type of device

    isConfigurable?: boolean

    Denotes if a serial device is configurable by the user. Typically, un-configurable devices will not accept Baud Rate from users.

    name: string

    The display name of this device

    Settings

    Member Visibility

    On This Page

    Properties