viam-sdk 0.25.2__py3-none-linux_armv7l.whl → 0.62.0__py3-none-linux_armv7l.whl

viam/components/board/board.py

@@ -4,7 +4,7 @@ from datetime import timedelta
 from typing import Any, Dict, Final, List, Optional
 
 from viam.proto.component.board import PowerMode, ReadAnalogReaderResponse, StreamTicksResponse
-from viam.resource.types import RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT, Subtype
+from viam.resource.types import API, RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT
 from viam.streams import Stream
 
 from ..component_base import ComponentBase
@@ -31,10 +31,10 @@ class Board(ComponentBase):
 
         from viam.components.board import Board
 
-    For more information, see `Board component <https://docs.viam.com/components/board/>`_.
+    For more information, see `Board component <https://docs.viam.com/dev/reference/apis/components/board/>`_.
     """
 
-    SUBTYPE: Final = Subtype(  # pyright: ignore [reportIncompatibleVariableOverride]
+    API: Final = API(  # pyright: ignore [reportIncompatibleVariableOverride]
         RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT, "board"
     )
 
@@ -52,7 +52,7 @@ class Board(ComponentBase):
         the reader's minimum and maximum possible values, and its step size (the minimum possible
         change between values it can read).
 
-        For more information, see `analogs <https://docs.viam.com/components/board/#analogs>`_.
+        For more information, see `analogs <https://docs.viam.com/dev/reference/apis/components/board/#analogs>`_.
         """
 
         def __init__(self, name: str):
@@ -65,10 +65,10 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the Analog "my_example_analog_reader".
-                reader = await my_board.analog_reader_by_name(
+                reader = await my_board.analog_by_name(
                     name="my_example_analog_reader")
 
                 # Get the value of the digital signal "my_example_analog_reader" has most
@@ -78,7 +78,7 @@ class Board(ComponentBase):
             Returns:
                 Value: The current value, including the min, max, and step_size of the reader.
 
-            For more information, see `Board component Analog API <https://docs.viam.com/components/board/#analog-api>`_.
+            For more information, see `Board component Analog API <https://docs.viam.com/dev/reference/apis/components/board/#analog-api>`_.
             """
             ...
 
@@ -89,7 +89,7 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the Analog "my_example_analog_writer".
                 writer = await my_board.analog_by_name(
@@ -100,7 +100,7 @@ class Board(ComponentBase):
             Args:
                 value (int): Value to write to the analog writer.
 
-            For more information, see `Board component Analog API <https://docs.viam.com/components/board/#analog-api>`_.
+            For more information, see `Board component Analog API <https://docs.viam.com/dev/reference/apis/components/board/#analog-api>`_.
             """
             ...
 
@@ -110,7 +110,7 @@ class Board(ComponentBase):
         when interrupted, calls the added callbacks. Post processors can
         be added to modify what Value it ultimately returns.
 
-        For more information, see `digital_interrupts <https://docs.viam.com/components/board/#digital_interrupts>`_.
+        For more information, see `digital_interrupts <https://docs.viam.com/dev/reference/apis/components/board/#digital_interrupts>`_.
         """
 
         name: str
@@ -127,7 +127,7 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the DigitalInterrupt "my_example_digital_interrupt".
                 interrupt = await my_board.digital_interrupt_by_name(
@@ -141,7 +141,7 @@ class Board(ComponentBase):
                 int: The current value.
 
             For more information, see
-            `Board component DigitalInterrupt API <https://docs.viam.com/components/board/#digitalinterrupt-api>`_.
+            `Board component DigitalInterrupt API <https://docs.viam.com/dev/reference/apis/components/board/#digitalinterrupt-api>`_.
             """
             ...
 
@@ -163,18 +163,18 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the GPIOPin with pin number 15.
                 pin = await my_board.gpio_pin_by_name(name="15")
 
                 # Set the pin to high.
-                await pin.set(high="true")
+                await pin.set(high=True)
 
             Args:
                 high (bool): When true, sets the pin to high. When false, sets the pin to low.
 
-            For more information, see `GPIOPin API <https://docs.viam.com/components/board/#gpiopin-api>`_.
+            For more information, see `GPIOPin API <https://docs.viam.com/dev/reference/apis/components/board/#gpiopin-api>`_.
             """
             ...
 
@@ -185,7 +185,7 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the GPIOPin with pin number 15.
                 pin = await my_board.gpio_pin_by_name(name="15")
@@ -196,7 +196,7 @@ class Board(ComponentBase):
             Returns:
                 bool: Indicates if the state of the pin is high.
 
-            For more information, see `GPIOPin API <https://docs.viam.com/components/board/#gpiopin-api>`_.
+            For more information, see `GPIOPin API <https://docs.viam.com/dev/reference/apis/components/board/#gpiopin-api>`_.
             """
             ...
 
@@ -207,7 +207,7 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the GPIOPin with pin number 15.
                 pin = await my_board.gpio_pin_by_name(name="15")
@@ -218,7 +218,7 @@ class Board(ComponentBase):
             Returns:
                 float: The duty cycle.
 
-            For more information, see `GPIOPin API <https://docs.viam.com/components/board/#gpiopin-api>`_.
+            For more information, see `GPIOPin API <https://docs.viam.com/dev/reference/apis/components/board/#gpiopin-api>`_.
             """
             ...
 
@@ -229,19 +229,19 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the GPIOPin with pin number 15.
                 pin = await my_board.gpio_pin_by_name(name="15")
 
                 # Set the duty cycle to .6, meaning that this pin will be in the high state for
                 # 60% of the duration of the PWM interval period.
-                await pin.set_pwm(cycle=.6)
+                await pin.set_pwm(duty_cycle=.6)
 
             Args:
                 duty_cycle (float): The duty cycle.
 
-            For more information, see `GPIOPin API <https://docs.viam.com/components/board/#gpiopin-api>`_.
+            For more information, see `GPIOPin API <https://docs.viam.com/dev/reference/apis/components/board/#gpiopin-api>`_.
             """
             ...
 
@@ -252,7 +252,7 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the GPIOPin with pin number 15.
                 pin = await my_board.gpio_pin_by_name(name="15")
@@ -263,7 +263,7 @@ class Board(ComponentBase):
             Returns:
                 int: The PWM frequency.
 
-            For more information, see `GPIOPin API <https://docs.viam.com/components/board/#gpiopin-api>`_.
+            For more information, see `GPIOPin API <https://docs.viam.com/dev/reference/apis/components/board/#gpiopin-api>`_.
             """
             ...
 
@@ -282,7 +282,7 @@ class Board(ComponentBase):
 
             ::
 
-                my_board = Board.from_robot(robot=robot, name="my_board")
+                my_board = Board.from_robot(robot=machine, name="my_board")
 
                 # Get the GPIOPin with pin number 15.
                 pin = await my_board.gpio_pin_by_name(name="15")
@@ -293,7 +293,7 @@ class Board(ComponentBase):
             Args:
                 frequency (int): The frequency, in Hz.
 
-            For more information, see `GPIOPin API <https://docs.viam.com/components/board/#gpiopin-api>`_.
+            For more information, see `GPIOPin API <https://docs.viam.com/dev/reference/apis/components/board/#gpiopin-api>`_.
             """
             ...
 
@@ -304,7 +304,7 @@ class Board(ComponentBase):
 
         ::
 
-            my_board = Board.from_robot(robot=robot, name="my_board")
+            my_board = Board.from_robot(robot=machine, name="my_board")
 
             # Get the Analog "my_example_analog_reader".
             reader = await my_board.analog_by_name(name="my_example_analog_reader")
@@ -315,7 +315,7 @@ class Board(ComponentBase):
         Returns:
             Analog: The analog reader or writer.
 
-        For more information, see `Board component <https://docs.viam.com/components/board/>`_.
+        For more information, see `Board component <https://docs.viam.com/dev/reference/apis/components/board/#analogbyname>`_.
         """
         ...
 
@@ -326,7 +326,7 @@ class Board(ComponentBase):
 
         ::
 
-            my_board = Board.from_robot(robot=robot, name="my_board")
+            my_board = Board.from_robot(robot=machine, name="my_board")
 
             # Get the DigitalInterrupt "my_example_digital_interrupt".
             interrupt = await my_board.digital_interrupt_by_name(
@@ -338,7 +338,7 @@ class Board(ComponentBase):
         Returns:
             DigitalInterrupt: The digital interrupt.
 
-        For more information, see `Board component <https://docs.viam.com/components/board/>`_.
+        For more information, see `Board component <https://docs.viam.com/dev/reference/apis/components/board/#digitalinterruptbyname>`_.
         """
         ...
 
@@ -349,7 +349,7 @@ class Board(ComponentBase):
 
         ::
 
-            my_board = Board.from_robot(robot=robot, name="my_board")
+            my_board = Board.from_robot(robot=machine, name="my_board")
 
             # Get the GPIOPin with pin number 15.
             pin = await my_board.gpio_pin_by_name(name="15")
@@ -360,45 +360,7 @@ class Board(ComponentBase):
         Returns:
             GPIOPin: The pin.
 
-        For more information, see `Board component <https://docs.viam.com/components/board/>`_.
-        """
-        ...
-
-    @abc.abstractmethod
-    async def analog_names(self) -> List[str]:
-        """
-        Get the names of all known analog readers and/or writers.
-
-        ::
-
-            my_board = Board.from_robot(robot=robot, name="my_board")
-
-            # Get the name of every Analog configured on the board.
-            names = await my_board.analog_names()
-
-        Returns:
-            List[str]: The list of names of all known analog readers/writers.
-
-        For more information, see `Board component <https://docs.viam.com/components/board/>`_.
-        """
-        ...
-
-    @abc.abstractmethod
-    async def digital_interrupt_names(self) -> List[str]:
-        """
-        Get the names of all known digital interrupts.
-
-        ::
-
-            my_board = Board.from_robot(robot=robot, name="my_board")
-
-            # Get the name of every DigitalInterrupt configured on the board.
-            names = await my_board.digital_interrupt_names()
-
-        Returns:
-            List[str]: The names of the digital interrupts.
-
-        For more information, see `Board component <https://docs.viam.com/components/board/>`_.
+        For more information, see `Board component <https://docs.viam.com/dev/reference/apis/components/board/#gpiopinbyname>`_.
         """
         ...
 
@@ -411,7 +373,7 @@ class Board(ComponentBase):
 
         ::
 
-            my_board = Board.from_robot(robot=robot, name="my_board")
+            my_board = Board.from_robot(robot=machine, name="my_board")
 
             # Set the power mode of the board to OFFLINE_DEEP.
             status = await my_board.set_power_mode(mode=PowerMode.POWER_MODE_OFFLINE_DEEP)
@@ -420,7 +382,7 @@ class Board(ComponentBase):
             mode (PowerMode): The desired power mode.
             duration (Optional[timedelta]): Requested duration to stay in power mode.
 
-        For more information, see `Board component <https://docs.viam.com/components/board/>`_.
+        For more information, see `Board component <https://docs.viam.com/dev/reference/apis/components/board/#setpowermode>`_.
         """
         ...
 
@@ -432,12 +394,12 @@ class Board(ComponentBase):
         ::
 
 
-            my_board = Board.from_robot(robot=robot, name="my_board")
-            di8 = await my_board.digital_interrupt_by_name(name="8"))
-            di11 = await my_board.digital_interrupt_by_name(name="11"))
+            my_board = Board.from_robot(robot=machine, name="my_board")
+            di8 = await my_board.digital_interrupt_by_name(name="8")
+            di11 = await my_board.digital_interrupt_by_name(name="11")
 
             # Iterate over stream of ticks from pins 8 and 11.
-            async for tick in my_board.stream_ticks([di8, di11]):
+            async for tick in await my_board.stream_ticks([di8, di11]):
                 print(f"Pin {tick.pin_name} changed to {'high' if tick.high else 'low'} at {tick.time}")
 
 
@@ -447,6 +409,6 @@ class Board(ComponentBase):
         Returns:
             TickStream: stream of ticks.
 
-        For more information, see `Board component <https://docs.viam.com/components/board/>`_.
+        For more information, see `Board component <https://docs.viam.com/dev/reference/apis/components/board/#streamticks>`_.
         """
         ...

viam/components/board/client.py

@@ -5,7 +5,6 @@ from google.protobuf.duration_pb2 import Duration
 from grpclib.client import Channel
 from grpclib.client import Stream as ClientStream
 
-from viam.logging import getLogger
 from viam.proto.common import DoCommandRequest, DoCommandResponse, Geometry
 from viam.proto.component.board import (
     BoardServiceStub,
@@ -27,14 +26,12 @@ from viam.proto.component.board import (
     StreamTicksResponse,
     WriteAnalogRequest,
 )
-from viam.resource.rpc_client_base import ReconfigurableResourceRPCClientBase
+from viam.resource.rpc_client_base import ReconfigurableResourceRPCClientBase, ResourceRPCClientBase
 from viam.streams import StreamWithIterator
 from viam.utils import ValueTypes, dict_to_struct, get_geometries, struct_to_dict
 
 from .board import Board, TickStream
 
-LOGGER = getLogger(__name__)
-
 
 class AnalogClient(Board.Analog):
     def __init__(self, name: str, board: "BoardClient"):
@@ -46,12 +43,11 @@ class AnalogClient(Board.Analog):
         *,
         extra: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ) -> Board.Analog.Value:
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = ReadAnalogReaderRequest(board_name=self.board.name, analog_reader_name=self.name, extra=dict_to_struct(extra))
-        return await self.board.client.ReadAnalogReader(request, timeout=timeout)
+        return await self.board.client.ReadAnalogReader(request, timeout=timeout, metadata=md)
 
     async def write(
         self,
@@ -61,10 +57,9 @@ class AnalogClient(Board.Analog):
         timeout: Optional[float] = None,
         **kwargs,
     ):
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = WriteAnalogRequest(name=self.board.name, pin=self.name, value=value, extra=dict_to_struct(extra))
-        await self.board.client.WriteAnalog(request, timeout=timeout)
+        await self.board.client.WriteAnalog(request, timeout=timeout, metadata=md)
 
 
 class DigitalInterruptClient(Board.DigitalInterrupt):
@@ -77,12 +72,11 @@ class DigitalInterruptClient(Board.DigitalInterrupt):
         *,
         extra: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ) -> int:
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = GetDigitalInterruptValueRequest(board_name=self.board.name, digital_interrupt_name=self.name, extra=dict_to_struct(extra))
-        response: GetDigitalInterruptValueResponse = await self.board.client.GetDigitalInterruptValue(request, timeout=timeout)
+        response: GetDigitalInterruptValueResponse = await self.board.client.GetDigitalInterruptValue(request, timeout=timeout, metadata=md)
         return response.value
 
 
@@ -96,12 +90,11 @@ class GPIOPinClient(Board.GPIOPin):
         *,
         extra: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ) -> bool:
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = GetGPIORequest(name=self.board.name, pin=self.name, extra=dict_to_struct(extra))
-        response: GetGPIOResponse = await self.board.client.GetGPIO(request, timeout=timeout)
+        response: GetGPIOResponse = await self.board.client.GetGPIO(request, timeout=timeout, metadata=md)
         return response.high
 
     async def set(
@@ -110,24 +103,22 @@ class GPIOPinClient(Board.GPIOPin):
         *,
         extra: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ):
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = SetGPIORequest(name=self.board.name, pin=self.name, high=high, extra=dict_to_struct(extra))
-        await self.board.client.SetGPIO(request, timeout=timeout)
+        await self.board.client.SetGPIO(request, timeout=timeout, metadata=md)
 
     async def get_pwm(
         self,
         *,
         extra: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ) -> float:
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = PWMRequest(name=self.board.name, pin=self.name, extra=dict_to_struct(extra))
-        response: PWMResponse = await self.board.client.PWM(request, timeout=timeout)
+        response: PWMResponse = await self.board.client.PWM(request, timeout=timeout, metadata=md)
         return response.duty_cycle_pct
 
     async def set_pwm(
@@ -136,24 +127,22 @@ class GPIOPinClient(Board.GPIOPin):
         *,
         extra: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ):
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = SetPWMRequest(name=self.board.name, pin=self.name, duty_cycle_pct=duty_cycle, extra=dict_to_struct(extra))
-        await self.board.client.SetPWM(request, timeout=timeout)
+        await self.board.client.SetPWM(request, timeout=timeout, metadata=md)
 
     async def get_pwm_frequency(
         self,
         *,
         extra: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ) -> int:
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = PWMFrequencyRequest(name=self.board.name, pin=self.name, extra=dict_to_struct(extra))
-        response: PWMFrequencyResponse = await self.board.client.PWMFrequency(request, timeout=timeout)
+        response: PWMFrequencyResponse = await self.board.client.PWMFrequency(request, timeout=timeout, metadata=md)
         return response.frequency_hz
 
     async def set_pwm_frequency(
@@ -162,12 +151,11 @@ class GPIOPinClient(Board.GPIOPin):
         *,
         extra: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ):
-        if extra is None:
-            extra = {}
+        md = kwargs.get("metadata", ResourceRPCClientBase.Metadata()).proto
         request = SetPWMFrequencyRequest(name=self.board.name, pin=self.name, frequency_hz=frequency, extra=dict_to_struct(extra))
-        await self.board.client.SetPWMFrequency(request, timeout=timeout)
+        await self.board.client.SetPWMFrequency(request, timeout=timeout, metadata=md)
 
 
 class BoardClient(Board, ReconfigurableResourceRPCClientBase):
@@ -196,25 +184,16 @@ class BoardClient(Board, ReconfigurableResourceRPCClientBase):
     async def gpio_pin_by_name(self, name: str) -> Board.GPIOPin:
         return GPIOPinClient(name, self)
 
-    async def analog_names(self) -> List[str]:
-        if self._analog_names is None:
-            return []
-        return self._analog_names
-
-    async def digital_interrupt_names(self) -> List[str]:
-        if self._digital_interrupt_names is None:
-            return []
-        return self._digital_interrupt_names
-
     async def do_command(
         self,
         command: Mapping[str, ValueTypes],
         *,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ) -> Mapping[str, ValueTypes]:
+        md = kwargs.get("metadata", self.Metadata()).proto
         request = DoCommandRequest(name=self.name, command=dict_to_struct(command))
-        response: DoCommandResponse = await self.client.DoCommand(request, timeout=timeout)
+        response: DoCommandResponse = await self.client.DoCommand(request, timeout=timeout, metadata=md)
         return struct_to_dict(response.result)
 
     async def set_power_mode(
@@ -223,48 +202,35 @@ class BoardClient(Board, ReconfigurableResourceRPCClientBase):
         duration: Optional[timedelta] = None,
         *,
         timeout: Optional[float] = None,
-        **__,
+        **kwargs,
     ):
+        md = kwargs.get("metadata", self.Metadata()).proto
         duration_pb: Optional[Duration] = None
         if duration is not None:
             duration_pb = [(d, d.FromTimedelta(duration)) for d in [Duration()]][0][0]
         request = SetPowerModeRequest(name=self.name, power_mode=mode, duration=duration_pb)
-        await self.client.SetPowerMode(request, timeout=timeout)
-
-    async def get_geometries(self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) -> List[Geometry]:
-        return await get_geometries(self.client, self.name, extra, timeout)
+        await self.client.SetPowerMode(request, timeout=timeout, metadata=md)
 
-    async def write_analog(
-        self,
-        pin: str,
-        value: int,
-        *,
-        extra: Optional[Dict[str, Any]] = None,
-        timeout: Optional[float] = None,
-        **__,
-    ):
-        if extra is None:
-            extra = {}
-        request = WriteAnalogRequest(name=self.name, pin=pin, value=value, extra=dict_to_struct(extra))
-        await self.client.WriteAnalog(request, timeout=timeout)
+    async def get_geometries(self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs) -> List[Geometry]:
+        md = kwargs.get("metadata", self.Metadata())
+        return await get_geometries(self.client, self.name, extra, timeout, md)
 
     async def stream_ticks(
         self,
         interrupts: List[Board.DigitalInterrupt],
         *,
         extra: Optional[Dict[str, Any]] = None,
-        **__,
+        **kwargs,
     ) -> TickStream:
-        if extra is None:
-            extra = {}
         names = []
         for di in interrupts:
             names.append(di.name)
         request = StreamTicksRequest(name=self.name, pin_names=names, extra=dict_to_struct(extra))
 
         async def read():
+            md = kwargs.get("metadata", self.Metadata()).proto
             tick_stream: ClientStream[StreamTicksRequest, StreamTicksResponse]
-            async with self.client.StreamTicks.open() as tick_stream:
+            async with self.client.StreamTicks.open(metadata=md) as tick_stream:
                 try:
                     await tick_stream.send_message(request, end=True)
                     async for tick in tick_stream:

viam/components/button/__init__.py

@@ -0,0 +1,10 @@
+import viam.gen.component.button.v1.button_pb2
+from viam.resource.registry import Registry, ResourceRegistration
+
+from .button import Button
+from .client import ButtonClient
+from .service import ButtonRPCService
+
+__all__ = ["Button"]
+
+Registry.register_api(ResourceRegistration(Button, ButtonRPCService, lambda name, channel: ButtonClient(name, channel)))

viam/components/button/button.py

@@ -0,0 +1,41 @@
+import abc
+from typing import Any, Final, Mapping, Optional
+
+from viam.components.component_base import ComponentBase
+from viam.resource.types import API, RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT
+
+
+class Button(ComponentBase):
+    """
+    Button represents a device that can be pushed.
+
+    This acts as an abstract base class for any drivers representing specific
+    button implementations. This cannot be used on its own. If the ``__init__()`` function is
+    overridden, it must call the ``super().__init__()`` function.
+
+    ::
+
+        from viam.components.button import Button
+
+    For more information, see `Button component <https://docs.viam.com/dev/reference/apis/components/button/>` _.
+    """
+
+    API: Final = API(  # pyright: ignore [reportIncompatibleVariableOverride]
+        RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT, "button"
+    )
+
+    @abc.abstractmethod
+    async def push(self, *, extra: Optional[Mapping[str, Any]] = None, timeout: Optional[float] = None, **kwargs) -> None:
+        """
+        Push the button.
+
+        ::
+
+            my_button = Button.from_robot(robot=machine, name="my_button")
+
+            # Push the button
+            await my_button.push()
+
+        For more information, see `Button component <https://docs.viam.com/dev/reference/apis/components/button/>` _.
+        """
+        ...