https://github.com/todbot/circuitpython_synthhardware
Tools and libraries for todbot synth toys
https://github.com/todbot/circuitpython_synthhardware
Last synced: 3 months ago
JSON representation
Tools and libraries for todbot synth toys
- Host: GitHub
- URL: https://github.com/todbot/circuitpython_synthhardware
- Owner: todbot
- License: mit
- Created: 2023-10-11T19:56:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-11T22:59:08.000Z (almost 3 years ago)
- Last Synced: 2025-12-27T03:40:51.239Z (7 months ago)
- Language: Python
- Size: 37.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-synthhardware/badge/?version=latest
:target: https://circuitpython-synthhardware.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/todbot/CircuitPython_SynthHardware/workflows/Build%20CI/badge.svg
:target: https://github.com/todbot/CircuitPython_SynthHardware/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
Hardware abstraction libraries for todbot synth toys
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle `_
or individual libraries can be installed using
`circup `_.
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install synthhardware
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
Documentation
=============
API documentation for this library can be found on `Read the Docs `_.
For information on building library documentation, please check out
`this guide `_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.