Obstacles Protocols

/obstacles/?

SourceVisualizer
DestinationSimulator
Data TypeString
Message Format {reality}
Description The visualizer can request from the Simulator about obstacle data, filtered by the reality. Reply will be received through the topic /obstacles.

reality: M: mixed, V: virtual, R: real | default: M

/obstacles

Source Simulator
Destination Visualizer
Data Type JSON List
Message Format
[ Obstacle1, Obstacle2 ]
Description The Simulator will send this as response to the /obstacles/? request. This is always a retained type message.

obstacle: Refer Obstacle JSON API definitions for learn more about Obstacle JSONs schema.

/obstacles/delete

Source Simulator
Destination Visualizer
Data Type JSON
Message Format
{ "id": [obstacle_Id] }
Description Delete the obstacle from the environment, which has given id.

obstacle_Id: A randomly generated, unique UUID number of the obstacle, assigned by the Simulator, once it was created

/obstacles/delete/all

Source Simulator
Destination Visualizer
Data Type String
Message Format ?
Description Delete all the obstacles in the environment.