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

    Type Alias BridgeBox

    BRIDGE Box represents the root of the API endpoint routing

    This is the top-level type that contains all other types and endpoints. It is used to represent the state of the BridgeBox and its associated devices.

    type BridgeBox = {
        devices?: Record<string, Removable<Devices>>;
        enablePassthrough?: boolean;
        faults?: FaultHandler;
        networkDiagnostics?: Record<string, NetworkDiagnostics>;
        serialDevices?: Record<string, SerialDevice>;
        sonar?: Sonar;
        swupdate?: SWUpdate;
        systemDiagnostics?: SystemDiagnostics;
        systemSettings?: SystemSettings;
        version?: DeviceVersion;
    }
    Index

    Properties

    devices? enablePassthrough? faults? networkDiagnostics? serialDevices? sonar? swupdate? systemDiagnostics? systemSettings? version?

    Properties

    devices?: Record<string, Removable<Devices>>

    This contains a list of devices and associated mac addresses for accessing connected devices, such as vehicles, reels, etc.

    See a specific device type for more information. (Crawler, ROV, etc.)

    {
      "device1_mac": {
        "model": "14", //This is the only required property. It is used to denote which device is being referenced.
      },
      "device2_mac": {
        "model": "13", //See {@link DeviceModel | DeviceModel} for valid properties
      }
    }

    Devices

    enablePassthrough?: boolean

    Can be set to enable passthrough mode on the BridgeBox, which determines if the device will serve or receive DHCP requests.

    This is useful for scenarios where the BridgeBox needs to act as a DHCP relay or when integrating with existing network infrastructure.

    {
      "enablePassthrough": true
    }
    faults?: FaultHandler

    Allows users to clear faults from all of their devices. The BridgeBox will not send anything for this value, but if it receives it then it clears all active faults from any connected device.

    {
      "faults": {
        "clear": true
      }
    }

    FaultHandler

    networkDiagnostics?: Record<string, NetworkDiagnostics>

    Record of known network interfaces on the BridgeBox and their live performance diagnostics.

    Multiple records may be correlated to a single interfaceName. There will typically be two records for a given interfaceName to represent local and remote mac addresses of the network connection. Records here are differentiated by the network card's unique MAC Address.

    NetworkDiagnostics

    serialDevices?: Record<string, SerialDevice>

    This list contains all the serial devices that the backend can modify and communicate with. This is how we achieve serial-over-ip.

    It can be updated with a new key(generated by the frontend) to create a WebSerialDevice.

    {
      "serialDevices": {
         "External GPS Source": {
             "deviceType": "Internal",
             "baudRate": 115200,
             "name": "External GPS Source",
             "connectionId": "xHCI Host Controller 1",
             "connectionName": "Bottom USB Port"
         },
         "xHCI Host Controller 1": {
             "deviceType": "Controller",
             "baudRate": 115200,
             "name": "xHCI Host Controller 1",
             "connectionId": "External GPS",
             "connectionName": "Gps Source"
         }
      }
    }

    SerialDevice

    sonar?: Sonar

    Endpoint for the connected sonar. There can only be one sonar device connected at a time.

    Sonar for more information.

    swupdate?: SWUpdate

    This is the software update endpoint for the BridgeBox. It contains information about the current software update state, available updates, and progress of the update.

    {
     "swupdate": {
         "progress": 50
      }
    }

    SWUpdate

    systemDiagnostics?: SystemDiagnostics

    Raw usage values from the hardware running the BridgeBox. (e.g. CPU and memory usage)

    {
     "systemDiagnostics": {
         "conGuiCpuUsage": 25,
         "conGuiMemUsage": 60,
         "totalCpuUsage": 75,
         "totalMemUsage": 80
     }
    }

    SystemDiagnostics

    systemSettings?: SystemSettings

    An endpoint to facilitate requesting and adjusting system settings. Allows time and system of measurement adjustments.

    SystemSettings

    version?: DeviceVersion

    The BridgeBox version will be incremented when backend services or operating system updates are available. This type should be checked against the BridgeBox version provided within the update package meta data.

    DeviceVersion

    Settings

    Member Visibility

    On This Page

    Properties