From 3bf2704466c2299db90da4a218a3a264e6c25eff Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Sat, 20 Apr 2019 11:24:03 +0200 Subject: [PATCH] doc: add lpf2 ColorDistanceSensor Manually cherry-pick 925b6bc2474e8aa3b8d5c0d56029627f73edf029 --- pybricks/lpf2devices.py | 53 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/pybricks/lpf2devices.py b/pybricks/lpf2devices.py index bb52130..9f171a2 100644 --- a/pybricks/lpf2devices.py +++ b/pybricks/lpf2devices.py @@ -9,3 +9,56 @@ class Motor(CommonMotor): * ?/6181852: LEGO® BOOST Interactive Motor * TODO: Expand list with compatible devices """ + + +class ColorDistanceSensor(): + """LEGO® Power Functions 2.0 Color and Distance Sensor. + Element ?/6182145, contained in: + * 17101: LEGO® BOOST Creative Toolbox (2017) + * ?: Separate part (?) + """ + + def __init__(self, port): + """ColorDistanceSensor(port) + Arguments: + port (Port): Port to which the sensor is connected. + """ + pass + + def color(self): + """Measure the color of a surface. + + :returns: + ``Color.BLACK``, ``Color.BLUE``, ``Color.GREEN``, ``Color.YELLOW``, + ``Color.RED``, ``Color.WHITE``, or ``None``. + :rtype: :class:`Color `, or ``None`` if no color is detected. + """ + pass + + def ambient(self): + """Measure the ambient light intensity. + Returns: + :ref:`percentage`: Ambient light intensity, ranging from 0 (dark) to 100 (bright). + """ + pass + + def reflection(self): + """Measure the reflection of a surface using a red light. + Returns: + :ref:`percentage`: Reflection, ranging from 0.0 (no reflection) to 100.0 (high reflection). + """ + pass + + def rgb(self): + """Measure the reflection of a surface using a red, green, and then a blue light. + Returns: + tuple of three :ref:`percentages `: Reflection for red, green, and blue light, each ranging from 0.0 (no reflection) to 100.0 (high reflection). + """ + pass + + def distance(self): + """Measure the relative distance between the sensor and an object using infrared light. + Returns: + :ref:`relativedistance`: Relative distance ranging from 0 (closest) to 100 (farthest). + """ + pass