Add missing dependencies and example

This commit is contained in:
arofarn 2021-06-27 21:31:00 +02:00
parent 04218966a8
commit cae44db0f7
2 changed files with 32 additions and 2 deletions

3
.gitignore vendored
View File

@ -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

View File

@ -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 <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Adafruit Neopixel driver <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel>`_
* `Adafruit Seesaw driver <https://github.com/adafruit/Adafruit_CircuitPython_seesaw>`_
* `Adafruit Matrix Keypad library <https://github.com/adafruit/Adafruit_CircuitPython_MatrixKeypad>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading the `Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
@ -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