GitHub
Preparing search index...
The search index is not available
Viam SDK
Viam SDK
Mode
Variable Mode
Mode
:
typeof
navigationApi
.
Mode
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Viam SDK
addMetadata
createRobotClient
createViamClient
deleteMetadata
disableDebugLogging
doCommandFromClient
enableDebugLogging
isValidGeoPoint
Code
MachineConnectionEvent
ModelType
TrainingStatus
AppClient
ArmClient
BaseClient
BillingClient
BinaryID
BoardClient
ButtonClient
CameraClient
CloudConfig
ConnectError
ConnectionClosedError
DataClient
DataManagerClient
DiscoveryClient
Duration
EncoderClient
GantryClient
GenericComponentClient
GenericServiceClient
GripperClient
InputControllerClient
MlTrainingClient
MotionClient
MotorClient
MovementSensorClient
NavigationClient
PowerSensorClient
ProvisioningClient
RobotClient
SensorClient
ServoClient
SlamClient
StreamClient
Struct
SwitchClient
Timestamp
ViamClient
VisionClient
AccessToken
Arm
Base
Board
Button
Camera
Credential
DataManager
DialDirectConf
DialWebRTCConf
Discovery
Encoder
Gantry
GenericComponent
GenericService
Gripper
InputController
Motion
Motor
MovementSensor
Options
PowerSensor
Resource
Robot
Sensor
Servo
Stream
Switch
Tick
ViamClientOptions
AnalogValue
ArmJointPositions
BaseProperties
Capsule
Classification
CloudMetadata
CollisionSpecification
Constraints
CredentialType
Credentials
Detection
DialConf
EncoderPositionType
EncoderProperties
FilterOptions
GeoGeometry
GeoPoint
GeometriesInFrame
Geometry
GetPlanResponse
InputControllerEvent
JsonValue
LinearConstraint
ListPlanStatusesResponse
MimeType
Mode
MotionConfiguration
MovementSensorAccuracy
MovementSensorPosition
MovementSensorProperties
NavigationPosition
NavigationProperties
ObstacleDetector
Orientation
OrientationConstraint
Path
PlainMessage
PlanState
PointCloudObject
Pose
PoseInFrame
PowerMode
RectangularPrism
ResourceName
SlamPosition
SlamProperties
Sphere
Transform
Vector3
Waypoint
WorldState
AnalogValue
ArmJointPositions
BaseProperties
Capsule
Classification
CollisionSpecification
Constraints
Detection
EncoderPositionType
EncoderProperties
GeoGeometry
GeoPoint
GeometriesInFrame
Geometry
GetPlanResponse
InputControllerEvent
LinearConstraint
ListPlanStatusesResponse
Mode
MotionConfiguration
MovementSensorAccuracy
MovementSensorPosition
MovementSensorProperties
NavigationPosition
NavigationProperties
ObstacleDetector
Orientation
OrientationConstraint
Path
PlanState
PointCloudObject
Pose
PoseInFrame
PowerMode
RectangularPrism
ResourceName
SlamPosition
SlamProperties
Sphere
Transform
Vector3
Waypoint
WorldState
version
Client
appApi
AuthenticationType
ClientAuthentication
EnabledGrant
FragmentErrorType
FragmentVisibility
PKCE
RegistryItemStatus
SharedSecret_State
URLValidation
Visibility
APIKey
APIKeyWithAuthorizations
AddRoleRequest
AddRoleResponse
AdditionalFragment
AuthenticatorInfo
Authorization
AuthorizationDetails
AuthorizedPermissions
BillingAddress
ChangeRoleRequest
ChangeRoleResponse
CheckPermissionsRequest
CheckPermissionsResponse
CreateFragmentRequest
CreateFragmentResponse
CreateKeyFromExistingKeyAuthorizationsRequest
CreateKeyFromExistingKeyAuthorizationsResponse
CreateKeyRequest
CreateKeyResponse
CreateLocationRequest
CreateLocationResponse
CreateLocationSecretRequest
CreateLocationSecretResponse
CreateModuleRequest
CreateModuleResponse
CreateOAuthAppRequest
CreateOAuthAppResponse
CreateOrganizationInviteRequest
CreateOrganizationInviteResponse
CreateOrganizationRequest
CreateOrganizationResponse
CreateRegistryItemRequest
CreateRegistryItemResponse
CreateRobotPartSecretRequest
CreateRobotPartSecretResponse
DeleteFragmentRequest
DeleteFragmentResponse
DeleteFragmentTagRequest
DeleteFragmentTagResponse
DeleteKeyRequest
DeleteKeyResponse
DeleteLocationRequest
DeleteLocationResponse
DeleteLocationSecretRequest
DeleteLocationSecretResponse
DeleteOAuthAppRequest
DeleteOAuthAppResponse
DeleteOrganizationInviteRequest
DeleteOrganizationInviteResponse
DeleteOrganizationMemberRequest
DeleteOrganizationMemberResponse
DeleteOrganizationRequest
DeleteOrganizationResponse
DeleteRegistryItemRequest
DeleteRegistryItemResponse
DeleteRobotPartRequest
DeleteRobotPartResponse
DeleteRobotPartSecretRequest
DeleteRobotPartSecretResponse
DeleteRobotRequest
DeleteRobotResponse
DisableAuthServiceRequest
DisableAuthServiceResponse
DisableBillingServiceRequest
DisableBillingServiceResponse
EnableAuthServiceRequest
EnableAuthServiceResponse
EnableBillingServiceRequest
EnableBillingServiceResponse
Fragment
FragmentError
FragmentHistoryEntry
FragmentRevision
FragmentTag
FragmentUsage
GetBillingServiceConfigRequest
GetBillingServiceConfigResponse
GetFragmentHistoryRequest
GetFragmentHistoryResponse
GetFragmentRequest
GetFragmentResponse
GetFragmentUsageRequest
GetFragmentUsageResponse
GetLocationMetadataRequest
GetLocationMetadataResponse
GetLocationRequest
GetLocationResponse
GetModuleRequest
GetModuleResponse
GetOrganizationMetadataRequest
GetOrganizationMetadataResponse
GetOrganizationNamespaceAvailabilityRequest
GetOrganizationNamespaceAvailabilityResponse
GetOrganizationRequest
GetOrganizationResponse
GetOrganizationsWithAccessToLocationRequest
GetOrganizationsWithAccessToLocationResponse
GetRegistryItemRequest
GetRegistryItemResponse
GetRobotAPIKeysRequest
GetRobotAPIKeysResponse
GetRobotMetadataRequest
GetRobotMetadataResponse
GetRobotPartHistoryRequest
GetRobotPartHistoryResponse
GetRobotPartLogsRequest
GetRobotPartLogsResponse
GetRobotPartMetadataRequest
GetRobotPartMetadataResponse
GetRobotPartRequest
GetRobotPartResponse
GetRobotPartsRequest
GetRobotPartsResponse
GetRobotRequest
GetRobotResponse
GetRoverRentalRobotsRequest
GetRoverRentalRobotsResponse
GetUserIDByEmailRequest
GetUserIDByEmailResponse
ListAuthorizationsRequest
ListAuthorizationsResponse
ListFragmentsRequest
ListFragmentsResponse
ListKeysRequest
ListKeysResponse
ListLocationsRequest
ListLocationsResponse
ListMachineFragmentsRequest
ListMachineFragmentsResponse
ListModulesRequest
ListModulesResponse
ListOAuthAppsRequest
ListOAuthAppsResponse
ListOrganizationMembersRequest
ListOrganizationMembersResponse
ListOrganizationsByUserRequest
ListOrganizationsByUserResponse
ListOrganizationsRequest
ListOrganizationsResponse
ListRegistryItemsRequest
ListRegistryItemsResponse
ListRobotsRequest
ListRobotsResponse
Location
LocationAuth
LocationAuthRequest
LocationAuthResponse
LocationOrganization
MLModelMetadata
MLTrainingMetadata
MLTrainingVersion
MarkPartAsMainRequest
MarkPartAsMainResponse
MarkPartForRestartRequest
MarkPartForRestartResponse
Model
Module
ModuleFileInfo
ModuleMetadata
ModuleVersion
NewRobotPartRequest
NewRobotPartResponse
NewRobotRequest
NewRobotResponse
OAuthConfig
OrgDetails
Organization
OrganizationGetLogoRequest
OrganizationGetLogoResponse
OrganizationGetSupportEmailRequest
OrganizationGetSupportEmailResponse
OrganizationIdentity
OrganizationInvite
OrganizationMember
OrganizationSetLogoRequest
OrganizationSetLogoResponse
OrganizationSetSupportEmailRequest
OrganizationSetSupportEmailResponse
ReadOAuthAppRequest
ReadOAuthAppResponse
RegistryItem
RemoveRoleRequest
RemoveRoleResponse
RenameKeyRequest
RenameKeyResponse
ResendOrganizationInviteRequest
ResendOrganizationInviteResponse
ResolvedFragment
Robot
RobotPart
RobotPartHistoryEntry
RotateKeyRequest
RotateKeyResponse
RoverRentalRobot
SearchOrganizationsRequest
SearchOrganizationsResponse
SetFragmentTagRequest
SetFragmentTagResponse
ShareLocationRequest
ShareLocationResponse
SharedSecret
StorageConfig
TailRobotPartLogsRequest
TailRobotPartLogsResponse
TransferRegistryItemRequest
TransferRegistryItemResponse
UnshareLocationRequest
UnshareLocationResponse
UpdateBillingServiceRequest
UpdateBillingServiceResponse
UpdateFragmentRequest
UpdateFragmentResponse
UpdateLocationMetadataRequest
UpdateLocationMetadataResponse
UpdateLocationRequest
UpdateLocationResponse
UpdateMLModelMetadata
UpdateMLTrainingMetadata
UpdateModuleMetadata
UpdateModuleRequest
UpdateModuleResponse
UpdateOAuthAppRequest
UpdateOAuthAppResponse
UpdateOrganizationInviteAuthorizationsRequest
UpdateOrganizationInviteAuthorizationsResponse
UpdateOrganizationMetadataRequest
UpdateOrganizationMetadataResponse
UpdateOrganizationRequest
UpdateOrganizationResponse
UpdateRegistryItemRequest
UpdateRegistryItemResponse
UpdateRobotMetadataRequest
UpdateRobotMetadataResponse
UpdateRobotPartMetadataRequest
UpdateRobotPartMetadataResponse
UpdateRobotPartRequest
UpdateRobotPartResponse
UpdateRobotRequest
UpdateRobotResponse
UploadModuleFileRequest
UploadModuleFileResponse
Uploads
VersionHistory
appRobotApi
CredentialsType
AgentInfo
AppValidationStatus
AuthConfig
AuthHandlerConfig
CertificateRequest
CertificateResponse
CloudConfig
ComponentConfig
ConfigRequest
ConfigResponse
ExternalAuthConfig
Frame
JWKSFile
LocationSecret
LogConfiguration
LogPatternConfig
LogRequest
LogResponse
MaintenanceConfig
ModuleConfig
NeedsRestartRequest
NeedsRestartResponse
NetworkConfig
Orientation
Orientation_AxisAngles
Orientation_EulerAngles
Orientation_NoOrientation
Orientation_OrientationVectorDegrees
Orientation_OrientationVectorRadians
Orientation_Quaternion
PackageConfig
ProcessConfig
RemoteAuth
RemoteAuth_Credentials
RemoteConfig
ResourceLevelServiceConfig
RobotConfig
ServiceConfig
SessionsConfig
TrafficTunnelEndpoint
Translation
armApi
GetEndPositionRequest
GetEndPositionResponse
GetJointPositionsRequest
GetJointPositionsResponse
IsMovingRequest
IsMovingResponse
JointPositions
MoveOptions
MoveThroughJointPositionsRequest
MoveThroughJointPositionsResponse
MoveToJointPositionsRequest
MoveToJointPositionsResponse
MoveToPositionRequest
MoveToPositionResponse
Status
StopRequest
StopResponse
baseApi
GetPropertiesRequest
GetPropertiesResponse
IsMovingRequest
IsMovingResponse
MoveStraightRequest
MoveStraightResponse
SetPowerRequest
SetPowerResponse
SetVelocityRequest
SetVelocityResponse
SpinRequest
SpinResponse
StopRequest
StopResponse
billingApi
PaymentMethodType
SourceType
UsageCostType
GetCurrentMonthUsageRequest
GetCurrentMonthUsageResponse
GetInvoicePdfRequest
GetInvoicePdfResponse
GetInvoicesSummaryRequest
GetInvoicesSummaryResponse
GetOrgBillingInformationRequest
GetOrgBillingInformationResponse
InvoiceSummary
PaymentMethodCard
ResourceUsageCosts
ResourceUsageCostsBySource
SendPaymentRequiredEmailRequest
SendPaymentRequiredEmailResponse
UsageCost
boardApi
PowerMode
GetDigitalInterruptValueRequest
GetDigitalInterruptValueResponse
GetGPIORequest
GetGPIOResponse
PWMFrequencyRequest
PWMFrequencyResponse
PWMRequest
PWMResponse
ReadAnalogReaderRequest
ReadAnalogReaderResponse
SetGPIORequest
SetGPIOResponse
SetPWMFrequencyRequest
SetPWMFrequencyResponse
SetPWMRequest
SetPWMResponse
SetPowerModeRequest
SetPowerModeResponse
Status
StreamTicksRequest
StreamTicksResponse
WriteAnalogRequest
WriteAnalogResponse
buttonApi
PushRequest
PushResponse
cameraApi
Format
DistortionParameters
GetImageRequest
GetImageResponse
GetImagesRequest
GetImagesResponse
GetPointCloudRequest
GetPointCloudResponse
GetPropertiesRequest
GetPropertiesResponse
Image
IntrinsicParameters
Property
RenderFrameRequest
Webcam
Webcams
commonApi
KinematicsFileFormat
ActuatorStatus
Capsule
DoCommandRequest
DoCommandResponse
GeoGeometry
GeoPoint
GeometriesInFrame
Geometry
GetGeometriesRequest
GetGeometriesResponse
GetKinematicsRequest
GetKinematicsResponse
GetReadingsRequest
GetReadingsResponse
LogEntry
Orientation
PointCloudObject
Pose
PoseInFrame
RectangularPrism
ResourceName
ResponseMetadata
Sphere
Transform
Vector3
WorldState
safety_heartbeat_monitored
dataApi
Order
TagsFilterType
AddBinaryDataToDatasetByIDsRequest
AddBinaryDataToDatasetByIDsResponse
AddBoundingBoxToImageByIDRequest
AddBoundingBoxToImageByIDResponse
AddTagsToBinaryDataByFilterRequest
AddTagsToBinaryDataByFilterResponse
AddTagsToBinaryDataByIDsRequest
AddTagsToBinaryDataByIDsResponse
Annotations
BinaryData
BinaryDataByFilterRequest
BinaryDataByFilterResponse
BinaryDataByIDsRequest
BinaryDataByIDsResponse
BinaryMetadata
BoundingBox
BoundingBoxLabelsByFilterRequest
BoundingBoxLabelsByFilterResponse
CaptureInterval
CaptureMetadata
Classification
ConfigureDatabaseUserRequest
ConfigureDatabaseUserResponse
DataRequest
DeleteBinaryDataByFilterRequest
DeleteBinaryDataByFilterResponse
DeleteBinaryDataByIDsRequest
DeleteBinaryDataByIDsResponse
DeleteTabularDataRequest
DeleteTabularDataResponse
ExportTabularDataRequest
ExportTabularDataResponse
Filter
GetDatabaseConnectionRequest
GetDatabaseConnectionResponse
GetLatestTabularDataRequest
GetLatestTabularDataResponse
RemoveBinaryDataFromDatasetByIDsRequest
RemoveBinaryDataFromDatasetByIDsResponse
RemoveBoundingBoxFromImageByIDRequest
RemoveBoundingBoxFromImageByIDResponse
RemoveTagsFromBinaryDataByFilterRequest
RemoveTagsFromBinaryDataByFilterResponse
RemoveTagsFromBinaryDataByIDsRequest
RemoveTagsFromBinaryDataByIDsResponse
TabularData
TabularDataByFilterRequest
TabularDataByFilterResponse
TabularDataByMQLRequest
TabularDataByMQLResponse
TabularDataBySQLRequest
TabularDataBySQLResponse
TagsByFilterRequest
TagsByFilterResponse
TagsFilter
UpdateBoundingBoxRequest
UpdateBoundingBoxResponse
BinaryID
dataManagerApi
SyncRequest
SyncResponse
discoveryApi
DiscoverResourcesRequest
DiscoverResourcesResponse
encoderApi
PositionType
GetPositionRequest
GetPositionResponse
GetPropertiesRequest
GetPropertiesResponse
ResetPositionRequest
ResetPositionResponse
gantryApi
GetLengthsRequest
GetLengthsResponse
GetPositionRequest
GetPositionResponse
HomeRequest
HomeResponse
IsMovingRequest
IsMovingResponse
MoveToPositionRequest
MoveToPositionResponse
Status
StopRequest
StopResponse
genericComponentApi
GenericService
genericServiceApi
GenericService
gripperApi
GrabRequest
GrabResponse
IsMovingRequest
IsMovingResponse
OpenRequest
OpenResponse
StopRequest
StopResponse
inputControllerApi
Event
GetControlsRequest
GetControlsResponse
GetEventsRequest
GetEventsResponse
Status
StreamEventsRequest
StreamEventsRequest_Events
StreamEventsResponse
TriggerEventRequest
TriggerEventResponse
mlTrainingApi
ModelFramework
CancelTrainingJobRequest
CancelTrainingJobResponse
DeleteCompletedTrainingJobRequest
DeleteCompletedTrainingJobResponse
GetTrainingJobLogsRequest
GetTrainingJobLogsResponse
GetTrainingJobRequest
GetTrainingJobResponse
ListTrainingJobsRequest
ListTrainingJobsResponse
SubmitCustomTrainingJobRequest
SubmitCustomTrainingJobResponse
SubmitTrainingJobRequest
SubmitTrainingJobResponse
TrainingJobLogEntry
TrainingJobMetadata
ModelType
TrainingStatus
motionApi
PlanState
CollisionSpecification
CollisionSpecification_AllowedFrameCollisions
ComponentState
Constraints
GetPlanRequest
GetPlanResponse
GetPoseRequest
GetPoseResponse
LinearConstraint
ListPlanStatusesRequest
ListPlanStatusesResponse
MotionConfiguration
MoveOnGlobeRequest
MoveOnGlobeResponse
MoveOnMapRequest
MoveOnMapResponse
MoveRequest
MoveResponse
ObstacleDetector
OrientationConstraint
Plan
PlanStatus
PlanStatusWithID
PlanStep
PlanWithStatus
StopPlanRequest
StopPlanResponse
motorApi
GetPositionRequest
GetPositionResponse
GetPropertiesRequest
GetPropertiesResponse
GoForRequest
GoForResponse
GoToRequest
GoToResponse
IsMovingRequest
IsMovingResponse
IsPoweredRequest
IsPoweredResponse
ResetZeroPositionRequest
ResetZeroPositionResponse
SetPowerRequest
SetPowerResponse
SetRPMRequest
SetRPMResponse
Status
StopRequest
StopResponse
movementSensorApi
GetAccuracyRequest
GetAccuracyResponse
GetAngularVelocityRequest
GetAngularVelocityResponse
GetCompassHeadingRequest
GetCompassHeadingResponse
GetLinearAccelerationRequest
GetLinearAccelerationResponse
GetLinearVelocityRequest
GetLinearVelocityResponse
GetOrientationRequest
GetOrientationResponse
GetPositionRequest
GetPositionResponse
GetPropertiesRequest
GetPropertiesResponse
navigationApi
MapType
Mode
AddWaypointRequest
AddWaypointResponse
GetLocationRequest
GetLocationResponse
GetModeRequest
GetModeResponse
GetObstaclesRequest
GetObstaclesResponse
GetPathsRequest
GetPathsResponse
GetPropertiesRequest
GetPropertiesResponse
GetWaypointsRequest
GetWaypointsResponse
Path
RemoveWaypointRequest
RemoveWaypointResponse
SetModeRequest
SetModeResponse
Waypoint
powerSensorApi
GetCurrentRequest
GetCurrentResponse
GetPowerRequest
GetPowerResponse
GetVoltageRequest
GetVoltageResponse
provisioningApi
GetNetworkListRequest
GetNetworkListResponse
GetSmartMachineStatusRequest
GetSmartMachineStatusResponse
NetworkInfo
ProvisioningInfo
SetNetworkCredentialsRequest
SetNetworkCredentialsResponse
SetSmartMachineCredentialsRequest
SetSmartMachineCredentialsResponse
CloudConfig
robotApi
GetMachineStatusResponse_State
PeerConnectionType
ResourceStatus_State
BlockForOperationRequest
BlockForOperationResponse
CancelOperationRequest
CancelOperationResponse
ConfigStatus
DiscoverComponentsRequest
DiscoverComponentsResponse
Discovery
DiscoveryQuery
FrameSystemConfig
FrameSystemConfigRequest
FrameSystemConfigResponse
GetCloudMetadataRequest
GetCloudMetadataResponse
GetMachineStatusRequest
GetMachineStatusResponse
GetModelsFromModulesRequest
GetModelsFromModulesResponse
GetOperationsRequest
GetOperationsResponse
GetSessionsRequest
GetSessionsResponse
GetStatusRequest
GetStatusResponse
GetVersionRequest
GetVersionResponse
LogRequest
LogResponse
ModuleModel
Operation
PeerConnectionInfo
ResourceNamesRequest
ResourceNamesResponse
ResourceRPCSubtype
ResourceRPCSubtypesRequest
ResourceRPCSubtypesResponse
ResourceStatus
RestartModuleRequest
RestartModuleResponse
SendSessionHeartbeatRequest
SendSessionHeartbeatResponse
Session
ShutdownRequest
ShutdownResponse
StartSessionRequest
StartSessionResponse
Status
StopAllRequest
StopAllResponse
StopExtraParameters
StreamStatusRequest
StreamStatusResponse
TransformPCDRequest
TransformPCDResponse
TransformPoseRequest
TransformPoseResponse
TunnelRequest
TunnelResponse
sensorApi
SensorService
servoApi
GetPositionRequest
GetPositionResponse
IsMovingRequest
IsMovingResponse
MoveRequest
MoveResponse
Status
StopRequest
StopResponse
slamApi
MappingMode
SensorType
GetInternalStateRequest
GetInternalStateResponse
GetPointCloudMapRequest
GetPointCloudMapResponse
GetPositionRequest
GetPositionResponse
GetPropertiesRequest
GetPropertiesResponse
SensorInfo
streamApi
AddStreamRequest
AddStreamResponse
GetStreamOptionsRequest
GetStreamOptionsResponse
ListStreamsRequest
ListStreamsResponse
RemoveStreamRequest
RemoveStreamResponse
Resolution
SetStreamOptionsRequest
SetStreamOptionsResponse
switchApi
GetNumberOfPositionsRequest
GetNumberOfPositionsResponse
GetPositionRequest
GetPositionResponse
SetPositionRequest
SetPositionResponse
visionApi
CaptureAllFromCameraRequest
CaptureAllFromCameraResponse
Classification
Detection
GetClassificationsFromCameraRequest
GetClassificationsFromCameraResponse
GetClassificationsRequest
GetClassificationsResponse
GetDetectionsFromCameraRequest
GetDetectionsFromCameraResponse
GetDetectionsRequest
GetDetectionsResponse
GetObjectPointCloudsRequest
GetObjectPointCloudsResponse
GetPropertiesRequest
GetPropertiesResponse