Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mcp3421/badge/?version=latest
:target: https://docs.circuitpython.org/projects/mcp3421/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MCP3421/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MCP3421/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 driver for the MCP3421 analog to digital converter
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>`_.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5870>`_
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-mcp3421/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-mcp3421
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-mcp3421
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 adafruit-circuitpython-mcp3421
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 adafruit_mcp3421
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python3
import time
import board
import adafruit_mcp3421.mcp3421 as ADC
from adafruit_mcp3421.analog_in import AnalogIn
i2c = board.I2C()
adc = ADC.MCP3421(i2c)
adc_channel = AnalogIn(adc)
while True:
print((adc_channel.value,))
time.sleep(0.01)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mcp3421/en/latest/>`_.
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/adafruit/Adafruit_CircuitPython_MCP3421/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-mcp3421",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, mcp3421, ADC",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/64/7b/ef5e5c0af955b9972193983765d234a533088d1bb7cbccd534afd1f3da74/adafruit_circuitpython_mcp3421-1.1.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mcp3421/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/mcp3421/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MCP3421/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MCP3421/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 driver for the MCP3421 analog to digital converter\n\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\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5870>`_\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/adafruit-circuitpython-mcp3421/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-mcp3421\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-mcp3421\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 adafruit-circuitpython-mcp3421\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 adafruit_mcp3421\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.. code-block:: python3\n\n import time\n import board\n import adafruit_mcp3421.mcp3421 as ADC\n from adafruit_mcp3421.analog_in import AnalogIn\n\n i2c = board.I2C()\n\n adc = ADC.MCP3421(i2c)\n adc_channel = AnalogIn(adc)\n\n while True:\n print((adc_channel.value,))\n time.sleep(0.01)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mcp3421/en/latest/>`_.\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/adafruit/Adafruit_CircuitPython_MCP3421/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for the MCP3421 analog to digital converter",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MCP3421"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" mcp3421",
" adc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0032e3264a63d73d0606ee3742068098ac6bf7407b91479ca0db60098c89caac",
"md5": "0b158ed8e96e1a5453828397603e6c56",
"sha256": "ef0ef39ed2520df67c5d68cad663e1c942ec01a74b8e314ac18b7b40ab2410af"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mcp3421-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b158ed8e96e1a5453828397603e6c56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6849,
"upload_time": "2024-10-07T22:13:02",
"upload_time_iso_8601": "2024-10-07T22:13:02.960407Z",
"url": "https://files.pythonhosted.org/packages/00/32/e3264a63d73d0606ee3742068098ac6bf7407b91479ca0db60098c89caac/adafruit_circuitpython_mcp3421-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "647bef5e5c0af955b9972193983765d234a533088d1bb7cbccd534afd1f3da74",
"md5": "490c4df5737a1e68bca3659fa6052f41",
"sha256": "99a19b740dc07d426f838cab9de939f22a0b9a40e529ac0c08df06d464625888"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mcp3421-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "490c4df5737a1e68bca3659fa6052f41",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28115,
"upload_time": "2024-10-07T22:13:05",
"upload_time_iso_8601": "2024-10-07T22:13:05.522971Z",
"url": "https://files.pythonhosted.org/packages/64/7b/ef5e5c0af955b9972193983765d234a533088d1bb7cbccd534afd1f3da74/adafruit_circuitpython_mcp3421-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:13:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MCP3421",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-mcp3421"
}
JSON
