Deep Trekker BRIDGE API

💡 Read the Service Disclaimer before using the API.

Introduction

The Deep Trekker BRIDGE API is a programming interface developed to enable external development with Deep Trekker systems. This API enables integration of Deep Trekker’s vehicle systems into various applications, facilitating real-time access to data and control. It supports multiple connection methods and offers detailed schemas for consistent and reliable data transfer.

This documentation describes the core types, schemas, enumerations, and construct definitions used by client-side applications and server side devices to communicate with one another. Furthermore, it also describes the various supported connection methods and means of communicating data. Altogether, this forms the entirety of the Deep Trekker API.

Connection Methods

The JSON-based API data is inherently agnostic, allowing any communication protocol to convey Deep Trekker API data. However, Deep Trekker supports two specific connectivity methods that are officially compatible with its vehicles, controllers, and peripheral devices. These supported methods ensure seamless and reliable integration, facilitating efficient control and data exchange across the Deep Trekker ecosystem.

Direct Socket Connection

The most accessible connection method to the system is through the use of a TCP socket connection. This connection has no additional handshaking requirements and can be accessed via port 5005 on any of the supported hardware devices.

Simply establish a TCP connection to <device_ip_address>:5005.

Once the connection is made data will start to be received.

WebRTC Connection

A WebRTC connection interface is also available, incorporating video transport, encrypted connections, and handshaking for over-the-internet control. This interface is more complex and requires significantly more development effort and expertise to utilize. If you have specific requirements necessitating a WebRTC connection, please contact [email protected] for additional information.

Supported Hardware

Handheld Controller

The standard Deep Trekker hand controller supports the Direct Socket Connection to data readout and no vehicle control.

BRIDGE Box / BRIDGE Box Enabled Products

The BRIDGE Box and BRIDGE Box enabled products (such as Powered Reels and Consoles) have full support for the API.

Transfer Payload and Schema

Transfer Payload

All API data is transacted through the TransferPayload object. This object contains the schema payload, as well as the method type and error flagging.

Transfer payloads can use 4 different method types, as well as an error flag:

• Methods

  • GET - Used by the client to request API data
  • SET - Used by the client to send API data
  • UPDATE - Sent by the server to send API data updates
  • DELETE - Sent by the server to notify the client of removed API data

• Errors

  • ERROR - Sent by the server to communicate API transaction errors
    • The full list of errors and their details can be seen here.

JSON Schema

All payload data is required to satisfy the JSON schema detailed in this documentation.

Below is sample schema of the Deep Trekker REVOLUTION, detailed information about all supported devices and attributes can be found documented in this site.

{@codeblock ~~/dist/samples/json/states/revolutionRandomState.json}

⚖️ Service Disclaimer

The Deep Trekker API ("our API library") is provided as is, without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. We make no representations or warranties that the API library will meet your requirements or that its operation will be uninterrupted or error-free. We will not be liable for any damages of any kind arising from the use of the API library, including but not limited to direct, indirect, incidental, punitive, and consequential damages.

We do not provide technical support for integrating our API library into your software application. While we strive to make our API library easy to use and provide documentation and sample code, it is your responsibility to ensure that your software is compatible with our API library and that the integration is implemented correctly. We will not be liable for any issues or errors that arise from the integration of our API library into your software application.