This repository has been archived on 2020-10-18. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Pierrick C 4233a8841c Fix Related product list in TOC 2019-06-16 21:33:08 +02:00
docs Fix Related product list in TOC 2019-06-16 21:33:08 +02:00
examples Update README.rst, requirement.txt,... 2019-06-16 17:33:35 +02:00
.gitignore Init commit 2019-06-16 16:32:15 +02:00
.pylintrc Init commit 2019-06-16 16:32:15 +02:00
.readthedocs.yml Init commit 2019-06-16 16:32:15 +02:00
.travis.yml Update config files 2019-06-16 19:15:44 +02:00 Init commit 2019-06-16 16:32:15 +02:00
LICENSE Init commit 2019-06-16 16:32:15 +02:00
README.rst UPdate travis-ci badge 2019-06-16 19:03:07 +02:00 UPdate docstring 2019-06-16 20:51:05 +02:00
requirements.txt Fixed requirement.txt 2019-06-16 18:06:59 +02:00 Update config files 2019-06-16 19:15:44 +02:00



.. image::
    :alt: Documentation Status

.. image::
    :alt: Discord

.. image::
    :alt: Build Status

Use Adafruit TrellisM4 Express board as 2 Neotrellis board. You can you use this to extend TrellisM4 with Neotrellis (seesaw) boards.

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
`the Adafruit library and driver bundle <>`_.

Usage Example

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)


Contributions are welcome! Please read our `Code of Conduct
before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the
`circuitpython-build-tools <>`_ package.

.. code-block:: shell

    python3 -m venv .env
    source .env/bin/activate
    pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

.. code-block:: shell

    source .env/bin/activate

Then run the build:

.. code-block:: shell

    circuitpython-build-bundles --filename_prefix circuitpython-circuitpython-neotrellism4 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):

.. code-block:: shell

    python3 -m venv .env
    source .env/bin/activate
    pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

.. code-block:: shell

    cd docs
    sphinx-build -E -W -b html . _build/html

This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.