GitHub
Preparing search index...
The search index is not available
Viam SDK
Viam SDK
Index
Namespaces
app
Api
arm
Api
base
Api
billing
Api
board
Api
camera
Api
data
Api
encoder
Api
gantry
Api
generic
Component
Api
gripper
Api
input
Controller
Api
ml
Training
Api
motor
Api
movement
Sensor
Api
power
Sensor
Api
provisioning
Api
sensor
Api
servo
Api
stream
Api
Enumerations
Code
Machine
Connection
Event
Model
Type
Training
Status
Classes
App
Client
Billing
Client
BinaryID
Cloud
Config
Connect
Error
Connection
Closed
Error
Data
Client
Data
Manager
Client
Duration
Ml
Training
Client
Provisioning
Client
Struct
Timestamp
Viam
Client
Interfaces
Access
Token
Arm
Base
Board
Camera
Credential
Data
Manager
Dial
Direct
Conf
Dial
WebRTCConf
Encoder
Gantry
Generic
Component
Generic
Service
Gripper
Input
Controller
Motion
Motor
Movement
Sensor
Options
Power
Sensor
Resource
Robot
Sensor
Servo
Stream
Tick
Viam
Client
Options
Type Aliases
Analog
Value
Arm
Joint
Positions
Base
Properties
Capsule
Classification
Cloud
Metadata
Collision
Specification
Constraints
Credential
Type
Credentials
Detection
Dial
Conf
Encoder
Position
Type
Encoder
Properties
Filter
Options
Geo
Geometry
Geo
Point
Geometries
In
Frame
Geometry
Get
Plan
Response
Input
Controller
Event
Json
Value
Linear
Constraint
List
Plan
Statuses
Response
Mime
Type
Mode
Motion
Configuration
Movement
Sensor
Accuracy
Movement
Sensor
Position
Movement
Sensor
Properties
Navigation
Position
Navigation
Properties
Obstacle
Detector
Orientation
Orientation
Constraint
Path
Plain
Message
Plan
State
Point
Cloud
Object
Pose
Pose
In
Frame
Power
Mode
Rectangular
Prism
Resource
Name
Slam
Position
Slam
Properties
Sphere
Transform
Vector3
Waypoint
World
State
Variables
Analog
Value
Arm
Joint
Positions
Base
Properties
Capsule
Classification
Collision
Specification
Constraints
Detection
Encoder
Position
Type
Encoder
Properties
Geo
Geometry
Geo
Point
Geometries
In
Frame
Geometry
Get
Plan
Response
Input
Controller
Event
Linear
Constraint
List
Plan
Statuses
Response
Mode
Motion
Configuration
Movement
Sensor
Accuracy
Movement
Sensor
Position
Movement
Sensor
Properties
Navigation
Position
Navigation
Properties
Obstacle
Detector
Orientation
Orientation
Constraint
Path
Plan
State
Point
Cloud
Object
Pose
Pose
In
Frame
Power
Mode
Rectangular
Prism
Resource
Name
Slam
Position
Slam
Properties
Sphere
Transform
Vector3
Waypoint
World
State
version
Functions
add
Metadata
create
Robot
Client
create
Viam
Client
delete
Metadata
disable
Debug
Logging
do
Command
From
Client
enable
Debug
Logging
is
Valid
Geo
Point
Clients
Arm
Client
Base
Client
Board
Client
Camera
Client
Encoder
Client
Gantry
Client
Generic
Component
Client
Generic
Service
Client
Gripper
Client
Input
Controller
Client
Motion
Client
Motor
Client
Movement
Sensor
Client
Navigation
Client
Power
Sensor
Client
Robot
Client
Sensor
Client
Servo
Client
Slam
Client
Stream
Client
Vision
Client
Client
Raw Protobufs
common
Api
generic
Service
Api
motion
Api
navigation
Api
robot
Api
sensors
Api
slam
Api
vision
Api
Clients
Client
Renames and re-exports
RobotClient
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
Client
Viam SDK
addMetadata
createRobotClient
createViamClient
deleteMetadata
disableDebugLogging
doCommandFromClient
enableDebugLogging
isValidGeoPoint
Code
MachineConnectionEvent
ModelType
TrainingStatus
AppClient
ArmClient
BaseClient
BillingClient
BinaryID
BoardClient
CameraClient
CloudConfig
ConnectError
ConnectionClosedError
DataClient
DataManagerClient
Duration
EncoderClient
GantryClient
GenericComponentClient
GenericServiceClient
GripperClient
InputControllerClient
MlTrainingClient
MotionClient
MotorClient
MovementSensorClient
NavigationClient
PowerSensorClient
ProvisioningClient
RobotClient
SensorClient
ServoClient
SlamClient
StreamClient
Struct
Timestamp
ViamClient
VisionClient
AccessToken
Arm
Base
Board
Camera
Credential
DataManager
DialDirectConf
DialWebRTCConf
Encoder
Gantry
GenericComponent
GenericService
Gripper
InputController
Motion
Motor
MovementSensor
Options
PowerSensor
Resource
Robot
Sensor
Servo
Stream
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
FragmentErrorType
FragmentVisibility
RegistryItemStatus
SharedSecret_State
Visibility
APIKey
APIKeyWithAuthorizations
AddRoleRequest
AddRoleResponse
AuthenticatorInfo
Authorization
AuthorizationDetails
AuthorizedPermissions
BillingAddress
ChangeRoleRequest
ChangeRoleResponse
CheckPermissionsRequest
CheckPermissionsResponse
CreateFragmentRequest
CreateFragmentResponse
CreateKeyFromExistingKeyAuthorizationsRequest
CreateKeyFromExistingKeyAuthorizationsResponse
CreateKeyRequest
CreateKeyResponse
CreateLocationRequest
CreateLocationResponse
CreateLocationSecretRequest
CreateLocationSecretResponse
CreateModuleRequest
CreateModuleResponse
CreateOrganizationInviteRequest
CreateOrganizationInviteResponse
CreateOrganizationRequest
CreateOrganizationResponse
CreateRegistryItemRequest
CreateRegistryItemResponse
CreateRobotPartSecretRequest
CreateRobotPartSecretResponse
DeleteFragmentRequest
DeleteFragmentResponse
DeleteKeyRequest
DeleteKeyResponse
DeleteLocationRequest
DeleteLocationResponse
DeleteLocationSecretRequest
DeleteLocationSecretResponse
DeleteOrganizationInviteRequest
DeleteOrganizationInviteResponse
DeleteOrganizationMemberRequest
DeleteOrganizationMemberResponse
DeleteOrganizationRequest
DeleteOrganizationResponse
DeleteRegistryItemRequest
DeleteRegistryItemResponse
DeleteRobotPartRequest
DeleteRobotPartResponse
DeleteRobotPartSecretRequest
DeleteRobotPartSecretResponse
DeleteRobotRequest
DeleteRobotResponse
DisableBillingServiceRequest
DisableBillingServiceResponse
EnableBillingServiceRequest
EnableBillingServiceResponse
Fragment
FragmentError
FragmentHistoryEntry
GetBillingServiceConfigRequest
GetBillingServiceConfigResponse
GetFragmentHistoryRequest
GetFragmentHistoryResponse
GetFragmentRequest
GetFragmentResponse
GetLocationRequest
GetLocationResponse
GetModuleRequest
GetModuleResponse
GetOrganizationNamespaceAvailabilityRequest
GetOrganizationNamespaceAvailabilityResponse
GetOrganizationRequest
GetOrganizationResponse
GetOrganizationsWithAccessToLocationRequest
GetOrganizationsWithAccessToLocationResponse
GetRegistryItemRequest
GetRegistryItemResponse
GetRobotAPIKeysRequest
GetRobotAPIKeysResponse
GetRobotPartHistoryRequest
GetRobotPartHistoryResponse
GetRobotPartLogsRequest
GetRobotPartLogsResponse
GetRobotPartRequest
GetRobotPartResponse
GetRobotPartsRequest
GetRobotPartsResponse
GetRobotRequest
GetRobotResponse
GetRoverRentalRobotsRequest
GetRoverRentalRobotsResponse
GetUserIDByEmailRequest
GetUserIDByEmailResponse
ListAuthorizationsRequest
ListAuthorizationsResponse
ListFragmentsRequest
ListFragmentsResponse
ListKeysRequest
ListKeysResponse
ListLocationsRequest
ListLocationsResponse
ListMachineFragmentsRequest
ListMachineFragmentsResponse
ListModulesRequest
ListModulesResponse
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
OrgDetails
Organization
OrganizationGetSupportEmailRequest
OrganizationGetSupportEmailResponse
OrganizationIdentity
OrganizationInvite
OrganizationMember
OrganizationSetSupportEmailRequest
OrganizationSetSupportEmailResponse
RegistryItem
RemoveRoleRequest
RemoveRoleResponse
RenameKeyRequest
RenameKeyResponse
ResendOrganizationInviteRequest
ResendOrganizationInviteResponse
ResolvedFragment
Robot
RobotPart
RobotPartHistoryEntry
RotateKeyRequest
RotateKeyResponse
RoverRentalRobot
ShareLocationRequest
ShareLocationResponse
SharedSecret
StorageConfig
TailRobotPartLogsRequest
TailRobotPartLogsResponse
TransferRegistryItemRequest
TransferRegistryItemResponse
UnshareLocationRequest
UnshareLocationResponse
UpdateBillingServiceRequest
UpdateBillingServiceResponse
UpdateFragmentRequest
UpdateFragmentResponse
UpdateLocationRequest
UpdateLocationResponse
UpdateModuleRequest
UpdateModuleResponse
UpdateOrganizationInviteAuthorizationsRequest
UpdateOrganizationInviteAuthorizationsResponse
UpdateOrganizationRequest
UpdateOrganizationResponse
UpdateRegistryItemRequest
UpdateRegistryItemResponse
UpdateRobotPartRequest
UpdateRobotPartResponse
UpdateRobotRequest
UpdateRobotResponse
UploadModuleFileRequest
UploadModuleFileResponse
Uploads
VersionHistory
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
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
Filter
GetDatabaseConnectionRequest
GetDatabaseConnectionResponse
RemoveBinaryDataFromDatasetByIDsRequest
RemoveBinaryDataFromDatasetByIDsResponse
RemoveBoundingBoxFromImageByIDRequest
RemoveBoundingBoxFromImageByIDResponse
RemoveTagsFromBinaryDataByFilterRequest
RemoveTagsFromBinaryDataByFilterResponse
RemoveTagsFromBinaryDataByIDsRequest
RemoveTagsFromBinaryDataByIDsResponse
TabularData
TabularDataByFilterRequest
TabularDataByFilterResponse
TabularDataByMQLRequest
TabularDataByMQLResponse
TabularDataBySQLRequest
TabularDataBySQLResponse
TagsByFilterRequest
TagsByFilterResponse
TagsFilter
UpdateBoundingBoxRequest
UpdateBoundingBoxResponse
BinaryID
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
PeerConnectionType
ResourceStatus_State
BlockForOperationRequest
BlockForOperationResponse
CancelOperationRequest
CancelOperationResponse
ConfigStatus
DiscoverComponentsRequest
DiscoverComponentsResponse
Discovery
DiscoveryQuery
FrameSystemConfig
FrameSystemConfigRequest
FrameSystemConfigResponse
GetCloudMetadataRequest
GetCloudMetadataResponse
GetMachineStatusRequest
GetMachineStatusResponse
GetOperationsRequest
GetOperationsResponse
GetSessionsRequest
GetSessionsResponse
GetStatusRequest
GetStatusResponse
GetVersionRequest
GetVersionResponse
LogRequest
LogResponse
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
sensorApi
SensorService
sensorsApi
GetReadingsRequest
GetReadingsResponse
GetSensorsRequest
GetSensorsResponse
Readings
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
visionApi
CaptureAllFromCameraRequest
CaptureAllFromCameraResponse
Classification
Detection
GetClassificationsFromCameraRequest
GetClassificationsFromCameraResponse
GetClassificationsRequest
GetClassificationsResponse
GetDetectionsFromCameraRequest
GetDetectionsFromCameraResponse
GetDetectionsRequest
GetDetectionsResponse
GetObjectPointCloudsRequest
GetObjectPointCloudsResponse
GetPropertiesRequest
GetPropertiesResponse
Generated using
TypeDoc