Skip to content

Telemetry

!!! info "Coming soon" The Rover Nexus REST API is not yet available. This page describes the planned shape and may change. To integrate today, use the Zenoh messaging surface (primary) or the ROS 2 bridge.

Telemetry is the live operational data a robot reports: its position, heading, battery, mode, and health.

What it represents

Each robot continuously reports telemetry while it operates. The REST API lets you read the latest known telemetry for a robot or fleet — a snapshot of the most recent values. Typical fields include:

Field Description
Position The robot's current location
Heading The direction the robot is facing
Battery Charge level and related power status
Mode The robot's current operating mode
Health Overall status or health indicators

The exact telemetry field names, units, and value formats in the API response are coming soon.

Base URL

The API base URL for telemetry endpoints is coming soon.

Authentication

All requests require a valid credential. See Authentication.

Endpoints

The telemetry resource is read-only over REST and returns last-known values. Exact paths and payloads are not yet finalized.

Operation Description
Get latest (robot) Last-known telemetry for one robot
List latest (fleet) Last-known telemetry for robots in a fleet

Exact paths, methods, and parameters are coming soon.

Real-time streaming

The REST endpoints above return point-in-time snapshots. For continuous, live telemetry, Rover Nexus delivers updates over a real-time streaming channel rather than polling REST.

Details on the real-time telemetry channel — how to connect, authenticate, subscribe to a fleet or robot, and the format of streamed messages — are coming soon. To stream live telemetry today, use the Zenoh messaging surface or the ROS 2 bridge.

Errors and pagination

The error response format and the pagination scheme used by list endpoints are coming soon.