Skip to main content

CircuitPython library for controlling a SeeSaw helper chip.

Project description

Introduction

Documentation Status Discord Build Status

CircuitPython module for use with the Adafruit ATSAMD09 seesaw.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

See examples/seesaw_simpletest.py for usage example.

Contributing

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

Building locally

To build this library locally you’ll need to install the circuitpython-build-tools package.

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

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

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-seesaw --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):

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

Now, once you have the virtual environment activated:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-seesaw-1.2.2.tar.gz (25.0 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-seesaw-1.2.2.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-seesaw-1.2.2.tar.gz
Algorithm Hash digest
SHA256 1ab34e45cb3447fabac4bb05bba97b7580c6787bf8b49ffacf383c4d2f46dae7
MD5 64fc28a8019ec509f752475e005eb6fb
BLAKE2b-256 20a7c09e1ff4617c7caf5a5bc453f48fcf4bc9cec234f779c08002f40731f0c2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page