viam.gen.component.board.v1.board_pb2

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

Classes

`PowerMode`	Power Management API
`Status`	Abstract base class for protocol messages.
`SetGPIORequest`	Abstract base class for protocol messages.
`SetGPIOResponse`	Abstract base class for protocol messages.
`GetGPIORequest`	Abstract base class for protocol messages.
`GetGPIOResponse`	Abstract base class for protocol messages.
`PWMRequest`	Abstract base class for protocol messages.
`PWMResponse`	Abstract base class for protocol messages.
`SetPWMRequest`	Abstract base class for protocol messages.
`SetPWMResponse`	Abstract base class for protocol messages.
`PWMFrequencyRequest`	Abstract base class for protocol messages.
`PWMFrequencyResponse`	Abstract base class for protocol messages.
`SetPWMFrequencyRequest`	Abstract base class for protocol messages.
`SetPWMFrequencyResponse`	Abstract base class for protocol messages.
`ReadAnalogReaderRequest`	Analog Reader
`ReadAnalogReaderResponse`	Abstract base class for protocol messages.
`WriteAnalogRequest`	Analog Writer
`WriteAnalogResponse`	Abstract base class for protocol messages.
`GetDigitalInterruptValueRequest`	Digital Interrupt
`GetDigitalInterruptValueResponse`	Abstract base class for protocol messages.
`StreamTicksRequest`	Abstract base class for protocol messages.
`StreamTicksResponse`	Abstract base class for protocol messages.
`SetPowerModeRequest`	Abstract base class for protocol messages.
`SetPowerModeResponse`	Abstract base class for protocol messages.

Module Contents

viam.gen.component.board.v1.board_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.board.v1.board_pb2.PowerMode

Bases: _PowerMode

Power Management API

viam.gen.component.board.v1.board_pb2.POWER_MODE_UNSPECIFIED: PowerMode

viam.gen.component.board.v1.board_pb2.POWER_MODE_NORMAL: PowerMode

viam.gen.component.board.v1.board_pb2.POWER_MODE_OFFLINE_DEEP: PowerMode

type viam.gen.component.board.v1.board_pb2.Global___PowerMode = PowerMode

class viam.gen.component.board.v1.board_pb2.Status(*, analogs: collections.abc.Mapping[str, int] | None = ..., digital_interrupts: collections.abc.Mapping[str, int] | 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.

class AnalogsEntry(*, key: str = ..., value: int = ...)

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.

key: str

value: int

class DigitalInterruptsEntry(*, key: str = ..., value: int = ...)

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.

key: str

value: int

analogs() → google.protobuf.internal.containers.ScalarMap[str, int]

digital_interrupts() → google.protobuf.internal.containers.ScalarMap[str, int]

type viam.gen.component.board.v1.board_pb2.Global___Status = Status

class viam.gen.component.board.v1.board_pb2.SetGPIORequest(*, name: str = ..., pin: str = ..., high: bool = ..., 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.

name: str

pin: str

high: bool

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___SetGPIORequest = SetGPIORequest

class viam.gen.component.board.v1.board_pb2.SetGPIOResponse

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.

type viam.gen.component.board.v1.board_pb2.Global___SetGPIOResponse = SetGPIOResponse

class viam.gen.component.board.v1.board_pb2.GetGPIORequest(*, name: str = ..., pin: 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.

name: str

pin: str

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___GetGPIORequest = GetGPIORequest

class viam.gen.component.board.v1.board_pb2.GetGPIOResponse(*, high: 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.

high: bool

type viam.gen.component.board.v1.board_pb2.Global___GetGPIOResponse = GetGPIOResponse

class viam.gen.component.board.v1.board_pb2.PWMRequest(*, name: str = ..., pin: 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.

name: str

pin: str

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___PWMRequest = PWMRequest

class viam.gen.component.board.v1.board_pb2.PWMResponse(*, duty_cycle_pct: 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.

duty_cycle_pct: float: 0-1

type viam.gen.component.board.v1.board_pb2.Global___PWMResponse = PWMResponse

class viam.gen.component.board.v1.board_pb2.SetPWMRequest(*, name: str = ..., pin: str = ..., duty_cycle_pct: float = ..., 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.

name: str

pin: str

duty_cycle_pct: float: 0-1

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___SetPWMRequest = SetPWMRequest

class viam.gen.component.board.v1.board_pb2.SetPWMResponse

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.

type viam.gen.component.board.v1.board_pb2.Global___SetPWMResponse = SetPWMResponse

class viam.gen.component.board.v1.board_pb2.PWMFrequencyRequest(*, name: str = ..., pin: 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.

name: str

pin: str

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___PWMFrequencyRequest = PWMFrequencyRequest

class viam.gen.component.board.v1.board_pb2.PWMFrequencyResponse(*, frequency_hz: int = ...)

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.

frequency_hz: int

type viam.gen.component.board.v1.board_pb2.Global___PWMFrequencyResponse = PWMFrequencyResponse

class viam.gen.component.board.v1.board_pb2.SetPWMFrequencyRequest(*, name: str = ..., pin: str = ..., frequency_hz: int = ..., 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.

name: str

pin: str

frequency_hz: int

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___SetPWMFrequencyRequest = SetPWMFrequencyRequest

class viam.gen.component.board.v1.board_pb2.SetPWMFrequencyResponse

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.

type viam.gen.component.board.v1.board_pb2.Global___SetPWMFrequencyResponse = SetPWMFrequencyResponse

class viam.gen.component.board.v1.board_pb2.ReadAnalogReaderRequest(*, board_name: str = ..., analog_reader_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Analog Reader

board_name: str

analog_reader_name: str

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___ReadAnalogReaderRequest = ReadAnalogReaderRequest

class viam.gen.component.board.v1.board_pb2.ReadAnalogReaderResponse(*, value: int = ..., min_range: float = ..., max_range: float = ..., step_size: 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.

value: int

min_range: float

max_range: float

step_size: float

type viam.gen.component.board.v1.board_pb2.Global___ReadAnalogReaderResponse = ReadAnalogReaderResponse

class viam.gen.component.board.v1.board_pb2.WriteAnalogRequest(*, name: str = ..., pin: str = ..., value: int = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Analog Writer

name: str

pin: str

value: int

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___WriteAnalogRequest = WriteAnalogRequest

class viam.gen.component.board.v1.board_pb2.WriteAnalogResponse

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.

type viam.gen.component.board.v1.board_pb2.Global___WriteAnalogResponse = WriteAnalogResponse

class viam.gen.component.board.v1.board_pb2.GetDigitalInterruptValueRequest(*, board_name: str = ..., digital_interrupt_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Digital Interrupt

board_name: str

digital_interrupt_name: str

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___GetDigitalInterruptValueRequest = GetDigitalInterruptValueRequest

class viam.gen.component.board.v1.board_pb2.GetDigitalInterruptValueResponse(*, value: int = ...)

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.

value: int

type viam.gen.component.board.v1.board_pb2.Global___GetDigitalInterruptValueResponse = GetDigitalInterruptValueResponse

class viam.gen.component.board.v1.board_pb2.StreamTicksRequest(*, name: str = ..., pin_names: collections.abc.Iterable[str] | None = ..., 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.

name: str: Board name

pin_names() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: Name of digital interrupts to recieve ticks from

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.board.v1.board_pb2.Global___StreamTicksRequest = StreamTicksRequest

class viam.gen.component.board.v1.board_pb2.StreamTicksResponse(*, pin_name: str = ..., time: int = ..., high: 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.

pin_name: str: name of interrupt

time: int: Time in nanoseconds of a tick

high: bool: Value high or low of the tick

type viam.gen.component.board.v1.board_pb2.Global___StreamTicksResponse = StreamTicksResponse

class viam.gen.component.board.v1.board_pb2.SetPowerModeRequest(*, name: str = ..., power_mode: Global___PowerMode = ..., duration: google.protobuf.duration_pb2.Duration | None = ..., 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.

name: str: name of board

power_mode: Global___PowerMode: Requested power mode

duration() → google.protobuf.duration_pb2.Duration: Requested duration to stay in power_mode

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

WhichOneof(oneof_group: _WhichOneofArgType__duration) → _WhichOneofReturnType__duration | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

type viam.gen.component.board.v1.board_pb2.Global___SetPowerModeRequest = SetPowerModeRequest

class viam.gen.component.board.v1.board_pb2.SetPowerModeResponse

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.

type viam.gen.component.board.v1.board_pb2.Global___SetPowerModeResponse = SetPowerModeResponse

`DESCRIPTOR`
`POWER_MODE_UNSPECIFIED`
`POWER_MODE_NORMAL`
`POWER_MODE_OFFLINE_DEEP`
`Global___PowerMode`
`Global___Status`
`Global___SetGPIORequest`
`Global___SetGPIOResponse`
`Global___GetGPIORequest`
`Global___GetGPIOResponse`
`Global___PWMRequest`
`Global___PWMResponse`
`Global___SetPWMRequest`
`Global___SetPWMResponse`
`Global___PWMFrequencyRequest`
`Global___PWMFrequencyResponse`
`Global___SetPWMFrequencyRequest`
`Global___SetPWMFrequencyResponse`
`Global___ReadAnalogReaderRequest`
`Global___ReadAnalogReaderResponse`
`Global___WriteAnalogRequest`
`Global___WriteAnalogResponse`
`Global___GetDigitalInterruptValueRequest`
`Global___GetDigitalInterruptValueResponse`
`Global___StreamTicksRequest`
`Global___StreamTicksResponse`
`Global___SetPowerModeRequest`
`Global___SetPowerModeResponse`

viam.gen.component.board.v1.board_pb2

Attributes

Classes

Module Contents