step.calibration.sensors.step_dsl
=================================

.. py:module:: step.calibration.sensors.step_dsl

.. autoapi-nested-parse::

   Auto-generated step builders and DSL functions — DO NOT EDIT.

   Source: step.py



Classes
-------

.. autoapisummary::

   step.calibration.sensors.step_dsl.CalibrateSensorsBuilder


Functions
---------

.. autoapisummary::

   step.calibration.sensors.step_dsl.calibrate_sensors


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

.. py:class:: CalibrateSensorsBuilder

   Bases: :py:obj:`raccoon.step.step_builder.StepBuilder`


   Builder for CalibrateSensors. Auto-generated — do not edit.


   .. py:method:: calibration_time(value: float)


   .. py:method:: allow_use_existing(value: bool)


   .. py:method:: calibration_sets(value: Optional[List[str]])


.. py:function:: calibrate_sensors(calibration_time: float = 5.0, allow_use_existing: bool = True, calibration_sets: Optional[List[str]] = None)

   Calibrate IR sensors by sampling black and white surface readings.

   Guides the operator through sampling each IR sensor over calibration
   surfaces to establish black/white thresholds. The operator places the
   robot on the calibration surface and the step samples readings for the
   configured duration. Supports multiple named calibration sets (e.g.
   ``"default"`` and ``"transparent"``) for surface-specific thresholds.

   :param calibration_time: Duration for calibration sampling in seconds.
   :param allow_use_existing: If ``True``, offer to reuse existing calibration values instead of re-sampling.
   :param calibration_sets: Named calibration sets to calibrate (e.g. ``["default", "transparent"]``). Defaults to ``["default"]``.

   :returns: A CalibrateSensorsBuilder (chainable via ``.calibration_time()``, ``.allow_use_existing()``, ``.calibration_sets()``, ``.on_anomaly()``, ``.skip_timing()``).

   Example::

       from raccoon.step.calibration import calibrate_sensors

       # Basic IR calibration
       calibrate_sensors()

       # Two surface sets with longer sampling
       calibrate_sensors(
           calibration_time=8.0,
           calibration_sets=["default", "transparent"],
       )