viam.components.power_sensor

Submodules

• viam.components.power_sensor.client
• viam.components.power_sensor.power_sensor
• viam.components.power_sensor.service

Classes

PowerSensor

PowerSensor reports information about voltage, current and power.

Package Contents

class viam.components.power_sensor.PowerSensor(name: str, *, logger: logging.Logger | None = None)

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

For more information, see Power Sensor component.

API: Final

The API of the Resource

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

Async:

Return the voltage reading of a specified device and whether it is AC or DC.

my_power_sensor = PowerSensor.from_robot(robot=machine, 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:

A float representing the voltage reading in V. A bool indicating whether the voltage is AC (true) or DC (false).

Return type:

Tuple[float, bool]

For more information, see Power Sensor component.

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

Async:

Return the current of a specified device and whether it is AC or DC.

my_power_sensor = PowerSensor.from_robot(robot=machine, 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:

A tuple which includes a float representing the current reading in amps, and a bool indicating whether the current is AC (true) or DC (false).

Return type:

Tuple[float, bool]

For more information, see Power Sensor component.

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

Async:

Return the power reading in watts.

my_power_sensor = PowerSensor.from_robot(robot=machine, 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:

The power reading in watts.

Return type:

float

For more information, see Power Sensor component.

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

Get the measurements or readings that this power sensor provides. If a sensor is not configured correctly or fails to read a piece of data, it will not appear in the readings dictionary.

my_power_sensor = PowerSensor.from_robot(robot=machine, 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]

For more information, see Power Sensor component.

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 do_command(command: Mapping[str, ValueTypes], *, timeout: float | None = None, **kwargs) → Mapping[str, ValueTypes]

Async:

Send/Receive arbitrary commands to the Resource

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