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 <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-mcp48xx/>`_.
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 <https://circuitpython-mcp48xx.readthedocs.io/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/brushmate/CircuitPython_MCP48XX/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "circuitpython-mcp48xx",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, mcp4801, mcp4811, mcp4821, mcp4802, mcp4812, mcp4822",
"author": null,
"author_email": "Steffen Kreutz <brushmate@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5e/4c/87efd62de2dd4113502865ce98c966a9e5648c2b5c73d6e7007e8dfc3647/circuitpython-mcp48xx-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/circuitpython-mcp48xx/badge/?version=latest\n :target: https://circuitpython-mcp48xx.readthedocs.io/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/brushmate/CircuitPython_MCP48XX/workflows/Build%20CI/badge.svg\n :target: https://github.com/brushmate/CircuitPython_MCP48XX/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython module for the MCP4801, MCP4811, MCP4821, MCP4802, MCP4812, and MCP4822 digital to analog converters.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-mcp48xx/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-mcp48xx\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-mcp48xx\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install circuitpython-mcp48xx\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install mcp48xx\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-mcp48xx.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/brushmate/CircuitPython_MCP48XX/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for the MCP4801, MCP4811, MCP4821, MCP4802, MCP4812, and MCP4822 digital to analog converters.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/brushmate/CircuitPython_MCP48XX"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" mcp4801",
" mcp4811",
" mcp4821",
" mcp4802",
" mcp4812",
" mcp4822"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1fbe66ff9bd1d1067f1c0d78a6b7ec8b0789b34782c169d8a6f3b4aa84247944",
"md5": "60249b320c9d8f6c10540053f2761cbd",
"sha256": "0a399c13536cf271f157724f1e7a074ac7c99a4d03142b6f40fc18291cd113f6"
},
"downloads": -1,
"filename": "circuitpython_mcp48xx-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60249b320c9d8f6c10540053f2761cbd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6398,
"upload_time": "2024-04-11T08:20:18",
"upload_time_iso_8601": "2024-04-11T08:20:18.835896Z",
"url": "https://files.pythonhosted.org/packages/1f/be/66ff9bd1d1067f1c0d78a6b7ec8b0789b34782c169d8a6f3b4aa84247944/circuitpython_mcp48xx-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e4c87efd62de2dd4113502865ce98c966a9e5648c2b5c73d6e7007e8dfc3647",
"md5": "f13389527d0de25a9cd4851862d34c26",
"sha256": "1a707ada553c6ae9ab63eed4680ce6bf242ec4172377c875ed4b1782e52388c5"
},
"downloads": -1,
"filename": "circuitpython-mcp48xx-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f13389527d0de25a9cd4851862d34c26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28596,
"upload_time": "2024-04-11T08:20:20",
"upload_time_iso_8601": "2024-04-11T08:20:20.198516Z",
"url": "https://files.pythonhosted.org/packages/5e/4c/87efd62de2dd4113502865ce98c966a9e5648c2b5c73d6e7007e8dfc3647/circuitpython-mcp48xx-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 08:20:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brushmate",
"github_project": "CircuitPython_MCP48XX",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "circuitpython-mcp48xx"
}
JSON
