viam_sdk library Viam SDK

Robots at your fingertips.

Classes

AppRobotClient Viam SDK
gRPC client for connecting to app's RobotService.
Arm Components
Arm represents a physical robot arm that exists in three-dimensional space.
ArmClient Components
gRPC client for an Arm component.
AuthenticatedChannel Viam SDK
A channel that attaches an access token to gRPC metadata for every call
Base Components
Base represents a physical base of a robot.
BaseClient Components
gRPC client for the Base component.
Board Components
Board represents a physical general purpose compute board that contains various components such as analog readers, and digital interrupts.
BoardClient Components
gRPC client for the Board component.
Camera Components
Camera represents any physical hardware that can capture frames.
CameraClient Components
gRPC client for the Camera component
CloudConfig
minimal CloudConfig to create /etc/viam.json
Credentials Viam SDK
The credentials used for connecting to the robot
DialOptions Viam SDK
Describes the behavior for connecting to a robot
DialWebRtcOptions Viam SDK
Options specific for connecting over WebRTC
Discovery Viam SDK
Represents the result of a discovery query.
DiscoveryQuery Viam SDK
Represents a discovery query in the SDK to query for discoverable components.
DoCommandRequest
DoCommandRequest represents a generic DoCommand input
DoCommandResponse
DoCommandResponse represents a generic DoCommand output
Gantry Components
Gantry represents a physical Gantry and can be used for controlling gantries of N axes.
GantryClient Components
gRPC client for the Gantry component.
Generic Components
Generic represents a generic component that executes doCommand.
GenericClient Components
gRPC client for the Generic component.
GeoPoint
GetNetworkListRequest
GetNetworkListResponse
GetSmartMachineStatusRequest
GetSmartMachineStatusResponse
Gripper Components
Gripper represents a physical Gripper which can open and close.
GripperClient Components
gRPC client for the Gripper component.
MimeType Viam SDK
Mime types supported by Viam
Motor Components
Motor represents a physical motor.
MotorClient Components
gRPC client for the Motor component.
MovementSensor Components
MovementSensor reports information about the robot's direction, position and speed.
MovementSensorClient Components
gRPC client for the MovementSensor component.
NetworkInfo
Orientation
Pose
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.
PoseInFrame
PoseInFrame contains a pose and the and the reference frame in which it was observed
Position Viam SDK
PowerSensor Components
PowerSensor reports information about voltage, current, and power.
PowerSensorClient Components
gRPC client for the PowerSensor component.
PowerState Viam SDK
ProvisioningClient Viam SDK
gRPC client for connecting to Viam's Provisioning Service
ProvisioningInfo
Registry Viam SDK
The global registry of robot resources.
Resource Viam SDK
Abstract class that defines the base functionality for all Resource types
ResourceName
ResourceRegistration<T extends Resource> Viam SDK
An object representing a resource to be registered.
ResourceRPCClient<T extends Client> Viam SDK
Abstract class that defines the base functionality for all RPC clients for resources
RobotClient Viam SDK
gRPC client for a Robot. This class should be used for all interactions with a robot.
RobotClientOptions Viam SDK
The options that define the behavior of the RobotClient.
Sensor Components
Sensor represents a physical sensing device that can provide measurement readings.
SensorClient Components
gRPC client for the Sensor component.
Servo Components
Servo represents a physical servo.
ServoClient Components
gRPC client for the Servo component.
SetNetworkCredentialsRequest
SetNetworkCredentialsResponse
SetSmartMachineCredentialsRequest
SetSmartMachineCredentialsResponse
StreamClient Viam SDK
A client to manage a camera's WebRTC stream.
Subtype Viam SDK
Subtype defines a triplet of strings that correspond to a resource's specific API definition.
Vector3
Viam Viam SDK
An object to interact with the Viam app
ViamAuthorization Viam SDK
ViamImage Viam SDK
A custom image type that contains the MimeTYpe, raw image data, and lazily loads and caches an img.Image.
VisionClient Services

Enums

AuthorizationId Viam SDK
IdentityType Viam SDK
NetworkType Viam SDK
Permission Viam SDK
ResourceType Viam SDK

Extensions

FilterUtils on Filter Viam SDK

Constants

resourceNamespaceRDK → const String Viam SDK
{@category Viam SDK} The standard namespace for Viam resources (rdk)
resourceTypeComponent → const String Viam SDK
{@category Viam SDK} The standard type for component resources (component)
resourceTypeService → const String Viam SDK
{@category Viam SDK} The standard type for service resources (service)

Functions

dial(String address, DialOptions? options, String sessionCallback()) → Future<ClientChannelBase> Viam SDK
Connect to a robot at the provided address with the given options

Typedefs

Accuracy = GetAccuracyResponse Viam SDK
AnalogValue = ReadAnalogReaderResponse Viam SDK
BaseProperties = GetPropertiesResponse Viam SDK
CameraProperties = GetPropertiesResponse Viam SDK
The camera's supported features and settings
CloudMetadata = GetCloudMetadataResponse Viam SDK
Current = GetCurrentResponse Viam SDK
DatabaseConnection = GetDatabaseConnectionResponse Viam SDK
MotorProperties = GetPropertiesResponse Viam SDK
Properties = GetPropertiesResponse Viam SDK
Tick = StreamTicksResponse Viam SDK
Tick of a digital interrupt
VisionProperties = GetPropertiesResponse Viam SDK
The vision service's supported features and settings
Voltage = GetVoltageResponse Viam SDK