@deeptrekker/api-domain

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.

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.

Connection Methods

At this time, we primarily allow access to our API via socket connections. If you require a different method, please contact sales.

Direct 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.

You can parse this data to obtain a camera ip address to start a RTSP stream.

Supported Hardware

Handheld Controller

Connect an external device to the handheld controller via ethernet to access the API.

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

See {@link TransferPayload} for more information.

JSON Schema

{
    "payload": {
        "devices": {
            "0011223344":{
                "model": 19,
                "auxLight": {
                    "intensity": 100
                }
            }
        }
    }

}

⚖️ 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 payloads, 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.