:py:mod:`leads_arduino.wheel_speed_sensor`
==========================================

.. py:module:: leads_arduino.wheel_speed_sensor

.. autodoc2-docstring:: leads_arduino.wheel_speed_sensor
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`WheelSpeedSensor <leads_arduino.wheel_speed_sensor.WheelSpeedSensor>`
     - .. autodoc2-docstring:: leads_arduino.wheel_speed_sensor.WheelSpeedSensor
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`rpm2kmh <leads_arduino.wheel_speed_sensor.rpm2kmh>`
     - .. autodoc2-docstring:: leads_arduino.wheel_speed_sensor.rpm2kmh
          :summary:

API
~~~

.. py:function:: rpm2kmh(rpm: float, wheel_circumference: float) -> float
   :canonical: leads_arduino.wheel_speed_sensor.rpm2kmh

   .. autodoc2-docstring:: leads_arduino.wheel_speed_sensor.rpm2kmh

.. py:class:: WheelSpeedSensor(wheel_diameter: float, num_divisions: int = 1, odometer_tag: str | None = None, accelerometer_tag: str | None = None)
   :canonical: leads_arduino.wheel_speed_sensor.WheelSpeedSensor

   Bases: :py:obj:`leads.Device`

   .. autodoc2-docstring:: leads_arduino.wheel_speed_sensor.WheelSpeedSensor

   .. rubric:: Initialization

   .. autodoc2-docstring:: leads_arduino.wheel_speed_sensor.WheelSpeedSensor.__init__

   .. py:method:: initialize(*parent_tags: str) -> None
      :canonical: leads_arduino.wheel_speed_sensor.WheelSpeedSensor.initialize

      .. autodoc2-docstring:: leads_arduino.wheel_speed_sensor.WheelSpeedSensor.initialize

   .. py:method:: update(data: str) -> None
      :canonical: leads_arduino.wheel_speed_sensor.WheelSpeedSensor.update

      .. autodoc2-docstring:: leads_arduino.wheel_speed_sensor.WheelSpeedSensor.update

   .. py:method:: read() -> float
      :canonical: leads_arduino.wheel_speed_sensor.WheelSpeedSensor.read

      .. autodoc2-docstring:: leads_arduino.wheel_speed_sensor.WheelSpeedSensor.read