libstp.step.calibration.calibrate_wfl
=====================================

.. py:module:: libstp.step.calibration.calibrate_wfl

.. autoapi-nested-parse::

   Wait-for-light sensor calibration step using the new UI library.



Classes
-------

.. autoapisummary::

   libstp.step.calibration.calibrate_wfl.WFLCalibrationResult
   libstp.step.calibration.calibrate_wfl.CalibrateWaitForLight


Functions
---------

.. autoapisummary::

   libstp.step.calibration.calibrate_wfl.calibrate_wait_for_light


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

.. py:class:: WFLCalibrationResult

   Result of wait-for-light sensor calibration.


   .. py:attribute:: light_off
      :type:  float


   .. py:attribute:: light_on
      :type:  float


   .. py:attribute:: threshold
      :type:  float


.. py:class:: CalibrateWaitForLight(sensor: libstp.hal.AnalogSensor)

   Bases: :py:obj:`libstp.ui.step.UIStep`


   Step for calibrating a wait-for-light sensor.


   .. py:attribute:: sensor


   .. py:attribute:: calibration_result
      :type:  Optional[WFLCalibrationResult]
      :value: None



.. py:function:: calibrate_wait_for_light(sensor: libstp.hal.AnalogSensor) -> CalibrateWaitForLight

   Create a wait-for-light calibration step.

   :param sensor: The AnalogSensor to calibrate

   :returns: CalibrateWaitForLight step instance