Merge pull request gpiozero#333 from lurch/add_ledborg

Add LedBorg as a subclass of RGBLED

Author: bennuttall

docs/api_boards.rst

@@ -36,6 +36,13 @@ TrafficLights
     :inherited-members:
     :members:
 
+LedBorg
+=======
+
+.. autoclass:: LedBorg
+    :inherited-members:
+    :members:
+
 PiLITEr
 =======
 

docs/images/output_device_hierarchy.dot

@@ -21,5 +21,6 @@ digraph classes {
     PWMOutputDevice->OutputDevice;
     PWMLED->PWMOutputDevice;
     RGBLED->Device;
+    LedBorg->RGBLED;
 }
 

docs/images/output_device_hierarchy.pdf

@@ -106,6 +106,7 @@
     LEDCollection,
     LEDBoard,
     LEDBarGraph,
+    LedBorg,
     PiLiter,
     PiLiterBarGraph,
     TrafficLights,

docs/images/output_device_hierarchy.png

@@ -21,7 +21,14 @@
     OutputDeviceBadValue,
     )
 from .input_devices import Button
-from .output_devices import OutputDevice, LED, PWMLED, Buzzer, Motor
+from .output_devices import (
+    OutputDevice,
+    LED,
+    PWMLED,
+    RGBLED,
+    Buzzer,
+    Motor,
+    )
 from .threads import GPIOThread
 from .devices import Device, CompositeDevice
 from .mixins import SharedMixin, SourceMixin
@@ -431,6 +438,36 @@ def value(self, value):
             led.value = calc_value(index)
 
 
+class LedBorg(RGBLED):
+    """
+    Extends :class:`RGBLED` for the `PiBorg LedBorg`_: an add-on board
+    containing a very bright RGB LED.
+
+    The LedBorg pins are fixed and therefore there's no need to specify them
+    when constructing this class. The following example turns the LedBorg
+    purple::
+
+        from gpiozero import LedBorg
+
+        led = LedBorg()
+        led.color = (1, 0, 1)
+
+    :param tuple initial_value:
+        The initial color for the LedBorg. Defaults to black ``(0, 0, 0)``.
+
+    :param bool pwm:
+        If ``True`` (the default), construct :class:`PWMLED` instances for
+        each component of the LedBorg. If ``False``, construct regular
+        :class:`LED` instances, which prevents smooth color graduations.
+
+    .. _PiBorg LedBorg: https://www.piborg.org/ledborg
+    """
+
+    def __init__(self, initial_value=(0, 0, 0), pwm=True):
+        super(LedBorg, self).__init__(red=17, green=27, blue=22,
+                                      initial_value=initial_value, pwm=pwm)
+
+
 class PiLiter(LEDBoard):
     """
     Extends :class:`LEDBoard` for the `Ciseco Pi-LITEr`_: a strip of 8 very bright

docs/images/output_device_hierarchy.svg

@@ -18,7 +18,7 @@
 def setup_function(function):
     import gpiozero.devices
     # dirty, but it does the job
-    if function.__name__ in ('test_robot', 'test_ryanteck_robot', 'test_camjam_kit_robot'):
+    if function.__name__ in ('test_robot', 'test_ryanteck_robot', 'test_camjam_kit_robot', 'test_led_borg'):
         gpiozero.devices.pin_factory = MockPWMPin
     else:
         gpiozero.devices.pin_factory = MockPin
@@ -524,6 +524,11 @@ def test_led_bar_graph_pwm_initial_value():
         assert graph.value == -0.5
         assert (pin1.state, pin2.state, pin3.state) == (0, 0.5, 1)
 
+def test_led_borg():
+    pins = [MockPWMPin(n) for n in (17, 27, 22)]
+    with LedBorg() as board:
+        assert [device.pin for device in board._leds] == pins
+
 def test_pi_liter():
     pins = [MockPin(n) for n in (4, 17, 27, 18, 22, 23, 24, 25)]
     with PiLiter() as board: