protos/common/common library Protobuf Definitions

The proto definitions for common

Classes

ActuatorStatus
ActuatorStatus is a generic status for resources that only need to return actuator status.
Capsule
Common
DoCommandRequest
DoCommandRequest represents a generic DoCommand input
DoCommandResponse
DoCommandResponse represents a generic DoCommand output
GeometriesInFrame
GeometriesinFrame contains the dimensions of a given geometry, pose of its center point, and the reference frame by which it was observed.
Geometry
Geometry contains the dimensions of a given geometry and the pose of its center. The geometry is one of either a sphere or a box.
GeoObstacle
GeoObstacle contains information about the geometric structure of an obstacle and the location of the obstacle, captured in latitude and longitude.
GeoPoint
GetGeometriesRequest
GetGeometriesResponse
GetKinematicsRequest
GetKinematicsResponse
GetReadingsRequest
GetReadingsResponse
KinematicsFileFormat
LogEntry
Orientation
PointCloudObject
PointCloudObject contains an image in bytes with point cloud data of all of the objects captured by a given observer as well as a repeated list of geometries which respresents the center point and geometry of each of the objects within the point cloud
Pose
Pose is a combination of location and orientation. Location is expressed as distance which is represented by x , y, z coordinates. Orientation is expressed as an orientation vector which is represented by o_x, o_y, o_z and theta. The o_x, o_y, o_z coordinates represent the point on the cartesian unit sphere that the end of the arm is pointing to (with the origin as reference). That unit vector forms an axis around which theta rotates. This means that incrementing / decrementing theta will perform an inline rotation of the end effector. Theta is defined as rotation between two planes: the first being defined by the origin, the point (0,0,1), and the rx, ry, rz point, and the second being defined by the origin, the rx, ry, rz point and the local Z axis. Therefore, if theta is kept at zero as the north/south pole is circled, the Roll will correct itself to remain in-line.
PoseInFrame
PoseInFrame contains a pose and the and the reference frame in which it was observed
RectangularPrism
RectangularPrism contains a Vector3 field corresponding to the X, Y, Z dimensions of the prism in mms These dimensions are with respect to the referenceframe in which the RectangularPrism is defined
ResourceName
ResponseMetadata
Sphere
Transform
Transform contains a pose and two reference frames. The first reference frame is the starting reference frame, and the second reference frame is the observer reference frame. The second reference frame has a pose which represents the pose of an object in the first reference frame as observed within the second reference frame.
Vector3
WorldState
WorldState contains information about the physical environment around a given robot. All of the fields within this message are optional, they can include information about the physical dimensions of an obstacle, the freespace of a robot, and any desired transforms between a given reference frame and a new target reference frame.

Constants

ActuatorStatus$json → const Map<String, Object>
Capsule$json → const Map<String, Object>
DoCommandRequest$json → const Map<String, Object>
DoCommandResponse$json → const Map<String, Object>
GeometriesInFrame$json → const Map<String, Object>
Geometry$json → const Map<String, Object>
GeoObstacle$json → const Map<String, Object>
GeoPoint$json → const Map<String, Object>
GetGeometriesRequest$json → const Map<String, Object>
GetGeometriesResponse$json → const Map<String, Object>
GetKinematicsRequest$json → const Map<String, Object>
GetKinematicsResponse$json → const Map<String, Object>
GetReadingsRequest$json → const Map<String, Object>
GetReadingsResponse$json → const Map<String, Object>
GetReadingsResponse_ReadingsEntry$json → const Map<String, Object>
KinematicsFileFormat$json → const Map<String, Object>
LogEntry$json → const Map<String, Object>
Orientation$json → const Map<String, Object>
PointCloudObject$json → const Map<String, Object>
Pose$json → const Map<String, Object>
PoseInFrame$json → const Map<String, Object>
RectangularPrism$json → const Map<String, Object>
ResourceName$json → const Map<String, Object>
ResponseMetadata$json → const Map<String, Object>
Sphere$json → const Map<String, Object>
Transform$json → const Map<String, Object>
Vector3$json → const Map<String, Object>
WorldState$json → const Map<String, Object>

Properties

actuatorStatusDescriptor Uint8List
Descriptor for ActuatorStatus. Decode as a google.protobuf.DescriptorProto.
final
capsuleDescriptor Uint8List
Descriptor for Capsule. Decode as a google.protobuf.DescriptorProto.
final
doCommandRequestDescriptor Uint8List
Descriptor for DoCommandRequest. Decode as a google.protobuf.DescriptorProto.
final
doCommandResponseDescriptor Uint8List
Descriptor for DoCommandResponse. Decode as a google.protobuf.DescriptorProto.
final
geometriesInFrameDescriptor Uint8List
Descriptor for GeometriesInFrame. Decode as a google.protobuf.DescriptorProto.
final
geometryDescriptor Uint8List
Descriptor for Geometry. Decode as a google.protobuf.DescriptorProto.
final
geoObstacleDescriptor Uint8List
Descriptor for GeoObstacle. Decode as a google.protobuf.DescriptorProto.
final
geoPointDescriptor Uint8List
Descriptor for GeoPoint. Decode as a google.protobuf.DescriptorProto.
final
getGeometriesRequestDescriptor Uint8List
Descriptor for GetGeometriesRequest. Decode as a google.protobuf.DescriptorProto.
final
getGeometriesResponseDescriptor Uint8List
Descriptor for GetGeometriesResponse. Decode as a google.protobuf.DescriptorProto.
final
getKinematicsRequestDescriptor Uint8List
Descriptor for GetKinematicsRequest. Decode as a google.protobuf.DescriptorProto.
final
getKinematicsResponseDescriptor Uint8List
Descriptor for GetKinematicsResponse. Decode as a google.protobuf.DescriptorProto.
final
getReadingsRequestDescriptor Uint8List
Descriptor for GetReadingsRequest. Decode as a google.protobuf.DescriptorProto.
final
getReadingsResponseDescriptor Uint8List
Descriptor for GetReadingsResponse. Decode as a google.protobuf.DescriptorProto.
final
kinematicsFileFormatDescriptor Uint8List
Descriptor for KinematicsFileFormat. Decode as a google.protobuf.EnumDescriptorProto.
final
logEntryDescriptor Uint8List
Descriptor for LogEntry. Decode as a google.protobuf.DescriptorProto.
final
orientationDescriptor Uint8List
Descriptor for Orientation. Decode as a google.protobuf.DescriptorProto.
final
pointCloudObjectDescriptor Uint8List
Descriptor for PointCloudObject. Decode as a google.protobuf.DescriptorProto.
final
poseDescriptor Uint8List
Descriptor for Pose. Decode as a google.protobuf.DescriptorProto.
final
poseInFrameDescriptor Uint8List
Descriptor for PoseInFrame. Decode as a google.protobuf.DescriptorProto.
final
rectangularPrismDescriptor Uint8List
Descriptor for RectangularPrism. Decode as a google.protobuf.DescriptorProto.
final
resourceNameDescriptor Uint8List
Descriptor for ResourceName. Decode as a google.protobuf.DescriptorProto.
final
responseMetadataDescriptor Uint8List
Descriptor for ResponseMetadata. Decode as a google.protobuf.DescriptorProto.
final
sphereDescriptor Uint8List
Descriptor for Sphere. Decode as a google.protobuf.DescriptorProto.
final
transformDescriptor Uint8List
Descriptor for Transform. Decode as a google.protobuf.DescriptorProto.
final
vector3Descriptor Uint8List
Descriptor for Vector3. Decode as a google.protobuf.DescriptorProto.
final
worldStateDescriptor Uint8List
Descriptor for WorldState. Decode as a google.protobuf.DescriptorProto.
final

Enums

Geometry_GeometryType