add brightness property; update examples; format with black

Author: CedarGroveStudios

adafruit_neotrellis/multitrellis.py

@@ -1,16 +1,37 @@
-# SPDX-FileCopyrightText: 2018 Dean Miller for Adafruit Industries
+# SPDX-FileCopyrightText: 2021 Dean Miller for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
 """
-Interface for connecting together multiple NeoTrellis boards.
-"""
+``adafruit_multitrellis``
+====================================================
+
+A CircuitPython driver class for interfacing clusters of 4x4 NeoTrellis with
+elastomer buttons and NeoPixel RGB LEDs.
+
+* Author(s): Dean Miller, JG for CedarGroveMakerStudios
+
+Implementation Notes
+--------------------
+
+**Hardware:**
 
-# imports
+* 'NeoTrellis RGB Driver PCB for 4x4 Keypad, PID: 3954
+  <https://www.adafruit.com/product/3954>'
 
-__version__ = "1.1.8"
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://github.com/adafruit/circuitpython/releases
+
+* Adafruit Seesaw CircuitPython library
+  https://github.com/adafruit/Adafruit_CircuitPython_seesaw/releases
+"""
+
+__version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_neotrellis.git"
 
+
 from time import sleep
 from micropython import const
 from adafruit_seesaw.keypad import KeyEvent
@@ -81,11 +102,14 @@ def sync(self):
 
     @property
     def brightness(self):
+        """The NeoPixel brightness level of all clustered NeoTrellis boards."""
         return self.brightness
 
     @brightness.setter
     def brightness(self, new_brightness):
+        """Select a NeoPixel brightness level for all all clustered boards. A
+        valid brightness value is in the range of 0.0 to 1.0."""
         self._brightness = new_brightness
         for _r in range(self._rows):
-            for _c in range (self._cols):
+            for _c in range(self._cols):
                 self._trelli[_r][_c].brightness = self._brightness

adafruit_neotrellis/neotrellis.py

@@ -1,12 +1,13 @@
-# SPDX-FileCopyrightText: 2018 Dean Miller for Adafruit Industries
+# SPDX-FileCopyrightText: 2021 Dean Miller for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
 """
 ``adafruit_neotrellis``
 ====================================================
 
-4x4 elastomer buttons and RGB LEDs
+A CircuitPython driver class for the 4x4 NeoTrellis with elastomer buttons and
+NeoPixel RGB LEDs.
 
 * Author(s): Dean Miller, JG for CedarGroveMakerStudios
 
@@ -15,6 +16,9 @@
 
 **Hardware:**
 
+* 'NeoTrellis RGB Driver PCB for 4x4 Keypad, PID: 3954
+  <https://www.adafruit.com/product/3954>'
+
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
@@ -24,9 +28,7 @@
   https://github.com/adafruit/Adafruit_CircuitPython_seesaw/releases
 """
 
-# imports
-
-__version__ = "1.1.8"
+__version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_neotrellis.git"
 
 from time import sleep
@@ -54,14 +56,26 @@ def _seesaw_key(xval):
 
 
 class NeoTrellis(Keypad):
-    """Driver for the Adafruit NeoTrellis."""
-
-    def __init__(self, i2c_bus, interrupt=False, addr=_NEO_TRELLIS_ADDR, drdy=None, brightness=1.0):
+    """Driver for the Adafruit 4x4 NeoTrellis."""
+
+    def __init__(
+        self,
+        i2c_bus,
+        interrupt=False,
+        addr=_NEO_TRELLIS_ADDR,
+        drdy=None,
+        brightness=1.0,
+    ):
         super().__init__(i2c_bus, addr, drdy)
         self.interrupt_enabled = interrupt
         self._brightness = brightness
         self.callbacks = [None] * _NEO_TRELLIS_NUM_KEYS
-        self.pixels = NeoPixel(self, _NEO_TRELLIS_NEOPIX_PIN, _NEO_TRELLIS_NUM_KEYS, brightness=self._brightness)
+        self.pixels = NeoPixel(
+            self,
+            _NEO_TRELLIS_NEOPIX_PIN,
+            _NEO_TRELLIS_NUM_KEYS,
+            brightness=self._brightness,
+        )
 
     def activate_key(self, key, edge, enable=True):
         """Activate or deactivate a key on the trellis. Key is the key number from
@@ -89,9 +103,12 @@ def sync(self):
 
     @property
     def brightness(self):
+        """The NeoPixel brightness level of the board."""
         return self._brightness
 
     @brightness.setter
     def brightness(self, new_brightness):
+        """Select a NeoPixel brightness level for the board. A valid brightness
+        value is in the range of 0.0 to 1.0."""
         self._brightness = new_brightness
         self.pixels.brightness = self._brightness

examples/neotrellis_multitrellis_simpletest.py

@@ -22,7 +22,7 @@
 trelli = [
     [NeoTrellis(i2c_bus, False, addr=0x2E), NeoTrellis(i2c_bus, False, addr=0x2F)],
     [NeoTrellis(i2c_bus, False, addr=0x30), NeoTrellis(i2c_bus, False, addr=0x31)],
-    ]
+]
 
 trellis = MultiTrellis(trelli)