Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brushmate/circuitpython_mcp48xx

CircuitPython module for the MCP4801, MCP4811, MCP4821, MCP4802, MCP4812, and MCP4822 digital to analog converters.
https://github.com/brushmate/circuitpython_mcp48xx

circuitpython

Last synced: 14 days ago
JSON representation

CircuitPython module for the MCP4801, MCP4811, MCP4821, MCP4802, MCP4812, and MCP4822 digital to analog converters.

Awesome Lists containing this project

README

        

Introduction
============

.. image:: https://readthedocs.org/projects/circuitpython-mcp48xx/badge/?version=latest
:target: https://circuitpython-mcp48xx.readthedocs.io/
:alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord

.. image:: https://github.com/brushmate/CircuitPython_MCP48XX/workflows/Build%20CI/badge.svg
:target: https://github.com/brushmate/CircuitPython_MCP48XX/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

CircuitPython module for the MCP4801, MCP4811, MCP4821, MCP4802, MCP4812, and MCP4822 digital to analog converters.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython `_
* `Bus Device `_

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 from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI `_.
To install for current user:

.. code-block:: shell

pip3 install circuitpython-mcp48xx

To install system-wide (this may be required in some cases):

.. code-block:: shell

sudo pip3 install circuitpython-mcp48xx

To install in a virtual environment in your current project:

.. code-block:: shell

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-mcp48xx

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 mcp48xx

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.