Skip to content

OperationalState

HTTP API schema

OperationalState fields

(payload)string

Operational state of a device. RETURNING_TO_DOCK means a robot is driving back to its dock; CHARGING means it is on the dock drawing charge; DOCKED means it is on the dock and not charging (reported only on dock evidence, never for a robot that is merely idle); DOCK_MAINTENANCE means it is on the dock while the dock services it (emptying the dust bin, washing or drying the mop), and it does not start cleaning until that finishes; GOING_TO_POINT means a robot is driving to a requested map point by its own path planning, without cleaning.

View source specification ↗