doc/pupdevices/ColorDistanceSensor: add examples

This commit is contained in:
Laurens Valk
2020-07-11 19:40:00 +02:00
parent a02c7023e5
commit 6132ae66da
2 changed files with 48 additions and 1 deletions
+47
View File
@@ -96,6 +96,26 @@ Color and Distance Sensor
.. figure:: ../api/images/sensor_colordistance.png
:width: 35 %
.. toggle-header::
:header: **Show/hide examples**
**Example 1: Measuring color**
.. literalinclude::
../../pybricks-projects/snippets/pup/sensor_color_distance/color_print.py
**Example 2: Waiting for a color**
.. literalinclude::
../../pybricks-projects/snippets/pup/sensor_color_distance/wait_for_color.py
**Example 3: Measuring distance**
.. literalinclude::
../../pybricks-projects/snippets/pup/sensor_color_distance/distance_blink.py
.. autoclass:: pybricks.pupdevices.ColorDistanceSensor
:no-members:
@@ -109,6 +129,25 @@ Color and Distance Sensor
.. rubric:: Advanced color sensing
.. toggle-header::
:header: **Show/hide examples**
**Example 1: Reading hue, saturation, and value**
.. literalinclude::
../../pybricks-projects/snippets/pup/sensor_color_distance/hsv.py
**Example 2: Modifying the default color map**
.. literalinclude::
../../pybricks-projects/snippets/pup/sensor_color_distance/color_map_modify.py
**Example 3: Providing a whole new color map**
.. literalinclude::
../../pybricks-projects/snippets/pup/sensor_color_distance/color_map_new.py
.. automethod:: pybricks.pupdevices.ColorDistanceSensor.hsv
.. automethod:: pybricks.pupdevices.ColorDistanceSensor.color_map
@@ -119,6 +158,14 @@ Color and Distance Sensor
it off. If you use the sensor to measure something afterwards, the light
automatically turns back on at the default color for that sensing method.
.. toggle-header::
:header: **Show/hide examples**
**Example: Blinking the built-in light**
.. literalinclude::
../../pybricks-projects/snippets/pup/sensor_color_distance/distance_blink.py
.. automethod:: pybricks.pupdevices::ColorDistanceSensor.light.on
.. automethod:: pybricks.pupdevices::ColorDistanceSensor.light.off