Merge pull request #34 from RaspberryPiFoundation/dev

Push all change to master

Author: Martin O'Hanlon

README.rst

@@ -18,9 +18,9 @@ A beginner-friendly library for using common electronics components with the Ras
 
 Full documentation is available at `picozero.readthedocs.io <https://picozero.readthedocs.io>`_ :
 
-- `Installation and getting started guide <https://picozero.readthedocs.ioen/latest/gettingstarted.html>`_
-- `Recipes and how-to's <https://picozero.readthedocs.ioen/latest/recipes.html>`_
-- `API <https://picozero.readthedocs.ioen/latest/api.html>`_
+- `Installation and getting started guide <https://picozero.readthedocs.io/en/latest/gettingstarted.html>`_
+- `Recipes and how-to's <https://picozero.readthedocs.io/en/latest/recipes.html>`_
+- `API <https://picozero.readthedocs.io/en/latest/api.html>`_
 
-picozero is inspired by `gpiozero <https://gpiozero.readthedocs.io/en/stable/>`_ (and reuses some of its underlying struture), but is by design lighter weight and aligned with the Raspberry Pi Pico. 
+picozero is inspired by `gpiozero <https://gpiozero.readthedocs.io/en/stable/>`_ (and reuses some of its underlying structure), but is by design lighter weight and aligned with the Raspberry Pi Pico. 
 

docs/api.rst

@@ -24,6 +24,14 @@ PWMLED
     :inherited-members:
     :members:
 
+RGBLED
+----------
+
+.. autoclass:: RGBLED
+    :show-inheritance:
+    :inherited-members:
+    :members:
+
 Button
 ------
 

docs/conf.py

@@ -32,6 +32,7 @@ def __getattr__(cls, name):
             return Mock()
 
 sys.modules['machine'] = Mock()
+sys.modules['micropython'] = Mock()
 
 # add the ticks_ms function to time (as it is in micropython)
 import time

docs/examples/button_function.py

@@ -1,7 +1,7 @@
 from picozero import Button, pico_led
 from time import sleep
 
-button = Button(17)
+button = Button(18)
 
 def led_on_off():
     pico_led.on()

docs/examples/button_is_pressed.py

@@ -1,7 +1,7 @@
 from picozero import Button
 from time import sleep
 
-button = Button(17)
+button = Button(18)
 
 while True:
     if button.is_pressed:

docs/examples/button_led.py

@@ -1,6 +1,6 @@
 from picozero import Button, pico_led
 
-button = Button(17)
+button = Button(18)
 
 button.when_pressed = pico_led.on
 button.when_released = pico_led.off

docs/examples/buzzer.py

@@ -1,4 +1,4 @@
-# Active Buzzer that plays a not when powered
+# Active Buzzer that plays a note when powered
 from time import sleep
 from picozero import Buzzer
 

docs/examples/rgb_blink.py

@@ -0,0 +1,19 @@
+from picozero import RGBLED
+from time import sleep
+
+rgb = RGBLED(1, 2, 3)
+
+rgb.blink() # does not wait
+sleep(6)
+rgb.off()
+sleep(1)
+
+# blink purple 2 seconds, off 0.5 seconds
+rgb.blink(on_times=(2, 0.5), colors=((1, 0, 1), (0, 0, 0)), wait=True, n=3)
+
+rgb.off()
+sleep(1)
+
+# blink red 1 second, green 0.5 seconds, blue 0.25 seconds
+rgb.blink((1, 0.5, 0.25), colors=((1, 0, 0), (0, 1, 0), (0, 0, 1)), wait=True, n=2)
+    

docs/examples/rgb_cycle.py

@@ -0,0 +1,14 @@
+from picozero import RGBLED
+from time import sleep
+
+rgb = RGBLED(1, 2, 3)
+
+# Gradually colour cycle through colours between red and green, green and blue then blue and red
+rgb.cycle()
+sleep(4)
+rgb.off()
+sleep(1)
+
+# Colour cycle slower in the opposite direction
+rgb.cycle(fade_times=3, colors=((0, 0, 1), (0, 1, 0), (1, 0, 0)), wait=True, n=2)
+rgb.off()

docs/examples/rgb_pulse.py

@@ -0,0 +1,18 @@
+from picozero import RGBLED
+from time import sleep
+
+rgb = RGBLED(1, 2, 3)
+
+rgb.pulse() # does not wait
+sleep(6)
+rgb.off()
+sleep(1)
+
+# 2 second to fade from purple to off, 0.5 seconds to change from off to purple 
+rgb.pulse(fade_times=(2, 0.5), colors=((1, 0, 1), (0, 0, 0)), wait=True, n=3)
+
+rgb.off()
+sleep(1)
+
+# 4 seconds to change from red to green, 2 to change from green to blue, then 1 to change from blue back to red
+rgb.pulse((4, 2, 1), colors=((1, 0, 0), (0, 1, 0), (0, 0, 1)), wait=True, n=2)