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

doc/_common/ColorLight: docstring clean up

Browse Source 
This adds a (commented out) preview of the methods to the city hub light
This commit is contained in:
Laurens Valk
2020-07-07 09:44:16 +02:00
committed by laurensvalk
parent 8a43dc936a
commit 8078b6febb
3 changed files with 17 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/hubs_cityhub.inc
+6
View File
@@ -7,6 +7,12 @@
.. automethod:: pybricks.hubs::CityHub.light.off
.. .. automethod:: pybricks.hubs::CityHub.light.hsv
.. .. automethod:: pybricks.hubs::CityHub.light.pattern
.. .. automethod:: pybricks.hubs::CityHub.light.reset
.. rubric:: Using the battery
.. automethod:: pybricks.hubs::CityHub.battery.voltage
doc/api/pupdevices.rst
+2
View File
@@ -248,3 +248,5 @@ Light
.. automethod:: pybricks.pupdevices.Light.on
.. automethod:: pybricks.pupdevices.Light.off
.. .. automethod:: pybricks.pupdevices.Light.pattern
pybricks/_common.py
+9 -14
View File
@@ -405,20 +405,17 @@ class Light:
pass
def pattern(self, pattern, duration):
"""Make the light brightness follow a pattern as a function of time.
"""Makes the light brightness follow a pattern as a function of time.
The specified pattern function will be sampled at 64 points between 0
and the specified duration. The light will be held at a constant
brightness between samples. After the given duration, the pattern
repeats.
This function is not blocking. The pattern will be shown as the
user program continues.
Arguments:
pattern (callable): Function of the
form ``b = func(t)``` that returns the brightness ``b``
of the (0--100.0) as a function of time ``t`` in milliseconds.
form ``b = func(t)`` that returns the brightness ``b`` as a
function of time ``t`` in milliseconds.
time (:ref:`time`): Duration of the pattern.
"""
@@ -445,7 +442,7 @@ class ColorLight:
pass
def hsv(self, hue, saturation=100, value=100):
"""Set the hue, saturation and brightness of the light.
"""Sets the hue, saturation and brightness of the light.
Arguments:
hue (:ref:`hue`): Hue of the color.
@@ -455,21 +452,19 @@ class ColorLight:
pass
def pattern(self, pattern, duration):
"""Make the light follow a color pattern as a function of time.
"""Makes the light follow a color pattern as a function of time.
The specified pattern function will be sampled at 64 points between 0
and the specified duration. The light will be held constant between
samples. After the given duration, the pattern repeats.
This function is not blocking. The pattern will be shown as the
user program continues.
Arguments:
pattern (callable): Function of the
form ``h, s, v = func(t)``` that returns a tuple of ``h``,
form ``h, s, v = func(t)`` that returns a tuple of ``h``,
``s``, and ``v`` as a function of time ``t`` in milliseconds.
Instead of an HSV tuple, you may return
a :class:`Button <.parameters.Color>` for simplicity.
A function of the
form :class:`col <.parameters.Color>` ``= func(t)`` is also
allowed.
time (:ref:`time`): Duration of the pattern.
"""