diff --git a/.gitignore b/.gitignore index e812720..b799763 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,6 @@ dist **/*.egg-info .vscode *~ +/8x8_enclosure/tm4ext_lasercut_full.svg +/8x8_enclosure/tm4ext_lasercut_full.svg.licence +/8x8_enclosure/trellism4_extended.FCStd diff --git a/README.rst b/README.rst index ebdd87b..a73555b 100644 --- a/README.rst +++ b/README.rst @@ -21,7 +21,7 @@ Introduction :target: https://github.com/psf/black :alt: Code Style: Black -CircuitPython library to extended Adafruit NeotrellisM4 board with two Neotrellis seesaw boards (or more !). +Use Adafruit TrellisM4 Express board as 2 Neotrellis board. You can you use this to extend TrellisM4 with Neotrellis (seesaw) boards. Dependencies @@ -30,6 +30,9 @@ This driver depends on: * `Adafruit CircuitPython `_ * `Bus Device `_ +* `Adafruit Neopixel driver `_ +* `Adafruit Seesaw driver `_ +* `Adafruit Matrix Keypad library `_ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the `Adafruit library and driver bundle `_. @@ -38,7 +41,31 @@ This is easily achieved by downloading the `Adafruit library and driver bundle < Usage Example ============= -See examples directory. +To use Trellis as 2 Neotrellis (seesaw): + +.. code-block:: python3 + + from neotrellism4 import NeoTrellisM4 + trellis_left = NeoTrellisM4() + trellis_right = NeoTrellisM4(left_part=trellis_left) + +To use TrellisM4 tilled with Neotrellis (seesaw): + +.. code-block:: python3 + + from board import SCL, SDA + import busio + from adafruit_neotrellis.neotrellism4 import NeoTrellisM4 + from adafruit_neotrellis.neotrellis import NeoTrellis + from adafruit_neotrellis.multitrellis import MultiTrellis + I2C = busio.I2C(SCL, SDA) + trellim4_left = NeoTrellisM4() + trellim4_right = NeoTrellisM4(left_part=trellim4_left) + trelli = [ + [trellim4_left, trellim4_right], + [NeoTrellis(I2C, False, addr=0x2F), NeoTrellis(I2C, False, addr=0x2E)] + ] + trellis = MultiTrellis(trelli) Contributing