Split library into package and adapt examples+doc

Author: dglaude

README.rst

@@ -66,23 +66,23 @@ Matrix:
 
 .. code:: python
 
-    import adafruit_is31fl3731
+    from adafruit_is31fl3731 import Matrix
     import board
     import busio
     with busio.I2C(board.SCL, board.SDA) as i2c:
-        display = adafruit_is31fl3731.Matrix(i2c)
+        display = Matrix(i2c)
         display.fill(127)
 
 
 Charlie Wing:
 
 .. code:: python
 
-    import adafruit_is31fl3731
+    from adafruit_is31fl3731.CharlieWing import CharlieWing
     import board
     import busio
     with busio.I2C(board.SCL, board.SDA) as i2c:
-        display = adafruit_is31fl3731.CharlieWing(i2c)
+        display = CharlieWing(i2c)
         display.fill(127)
 
         # Turn off pixel 4,4, change its brightness and turn it back on

adafruit_is31fl3731/CharlieBonnet.py

@@ -0,0 +1,64 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Tony DiCola
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+`adafruit_is31fl3731`
+====================================================
+
+CircuitPython driver for the IS31FL3731 charlieplex IC.
+
+
+* Author(s): Tony DiCola, Melissa LeBlanc-Williams
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit 16x9 Charlieplexed PWM LED Matrix Driver - IS31FL3731
+  <https://www.adafruit.com/product/2946>`_
+
+* `Adafruit 15x7 CharliePlex LED Matrix Display FeatherWings
+  <https://www.adafruit.com/product/2965>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware (2.2.0+) for the ESP8622 and M0-based boards:
+  https://github.com/adafruit/circuitpython/releases
+"""
+
+# imports
+from . import Matrix
+
+
+class CharlieBonnet(Matrix):
+    """Supports the Charlieplexed bonnet"""
+
+    width = 16
+    height = 8
+
+    @staticmethod
+    def pixel_addr(x, y):
+        """Calulate the offset into the device array for x,y pixel"""
+        if x >= 8:
+            return (x - 6) * 16 - (y + 1)
+        return (x + 1) * 16 + (7 - y)

adafruit_is31fl3731/CharlieWing.py

@@ -0,0 +1,69 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Tony DiCola
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+`adafruit_is31fl3731`
+====================================================
+
+CircuitPython driver for the IS31FL3731 charlieplex IC.
+
+
+* Author(s): Tony DiCola, Melissa LeBlanc-Williams
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit 16x9 Charlieplexed PWM LED Matrix Driver - IS31FL3731
+  <https://www.adafruit.com/product/2946>`_
+
+* `Adafruit 15x7 CharliePlex LED Matrix Display FeatherWings
+  <https://www.adafruit.com/product/2965>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware (2.2.0+) for the ESP8622 and M0-based boards:
+  https://github.com/adafruit/circuitpython/releases
+"""
+
+# imports
+from . import Matrix
+
+
+class CharlieWing(Matrix):
+    """Supports the Charlieplexed feather wing
+    """
+
+    width = 15
+    height = 7
+
+    @staticmethod
+    def pixel_addr(x, y):
+        """Calulate the offset into the device array for x,y pixel
+        """
+        if x > 7:
+            x = 15 - x
+            y += 8
+        else:
+            y = 7 - y
+        return x * 16 + y

adafruit_is31fl3731/LedShim.py

@@ -0,0 +1,132 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Tony DiCola
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+`adafruit_is31fl3731.LedShim`
+====================================================
+
+CircuitPython driver for the IS31FL3731 charlieplex IC.
+
+
+* Author: David Glaude
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Pimoroni 28 RGB Led Shim
+  <https://www.adafruit.com/product/3831>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware:
+  https://github.com/adafruit/circuitpython/releases
+"""
+
+# imports
+from . import Matrix
+
+
+class LedShim(Matrix):
+    """Supports the LED SHIM by Pimoroni"""
+
+    width = 28
+    height = 3
+
+    def __init__(self, i2c, address=0x75):
+        super().__init__(i2c, address)
+
+    # pylint: disable-msg=too-many-arguments
+    def pixelrgb(self, x, r, g, b, blink=None, frame=None):
+        """
+        Blink or brightness for x-pixel
+
+        :param x: horizontal pixel position
+        :param r: red brightness value 0->255
+        :param g: green brightness value 0->255
+        :param b: blue brightness value 0->255
+        :param blink: True to blink
+        :param frame: the frame to set the pixel
+        """
+        super().pixel(x, 0, r, blink, frame)
+        super().pixel(x, 1, g, blink, frame)
+        super().pixel(x, 2, b, blink, frame)
+
+        # pylint: disable=inconsistent-return-statements
+        # pylint: disable=too-many-return-statements
+        # pylint: disable=too-many-branches
+
+    @staticmethod
+    def pixel_addr(x, y):
+        """Translate an x,y coordinate to a pixel index."""
+        if y == 0:
+            if x < 7:
+                return 118 - x
+            if x < 15:
+                return 141 - x
+            if x < 21:
+                return 106 + x
+            if x == 21:
+                return 15
+            return x - 14
+
+        if y == 1:
+            if x < 2:
+                return 69 - x
+            if x < 7:
+                return 86 - x
+            if x < 12:
+                return 28 - x
+            if x < 14:
+                return 45 - x
+            if x == 14:
+                return 47
+            if x == 15:
+                return 41
+            if x < 21:
+                return x + 9
+            if x == 21:
+                return 95
+            if x < 26:
+                return x + 67
+            return x + 50
+
+        if x == 0:
+            return 85
+        if x < 7:
+            return 102 - x
+        if x < 11:
+            return 44 - x
+        if x < 14:
+            return 61 - x
+        if x == 14:
+            return 63
+        if x < 17:
+            return 42 + x
+        if x < 21:
+            return x + 25
+        if x == 21:
+            return 111
+        if x < 27:
+            return x + 83
+        return 93

adafruit_is31fl3731/ScrollPhatHD.py

@@ -0,0 +1,65 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Tony DiCola
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+`adafruit_is31fl3731.ScrollPhatHD`
+====================================================
+
+CircuitPython driver for the Pimoroni 17x7 Scroll pHAT HD.
+
+
+* Author: David Glaude
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Pimoroni 17x7 Scroll pHAT HD
+  <https://www.adafruit.com/product/3473>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware:
+  https://github.com/adafruit/circuitpython/releases
+"""
+
+# imports
+from . import Matrix
+
+
+class ScrollPhatHD(Matrix):
+    """Supports the Scroll pHAT HD by Pimoroni"""
+
+    width = 17
+    height = 7
+
+    @staticmethod
+    def pixel_addr(x, y):
+        """Translate an x,y coordinate to a pixel index."""
+        if x <= 8:
+            x = 8 - x
+            y = 6 - y
+        else:
+            x = x - 8
+            y = y - 8
+        return x * 16 + y