From 6132ae66da47a614db15c2dd1576a1d55d8f2a1a Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Sat, 11 Jul 2020 19:40:00 +0200 Subject: [PATCH] doc/pupdevices/ColorDistanceSensor: add examples --- doc/api/pupdevices.rst | 47 ++++++++++++++++++++++++++++++++++++++++++ pybricks-projects | 2 +- 2 files changed, 48 insertions(+), 1 deletion(-) diff --git a/doc/api/pupdevices.rst b/doc/api/pupdevices.rst index a2b3048..83750c2 100644 --- a/doc/api/pupdevices.rst +++ b/doc/api/pupdevices.rst @@ -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 diff --git a/pybricks-projects b/pybricks-projects index dc82cd5..36a4bdd 160000 --- a/pybricks-projects +++ b/pybricks-projects @@ -1 +1 @@ -Subproject commit dc82cd5d07d85bdb96b6a09bac65d636a928c3b0 +Subproject commit 36a4bdd2a97774b02d40684585176d4428d8ae58