viam.components.power_sensor

Submodules

Package Contents

Classes

PowerSensor

PowerSensor reports information about voltage, current and power.
class viam.components.power_sensor.PowerSensor(name: str)[source]

Bases: viam.components.component_base.ComponentBase

PowerSensor reports information about voltage, current and power.

This acts as an abstract base class for any sensors that can provide data regarding voltage, current and/or power. This cannot be used on its own. If the __init__() function is overridden, it must call the super().__init__() function.

from viam.components.power_sensor import PowerSensor
SUBTYPE: Final
abstract async get_voltage(*, extra: Dict[str, Any] | None = None, timeout: float | None = None, **kwargs) → Tuple[float, bool][source]

Get the voltage reading and bool IsAC

my_power_sensor = PowerSensor.from_robot(robot=robot, name='my_power_sensor')

# Get the voltage reading from the power sensor
voltage, is_ac = await my_power_sensor.get_voltage()
print("The voltage is", voltage, "V, Is AC:", is_ac)
Returns:

voltage (volts) and bool IsAC

Return type:

Tuple[float, bool]

abstract async get_current(*, extra: Dict[str, Any] | None = None, timeout: float | None = None, **kwargs) → Tuple[float, bool][source]

Get the current reading and bool IsAC

my_power_sensor = PowerSensor.from_robot(robot=robot, name='my_power_sensor')

# Get the current reading from the power sensor
current, is_ac = await my_power_sensor.get_current()
print("The current is ", current, " A, Is AC: ", is_ac)
Returns:

current (amperes) and bool IsAC

Return type:

Tuple[float, bool]

abstract async get_power(*, extra: Dict[str, Any] | None = None, timeout: float | None = None, **kwargs) → float[source]

Get the power reading in watts

my_power_sensor = PowerSensor.from_robot(robot=robot, name='my_power_sensor')

# Get the power reading from the power sensor
power = await my_power_sensor.get_power()
print("The power is", power, "Watts")
Returns:

power in watts

Return type:

float

async get_readings(*, extra: Dict[str, Any] | None = None, timeout: float | None = None, **kwargs) → Mapping[str, viam.utils.SensorReading][source]

Obtain the measurements/data specific to this sensor. If a sensor is not configured to have a measurement or fails to read a piece of data, it will not appear in the readings dictionary.

my_power_sensor = PowerSensor.from_robot(robot=robot, name='my_power_sensor')

# Get the readings provided by the sensor.
readings = await my_power_sensor.get_readings()
Returns:

The readings for the PowerSensor. Can be of any type. Includes voltage in volts (float), current in

amperes (float), is_ac (bool), and power in watts (float).

Return type:

Mapping[str, Any]

classmethod from_robot(robot: viam.robot.client.RobotClient, name: str) → typing_extensions.Self

Get the component named name from the provided robot.

Parameters:

  • robot (RobotClient) – The robot

  • name (str) – The name of the component

Returns:

The component, if it exists on the robot

Return type:

Self

abstract async do_command(command: Mapping[str, ValueTypes], *, timeout: float | None = None, **kwargs) → Mapping[str, ValueTypes]

Send/Receive arbitrary commands to the Resource

command = {"cmd": "test", "data1": 500}
result = component.do(command)
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]

async get_geometries(*, extra: Dict[str, Any] | None = None, timeout: float | None = None) → List[viam.proto.common.Geometry]

Get all geometries associated with the Component, in their current configuration, in the frame of the Component.

geometries = await component.get_geometries()

if geometries:
    # Get the center of the first geometry
    print(f"Pose of the first geometry's centerpoint: {geometries[0].center}")
Returns:

The geometries associated with the Component.

Return type:

List[Geometry]

classmethod get_resource_name(name: str) → viam.proto.common.ResourceName

Get the ResourceName for this Resource with the given name

# Can be used with any resource, using an arm as an example
my_arm_name = my_arm.get_resource_name("my_arm")
Parameters:

name (str) – The name of the Resource

Returns:

The ResourceName of this Resource

Return type:

ResourceName

get_operation(kwargs: Mapping[str, Any]) → viam.operations.Operation

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 the Operation 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:

viam.operations.Operation

async close()

Safely shut down the resource and prevent further use.

Close must be idempotent. Later configuration may allow a resource to be “open” again. If a resource does not want or need a close function, it is assumed that the resource does not need to return errors when future non-Close methods are called.

await component.close()