Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 09:37:25 +00:00
Code Issues Releases Activity

api/pupdevices: update illuminate argument

Browse Source 
match the implementation and simplify description
This commit is contained in:
Laurens Valk
2020-05-27 13:58:30 +02:00
committed by laurensvalk
parent f604dd321e
commit ce993900d1
1 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pybricks/pupdevices.py
+8 -10
View File
@@ -152,14 +152,13 @@ class ColorSensor:
"""
pass
def color(self, illuminate=True):
def color(self, surface=True):
"""Scans the color of a surface or an external light source.
Arguments:
illuminate (bool): Choose ``true`` to keep the sensor light on.
This is useful to scan the color of objects and surfaces.
Choose ``false`` to turn the sensor light off. This is useful
to scan the color of a light source or screen.
surface (bool): Choose ``true`` to scan the color of objects
and surfaces. Choose ``false`` to scan the color of
screens and other external light sources.
:returns:
Detected color.
@@ -194,15 +193,14 @@ class ColorSensor:
"""
pass
def hsv(self, illuminate=True):
def hsv(self, surface=True):
"""Scans the hue, saturation and brightness value of a
surface or an external light source.
Arguments:
illuminate (bool): Choose ``true`` to keep the sensor light on.
This is useful to scan the color of objects and surfaces.
Choose ``false`` to turn the sensor light off. This is useful
to scan the color of a light source or screen.
surface (bool): Choose ``true`` to scan the color of objects
and surfaces. Choose ``false`` to scan the color of
screens and other external light sources.
:returns: Tuple with the hue, saturation, and value
(brightness) of the color.