Source code for viam.components.servo.servo

import abc
from typing import Any, Final, Mapping, Optional

from viam.resource.types import RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT, Subtype

from ..component_base import ComponentBase


[docs]class Servo(ComponentBase): """ Servo represents a physical servo. This acts as an abstract base class for any drivers representing specific servo implementations. This cannot be used on its own. If the ``__init__()`` function is overridden, it must call the ``super().__init__()`` function. """ SUBTYPE: Final = Subtype( # pyright: ignore [reportIncompatibleVariableOverride] RESOURCE_NAMESPACE_RDK, RESOURCE_TYPE_COMPONENT, "servo" )
[docs] @abc.abstractmethod async def move(self, angle: int, *, extra: Optional[Mapping[str, Any]] = None, timeout: Optional[float] = None, **kwargs): """ Move the servo to the provided angle. Args: angle (int): The desired angle of the servo in degrees. """ ...
[docs] @abc.abstractmethod async def get_position(self, *, extra: Optional[Mapping[str, Any]] = None, timeout: Optional[float] = None, **kwargs) -> int: """ Get the current angle (degrees) of the servo. Returns: int: The current angle of the servo in degrees. """ ...
[docs] @abc.abstractmethod async def stop(self, *, extra: Optional[Mapping[str, Any]] = None, timeout: Optional[float] = None, **kwargs): """ Stop the servo. It is assumed that the servo stops immediately. """ ...
[docs] @abc.abstractmethod async def is_moving(self) -> bool: """ Get if the servo is currently moving. Returns: bool: Whether the servo is moving. """ ...