viam.resource.base
Module Contents
Classes
The base requirements for a Resource. |
- class viam.resource.base.ResourceBase[source]
Bases:
Protocol
The base requirements for a Resource.
- SUBTYPE: ClassVar[viam.resource.types.Subtype]
The Subtype of the Resource
- name: str
The name of the Resource
- classmethod get_resource_name(name: str) viam.proto.common.ResourceName [source]
Get the ResourceName for this Resource with the given name
- Parameters:
name (str) – The name of the Resource
- classmethod from_robot(robot: viam.robot.client.RobotClient, name: str) typing_extensions.Self [source]
Get the Resource named
name
from the provided robot.- Parameters:
robot (RobotClient) – The robot
name (str) – The name of the Resource
- Returns:
The Resource, if it exists on the robot
- Return type:
Self
- abstract async do_command(command: Mapping[str, viam.utils.ValueTypes], *, timeout: Optional[float] = None, **kwargs) Mapping[str, viam.utils.ValueTypes] [source]
Send/Receive arbitrary commands to the Resource
- Parameters:
command (Mapping[str, ValueTypes]) – The command to execute
- Raises:
NotImplementedError – Raised if the Resource does not support arbitrary commands
- Returns:
Result of the executed command
- Return type:
Mapping[str, ValueTypes]
- get_operation(kwargs: Mapping[str, Any]) viam.operations.Operation [source]
Get the
Operation
associated with the currently running function.When writing custom resources, you should get the
Operation
by calling this function and check to see if it’s cancelled. If theOperation
is cancelled, then you can perform any necessary (terminating long running tasks, cleaning up connections, etc. ).- Parameters:
kwargs (Mapping[str, Any]) – The kwargs object containing the operation
- Returns:
The operation associated with this function
- Return type: