viam.gen.component.board.v1.board_pb2 ===================================== .. py:module:: viam.gen.component.board.v1.board_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Attributes ---------- .. autoapisummary:: viam.gen.component.board.v1.board_pb2.DESCRIPTOR viam.gen.component.board.v1.board_pb2.POWER_MODE_UNSPECIFIED viam.gen.component.board.v1.board_pb2.POWER_MODE_NORMAL viam.gen.component.board.v1.board_pb2.POWER_MODE_OFFLINE_DEEP viam.gen.component.board.v1.board_pb2.Global___PowerMode viam.gen.component.board.v1.board_pb2.Global___Status viam.gen.component.board.v1.board_pb2.Global___SetGPIORequest viam.gen.component.board.v1.board_pb2.Global___SetGPIOResponse viam.gen.component.board.v1.board_pb2.Global___GetGPIORequest viam.gen.component.board.v1.board_pb2.Global___GetGPIOResponse viam.gen.component.board.v1.board_pb2.Global___PWMRequest viam.gen.component.board.v1.board_pb2.Global___PWMResponse viam.gen.component.board.v1.board_pb2.Global___SetPWMRequest viam.gen.component.board.v1.board_pb2.Global___SetPWMResponse viam.gen.component.board.v1.board_pb2.Global___PWMFrequencyRequest viam.gen.component.board.v1.board_pb2.Global___PWMFrequencyResponse viam.gen.component.board.v1.board_pb2.Global___SetPWMFrequencyRequest viam.gen.component.board.v1.board_pb2.Global___SetPWMFrequencyResponse viam.gen.component.board.v1.board_pb2.Global___ReadAnalogReaderRequest viam.gen.component.board.v1.board_pb2.Global___ReadAnalogReaderResponse viam.gen.component.board.v1.board_pb2.Global___WriteAnalogRequest viam.gen.component.board.v1.board_pb2.Global___WriteAnalogResponse viam.gen.component.board.v1.board_pb2.Global___GetDigitalInterruptValueRequest viam.gen.component.board.v1.board_pb2.Global___GetDigitalInterruptValueResponse viam.gen.component.board.v1.board_pb2.Global___StreamTicksRequest viam.gen.component.board.v1.board_pb2.Global___StreamTicksResponse viam.gen.component.board.v1.board_pb2.Global___SetPowerModeRequest viam.gen.component.board.v1.board_pb2.Global___SetPowerModeResponse Classes ------- .. autoapisummary:: viam.gen.component.board.v1.board_pb2.PowerMode viam.gen.component.board.v1.board_pb2.Status viam.gen.component.board.v1.board_pb2.SetGPIORequest viam.gen.component.board.v1.board_pb2.SetGPIOResponse viam.gen.component.board.v1.board_pb2.GetGPIORequest viam.gen.component.board.v1.board_pb2.GetGPIOResponse viam.gen.component.board.v1.board_pb2.PWMRequest viam.gen.component.board.v1.board_pb2.PWMResponse viam.gen.component.board.v1.board_pb2.SetPWMRequest viam.gen.component.board.v1.board_pb2.SetPWMResponse viam.gen.component.board.v1.board_pb2.PWMFrequencyRequest viam.gen.component.board.v1.board_pb2.PWMFrequencyResponse viam.gen.component.board.v1.board_pb2.SetPWMFrequencyRequest viam.gen.component.board.v1.board_pb2.SetPWMFrequencyResponse viam.gen.component.board.v1.board_pb2.ReadAnalogReaderRequest viam.gen.component.board.v1.board_pb2.ReadAnalogReaderResponse viam.gen.component.board.v1.board_pb2.WriteAnalogRequest viam.gen.component.board.v1.board_pb2.WriteAnalogResponse viam.gen.component.board.v1.board_pb2.GetDigitalInterruptValueRequest viam.gen.component.board.v1.board_pb2.GetDigitalInterruptValueResponse viam.gen.component.board.v1.board_pb2.StreamTicksRequest viam.gen.component.board.v1.board_pb2.StreamTicksResponse viam.gen.component.board.v1.board_pb2.SetPowerModeRequest viam.gen.component.board.v1.board_pb2.SetPowerModeResponse Module Contents --------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: PowerMode Bases: :py:obj:`_PowerMode` Power Management API .. py:data:: POWER_MODE_UNSPECIFIED :type: PowerMode .. py:data:: POWER_MODE_NORMAL :type: PowerMode .. py:data:: POWER_MODE_OFFLINE_DEEP :type: PowerMode .. py:type:: Global___PowerMode :canonical: PowerMode .. py:class:: Status(*, analogs: collections.abc.Mapping[str, int] | None = ..., digital_interrupts: collections.abc.Mapping[str, int] | None = ...) Bases: :py:obj:`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. .. py:class:: AnalogsEntry(*, key: str = ..., value: int = ...) Bases: :py:obj:`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. .. py:attribute:: key :type: str .. py:attribute:: value :type: int .. py:class:: DigitalInterruptsEntry(*, key: str = ..., value: int = ...) Bases: :py:obj:`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. .. py:attribute:: key :type: str .. py:attribute:: value :type: int .. py:method:: analogs() -> google.protobuf.internal.containers.ScalarMap[str, int] .. py:method:: digital_interrupts() -> google.protobuf.internal.containers.ScalarMap[str, int] .. py:type:: Global___Status :canonical: Status .. py:class:: SetGPIORequest(*, name: str = ..., pin: str = ..., high: bool = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str .. py:attribute:: pin :type: str .. py:attribute:: high :type: bool .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___SetGPIORequest :canonical: SetGPIORequest .. py:class:: SetGPIOResponse Bases: :py:obj:`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. .. py:type:: Global___SetGPIOResponse :canonical: SetGPIOResponse .. py:class:: GetGPIORequest(*, name: str = ..., pin: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str .. py:attribute:: pin :type: str .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___GetGPIORequest :canonical: GetGPIORequest .. py:class:: GetGPIOResponse(*, high: bool = ...) Bases: :py:obj:`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. .. py:attribute:: high :type: bool .. py:type:: Global___GetGPIOResponse :canonical: GetGPIOResponse .. py:class:: PWMRequest(*, name: str = ..., pin: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str .. py:attribute:: pin :type: str .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___PWMRequest :canonical: PWMRequest .. py:class:: PWMResponse(*, duty_cycle_pct: float = ...) Bases: :py:obj:`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. .. py:attribute:: duty_cycle_pct :type: float 0-1 .. py:type:: Global___PWMResponse :canonical: PWMResponse .. py:class:: SetPWMRequest(*, name: str = ..., pin: str = ..., duty_cycle_pct: float = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str .. py:attribute:: pin :type: str .. py:attribute:: duty_cycle_pct :type: float 0-1 .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___SetPWMRequest :canonical: SetPWMRequest .. py:class:: SetPWMResponse Bases: :py:obj:`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. .. py:type:: Global___SetPWMResponse :canonical: SetPWMResponse .. py:class:: PWMFrequencyRequest(*, name: str = ..., pin: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str .. py:attribute:: pin :type: str .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___PWMFrequencyRequest :canonical: PWMFrequencyRequest .. py:class:: PWMFrequencyResponse(*, frequency_hz: int = ...) Bases: :py:obj:`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. .. py:attribute:: frequency_hz :type: int .. py:type:: Global___PWMFrequencyResponse :canonical: PWMFrequencyResponse .. py:class:: SetPWMFrequencyRequest(*, name: str = ..., pin: str = ..., frequency_hz: int = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str .. py:attribute:: pin :type: str .. py:attribute:: frequency_hz :type: int .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___SetPWMFrequencyRequest :canonical: SetPWMFrequencyRequest .. py:class:: SetPWMFrequencyResponse Bases: :py:obj:`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. .. py:type:: Global___SetPWMFrequencyResponse :canonical: SetPWMFrequencyResponse .. py:class:: ReadAnalogReaderRequest(*, board_name: str = ..., analog_reader_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Analog Reader .. py:attribute:: board_name :type: str .. py:attribute:: analog_reader_name :type: str .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___ReadAnalogReaderRequest :canonical: ReadAnalogReaderRequest .. py:class:: ReadAnalogReaderResponse(*, value: int = ..., min_range: float = ..., max_range: float = ..., step_size: float = ...) Bases: :py:obj:`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. .. py:attribute:: value :type: int .. py:attribute:: min_range :type: float .. py:attribute:: max_range :type: float .. py:attribute:: step_size :type: float .. py:type:: Global___ReadAnalogReaderResponse :canonical: ReadAnalogReaderResponse .. py:class:: WriteAnalogRequest(*, name: str = ..., pin: str = ..., value: int = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Analog Writer .. py:attribute:: name :type: str .. py:attribute:: pin :type: str .. py:attribute:: value :type: int .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___WriteAnalogRequest :canonical: WriteAnalogRequest .. py:class:: WriteAnalogResponse Bases: :py:obj:`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. .. py:type:: Global___WriteAnalogResponse :canonical: WriteAnalogResponse .. py:class:: GetDigitalInterruptValueRequest(*, board_name: str = ..., digital_interrupt_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Digital Interrupt .. py:attribute:: board_name :type: str .. py:attribute:: digital_interrupt_name :type: str .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___GetDigitalInterruptValueRequest :canonical: GetDigitalInterruptValueRequest .. py:class:: GetDigitalInterruptValueResponse(*, value: int = ...) Bases: :py:obj:`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. .. py:attribute:: value :type: int .. py:type:: Global___GetDigitalInterruptValueResponse :canonical: GetDigitalInterruptValueResponse .. py:class:: StreamTicksRequest(*, name: str = ..., pin_names: collections.abc.Iterable[str] | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str Board name .. py:method:: pin_names() -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] Name of digital interrupts to recieve ticks from .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___StreamTicksRequest :canonical: StreamTicksRequest .. py:class:: StreamTicksResponse(*, pin_name: str = ..., time: int = ..., high: bool = ...) Bases: :py:obj:`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. .. py:attribute:: pin_name :type: str name of interrupt .. py:attribute:: time :type: int Time in nanoseconds of a tick .. py:attribute:: high :type: bool Value high or low of the tick .. py:type:: Global___StreamTicksResponse :canonical: StreamTicksResponse .. py:class:: SetPowerModeRequest(*, name: str = ..., power_mode: Global___PowerMode = ..., duration: google.protobuf.duration_pb2.Duration | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str name of board .. py:attribute:: power_mode :type: Global___PowerMode Requested power mode .. py:method:: duration() -> google.protobuf.duration_pb2.Duration Requested duration to stay in `power_mode` .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:type:: Global___SetPowerModeRequest :canonical: SetPowerModeRequest .. py:class:: SetPowerModeResponse Bases: :py:obj:`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. .. py:type:: Global___SetPowerModeResponse :canonical: SetPowerModeResponse