From 3bb21c91b5e2faddf2d35730d01b9d407823636c Mon Sep 17 00:00:00 2001 From: Pierrick C Date: Sun, 16 Jun 2019 17:25:20 +0200 Subject: [PATCH] Updated README --- README.rst | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a788cdd..d6d7dac 100644 --- a/README.rst +++ b/README.rst @@ -22,6 +22,9 @@ This driver depends on: * `Adafruit CircuitPython `_ * `Bus Device `_ +* `Adafruit Seesaw helper ` +* `Adafruit MatrixKeypad ` +* `Neopixel ` Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading @@ -58,7 +61,32 @@ To install in a virtual environment in your current project: Usage Example ============= -.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. +To use Trellis as 2 Neotrellis (seesaw): +.. code-block:: python3 + from neotrellism4 import NeoTrellisM4 + + #create the trellis + 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 ============