viam.gen.component.powersensor.v1.powersensor_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Module Contents

Classes

GetVoltageRequest	Abstract base class for protocol messages.
GetVoltageResponse	Abstract base class for protocol messages.
GetCurrentRequest	Abstract base class for protocol messages.
GetCurrentResponse	Abstract base class for protocol messages.
GetPowerRequest	Abstract base class for protocol messages.
GetPowerResponse	Abstract base class for protocol messages.

Attributes

DESCRIPTOR
global___GetVoltageRequest
global___GetVoltageResponse
global___GetCurrentRequest
global___GetCurrentResponse
global___GetPowerRequest
global___GetPowerResponse

viam.gen.component.powersensor.v1.powersensor_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.powersensor.v1.powersensor_pb2.GetVoltageRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a power sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.component.powersensor.v1.powersensor_pb2.global___GetVoltageRequest

class viam.gen.component.powersensor.v1.powersensor_pb2.GetVoltageResponse(*, volts: float = ..., is_ac: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

volts: float

Voltage in volts

is_ac: bool

Bool describing whether the voltage is DC or AC

viam.gen.component.powersensor.v1.powersensor_pb2.global___GetVoltageResponse

class viam.gen.component.powersensor.v1.powersensor_pb2.GetCurrentRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a power sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.component.powersensor.v1.powersensor_pb2.global___GetCurrentRequest

class viam.gen.component.powersensor.v1.powersensor_pb2.GetCurrentResponse(*, amperes: float = ..., is_ac: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

amperes: float

Current in amperes

is_ac: bool

Bool descibing whether the current is DC or AC

viam.gen.component.powersensor.v1.powersensor_pb2.global___GetCurrentResponse

class viam.gen.component.powersensor.v1.powersensor_pb2.GetPowerRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a power sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.component.powersensor.v1.powersensor_pb2.global___GetPowerRequest

class viam.gen.component.powersensor.v1.powersensor_pb2.GetPowerResponse(*, watts: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

watts: float

Power in watts

viam.gen.component.powersensor.v1.powersensor_pb2.global___GetPowerResponse