https://github.com/neradoc/circuitpython_m5stack_unit8

Library for M5Stack's Unit8 Encoder and Unit8 Angle breakouts.
https://github.com/neradoc/circuitpython_m5stack_unit8

Last synced: about 1 month ago
JSON representation

Library for M5Stack's Unit8 Encoder and Unit8 Angle breakouts.

• Host: GitHub
• URL: https://github.com/neradoc/circuitpython_m5stack_unit8
• Owner: Neradoc
• License: mit
• Created: 2023-04-02T16:08:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-04-21T17:20:50.000Z (over 1 year ago)
• Last Synced: 2024-10-09T12:42:56.439Z (2 months ago)
• Language: Python
• Size: 412 KB
• Stars: 2
• Watchers: 2
• 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/m5stack-unit8-for-circuitpython/badge/?version=latest

    :target: https://m5stack-unit8-for-circuitpython.readthedocs.io/

    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/Neradoc/CircuitPython_m5stack_unit8/workflows/Build%20CI/badge.svg

    :target: https://github.com/Neradoc/CircuitPython_m5stack_unit8/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

Library for M5Stack's Unit8 Encoder and Unit8 Angle breakouts.

NOTE: for Circuitpython use in particular, there are no pull-up resistors on those boards, you will need to add them in the circuit.

.. image:: images/m5stack_unit8.jpg

    :alt: Picture of M5Stack Unit8 Angle and Encoder

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

* `Register `_

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 m5stack_unit8

Or the following command to update an existing version:

.. code-block:: shell

    circup update

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.