Skip to content

Get Current State Of The Robot

getState() -> {Promise.<any>}

Get the current state of the robot at a time

Parameters

none

Return value Promise.<any>

The current state of the robot

Example

JavaScript
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
...
const state = await axRobot.getState();
console.log(state.isManualMode); // whether to push the mode
console.log(state.isTasking); // Whether the task is being executed
console.log(state.isCharging); // is charging
console.log(state.isRemoteMode); // Whether remote control
console.log(state.battery); // current battery (percentage)
console.log(state.robotId); // Robot ID
console.log(state.speed); // current speed (m/s)
console.log(state.isFrontBumperPressed); //  Detected forward collision, robot stops moving
console.log(state.isRearBumperPressed); //  Detected rear collision, robot stops moving
console.log(state.isWaitingForDest); //  Waiting for other robots to leave the temporary stop area
console.log(state.areaId); // current area ID
console.log(state.isEmergencyStop); // Whether emergency stop state
console.log(state.x); // x component of position coordinates
console.log(state.y); // y component of position coordinates
console.log(state.yaw); // current angle (radians)
console.log(state.locQuality); // Current positioning quality (0-100)
console.log(state.hasObstruction); // Is there an obstacle currently
console.log(state.errors); // fault code
console.log(state.isGoHome); // Whether it is returning to the pile for charging
console.log(state.timestamp); // timestamp of robot state

// do something
...