Skip to content

doublerobotics/d3-sdk

Repository files navigation

Double 3 Developer SDK

Before accessing any developer features, your Double 3 will need to be put into developer mode.

Hardware

Double 3 is powered by an Nvidia Jetson TX2-4GB System-on-Module connected to various built-in sensors and devices. The hardware is similar to an Nvidia Jetson TX2 Dev Kit with added peripherals.

Custom Applications

You can write and deploy your own custom code on your D3. The D3 head runs Ubuntu 18.04 with the aarch64 architecture, so you can write code in any language that runs on that platform.

The core D3 software runs as a system service called d3. Your code will interact with this service by sending commands and receiving events. All commands and events are sent over a standard Unix domain socket. See more about communicating with the D3 service.

HTML Applications

You can write an application in HTML and JavaScript and run it in the GUI module as a custom standby screen. You can set it to load on the D3 screen on boot. The GUI module runs an instance of Electron's BrowserWindow, which is essentially a Chromium web view window. Your application is not Electron-specific code, but just a standard web application. It has a preloaded global object that facilitates communication with the d3 service.

Most applications can be HTML applications. You have access to cameras, microphones, and the output of most sensors.

Native Applications

You can also write applications in any other language that will run on the device, such as Python, C++, or Go. However, you will need to manage launching your application on boot. If you choose to do this, you can disable the default GUI from launching on boot.

With a native application, you can get access to raw sensor data, such as direct access to the RealSense D430 depth sensors. You could also create a user interface using any GUI toolkit that you prefer.

In-Call Sidebar Apps

In-Call sidebar apps give developers the ability to add functionality to the driving experience in our desktop web driver client. See more

Examples

  1. nodejs-basic - This example shows the most basic way to communicate with the d3 service in Node.js.
  2. python-basic - This example shows the most basic way to communicate with the d3 service in Python.
  3. standby-basic - This example shows the most basic usage of displaying a page on screen, sending commands via DRDoubleSDK and processing incoming events.
  4. standby-camera - This example shows how to set the output of the camera as a v4l2 source and show it on the D3 screen with getUserMedia.
  5. standby-webrtc - This example shows how to orchestrate a WebRTC call using a custom standby screen and the native WebRTC implementation that takes advantage of the hardware h264 encoder.
  6. sidebar-basic - This example shows the basic functionality of an In-Call Sidebar App.

Documentation

  • Glossary describes key terms used throughout this documentation.
  • Release Notes shows the history of new features.

D3 API

  • API lists all commands and events.
  • Cameras describes how to access the on-board cameras in various ways.
  • Click-to-Drive describes how to implement Click-to-Drive in your application.
  • Communication describes the command and event JSON packet structures.
  • Sidebar Apps discusses In-Call Sidebar Apps.
  • Standby Apps discusses Standby Apps.

System Configuration

  • Console and Ubuntu Desktop describes how to access Ubuntu in standard ways.
  • Developer Mode describes entering and exiting developer mode.
  • Performance Model describes how to control battery life vs high performance CPU and GPU.
  • Security discusses security measures and how to maintain security when deploying.
  • Software Updates discusses installing software and updating the D3 software.
  • Startup describes how to customize what runs on boot.
  • USB Drive shows how to set up a USB flash drive for writing and executing code.
  • WPA2 Manual Config describes how to add a more complex WiFi network, such as EAP-TLS.

Developer Mailing List

Get an email with release notes for each update by signing up for the developer mailing list.

D3 System Diagram

Monitor

The Monitor allows you to view and control all of your Double's features from a web interface hosted by an internal server on your D3. The Monitor is a great way to test the functionality of commands before writing any code.

Open the Monitor of your D3 in Chrome on your computer by visiting: http://YOUR_D3_IP:8080. You can find your D3's local IP by tapping the WiFi icon on the default standby screen. This tool uses the same API commands that you can use in a custom application to communicate with the D3 system.

D3 Developer Monitor

About

Developer SDK for Double 3 telepresence robot platform

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published