Skip to main content

Documentation

The WARA PS core system is built around a shared MQTT broker. Agents announce what they are, publish sensor data and receive tasks as messages on well-defined topics. A small number of supporting services are exposed over HTTP.

Messaging APIs​

Generated from the WARA PS AsyncAPI specifications. Each page describes one topic: its address, the direction of the message, MQTT quality-of-service settings and the payload schema with examples.

APIPurpose
DeclarationsHeartbeat and capability declarations every agent publishes
SensorsPosition, speed, heading, energy and other telemetry
TasksCommands sent to agents, and their responses and feedback
Map ObjectsPoints, paths and areas shared on the common map
Video Server (RTMP)Publishing and watching agent video streams

PUB and SUB are shown from the agent's point of view: PUB topics are published by the agent, SUB topics are subscribed to by the agent.

HTTP APIs​

Generated from OpenAPI specifications, with request samples in several languages.