protos/app/robot library Protobuf Definitions

The proto definitions for robot

Classes

AgentInfo
AppValidationStatus
AuthConfig
AuthHandlerConfig
CertificateRequest
CertificateResponse
CloudConfig
ComponentConfig
ConfigRequest
ConfigResponse
CredentialsType
ExternalAuthConfig
ExternalAuthConfig describes how a viam managed robot can accept credentials signed by the cloud app.
Frame
JWKSFile
LocationSecret
Valid location secret that can be used for authentication to the robot.
LogConfiguration
LogRequest
LogResponse
ModuleConfig
ModuleConfig is the configuration for a module.
NeedsRestartRequest
NeedsRestartResponse
NetworkConfig
Orientation
Orientation_AxisAngles
See here for a thorough explanation: https://en.wikipedia.org/wiki/Axis%E2%80%93angle_representation Basic explanation: Imagine a 3d cartesian grid centered at 0,0,0, and a sphere of radius 1 centered at that same point. An orientation can be expressed by first specifying an axis, i.e. a line from the origin to a point on that sphere, represented by (rx, ry, rz), and a rotation around that axis, theta. These four numbers can be used as-is (R4), or they can be converted to R3, where theta is multiplied by each of the unit sphere components to give a vector whose length is theta and whose direction is the original axis. AxisAngles represents an R4 axis angle.
Orientation_EulerAngles
EulerAngles are three angles (in radians) used to represent the rotation of an object in 3D Euclidean space The Tait–Bryan angle formalism is used, with rotations around three distinct axes in the z-y′-x″ sequence.
Orientation_NoOrientation
Orientation_OrientationVectorDegrees
OrientationVectorDegrees is the orientation vector between two objects, but expressed in degrees rather than radians. Because protobuf Pose is in degrees, this is necessary.
Orientation_OrientationVectorRadians
OrientationVector containing ox, oy, oz, theta represents an orientation vector Structured similarly to an angle axis, an orientation vector works differently. Rather than representing an orientation with an arbitrary axis and a rotation around it from an origin, an orientation vector represents orientation such that the ox/oy/oz components represent the point on the cartesian unit sphere at which your end effector is pointing from the origin, and that unit vector forms an axis around which theta rotates. This means that incrementing/decrementing theta will perform an in-line rotation of the end effector. Theta is defined as rotation between two planes: the plane defined by the origin, the point (0,0,1), and the rx,ry,rz point, and the plane defined by the origin, the rx,ry,rz point, and the new local Z axis. So if theta is kept at zero as the north/south pole is circled, the Roll will correct itself to remain in-line.
Orientation_Quaternion
Quaternion is a float64 precision quaternion.
PackageConfig
PackageConfig is the configration for deployed Packages.
ProcessConfig
A ProcessConfig describes how to manage a system process.
RemoteAuth
RemoteAuth specifies how to authenticate against a remote. If no credentials are specified, authentication does not happen. If an entity is specified, the authentication request will specify it.
RemoteAuth_Credentials
Credentials packages up both a type of credential along with its payload which is formatted specific to the type.
RemoteConfig
A RemoteConfig describes a remote robot that should be integrated. The Frame field defines how the "world" node of the remote robot should be reconciled with the "world" node of the the current robot. All components of the remote robot who have Parent as "world" will be attached to the parent defined in Frame, and with the given offset as well.
ResourceLevelServiceConfig
A ResourceLevelServiceConfig describes component or remote configuration for a service.
RobotConfig
RobotServiceBase
RobotServiceClient
ServiceConfig
SessionsConfig
Translation

Constants

AgentInfo$json → const Map<String, Object>
AppValidationStatus$json → const Map<String, Object>
AuthConfig$json → const Map<String, Object>
AuthHandlerConfig$json → const Map<String, Object>
CertificateRequest$json → const Map<String, Object>
CertificateResponse$json → const Map<String, Object>
CloudConfig$json → const Map<String, Object>
ComponentConfig$json → const Map<String, Object>
ConfigRequest$json → const Map<String, Object>
ConfigResponse$json → const Map<String, Object>
CredentialsType$json → const Map<String, Object>
ExternalAuthConfig$json → const Map<String, Object>
Frame$json → const Map<String, Object>
JWKSFile$json → const Map<String, Object>
LocationSecret$json → const Map<String, Object>
LogConfiguration$json → const Map<String, Object>
LogRequest$json → const Map<String, Object>
LogResponse$json → const Map<String, String>
ModuleConfig$json → const Map<String, Object>
ModuleConfig_EnvEntry$json → const Map<String, Object>
NeedsRestartRequest$json → const Map<String, Object>
NeedsRestartResponse$json → const Map<String, Object>
NetworkConfig$json → const Map<String, Object>
Orientation$json → const Map<String, Object>
Orientation_AxisAngles$json → const Map<String, Object>
Orientation_EulerAngles$json → const Map<String, Object>
Orientation_NoOrientation$json → const Map<String, String>
Orientation_OrientationVectorDegrees$json → const Map<String, Object>
Orientation_OrientationVectorRadians$json → const Map<String, Object>
Orientation_Quaternion$json → const Map<String, Object>
PackageConfig$json → const Map<String, Object>
ProcessConfig$json → const Map<String, Object>
ProcessConfig_EnvEntry$json → const Map<String, Object>
RemoteAuth$json → const Map<String, Object>
RemoteAuth_Credentials$json → const Map<String, Object>
RemoteConfig$json → const Map<String, Object>
ResourceLevelServiceConfig$json → const Map<String, Object>
RobotConfig$json → const Map<String, Object>
ServiceConfig$json → const Map<String, Object>
SessionsConfig$json → const Map<String, Object>
Translation$json → const Map<String, Object>

Properties

agentInfoDescriptor → Uint8List
Descriptor for AgentInfo. Decode as a google.protobuf.DescriptorProto.
final
appValidationStatusDescriptor → Uint8List
Descriptor for AppValidationStatus. Decode as a google.protobuf.DescriptorProto.
final
authConfigDescriptor → Uint8List
Descriptor for AuthConfig. Decode as a google.protobuf.DescriptorProto.
final
authHandlerConfigDescriptor → Uint8List
Descriptor for AuthHandlerConfig. Decode as a google.protobuf.DescriptorProto.
final
certificateRequestDescriptor → Uint8List
Descriptor for CertificateRequest. Decode as a google.protobuf.DescriptorProto.
final
certificateResponseDescriptor → Uint8List
Descriptor for CertificateResponse. Decode as a google.protobuf.DescriptorProto.
final
cloudConfigDescriptor → Uint8List
Descriptor for CloudConfig. Decode as a google.protobuf.DescriptorProto.
final
componentConfigDescriptor → Uint8List
Descriptor for ComponentConfig. Decode as a google.protobuf.DescriptorProto.
final
configRequestDescriptor → Uint8List
Descriptor for ConfigRequest. Decode as a google.protobuf.DescriptorProto.
final
configResponseDescriptor → Uint8List
Descriptor for ConfigResponse. Decode as a google.protobuf.DescriptorProto.
final
credentialsTypeDescriptor → Uint8List
Descriptor for CredentialsType. Decode as a google.protobuf.EnumDescriptorProto.
final
externalAuthConfigDescriptor → Uint8List
Descriptor for ExternalAuthConfig. Decode as a google.protobuf.DescriptorProto.
final
frameDescriptor → Uint8List
Descriptor for Frame. Decode as a google.protobuf.DescriptorProto.
final
jWKSFileDescriptor → Uint8List
Descriptor for JWKSFile. Decode as a google.protobuf.DescriptorProto.
final
locationSecretDescriptor → Uint8List
Descriptor for LocationSecret. Decode as a google.protobuf.DescriptorProto.
final
logConfigurationDescriptor → Uint8List
Descriptor for LogConfiguration. Decode as a google.protobuf.DescriptorProto.
final
logRequestDescriptor → Uint8List
Descriptor for LogRequest. Decode as a google.protobuf.DescriptorProto.
final
logResponseDescriptor → Uint8List
Descriptor for LogResponse. Decode as a google.protobuf.DescriptorProto.
final
moduleConfigDescriptor → Uint8List
Descriptor for ModuleConfig. Decode as a google.protobuf.DescriptorProto.
final
needsRestartRequestDescriptor → Uint8List
Descriptor for NeedsRestartRequest. Decode as a google.protobuf.DescriptorProto.
final
needsRestartResponseDescriptor → Uint8List
Descriptor for NeedsRestartResponse. Decode as a google.protobuf.DescriptorProto.
final
networkConfigDescriptor → Uint8List
Descriptor for NetworkConfig. Decode as a google.protobuf.DescriptorProto.
final
orientationDescriptor → Uint8List
Descriptor for Orientation. Decode as a google.protobuf.DescriptorProto.
final
packageConfigDescriptor → Uint8List
Descriptor for PackageConfig. Decode as a google.protobuf.DescriptorProto.
final
processConfigDescriptor → Uint8List
Descriptor for ProcessConfig. Decode as a google.protobuf.DescriptorProto.
final
remoteAuthDescriptor → Uint8List
Descriptor for RemoteAuth. Decode as a google.protobuf.DescriptorProto.
final
remoteConfigDescriptor → Uint8List
Descriptor for RemoteConfig. Decode as a google.protobuf.DescriptorProto.
final
resourceLevelServiceConfigDescriptor → Uint8List
Descriptor for ResourceLevelServiceConfig. Decode as a google.protobuf.DescriptorProto.
final
robotConfigDescriptor → Uint8List
Descriptor for RobotConfig. Decode as a google.protobuf.DescriptorProto.
final
serviceConfigDescriptor → Uint8List
Descriptor for ServiceConfig. Decode as a google.protobuf.DescriptorProto.
final
sessionsConfigDescriptor → Uint8List
Descriptor for SessionsConfig. Decode as a google.protobuf.DescriptorProto.
final
translationDescriptor → Uint8List
Descriptor for Translation. Decode as a google.protobuf.DescriptorProto.
final

Enums

Orientation_Type