OpenRoadCode Navigation Command Service IDD

Interface

The navigation command service is a ZeroMQ REQ/REP interface. The server endpoint is defined by services.navigation.zeromq_navigation_command_server.DEFAULT_NAVIGATION_COMMAND_ENDPOINT and may be overridden by runtime configuration.

Each request is one JSON object. Each request receives exactly one JSON response.

Commands

Versioning is command-semantic rather than envelope-version based in the current interface. The supported command names are:

navigation.calibrate_stationary
navigation.reset_heading
navigation.route.calculate
navigation.route.start
navigation.route.cancel
navigation.route.simulate
navigation.route.simulation.stop

Request envelope

{
  "command": "navigation.route.calculate",
  "arguments": {}
}

command is required. arguments is an object and may be empty.

Response envelope

Successful commands return:

{
  "ok": true,
  "message": "Route calculated",
  "data": {}
}

Rejected commands return:

{
  "ok": false,
  "message": "Human-readable failure reason",
  "data": null
}

data is command-specific and may be omitted or null when the command has no result payload.

Stationary calibration

Command: navigation.calibrate_stationary

Arguments:

Field	JSON type	Default	Meaning
`sample_count`	integer	100	Number of stationary samples to collect
`sample_interval_s`	number	0.01	Delay in seconds between samples

Successful response message: Stationary calibration complete.

Heading reset

Command: navigation.reset_heading

Arguments:

Field	JSON type	Default	Meaning
`heading_deg`	number	0.0	Relative heading to establish, in degrees

Successful response message: Heading reset complete.

Route calculation

Command: navigation.route.calculate

Request example:

{
  "command": "navigation.route.calculate",
  "arguments": {
    "origin": {"latitude": 42.8028, "longitude": -83.0127},
    "destination": {"latitude": 42.3314, "longitude": -83.0458},
    "travel_mode": "AUTO"
  }
}

Coordinates in this command interface are decimal degrees. Supported travel-mode names correspond to TravelMode: AUTO, BICYCLE, PEDESTRIAN, and MOTORCYCLE.

Latitude must be within -90..90 and longitude within -180..180. Omit origin to use the current usable navigation fix. destination may instead be an address string when geocoding is configured. travel_mode defaults to AUTO.

Successful route data has this shape:

{
  "operation_id": "route-operation-id",
  "distance_miles": 35.2,
  "duration_seconds": 2700.0,
  "shape": [
    {"latitude": 42.8028, "longitude": -83.0127}
  ],
  "maneuvers": [
    {
      "instruction": "Head south",
      "verbal_instruction": "Head south",
      "distance_miles": 0.4,
      "duration_seconds": 50.0,
      "begin_shape_index": 0,
      "end_shape_index": 4
    }
  ]
}

The command contract currently preserves the route-planning domain model’s explicitly named mile/second units. This differs intentionally from normalized PUB/SUB telemetry contracts, which use SI units on the wire.

operation_id is the route’s correlation identifier for diagnostics and may be null when no identifier was assigned.

Active route and local playback

Command	Arguments	Successful result / behavior
`navigation.route.start`	Same as route calculation	Returns route data and activates guidance; message `Route started`
`navigation.route.cancel`	Empty object	Cancels the active session and stops playback; message `Active route cancelled`; no data
`navigation.route.simulate`	Optional `time_scale`, positive finite number, default 60	Starts active-route playback; message `Route simulation started at <scale>x`; no data
`navigation.route.simulation.stop`	Empty object	Stops playback without canceling the route; message `Route simulation stopped`; no data

Example playback request:

{"command": "navigation.route.simulate", "arguments": {"time_scale": 60}}

time_scale is a dimensionless speed multiplier relative to planned route duration. Playback follows calculated geometry, not traffic or real vehicle movement. Position telemetry identifies these reports as route-simulation. Android/gpsd playback is local to ORC: live receivers keep running and the bridge continues reporting real GPS. Stop/cancel/replacement/arrival resumes fresh live delivery; restarting never resumes an old playback session. Browser and standalone simulation sources return to their normal configured input/profile on stop.

Simulation rejects unavailable playback support, a missing active route, a non-running source, invalid time scale, or unusable route geometry with ok=false and a reason. Route start rejects unavailable guidance. Cancellation is idempotent, and stopping supported playback while inactive is harmless.

Error behavior

Unknown commands return ok=false. Route calculation also returns ok=false when route planning is unavailable, origin/destination objects are missing or malformed, or the travel mode is unsupported. Transport clients may separately raise an error on timeout or malformed response data.

Ownership

NavigationCommandService owns command semantics independently of transport. The ZeroMQ server owns REQ/REP transport only. UI request handlers and NavigationCommandClient are clients of this service and must not duplicate command execution policy.

Versioning

Breaking changes to an existing command’s request or response semantics require coordinated client/server updates. If independent compatibility becomes necessary, add an explicit protocol version before introducing incompatible deployed endpoints.