viam.gen.component.board.v1.board_pb2
@generated by mypy-protobuf. Do not edit manually! isort:skip_file
Module Contents
Classes
Power Management API |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Analog Reader |
|
Abstract base class for protocol messages. |
|
Analog Writer |
|
Abstract base class for protocol messages. |
|
Digital Interrupt |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
Attributes
- 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.global___PowerMode
- class viam.gen.component.board.v1.board_pb2.Status(*, analogs: collections.abc.Mapping[str, viam.gen.common.v1.common_pb2.AnalogStatus] | None = ..., digital_interrupts: collections.abc.Mapping[str, viam.gen.common.v1.common_pb2.DigitalInterruptStatus] | 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: viam.gen.common.v1.common_pb2.AnalogStatus | 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 value: viam.gen.common.v1.common_pb2.AnalogStatus
- key: str
- HasField(field_name: Literal[value, b'value']) 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.
- class DigitalInterruptsEntry(*, key: str = ..., value: viam.gen.common.v1.common_pb2.DigitalInterruptStatus | 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 value: viam.gen.common.v1.common_pb2.DigitalInterruptStatus
- key: str
- HasField(field_name: Literal[value, b'value']) 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.
- property analogs: google.protobuf.internal.containers.MessageMap[str, viam.gen.common.v1.common_pb2.AnalogStatus]
- property digital_interrupts: google.protobuf.internal.containers.MessageMap[str, viam.gen.common.v1.common_pb2.DigitalInterruptStatus]
- viam.gen.component.board.v1.board_pb2.global___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.
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
- pin: str
- high: bool
- 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.board.v1.board_pb2.global___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.
- viam.gen.component.board.v1.board_pb2.global___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.
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
- pin: str
- 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.board.v1.board_pb2.global___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
- viam.gen.component.board.v1.board_pb2.global___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.
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
- pin: str
- 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.board.v1.board_pb2.global___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
- viam.gen.component.board.v1.board_pb2.global___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.
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
- pin: str
- duty_cycle_pct: float
0-1
- 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.board.v1.board_pb2.global___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.
- viam.gen.component.board.v1.board_pb2.global___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.
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
- pin: str
- 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.board.v1.board_pb2.global___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
- viam.gen.component.board.v1.board_pb2.global___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.
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
- pin: str
- frequency_hz: int
- 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.board.v1.board_pb2.global___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.
- viam.gen.component.board.v1.board_pb2.global___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
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- board_name: str
- analog_reader_name: str
- 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.board.v1.board_pb2.global___ReadAnalogReaderRequest
- class viam.gen.component.board.v1.board_pb2.ReadAnalogReaderResponse(*, 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
- viam.gen.component.board.v1.board_pb2.global___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
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
- pin: str
- value: int
- 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.board.v1.board_pb2.global___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.
- viam.gen.component.board.v1.board_pb2.global___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
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- board_name: str
- digital_interrupt_name: str
- 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.board.v1.board_pb2.global___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
- viam.gen.component.board.v1.board_pb2.global___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.
- property pin_names: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
Name of digital interrupts to recieve ticks from
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
Board name
- 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.board.v1.board_pb2.global___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
- viam.gen.component.board.v1.board_pb2.global___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.
- property duration: google.protobuf.duration_pb2.Duration
Requested duration to stay in power_mode
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- name: str
name of board
- power_mode: global___PowerMode
Requested power mode
- HasField(field_name: Literal[_duration, b'_duration', duration, b'duration', 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.
- WhichOneof(oneof_group: Literal[_duration, b'_duration']) Literal[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
- viam.gen.component.board.v1.board_pb2.global___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.
- viam.gen.component.board.v1.board_pb2.global___SetPowerModeResponse