SimulatorRoom
HTTP API schema
← HTTP API referenceView source specification ↗
A room a simulated robot vacuum can clean. The room becomes an endpoint group the simulator can control with clean-room, shown on the robot's house map when it has a polygon.
SimulatorRoom fields
- name
stringRequired Room name, unique within the simulator ignoring case
minLength: 1
maxLength: 64
- polygon
array<array<number>> Outline of the room as [x, y] points in metres, in the simulator's single map frame (x increases right, y increases up). The ring is closed for you. Omit it to leave the room off the map.
- Item
number minimum: -1000
maximum: 1000
- Item