Files
pybricks-api/doc/main/pupdevices/ultrasonicsensor.rst
T
Laurens Valk 4967b96ddd doc/main: Fix trailing whitespace.
For some reason this was not caught by CI.
2025-05-01 11:27:33 +02:00

49 lines
1.3 KiB
ReStructuredText

.. pybricks-requirements::
Ultrasonic Sensor
^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: ../../main/diagrams/sensor_ultrasonic_lights.png
:width: 80 %
.. blockimg:: pybricks_variables_set_ultrasonic_sensor
.. autoclass:: pybricks.pupdevices.UltrasonicSensor
:no-members:
.. blockimg:: pybricks_blockDistance_UltrasonicSensor
.. automethod:: pybricks.pupdevices.UltrasonicSensor.distance
.. automethod:: pybricks.pupdevices.UltrasonicSensor.presence
.. rubric:: Built-in lights
This sensor has 4 built-in lights. You can adjust the brightness of each
light.
.. blockimg:: pybricks_blockLightOn_ultrasonicsensor_on
.. blockimg:: pybricks_blockLightOn_ultrasonicsensor_on_list
.. automethod:: pybricks.pupdevices::UltrasonicSensor.lights.on
.. blockimg:: pybricks_blockLightOn_ultrasonicsensor_off
.. automethod:: pybricks.pupdevices::UltrasonicSensor.lights.off
Examples
-------------------
Measuring distance and switching on the lights
**********************************************
.. literalinclude::
../../../examples/pup/sensor_ultrasonic/basics.py
Gradually change the brightness of the lights
**********************************************
.. literalinclude::
../../../examples/pup/sensor_ultrasonic/math.py