Speech Recognition icon Speech Recognition — Windows Speech Recognition skill: detect custom phrases via PC mic, trigger configurable scripts/actions with adjustable confidence. Try it →
 

Navigation

Feed the robot's position and sensor scans to ARCx's navigation system, which navigation robot skills use to build maps and plan routes, and set whether navigation is running, paused or cancelled. Most projects let their sensor robot skills do this; these commands are for sensors and position sources a script reads itself.

Where to find it: type Navigation. in a JavaScript script, or open the ARCx API view of the script editor and expand Navigation

Commands

Command What it does
Navigation.setNavigationStatusToNavigating Sets the navigation messaging system's status to navigating and tells the navigation skills listening for status changes.
Navigation.setNavigationStatusToPause Sets the navigation messaging system's status to paused and tells the navigation skills listening for status changes.
Navigation.setNavigationStatusToStopCancel Sets the navigation messaging system's status to stopped or cancelled and tells the navigation skills listening for status changes.
Navigation.updatePose Report where the robot is, in ROS's frame and units: x metres forward and y metres left of where tracking began, and the yaw in radians, counter-clockwise (positive turning left).
Navigation.updateScan Report one distance reading: the range in metres (0 for nothing detected), a confidence from 0 to 255, and the angle in radians from straight ahead, counter-clockwise (PI/2 is left), as in a ROS LaserScan.

Details

Sets the navigation messaging system's status to navigating and tells the navigation skills listening for status changes. Also sets the $NavigationStatus global variable to Navigating.

Navigation.setNavigationStatusToNavigating()

Sets the navigation messaging system's status to paused and tells the navigation skills listening for status changes. Also sets the $NavigationStatus global variable to Paused.

Navigation.setNavigationStatusToPause()

Sets the navigation messaging system's status to stopped or cancelled and tells the navigation skills listening for status changes. Also sets the $NavigationStatus global variable to StoppedCancelled.

Navigation.setNavigationStatusToStopCancel()

Report where the robot is, in ROS's frame and units: x metres forward and y metres left of where tracking began, and the yaw in radians, counter-clockwise (positive turning left).

Navigation.updatePose(x, y, yaw)
Navigation.updatePose(x, y, yaw, confidence)
Value Type What it is
x number Metres forward of where tracking began.
y number Metres left of where tracking began.
yaw number The heading in radians, counter-clockwise (positive turning left), wrapped into -PI to PI.
confidence number Optional. How sure the position is, from -1 (not confident) to 1 (very confident). Reporting without it uses 1.

Report one distance reading: the range in metres (0 for nothing detected), a confidence from 0 to 255, and the angle in radians from straight ahead, counter-clockwise (PI/2 is left), as in a ROS LaserScan.

Navigation.updateScan(range, confidence, angle)
Value Type What it is
range number Distance to the detected object in metres, or 0 when nothing was detected.
confidence number How sure the reading is, 0 (not confident) to 255 (very confident).
angle number Angle in radians from straight ahead, counter-clockwise (PI/2 is left), wrapped into -PI to PI.