Skip to content

RoboticVacuumCleanerInterfaceCleanRoomMessage

HTTP API schema

← HTTP API reference

Clean one or more rooms, in the requested order. Each entry is a canonical endpoint group the robot can control through a CAN_CONTROL relationship. More than one room requires the configuration to declare supportsMultiRoomCleaning; otherwise the request is rejected with MULTI_ROOM_UNSUPPORTED.

RoboticVacuumCleanerInterfaceCleanRoomMessage fields

groupIdsarray<string>Required

Endpoint group IDs of the rooms to clean, in cleaning order

uniqueItems: true

repeatinteger

Number of cleaning passes per room; defaults to 1

minimum: 1

maximum: 3

View source specification ↗