package
0.0.0-20210319174132-8b9dd21232b6
Repository: https://github.com/digital-dream-labs/vector-go-sdk.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
Action aborted itself (e.g.
Action was cancelled by SDK request.
Action is still running.
Action completed successfully.
Animation Action aborted itself (e.g.
There was an error related to vision markers.
There was a problem related to a subscribed or unsupported message tag.
There was a problem with the Object ID provided (e.g.
There was a problem with the Pose provided.
The SDK-provided tag was bad.
Vector is on the charger but cannot sense the contacts.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Failed to get into position.
Shouldn't occur outside of factory.
Failed to follow the planned path.
There was an error following the planned path.
The action was interrupted by another Action or Behavior.
The robot ended up in an "off treads state" not valid for this action (e.g.
The previous attempt to pick and place an object failed.
The Up Axis of a carried object doesn't match the desired placement pose.
The required motor isn't moving so the action cannot complete.
No valid Animation name was found.
An invalid distance value was given.
There was a problem with the Face ID (e.g.
No goal pose was set.
No pre-action poses were found (e.g.
No object is being carried, but the action requires one.
Not carrying an object when it was expected, but may succeed if the action is retried.
Vector is expected to be on the charger, but is not.
Driving onto the charger failed, but may succeed if the action is retried.
Initial state of an Action to indicate it has not yet started.
No sub-action was provided.
Vector was unable to plan a path.
Vector was unable to plan a path, but may succeed if the action is retried.
The object that Vector is attempting to pickup is unexpectedly moving (e.g it is being moved by someone else).
The object that Vector thought he was lifting didn't start moving, so he must have missed.
There is no room to place the object at the desired destination.
The Action failed, but may succeed if retried.
Shouldn't occur in SDK usage.
Action is not permitted on the charger.
Vector is unexpectedly still carrying an object.
Vector failed to drive off the charger.
The Action timed out before completing correctly.
One or more movement tracks (Head, Lift, Body, Face, Backpack Lights, Audio) are already being used by another Action.
There was an internal error related to an unexpected type of dock action.
Vector's pitch is at an unexpected angle for the Action.
Shouldn't occur outside of factory.
There was a problem in the subclass's update on the robot.
Vector did not see the expected result (e.g.
No description provided by the author
No description provided by the author
No description provided by the author
Opted in, and authorized / in use.
Invalid/error/versioning issue.
Opted in, and attempting to authorize.
Not opted in, or opt-in attempted but failed.
Opted in, and waiting on the user to enter a code.
Align the front of Vector's body (useful for when the lift is up).
For use with distanceFromMarker parameter.
Align the tips of the lift fingers with the target object.
Align the flat part of the lift with the object (useful for getting the fingers in the cube's grooves).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
error value.
The number of audio directions the four microphones can isolate.
The sampling rate victor's microphones record at.
The sampling rate the robot processes audio at.
The number of audio samples in each internal audio chunk.
The number of audio samples delivered in each audio feed response.
beamforming support for focusing on specific direction - sounds cleanest.
unprocessed single microphone data - most performant on robot.
deactivates audio SDK mode.
error value.
multi-microphone non-beamforming - best for voice detection programs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Normal priority level.
Highest priority level.
Enable long-running SDK control between script execution.
Unknown priority.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Failures:.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Clad does not account for "Unknown" in the count.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
e.g.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Minimized grayscale JPEG - no header, no footer, no byte stuffing, with added color data.
Minimized grayscale JPEG - no header, no footer, no byte stuffing.
No description provided by the author
no compression.
no compression, just [RGBRGBRG...].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The depth of custom walls used in the engine.
error value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Light Cube (a.k.a.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Maintain this numbering for backward compatibility.
No description provided by the author
No description provided by the author
No description provided by the author
Current version (incremented on 2019.03.12 for streaming update status support.).
Minimum supported version.
Required zero value for enums.
No description provided by the author
No description provided by the author
Currently updating values from another call.
The user was not authorizied.
The requested attribute was not found.
The message has been handled successfully at the interface level.
The message has been sent to the robot.
The message has completed as expected.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Enum value maps for AccountSetting.
Enum value maps for AccountSetting.
Enum value maps for ActionResult_ActionResultCode.
Enum value maps for ActionResult_ActionResultCode.
Enum value maps for ActionTagConstants.
Enum value maps for ActionTagConstants.
Enum value maps for AlexaAuthState.
Enum value maps for AlexaAuthState.
Enum value maps for AlignmentType.
Enum value maps for AlignmentType.
Enum value maps for ApiVersion.
Enum value maps for ApiVersion.
Enum value maps for AttentionTransferReason.
Enum value maps for AttentionTransferReason.
Enum value maps for AudioConstants.
Enum value maps for AudioConstants.
Enum value maps for AudioProcessingMode.
Enum value maps for AudioProcessingMode.
Enum value maps for BatteryLevel.
Enum value maps for BatteryLevel.
Enum value maps for BehaviorResults.
Enum value maps for BehaviorResults.
Enum value maps for ButtonWakeWord.
Enum value maps for ButtonWakeWord.
Enum value maps for CheckCloudResponse_ConnectionCode.
Enum value maps for CheckCloudResponse_ConnectionCode.
Enum value maps for CheckUpdateStatusResponse_UpdateStatus.
Enum value maps for CheckUpdateStatusResponse_UpdateStatus.
Enum value maps for ControlRequest_Priority.
Enum value maps for ControlRequest_Priority.
Enum value maps for CubeBattery_CubeBatteryLevel.
Enum value maps for CubeBattery_CubeBatteryLevel.
Enum value maps for CustomObjectDeletionMode.
Enum value maps for CustomObjectDeletionMode.
Enum value maps for CustomObjectMarker.
Enum value maps for CustomObjectMarker.
Enum value maps for CustomType.
Enum value maps for CustomType.
optional bool streamed = 60000;.
Enum value maps for EyeColor.
Enum value maps for EyeColor.
Enum value maps for FaceEnrollmentResult.
Enum value maps for FaceEnrollmentResult.
Enum value maps for FacialExpression.
Enum value maps for FacialExpression.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum value maps for ImageChunk_ImageEncoding.
Enum value maps for ImageChunk_ImageEncoding.
Enum value maps for JdocResolveMethod.
Enum value maps for JdocResolveMethod.
Enum value maps for JdocType.
Enum value maps for JdocType.
Enum value maps for MasterVolumeLevel.
Enum value maps for MasterVolumeLevel.
Enum value maps for NavNodeContentType.
Enum value maps for NavNodeContentType.
Enum value maps for ObjectConstants.
Enum value maps for ObjectConstants.
Enum value maps for ObjectFamily.
Enum value maps for ObjectFamily.
Enum value maps for ObjectType.
Enum value maps for ObjectType.
Enum value maps for OnboardingPhase.
Enum value maps for OnboardingPhase.
Enum value maps for OnboardingPhaseState.
Enum value maps for OnboardingPhaseState.
Enum value maps for OnboardingStages.
Enum value maps for OnboardingStages.
Enum value maps for ProtocolVersion.
Enum value maps for ProtocolVersion.
Enum value maps for ProtocolVersionResponse_Result.
Enum value maps for ProtocolVersionResponse_Result.
Enum value maps for ResponseStatus_StatusCode.
Enum value maps for ResponseStatus_StatusCode.
Enum value maps for ResultCode.
Enum value maps for ResultCode.
Enum value maps for RobotSetting.
Enum value maps for RobotSetting.
Enum value maps for RobotStatus.
Enum value maps for RobotStatus.
Enum value maps for SayTextResponse_UtteranceState.
Enum value maps for SayTextResponse_UtteranceState.
Enum value maps for SetCubeLightsRequest_MakeRelativeMode.
Enum value maps for SetCubeLightsRequest_MakeRelativeMode.
Enum value maps for UpAxis.
Enum value maps for UpAxis.
Enum value maps for UserAuthenticationResponse_Code.
Enum value maps for UserAuthenticationResponse_Code.
Enum value maps for Volume.
Enum value maps for Volume.

# Structs

All values are in mm/s^2.
No description provided by the author
No description provided by the author
No description provided by the author
These codes are duplicated from actionResults.clad file and need to be kept in sync The possible results of running an action.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An animation object.
An animation trigger object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
One frame of robot audio data and associated metadata.
Request the robot to send audio data.
Streamed audio data from the robot.
Event sent when the robot changes the mode it's processing and sending audio.
Request how the robot should process and send audio.
No description provided by the author
No description provided by the author
Messages that can be sent to the behavior stream.
No description provided by the author
No description provided by the author
Responses from the behavior stream.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Cancel a previously-requested action.
Response from the robot to CancelActionByIdTagRequest.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Attempt to connect to a cube.
No description provided by the author
No description provided by the author
The SDK user is now free to run any actions and behaviors they like.
This informs the user that they lost control of the behavior system.
Tell the behavior stream to release control from the SDK.
Request control of the behavior system at a given priority.
Creates a CustomObject at the specific pose with no markers associated with it Since this object has no markers with which to be observed, it will remain in the specified pose as an obstacle forever (or until deleted with a deletion message above).
No description provided by the author
No description provided by the author
Indicates that a the connection subscribed through ConnectCube has been lost.
No description provided by the author
No description provided by the author
Defines a custom object of the given size with the given markers centered on each side If isUnique=true, there is guaranteed to be no more than one object of this type present in the world.
Defines a custom cube of the given size.
Defines a custom wall of the given height and width, with the same marker centered on both sides (front and back).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deletes all custom objects matching a given deletion mode.
No description provided by the author
No description provided by the author
No description provided by the author
Requests a disconnection from the currently connected cube.
No description provided by the author
See DisplayFaceImageRGB rpc for more details.
See DisplayFaceImageRGB rpc for more details.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
See the DriveWheels rpc for more details.
See the DriveWheels rpc for more details.
When enabled, RobotObservedFace messages will be produced.
No description provided by the author
Toggle image streaming at the given resolution.
No description provided by the author
When enabled, RobotObservedObject messages will be produced.
No description provided by the author
When enabled, camera feed will appear on the robot's face, along with any detections that are enabled from above messages.
No description provided by the author
When enabled, RobotObservedMotion messages will be produced.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Messages originating from the engine.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Audio has been sent to robot that would overrun the memory buffer.
Cancel a playing external robot audio stream.
Send chunk of audio data to stream on robot.
Send notification of last chunk of audio sent to robot.
Audio has been played on the Robot.
Audio playback failure.
Preflight and initialization for audio streaming to robot.
Request to stream audio to the robot.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Response from streaming audio to robot.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Plays the default cube connection animation on the currently connected cube's lights.
No description provided by the author
Forget the robot's preferred cube.
No description provided by the author
GoToObject.
No description provided by the author
GotoPose.
No description provided by the author
All values are in rad/s.
One frame of image data and associated metadata.
Request whether or not image streaming is enabled on the robot.
Indicates whether or not image streaming is enabled on the robot.
No description provided by the author
No description provided by the author
A null message used by streams to verify that the client is still connected.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
See ListAnimations rpc for more details.
See ListAnimations rpc for more details.
See ListAnimationTriggers rpc for more details.
See ListAnimationTriggers rpc for more details.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Sent if MirrorMode (camera feed displayed on face) is currently enabled but is automatically being disabled.
See the MoveHead rpc for more details.
See the MoveHead rpc for more details.
See the MoveLift rpc for more details.
See the MoveLift rpc for more details.
No description provided by the author
Requests nav map data from the robot at a specified maximum update frequency.
A full nav map sent from the robot.
General information about the nav map as a whole.
An individual sample of vector's nav map.
No description provided by the author
Indicates that a cube has connected or disconnected to the robot.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
1p0 backward compatibility messages - - - - -.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Struct containing all the information relevant to how a path should be modified or traversed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PickupObject.
No description provided by the author
PlaceObjectOnGroundHere.
No description provided by the author
See PlayAnimation rpc for more details.
See PlayAnimation rpc for more details.
See PlayAnimationTrigger rpc for more details.
PopAWheelie.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The ability to reserve control before/after SDK scripts has been lost.
A shared response message sent back as part of most requests.
RobotChangedObservedFaceID This generally happens when a tracked face (negative ID) is recognized and receives a positive ID or when face records get merged.
No description provided by the author
No description provided by the author
No description provided by the author
RobotObservedObject for signaling that an object with specified ID/Type was seen at a particular location in the image and the world.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
this triggers a Vector Behavior, different from RollObjectRequest which triggers an Action.
No description provided by the author
RollObject.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Sets each LED on victor's cube.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SetHeadAngle.
No description provided by the author
SetLiftHeight.
No description provided by the author
Set the robot's preferred cube and save it to disk.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
See the StopAllMotors rpc for more details.
See the StopAllMotors rpc for more details.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TurnInPlace If isAbsolute == 0, turns the specified number of radians, relative to the robot's current heading* If isAbsolute != 0, turns to the specified absolute orientation.
No description provided by the author
TurnTowardsFace.
No description provided by the author
UnimplementedExternalInterfaceServer can be embedded to have forward compatible implementations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Sent when vision modes are automatically disabled due to the SDK no longer having control of the robot.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExternalInterfaceClient is the client API for ExternalInterface service.
ExternalInterfaceServer is the server API for ExternalInterface service.

# Type aliases

No description provided by the author
The possible results of running an action.
No description provided by the author
No description provided by the author
This is a uint8 in CLAD.
No description provided by the author
NOTE: must match attentionTransferTypes.clad.
Constants associated with the audio feed.
The robot can process audio in a variety of ways.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Where in the behavior tree the SDK code should be executed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an int8 on the clad side.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Every tile in the nav map will be tagged with a content key referring to the different environmental elements that Vector can identify.
Constants associated with the audio feed.
Note: ObjectFamily is deprecated and will be removed in future releases.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
<p>The valid versions of the protocol.</p> <p>Protocol versions are updated when messages change significantly: new ones are added and removed, fields deprecated, etc.</p> <p>The goal is to support as many old versions as possible, only bumping the minimum when there is no way to handle a prior version.</p>.
No description provided by the author
No description provided by the author
No description provided by the author
RobotSetting enum values are not in all caps for historical reasons.
No description provided by the author
No description provided by the author
This is a uint_8 internally.
No description provided by the author
No description provided by the author
No description provided by the author