ui.screens.analog_sensor ======================== .. py:module:: ui.screens.analog_sensor .. autoapi-nested-parse:: Analog sensor calibration UI screens. Classes ------- .. autoapisummary:: ui.screens.analog_sensor.AnalogSensorConfirmResult ui.screens.analog_sensor.AnalogSensorPositionScreen ui.screens.analog_sensor.AnalogSensorSamplingScreen ui.screens.analog_sensor.AnalogSensorConfirmScreen Module Contents --------------- .. py:class:: AnalogSensorConfirmResult Result from AnalogSensorConfirmScreen. .. py:attribute:: confirmed :type: bool .. py:class:: AnalogSensorPositionScreen(port: int, set_name: str = 'default') Bases: :py:obj:`ui.screen.UIScreen`\ [\ :py:obj:`None`\ ] Prompt the operator to position the robot at the target location. .. py:attribute:: title :value: 'Analog Sensor Calibration' .. py:attribute:: port .. py:attribute:: set_name :value: 'default' .. py:method:: build() -> ui.widgets.Widget Build the screen layout. Called on every render. Return a Widget tree describing what to display. .. py:method:: on_press() :async: .. py:class:: AnalogSensorSamplingScreen(port: int, duration: float) Bases: :py:obj:`ui.screen.UIScreen`\ [\ :py:obj:`None`\ ] Shown while the sensor is being sampled (closed externally via run_with_ui). .. py:attribute:: title :value: 'Analog Sensor Calibration' .. py:attribute:: port .. py:attribute:: duration .. py:method:: build() -> ui.widgets.Widget Build the screen layout. Called on every render. Return a Widget tree describing what to display. .. py:class:: AnalogSensorConfirmScreen(port: int, set_name: str, target_value: float, std: float, sample_count: int) Bases: :py:obj:`ui.screen.UIScreen`\ [\ :py:obj:`AnalogSensorConfirmResult`\ ] Show the captured reference value for operator confirmation. .. py:attribute:: title :value: 'Analog Sensor Calibration' .. py:attribute:: port .. py:attribute:: set_name .. py:attribute:: target_value .. py:attribute:: std .. py:attribute:: sample_count .. py:method:: build() -> ui.widgets.Widget Build the screen layout. Called on every render. Return a Widget tree describing what to display. .. py:method:: on_confirm() :async: .. py:method:: on_retry() :async: