Skip to content

RoboticVacuumCleanerInterfaceGoToPointMessage

HTTP API schema

Drive the robot to a map point by its own path planning, without cleaning. The request returns once the robot has started travelling; read arrival from the operational state, which reads GOING_TO_POINT while travelling and leaves it when the robot stops at the point. The point is a GeoJSON Point whose coordinates are [x, y] in metres, x to the right and y up. The robot stays at the point and does not return to the dock. The robot must not be under remote control: end the remote-control session first. The point must lie inside the map and in the frame the robot's pose reports.

RoboticVacuumCleanerInterfaceGoToPointMessage fields

pointSpatialPointRequired
relativeToGroupRouteIdstringRequired

Provider group route whose frame the point uses: the same relativeToGroupRouteId value the robot's spatial pose reports (for example <duid>/map:0). A different frame is rejected

minLength: 1

View source specification ↗