Alpha
Optional
moduleId: stringThe id matching the module_id field of the registry module in your part configuration
Optional
moduleName: stringThe name matching the name field of the local/registry module in your part configuration
Alpha
onCall a function when a connection event occurs.
Note that direct gRPC connections that disconnect will not emit a
disconnect event. WebRTC connections that disconnect will emit a disconnect
event. All connections emit events during manual calls of connect
and
disconnect
.
The event MachineConnectionEvent that was triggered, or all connection events with 'connectionstatechange'.
The function to call
Alpha
Get the current status of the robot.
Alpha
Get app-related information about the robot.
Alpha
Get the list of discovered component configurations.
Alpha
Deprecated: v0.36.0, use the Discovery Service APIs instead.
Get the list of discovered component configurations.
The list of component models to discovery.
Alpha
Get the configuration of the frame system of a given robot.
Alpha
Transform a given source point cloud from the reference frame to a new specified destination which is a reference frame.
The point clouds to transform. This should be in the PCD format encoded into bytes: https://pointclouds.org/documentation/tutorials/pcd_file_format.html
The reference frame of the point cloud.
The reference frame into which the source data should be transformed, if unset this defaults to the "world" reference frame. Do not move the robot between the generation of the initial pointcloud and the receipt of the transformed pointcloud because that will make the transformations inaccurate.
Alpha
Transform a given source Pose from the reference frame to a new specified destination which is a reference frame.
The name of the reference frame to transform the given
Pose information on any additional reference frames that are needed to perform the transform
Alpha
Cancel all current and outstanding operations for the robot and stop all actuators and movement.
Optional
extra: Map<string, Struct>Any extra parameters to pass to the components' stop
methods, keyed on the component's resource name.
Alpha
Get a list of all resources on the robot.
Alpha
Get a list of all resource types.
Restarts a module running on the machine with the given id or name.