Skip to content

RoboticVacuumCleanerInterfaceOperationalStateAttribute

HTTP API schema

The vacuum's current operational state, such as cleaning, docked or returning to its dock. While the robot is under remote control it may report no operational state; read remote-control/session instead.

RoboticVacuumCleanerInterfaceOperationalStateAttribute fields

valueOperationalStateRequired
errorReasonstring

Plain-language reason the vacuum reports while value is ERROR, for example Robot trapped or Main brush jammed. Omitted when the vacuum reports no error or the device gives no reason. Show it to the customer; the vacuum usually needs a person to clear the cause before it can dock or clean.

providerErrorCodeinteger

The vendor's numeric error code behind errorReason, present whenever the vacuum reports a nonzero error code, including codes without a Port OS wording.

View source specification ↗