Documentation ¶
Index ¶
- Variables
- type ActuatorStatus
- type Capsule
- type DoCommandRequest
- func (*DoCommandRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DoCommandRequest) GetCommand() *structpb.Struct
- func (x *DoCommandRequest) GetName() string
- func (*DoCommandRequest) ProtoMessage()
- func (x *DoCommandRequest) ProtoReflect() protoreflect.Message
- func (x *DoCommandRequest) Reset()
- func (x *DoCommandRequest) String() string
- type DoCommandResponse
- func (*DoCommandResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DoCommandResponse) GetResult() *structpb.Struct
- func (*DoCommandResponse) ProtoMessage()
- func (x *DoCommandResponse) ProtoReflect() protoreflect.Message
- func (x *DoCommandResponse) Reset()
- func (x *DoCommandResponse) String() string
- type GeoGeometry
- func (*GeoGeometry) Descriptor() ([]byte, []int)deprecated
- func (x *GeoGeometry) GetGeometries() []*Geometry
- func (x *GeoGeometry) GetLocation() *GeoPoint
- func (*GeoGeometry) ProtoMessage()
- func (x *GeoGeometry) ProtoReflect() protoreflect.Message
- func (x *GeoGeometry) Reset()
- func (x *GeoGeometry) String() string
- type GeoPoint
- type GeometriesInFrame
- func (*GeometriesInFrame) Descriptor() ([]byte, []int)deprecated
- func (x *GeometriesInFrame) GetGeometries() []*Geometry
- func (x *GeometriesInFrame) GetReferenceFrame() string
- func (*GeometriesInFrame) ProtoMessage()
- func (x *GeometriesInFrame) ProtoReflect() protoreflect.Message
- func (x *GeometriesInFrame) Reset()
- func (x *GeometriesInFrame) String() string
- type Geometry
- func (*Geometry) Descriptor() ([]byte, []int)deprecated
- func (x *Geometry) GetBox() *RectangularPrism
- func (x *Geometry) GetCapsule() *Capsule
- func (x *Geometry) GetCenter() *Pose
- func (m *Geometry) GetGeometryType() isGeometry_GeometryType
- func (x *Geometry) GetLabel() string
- func (x *Geometry) GetSphere() *Sphere
- func (*Geometry) ProtoMessage()
- func (x *Geometry) ProtoReflect() protoreflect.Message
- func (x *Geometry) Reset()
- func (x *Geometry) String() string
- type Geometry_Box
- type Geometry_Capsule
- type Geometry_Sphere
- type GetGeometriesRequest
- func (*GetGeometriesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetGeometriesRequest) GetExtra() *structpb.Struct
- func (x *GetGeometriesRequest) GetName() string
- func (*GetGeometriesRequest) ProtoMessage()
- func (x *GetGeometriesRequest) ProtoReflect() protoreflect.Message
- func (x *GetGeometriesRequest) Reset()
- func (x *GetGeometriesRequest) String() string
- type GetGeometriesResponse
- func (*GetGeometriesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetGeometriesResponse) GetGeometries() []*Geometry
- func (*GetGeometriesResponse) ProtoMessage()
- func (x *GetGeometriesResponse) ProtoReflect() protoreflect.Message
- func (x *GetGeometriesResponse) Reset()
- func (x *GetGeometriesResponse) String() string
- type GetKinematicsRequest
- func (*GetKinematicsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetKinematicsRequest) GetExtra() *structpb.Struct
- func (x *GetKinematicsRequest) GetName() string
- func (*GetKinematicsRequest) ProtoMessage()
- func (x *GetKinematicsRequest) ProtoReflect() protoreflect.Message
- func (x *GetKinematicsRequest) Reset()
- func (x *GetKinematicsRequest) String() string
- type GetKinematicsResponse
- func (*GetKinematicsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetKinematicsResponse) GetFormat() KinematicsFileFormat
- func (x *GetKinematicsResponse) GetKinematicsData() []byte
- func (*GetKinematicsResponse) ProtoMessage()
- func (x *GetKinematicsResponse) ProtoReflect() protoreflect.Message
- func (x *GetKinematicsResponse) Reset()
- func (x *GetKinematicsResponse) String() string
- type GetReadingsRequest
- func (*GetReadingsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetReadingsRequest) GetExtra() *structpb.Struct
- func (x *GetReadingsRequest) GetName() string
- func (*GetReadingsRequest) ProtoMessage()
- func (x *GetReadingsRequest) ProtoReflect() protoreflect.Message
- func (x *GetReadingsRequest) Reset()
- func (x *GetReadingsRequest) String() string
- type GetReadingsResponse
- func (*GetReadingsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetReadingsResponse) GetReadings() map[string]*structpb.Value
- func (*GetReadingsResponse) ProtoMessage()
- func (x *GetReadingsResponse) ProtoReflect() protoreflect.Message
- func (x *GetReadingsResponse) Reset()
- func (x *GetReadingsResponse) String() string
- type KinematicsFileFormat
- func (KinematicsFileFormat) Descriptor() protoreflect.EnumDescriptor
- func (x KinematicsFileFormat) Enum() *KinematicsFileFormat
- func (KinematicsFileFormat) EnumDescriptor() ([]byte, []int)deprecated
- func (x KinematicsFileFormat) Number() protoreflect.EnumNumber
- func (x KinematicsFileFormat) String() string
- func (KinematicsFileFormat) Type() protoreflect.EnumType
- type LogEntry
- func (*LogEntry) Descriptor() ([]byte, []int)deprecated
- func (x *LogEntry) GetCaller() *structpb.Struct
- func (x *LogEntry) GetFields() []*structpb.Struct
- func (x *LogEntry) GetHost() string
- func (x *LogEntry) GetLevel() string
- func (x *LogEntry) GetLoggerName() string
- func (x *LogEntry) GetMessage() string
- func (x *LogEntry) GetStack() string
- func (x *LogEntry) GetTime() *timestamppb.Timestamp
- func (*LogEntry) ProtoMessage()
- func (x *LogEntry) ProtoReflect() protoreflect.Message
- func (x *LogEntry) Reset()
- func (x *LogEntry) String() string
- type Orientation
- func (*Orientation) Descriptor() ([]byte, []int)deprecated
- func (x *Orientation) GetOX() float64
- func (x *Orientation) GetOY() float64
- func (x *Orientation) GetOZ() float64
- func (x *Orientation) GetTheta() float64
- func (*Orientation) ProtoMessage()
- func (x *Orientation) ProtoReflect() protoreflect.Message
- func (x *Orientation) Reset()
- func (x *Orientation) String() string
- type PointCloudObject
- func (*PointCloudObject) Descriptor() ([]byte, []int)deprecated
- func (x *PointCloudObject) GetGeometries() *GeometriesInFrame
- func (x *PointCloudObject) GetPointCloud() []byte
- func (*PointCloudObject) ProtoMessage()
- func (x *PointCloudObject) ProtoReflect() protoreflect.Message
- func (x *PointCloudObject) Reset()
- func (x *PointCloudObject) String() string
- type Pose
- func (*Pose) Descriptor() ([]byte, []int)deprecated
- func (x *Pose) GetOX() float64
- func (x *Pose) GetOY() float64
- func (x *Pose) GetOZ() float64
- func (x *Pose) GetTheta() float64
- func (x *Pose) GetX() float64
- func (x *Pose) GetY() float64
- func (x *Pose) GetZ() float64
- func (*Pose) ProtoMessage()
- func (x *Pose) ProtoReflect() protoreflect.Message
- func (x *Pose) Reset()
- func (x *Pose) String() string
- type PoseInFrame
- func (*PoseInFrame) Descriptor() ([]byte, []int)deprecated
- func (x *PoseInFrame) GetPose() *Pose
- func (x *PoseInFrame) GetReferenceFrame() string
- func (*PoseInFrame) ProtoMessage()
- func (x *PoseInFrame) ProtoReflect() protoreflect.Message
- func (x *PoseInFrame) Reset()
- func (x *PoseInFrame) String() string
- type RectangularPrism
- type ResourceName
- func (*ResourceName) Descriptor() ([]byte, []int)deprecated
- func (x *ResourceName) GetLocalName() string
- func (x *ResourceName) GetName() string
- func (x *ResourceName) GetNamespace() string
- func (x *ResourceName) GetRemotePath() []string
- func (x *ResourceName) GetSubtype() string
- func (x *ResourceName) GetType() string
- func (*ResourceName) ProtoMessage()
- func (x *ResourceName) ProtoReflect() protoreflect.Message
- func (x *ResourceName) Reset()
- func (x *ResourceName) String() string
- type ResponseMetadata
- func (*ResponseMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *ResponseMetadata) GetCapturedAt() *timestamppb.Timestamp
- func (*ResponseMetadata) ProtoMessage()
- func (x *ResponseMetadata) ProtoReflect() protoreflect.Message
- func (x *ResponseMetadata) Reset()
- func (x *ResponseMetadata) String() string
- type Sphere
- type Transform
- func (*Transform) Descriptor() ([]byte, []int)deprecated
- func (x *Transform) GetPhysicalObject() *Geometry
- func (x *Transform) GetPoseInObserverFrame() *PoseInFrame
- func (x *Transform) GetReferenceFrame() string
- func (*Transform) ProtoMessage()
- func (x *Transform) ProtoReflect() protoreflect.Message
- func (x *Transform) Reset()
- func (x *Transform) String() string
- type Vector3
- type WorldState
- func (*WorldState) Descriptor() ([]byte, []int)deprecated
- func (x *WorldState) GetObstacles() []*GeometriesInFrame
- func (x *WorldState) GetTransforms() []*Transform
- func (*WorldState) ProtoMessage()
- func (x *WorldState) ProtoReflect() protoreflect.Message
- func (x *WorldState) Reset()
- func (x *WorldState) String() string
Constants ¶
This section is empty.
Variables ¶
var ( KinematicsFileFormat_name = map[int32]string{ 0: "KINEMATICS_FILE_FORMAT_UNSPECIFIED", 1: "KINEMATICS_FILE_FORMAT_SVA", 2: "KINEMATICS_FILE_FORMAT_URDF", } KinematicsFileFormat_value = map[string]int32{ "KINEMATICS_FILE_FORMAT_UNSPECIFIED": 0, "KINEMATICS_FILE_FORMAT_SVA": 1, "KINEMATICS_FILE_FORMAT_URDF": 2, } )
Enum value maps for KinematicsFileFormat.
var ( // safety_heartbeat_monitored is used on methods to signify that if a session is in use // and the session was the last to call this method, the resource associated with the // method will be stopped. // // optional bool safety_heartbeat_monitored = 84260; E_SafetyHeartbeatMonitored = &file_common_v1_common_proto_extTypes[0] )
Extension fields to descriptorpb.MethodOptions.
var File_common_v1_common_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type ActuatorStatus ¶
type ActuatorStatus struct { IsMoving bool `protobuf:"varint,1,opt,name=is_moving,json=isMoving,proto3" json:"is_moving,omitempty"` // contains filtered or unexported fields }
ActuatorStatus is a generic status for resources that only need to return actuator status.
func (*ActuatorStatus) Descriptor
deprecated
func (*ActuatorStatus) Descriptor() ([]byte, []int)
Deprecated: Use ActuatorStatus.ProtoReflect.Descriptor instead.
func (*ActuatorStatus) GetIsMoving ¶
func (x *ActuatorStatus) GetIsMoving() bool
func (*ActuatorStatus) ProtoMessage ¶
func (*ActuatorStatus) ProtoMessage()
func (*ActuatorStatus) ProtoReflect ¶
func (x *ActuatorStatus) ProtoReflect() protoreflect.Message
func (*ActuatorStatus) Reset ¶
func (x *ActuatorStatus) Reset()
func (*ActuatorStatus) String ¶
func (x *ActuatorStatus) String() string
type Capsule ¶ added in v0.1.49
type Capsule struct { RadiusMm float64 `protobuf:"fixed64,1,opt,name=radius_mm,json=radiusMm,proto3" json:"radius_mm,omitempty"` LengthMm float64 `protobuf:"fixed64,2,opt,name=length_mm,json=lengthMm,proto3" json:"length_mm,omitempty"` // contains filtered or unexported fields }
func (*Capsule) Descriptor
deprecated
added in
v0.1.49
func (*Capsule) GetLengthMm ¶ added in v0.1.49
func (*Capsule) GetRadiusMm ¶ added in v0.1.49
func (*Capsule) ProtoMessage ¶ added in v0.1.49
func (*Capsule) ProtoMessage()
func (*Capsule) ProtoReflect ¶ added in v0.1.49
func (x *Capsule) ProtoReflect() protoreflect.Message
type DoCommandRequest ¶ added in v0.1.77
type DoCommandRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Command *structpb.Struct `protobuf:"bytes,2,opt,name=command,proto3" json:"command,omitempty"` // contains filtered or unexported fields }
DoCommandRequest represents a generic DoCommand input
func (*DoCommandRequest) Descriptor
deprecated
added in
v0.1.77
func (*DoCommandRequest) Descriptor() ([]byte, []int)
Deprecated: Use DoCommandRequest.ProtoReflect.Descriptor instead.
func (*DoCommandRequest) GetCommand ¶ added in v0.1.77
func (x *DoCommandRequest) GetCommand() *structpb.Struct
func (*DoCommandRequest) GetName ¶ added in v0.1.77
func (x *DoCommandRequest) GetName() string
func (*DoCommandRequest) ProtoMessage ¶ added in v0.1.77
func (*DoCommandRequest) ProtoMessage()
func (*DoCommandRequest) ProtoReflect ¶ added in v0.1.77
func (x *DoCommandRequest) ProtoReflect() protoreflect.Message
func (*DoCommandRequest) Reset ¶ added in v0.1.77
func (x *DoCommandRequest) Reset()
func (*DoCommandRequest) String ¶ added in v0.1.77
func (x *DoCommandRequest) String() string
type DoCommandResponse ¶ added in v0.1.77
type DoCommandResponse struct { Result *structpb.Struct `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"` // contains filtered or unexported fields }
DoCommandResponse represents a generic DoCommand output
func (*DoCommandResponse) Descriptor
deprecated
added in
v0.1.77
func (*DoCommandResponse) Descriptor() ([]byte, []int)
Deprecated: Use DoCommandResponse.ProtoReflect.Descriptor instead.
func (*DoCommandResponse) GetResult ¶ added in v0.1.77
func (x *DoCommandResponse) GetResult() *structpb.Struct
func (*DoCommandResponse) ProtoMessage ¶ added in v0.1.77
func (*DoCommandResponse) ProtoMessage()
func (*DoCommandResponse) ProtoReflect ¶ added in v0.1.77
func (x *DoCommandResponse) ProtoReflect() protoreflect.Message
func (*DoCommandResponse) Reset ¶ added in v0.1.77
func (x *DoCommandResponse) Reset()
func (*DoCommandResponse) String ¶ added in v0.1.77
func (x *DoCommandResponse) String() string
type GeoGeometry ¶ added in v0.1.300
type GeoGeometry struct { // Location of the geometry Location *GeoPoint `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"` // Geometries associated with the location, where embedded Pose data is with respect to the specified location Geometries []*Geometry `protobuf:"bytes,2,rep,name=geometries,proto3" json:"geometries,omitempty"` // contains filtered or unexported fields }
GeoGeometry contains information describing Geometry(s) that is located at a GeoPoint
func (*GeoGeometry) Descriptor
deprecated
added in
v0.1.300
func (*GeoGeometry) Descriptor() ([]byte, []int)
Deprecated: Use GeoGeometry.ProtoReflect.Descriptor instead.
func (*GeoGeometry) GetGeometries ¶ added in v0.1.300
func (x *GeoGeometry) GetGeometries() []*Geometry
func (*GeoGeometry) GetLocation ¶ added in v0.1.300
func (x *GeoGeometry) GetLocation() *GeoPoint
func (*GeoGeometry) ProtoMessage ¶ added in v0.1.300
func (*GeoGeometry) ProtoMessage()
func (*GeoGeometry) ProtoReflect ¶ added in v0.1.300
func (x *GeoGeometry) ProtoReflect() protoreflect.Message
func (*GeoGeometry) Reset ¶ added in v0.1.300
func (x *GeoGeometry) Reset()
func (*GeoGeometry) String ¶ added in v0.1.300
func (x *GeoGeometry) String() string
type GeoPoint ¶
type GeoPoint struct { Latitude float64 `protobuf:"fixed64,1,opt,name=latitude,proto3" json:"latitude,omitempty"` Longitude float64 `protobuf:"fixed64,2,opt,name=longitude,proto3" json:"longitude,omitempty"` // contains filtered or unexported fields }
func (*GeoPoint) Descriptor
deprecated
func (*GeoPoint) GetLatitude ¶
func (*GeoPoint) GetLongitude ¶
func (*GeoPoint) ProtoMessage ¶
func (*GeoPoint) ProtoMessage()
func (*GeoPoint) ProtoReflect ¶
func (x *GeoPoint) ProtoReflect() protoreflect.Message
type GeometriesInFrame ¶
type GeometriesInFrame struct { // Reference frame of the observer of the geometry ReferenceFrame string `protobuf:"bytes,1,opt,name=reference_frame,json=referenceFrame,proto3" json:"reference_frame,omitempty"` // Dimensional type Geometries []*Geometry `protobuf:"bytes,2,rep,name=geometries,proto3" json:"geometries,omitempty"` // contains filtered or unexported fields }
GeometriesinFrame contains the dimensions of a given geometry, pose of its center point, and the reference frame by which it was observed.
func (*GeometriesInFrame) Descriptor
deprecated
func (*GeometriesInFrame) Descriptor() ([]byte, []int)
Deprecated: Use GeometriesInFrame.ProtoReflect.Descriptor instead.
func (*GeometriesInFrame) GetGeometries ¶
func (x *GeometriesInFrame) GetGeometries() []*Geometry
func (*GeometriesInFrame) GetReferenceFrame ¶
func (x *GeometriesInFrame) GetReferenceFrame() string
func (*GeometriesInFrame) ProtoMessage ¶
func (*GeometriesInFrame) ProtoMessage()
func (*GeometriesInFrame) ProtoReflect ¶
func (x *GeometriesInFrame) ProtoReflect() protoreflect.Message
func (*GeometriesInFrame) Reset ¶
func (x *GeometriesInFrame) Reset()
func (*GeometriesInFrame) String ¶
func (x *GeometriesInFrame) String() string
type Geometry ¶
type Geometry struct { // Pose of a geometries center point Center *Pose `protobuf:"bytes,1,opt,name=center,proto3" json:"center,omitempty"` // Dimensions of a given geometry. This can be a sphere or box // // Types that are assignable to GeometryType: // // *Geometry_Sphere // *Geometry_Box // *Geometry_Capsule GeometryType isGeometry_GeometryType `protobuf_oneof:"geometry_type"` // Label of the geometry. If none supplied, will be an empty string. Label string `protobuf:"bytes,4,opt,name=label,proto3" json:"label,omitempty"` // contains filtered or unexported fields }
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.
func (*Geometry) Descriptor
deprecated
func (*Geometry) GetBox ¶
func (x *Geometry) GetBox() *RectangularPrism
func (*Geometry) GetCapsule ¶ added in v0.1.49
func (*Geometry) GetGeometryType ¶
func (m *Geometry) GetGeometryType() isGeometry_GeometryType
func (*Geometry) ProtoMessage ¶
func (*Geometry) ProtoMessage()
func (*Geometry) ProtoReflect ¶
func (x *Geometry) ProtoReflect() protoreflect.Message
type Geometry_Box ¶
type Geometry_Box struct {
Box *RectangularPrism `protobuf:"bytes,3,opt,name=box,proto3,oneof"`
}
type Geometry_Capsule ¶ added in v0.1.49
type Geometry_Capsule struct {
Capsule *Capsule `protobuf:"bytes,5,opt,name=capsule,proto3,oneof"`
}
type Geometry_Sphere ¶
type Geometry_Sphere struct {
Sphere *Sphere `protobuf:"bytes,2,opt,name=sphere,proto3,oneof"`
}
type GetGeometriesRequest ¶ added in v0.1.129
type GetGeometriesRequest struct { // The component name Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Additional arguments to the method Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"` // contains filtered or unexported fields }
func (*GetGeometriesRequest) Descriptor
deprecated
added in
v0.1.129
func (*GetGeometriesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetGeometriesRequest.ProtoReflect.Descriptor instead.
func (*GetGeometriesRequest) GetExtra ¶ added in v0.1.159
func (x *GetGeometriesRequest) GetExtra() *structpb.Struct
func (*GetGeometriesRequest) GetName ¶ added in v0.1.129
func (x *GetGeometriesRequest) GetName() string
func (*GetGeometriesRequest) ProtoMessage ¶ added in v0.1.129
func (*GetGeometriesRequest) ProtoMessage()
func (*GetGeometriesRequest) ProtoReflect ¶ added in v0.1.129
func (x *GetGeometriesRequest) ProtoReflect() protoreflect.Message
func (*GetGeometriesRequest) Reset ¶ added in v0.1.129
func (x *GetGeometriesRequest) Reset()
func (*GetGeometriesRequest) String ¶ added in v0.1.129
func (x *GetGeometriesRequest) String() string
type GetGeometriesResponse ¶ added in v0.1.129
type GetGeometriesResponse struct { // All geometries associated with the component, in their current configuration, in the frame of that component. Geometries []*Geometry `protobuf:"bytes,1,rep,name=geometries,proto3" json:"geometries,omitempty"` // contains filtered or unexported fields }
func (*GetGeometriesResponse) Descriptor
deprecated
added in
v0.1.129
func (*GetGeometriesResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetGeometriesResponse.ProtoReflect.Descriptor instead.
func (*GetGeometriesResponse) GetGeometries ¶ added in v0.1.129
func (x *GetGeometriesResponse) GetGeometries() []*Geometry
func (*GetGeometriesResponse) ProtoMessage ¶ added in v0.1.129
func (*GetGeometriesResponse) ProtoMessage()
func (*GetGeometriesResponse) ProtoReflect ¶ added in v0.1.129
func (x *GetGeometriesResponse) ProtoReflect() protoreflect.Message
func (*GetGeometriesResponse) Reset ¶ added in v0.1.129
func (x *GetGeometriesResponse) Reset()
func (*GetGeometriesResponse) String ¶ added in v0.1.129
func (x *GetGeometriesResponse) String() string
type GetKinematicsRequest ¶ added in v0.1.129
type GetKinematicsRequest struct { // The component name Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Additional arguments to the method Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"` // contains filtered or unexported fields }
func (*GetKinematicsRequest) Descriptor
deprecated
added in
v0.1.129
func (*GetKinematicsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetKinematicsRequest.ProtoReflect.Descriptor instead.
func (*GetKinematicsRequest) GetExtra ¶ added in v0.1.159
func (x *GetKinematicsRequest) GetExtra() *structpb.Struct
func (*GetKinematicsRequest) GetName ¶ added in v0.1.129
func (x *GetKinematicsRequest) GetName() string
func (*GetKinematicsRequest) ProtoMessage ¶ added in v0.1.129
func (*GetKinematicsRequest) ProtoMessage()
func (*GetKinematicsRequest) ProtoReflect ¶ added in v0.1.129
func (x *GetKinematicsRequest) ProtoReflect() protoreflect.Message
func (*GetKinematicsRequest) Reset ¶ added in v0.1.129
func (x *GetKinematicsRequest) Reset()
func (*GetKinematicsRequest) String ¶ added in v0.1.129
func (x *GetKinematicsRequest) String() string
type GetKinematicsResponse ¶ added in v0.1.129
type GetKinematicsResponse struct { // The kinematics of the component, in either URDF format or in Viam’s kinematic parameter format (spatial vector algebra) // https://docs.viam.com/internals/kinematic-chain-config/#kinematic-parameters Format KinematicsFileFormat `protobuf:"varint,1,opt,name=format,proto3,enum=viam.common.v1.KinematicsFileFormat" json:"format,omitempty"` // The byte contents of the file KinematicsData []byte `protobuf:"bytes,2,opt,name=kinematics_data,json=kinematicsData,proto3" json:"kinematics_data,omitempty"` // contains filtered or unexported fields }
func (*GetKinematicsResponse) Descriptor
deprecated
added in
v0.1.129
func (*GetKinematicsResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetKinematicsResponse.ProtoReflect.Descriptor instead.
func (*GetKinematicsResponse) GetFormat ¶ added in v0.1.129
func (x *GetKinematicsResponse) GetFormat() KinematicsFileFormat
func (*GetKinematicsResponse) GetKinematicsData ¶ added in v0.1.129
func (x *GetKinematicsResponse) GetKinematicsData() []byte
func (*GetKinematicsResponse) ProtoMessage ¶ added in v0.1.129
func (*GetKinematicsResponse) ProtoMessage()
func (*GetKinematicsResponse) ProtoReflect ¶ added in v0.1.129
func (x *GetKinematicsResponse) ProtoReflect() protoreflect.Message
func (*GetKinematicsResponse) Reset ¶ added in v0.1.129
func (x *GetKinematicsResponse) Reset()
func (*GetKinematicsResponse) String ¶ added in v0.1.129
func (x *GetKinematicsResponse) String() string
type GetReadingsRequest ¶ added in v0.1.217
type GetReadingsRequest struct { // Name of a sensor Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Additional arguments to the method Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"` // contains filtered or unexported fields }
func (*GetReadingsRequest) Descriptor
deprecated
added in
v0.1.217
func (*GetReadingsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetReadingsRequest.ProtoReflect.Descriptor instead.
func (*GetReadingsRequest) GetExtra ¶ added in v0.1.217
func (x *GetReadingsRequest) GetExtra() *structpb.Struct
func (*GetReadingsRequest) GetName ¶ added in v0.1.217
func (x *GetReadingsRequest) GetName() string
func (*GetReadingsRequest) ProtoMessage ¶ added in v0.1.217
func (*GetReadingsRequest) ProtoMessage()
func (*GetReadingsRequest) ProtoReflect ¶ added in v0.1.217
func (x *GetReadingsRequest) ProtoReflect() protoreflect.Message
func (*GetReadingsRequest) Reset ¶ added in v0.1.217
func (x *GetReadingsRequest) Reset()
func (*GetReadingsRequest) String ¶ added in v0.1.217
func (x *GetReadingsRequest) String() string
type GetReadingsResponse ¶ added in v0.1.217
type GetReadingsResponse struct { Readings map[string]*structpb.Value `` /* 157-byte string literal not displayed */ // contains filtered or unexported fields }
func (*GetReadingsResponse) Descriptor
deprecated
added in
v0.1.217
func (*GetReadingsResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetReadingsResponse.ProtoReflect.Descriptor instead.
func (*GetReadingsResponse) GetReadings ¶ added in v0.1.217
func (x *GetReadingsResponse) GetReadings() map[string]*structpb.Value
func (*GetReadingsResponse) ProtoMessage ¶ added in v0.1.217
func (*GetReadingsResponse) ProtoMessage()
func (*GetReadingsResponse) ProtoReflect ¶ added in v0.1.217
func (x *GetReadingsResponse) ProtoReflect() protoreflect.Message
func (*GetReadingsResponse) Reset ¶ added in v0.1.217
func (x *GetReadingsResponse) Reset()
func (*GetReadingsResponse) String ¶ added in v0.1.217
func (x *GetReadingsResponse) String() string
type KinematicsFileFormat ¶ added in v0.1.129
type KinematicsFileFormat int32
const ( KinematicsFileFormat_KINEMATICS_FILE_FORMAT_UNSPECIFIED KinematicsFileFormat = 0 KinematicsFileFormat_KINEMATICS_FILE_FORMAT_SVA KinematicsFileFormat = 1 KinematicsFileFormat_KINEMATICS_FILE_FORMAT_URDF KinematicsFileFormat = 2 )
func (KinematicsFileFormat) Descriptor ¶ added in v0.1.129
func (KinematicsFileFormat) Descriptor() protoreflect.EnumDescriptor
func (KinematicsFileFormat) Enum ¶ added in v0.1.129
func (x KinematicsFileFormat) Enum() *KinematicsFileFormat
func (KinematicsFileFormat) EnumDescriptor
deprecated
added in
v0.1.129
func (KinematicsFileFormat) EnumDescriptor() ([]byte, []int)
Deprecated: Use KinematicsFileFormat.Descriptor instead.
func (KinematicsFileFormat) Number ¶ added in v0.1.129
func (x KinematicsFileFormat) Number() protoreflect.EnumNumber
func (KinematicsFileFormat) String ¶ added in v0.1.129
func (x KinematicsFileFormat) String() string
func (KinematicsFileFormat) Type ¶ added in v0.1.129
func (KinematicsFileFormat) Type() protoreflect.EnumType
type LogEntry ¶ added in v0.1.257
type LogEntry struct { Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"` Level string `protobuf:"bytes,2,opt,name=level,proto3" json:"level,omitempty"` Time *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=time,proto3" json:"time,omitempty"` LoggerName string `protobuf:"bytes,4,opt,name=logger_name,json=loggerName,proto3" json:"logger_name,omitempty"` Message string `protobuf:"bytes,5,opt,name=message,proto3" json:"message,omitempty"` Caller *structpb.Struct `protobuf:"bytes,6,opt,name=caller,proto3" json:"caller,omitempty"` Stack string `protobuf:"bytes,7,opt,name=stack,proto3" json:"stack,omitempty"` Fields []*structpb.Struct `protobuf:"bytes,8,rep,name=fields,proto3" json:"fields,omitempty"` // contains filtered or unexported fields }
func (*LogEntry) Descriptor
deprecated
added in
v0.1.257
func (*LogEntry) GetLoggerName ¶ added in v0.1.257
func (*LogEntry) GetMessage ¶ added in v0.1.257
func (*LogEntry) GetTime ¶ added in v0.1.257
func (x *LogEntry) GetTime() *timestamppb.Timestamp
func (*LogEntry) ProtoMessage ¶ added in v0.1.257
func (*LogEntry) ProtoMessage()
func (*LogEntry) ProtoReflect ¶ added in v0.1.257
func (x *LogEntry) ProtoReflect() protoreflect.Message
type Orientation ¶
type Orientation struct { // x component of a vector defining axis of rotation OX float64 `protobuf:"fixed64,1,opt,name=o_x,json=oX,proto3" json:"o_x,omitempty"` // y component of a vector defining axis of rotation OY float64 `protobuf:"fixed64,2,opt,name=o_y,json=oY,proto3" json:"o_y,omitempty"` // z component of a vector defining axis of rotation OZ float64 `protobuf:"fixed64,3,opt,name=o_z,json=oZ,proto3" json:"o_z,omitempty"` // degrees Theta float64 `protobuf:"fixed64,4,opt,name=theta,proto3" json:"theta,omitempty"` // contains filtered or unexported fields }
func (*Orientation) Descriptor
deprecated
func (*Orientation) Descriptor() ([]byte, []int)
Deprecated: Use Orientation.ProtoReflect.Descriptor instead.
func (*Orientation) GetOX ¶
func (x *Orientation) GetOX() float64
func (*Orientation) GetOY ¶
func (x *Orientation) GetOY() float64
func (*Orientation) GetOZ ¶
func (x *Orientation) GetOZ() float64
func (*Orientation) GetTheta ¶
func (x *Orientation) GetTheta() float64
func (*Orientation) ProtoMessage ¶
func (*Orientation) ProtoMessage()
func (*Orientation) ProtoReflect ¶
func (x *Orientation) ProtoReflect() protoreflect.Message
func (*Orientation) Reset ¶
func (x *Orientation) Reset()
func (*Orientation) String ¶
func (x *Orientation) String() string
type PointCloudObject ¶
type PointCloudObject struct { // image frame expressed in bytes PointCloud []byte `protobuf:"bytes,1,opt,name=point_cloud,json=pointCloud,proto3" json:"point_cloud,omitempty"` // volume of a given geometry Geometries *GeometriesInFrame `protobuf:"bytes,2,opt,name=geometries,proto3" json:"geometries,omitempty"` // contains filtered or unexported fields }
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
func (*PointCloudObject) Descriptor
deprecated
func (*PointCloudObject) Descriptor() ([]byte, []int)
Deprecated: Use PointCloudObject.ProtoReflect.Descriptor instead.
func (*PointCloudObject) GetGeometries ¶
func (x *PointCloudObject) GetGeometries() *GeometriesInFrame
func (*PointCloudObject) GetPointCloud ¶
func (x *PointCloudObject) GetPointCloud() []byte
func (*PointCloudObject) ProtoMessage ¶
func (*PointCloudObject) ProtoMessage()
func (*PointCloudObject) ProtoReflect ¶
func (x *PointCloudObject) ProtoReflect() protoreflect.Message
func (*PointCloudObject) Reset ¶
func (x *PointCloudObject) Reset()
func (*PointCloudObject) String ¶
func (x *PointCloudObject) String() string
type Pose ¶
type Pose struct { // millimeters from the origin X float64 `protobuf:"fixed64,1,opt,name=x,proto3" json:"x,omitempty"` // millimeters from the origin Y float64 `protobuf:"fixed64,2,opt,name=y,proto3" json:"y,omitempty"` // millimeters from the origin Z float64 `protobuf:"fixed64,3,opt,name=z,proto3" json:"z,omitempty"` // z component of a vector defining axis of rotation OX float64 `protobuf:"fixed64,4,opt,name=o_x,json=oX,proto3" json:"o_x,omitempty"` // x component of a vector defining axis of rotation OY float64 `protobuf:"fixed64,5,opt,name=o_y,json=oY,proto3" json:"o_y,omitempty"` // y component of a vector defining axis of rotation OZ float64 `protobuf:"fixed64,6,opt,name=o_z,json=oZ,proto3" json:"o_z,omitempty"` // degrees Theta float64 `protobuf:"fixed64,7,opt,name=theta,proto3" json:"theta,omitempty"` // contains filtered or unexported fields }
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.
func (*Pose) Descriptor
deprecated
func (*Pose) ProtoMessage ¶
func (*Pose) ProtoMessage()
func (*Pose) ProtoReflect ¶
func (x *Pose) ProtoReflect() protoreflect.Message
type PoseInFrame ¶
type PoseInFrame struct { ReferenceFrame string `protobuf:"bytes,1,opt,name=reference_frame,json=referenceFrame,proto3" json:"reference_frame,omitempty"` Pose *Pose `protobuf:"bytes,2,opt,name=pose,proto3" json:"pose,omitempty"` // contains filtered or unexported fields }
PoseInFrame contains a pose and the and the reference frame in which it was observed
func (*PoseInFrame) Descriptor
deprecated
func (*PoseInFrame) Descriptor() ([]byte, []int)
Deprecated: Use PoseInFrame.ProtoReflect.Descriptor instead.
func (*PoseInFrame) GetPose ¶
func (x *PoseInFrame) GetPose() *Pose
func (*PoseInFrame) GetReferenceFrame ¶
func (x *PoseInFrame) GetReferenceFrame() string
func (*PoseInFrame) ProtoMessage ¶
func (*PoseInFrame) ProtoMessage()
func (*PoseInFrame) ProtoReflect ¶
func (x *PoseInFrame) ProtoReflect() protoreflect.Message
func (*PoseInFrame) Reset ¶
func (x *PoseInFrame) Reset()
func (*PoseInFrame) String ¶
func (x *PoseInFrame) String() string
type RectangularPrism ¶
type RectangularPrism struct { DimsMm *Vector3 `protobuf:"bytes,1,opt,name=dims_mm,json=dimsMm,proto3" json:"dims_mm,omitempty"` // contains filtered or unexported fields }
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
func (*RectangularPrism) Descriptor
deprecated
func (*RectangularPrism) Descriptor() ([]byte, []int)
Deprecated: Use RectangularPrism.ProtoReflect.Descriptor instead.
func (*RectangularPrism) GetDimsMm ¶
func (x *RectangularPrism) GetDimsMm() *Vector3
func (*RectangularPrism) ProtoMessage ¶
func (*RectangularPrism) ProtoMessage()
func (*RectangularPrism) ProtoReflect ¶
func (x *RectangularPrism) ProtoReflect() protoreflect.Message
func (*RectangularPrism) Reset ¶
func (x *RectangularPrism) Reset()
func (*RectangularPrism) String ¶
func (x *RectangularPrism) String() string
type ResourceName ¶
type ResourceName struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` Subtype string `protobuf:"bytes,3,opt,name=subtype,proto3" json:"subtype,omitempty"` Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"` RemotePath []string `protobuf:"bytes,5,rep,name=remote_path,json=remotePath,proto3" json:"remote_path,omitempty"` LocalName string `protobuf:"bytes,6,opt,name=local_name,json=localName,proto3" json:"local_name,omitempty"` // contains filtered or unexported fields }
func (*ResourceName) Descriptor
deprecated
func (*ResourceName) Descriptor() ([]byte, []int)
Deprecated: Use ResourceName.ProtoReflect.Descriptor instead.
func (*ResourceName) GetLocalName ¶ added in v0.1.356
func (x *ResourceName) GetLocalName() string
func (*ResourceName) GetName ¶
func (x *ResourceName) GetName() string
func (*ResourceName) GetNamespace ¶
func (x *ResourceName) GetNamespace() string
func (*ResourceName) GetRemotePath ¶ added in v0.1.356
func (x *ResourceName) GetRemotePath() []string
func (*ResourceName) GetSubtype ¶
func (x *ResourceName) GetSubtype() string
func (*ResourceName) GetType ¶
func (x *ResourceName) GetType() string
func (*ResourceName) ProtoMessage ¶
func (*ResourceName) ProtoMessage()
func (*ResourceName) ProtoReflect ¶
func (x *ResourceName) ProtoReflect() protoreflect.Message
func (*ResourceName) Reset ¶
func (x *ResourceName) Reset()
func (*ResourceName) String ¶
func (x *ResourceName) String() string
type ResponseMetadata ¶ added in v0.1.156
type ResponseMetadata struct { // captured_at is the time at which the resource as close as physically possible, captured // the data in the response. // Note: If correlating between other resources, be sure that the means // of measuring the capture are similar enough such that comparison can be made between them. CapturedAt *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=captured_at,json=capturedAt,proto3,oneof" json:"captured_at,omitempty"` // contains filtered or unexported fields }
func (*ResponseMetadata) Descriptor
deprecated
added in
v0.1.156
func (*ResponseMetadata) Descriptor() ([]byte, []int)
Deprecated: Use ResponseMetadata.ProtoReflect.Descriptor instead.
func (*ResponseMetadata) GetCapturedAt ¶ added in v0.1.156
func (x *ResponseMetadata) GetCapturedAt() *timestamppb.Timestamp
func (*ResponseMetadata) ProtoMessage ¶ added in v0.1.156
func (*ResponseMetadata) ProtoMessage()
func (*ResponseMetadata) ProtoReflect ¶ added in v0.1.156
func (x *ResponseMetadata) ProtoReflect() protoreflect.Message
func (*ResponseMetadata) Reset ¶ added in v0.1.156
func (x *ResponseMetadata) Reset()
func (*ResponseMetadata) String ¶ added in v0.1.156
func (x *ResponseMetadata) String() string
type Sphere ¶
type Sphere struct { RadiusMm float64 `protobuf:"fixed64,1,opt,name=radius_mm,json=radiusMm,proto3" json:"radius_mm,omitempty"` // contains filtered or unexported fields }
func (*Sphere) Descriptor
deprecated
func (*Sphere) GetRadiusMm ¶
func (*Sphere) ProtoMessage ¶
func (*Sphere) ProtoMessage()
func (*Sphere) ProtoReflect ¶
func (x *Sphere) ProtoReflect() protoreflect.Message
type Transform ¶
type Transform struct { // the name of a given reference frame ReferenceFrame string `protobuf:"bytes,1,opt,name=reference_frame,json=referenceFrame,proto3" json:"reference_frame,omitempty"` // the pose of the above reference frame with respect to a different observer reference frame PoseInObserverFrame *PoseInFrame `protobuf:"bytes,2,opt,name=pose_in_observer_frame,json=poseInObserverFrame,proto3" json:"pose_in_observer_frame,omitempty"` PhysicalObject *Geometry `protobuf:"bytes,3,opt,name=physical_object,json=physicalObject,proto3,oneof" json:"physical_object,omitempty"` // contains filtered or unexported fields }
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.
func (*Transform) Descriptor
deprecated
func (*Transform) GetPhysicalObject ¶ added in v0.1.20
func (*Transform) GetPoseInObserverFrame ¶
func (x *Transform) GetPoseInObserverFrame() *PoseInFrame
func (*Transform) GetReferenceFrame ¶
func (*Transform) ProtoMessage ¶
func (*Transform) ProtoMessage()
func (*Transform) ProtoReflect ¶
func (x *Transform) ProtoReflect() protoreflect.Message
type Vector3 ¶
type Vector3 struct { X float64 `protobuf:"fixed64,1,opt,name=x,proto3" json:"x,omitempty"` Y float64 `protobuf:"fixed64,2,opt,name=y,proto3" json:"y,omitempty"` Z float64 `protobuf:"fixed64,3,opt,name=z,proto3" json:"z,omitempty"` // contains filtered or unexported fields }
func (*Vector3) Descriptor
deprecated
func (*Vector3) ProtoMessage ¶
func (*Vector3) ProtoMessage()
func (*Vector3) ProtoReflect ¶
func (x *Vector3) ProtoReflect() protoreflect.Message
type WorldState ¶
type WorldState struct { // a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional Obstacles []*GeometriesInFrame `protobuf:"bytes,1,rep,name=obstacles,proto3" json:"obstacles,omitempty"` // a list of Transforms, optionally with geometries. Used as supplemental transforms to transform a pose from one reference frame to // another, or to attach moving geometries to the frame system. This field is optional Transforms []*Transform `protobuf:"bytes,3,rep,name=transforms,proto3" json:"transforms,omitempty"` // contains filtered or unexported fields }
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.
func (*WorldState) Descriptor
deprecated
func (*WorldState) Descriptor() ([]byte, []int)
Deprecated: Use WorldState.ProtoReflect.Descriptor instead.
func (*WorldState) GetObstacles ¶
func (x *WorldState) GetObstacles() []*GeometriesInFrame
func (*WorldState) GetTransforms ¶
func (x *WorldState) GetTransforms() []*Transform
func (*WorldState) ProtoMessage ¶
func (*WorldState) ProtoMessage()
func (*WorldState) ProtoReflect ¶
func (x *WorldState) ProtoReflect() protoreflect.Message
func (*WorldState) Reset ¶
func (x *WorldState) Reset()
func (*WorldState) String ¶
func (x *WorldState) String() string