Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mcp3xxx/badge/?version=latest
:target: https://docs.circuitpython.org/projects/mcp3xxx/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_MCP3xxx/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MCP3xxx/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 library for the MCP3xxx series of analog-to-digital converters.
Currently supports:
* `MCP3008: 8-Channel 10-Bit ADC With SPI Interface <https://www.adafruit.com/product/856>`_
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-mcp3xxx/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-mcp3xxx
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-mcp3xxx
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-mcp3xxx
Usage Example
=============
MCP3008 Single Ended
---------------------
.. code-block:: python
import busio
import digitalio
import board
import adafruit_mcp3xxx.mcp3008 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn
# create the spi bus
spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)
# create the cs (chip select)
cs = digitalio.DigitalInOut(board.D5)
# create the mcp object
mcp = MCP.MCP3008(spi, cs)
# create an analog input channel on pin 0
chan = AnalogIn(mcp, MCP.P0)
print('Raw ADC Value: ', chan.value)
print('ADC Voltage: ' + str(chan.voltage) + 'V')
MCP3008 Differential
--------------------
.. code-block:: python
import busio
import digitalio
import board
import adafruit_mcp3xxx.mcp3008 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn
# create the spi bus
spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)
# create the cs (chip select)
cs = digitalio.DigitalInOut(board.D5)
# create the mcp object
mcp = MCP.MCP3008(spi, cs)
# create a differential ADC channel between Pin 0 and Pin 1
chan = AnalogIn(mcp, MCP.P0, MCP.P1)
print('Differential ADC Value: ', chan.value)
print('Differential ADC Voltage: ' + str(chan.voltage) + 'V')
MCP3004 Single-Ended
---------------------
.. code-block:: python
import busio
import digitalio
import board
import adafruit_mcp3xxx.mcp3004 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn
# create the spi bus
spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)
# create the cs (chip select)
cs = digitalio.DigitalInOut(board.D5)
# create the mcp object
mcp = MCP.MCP3004(spi, cs)
# create an analog input channel on pin 0
chan = AnalogIn(mcp, MCP.P0)
print('Raw ADC Value: ', chan.value)
print('ADC Voltage: ' + str(chan.voltage) + 'V')
MCP3004 Differential
--------------------
.. code-block:: python
import busio
import digitalio
import board
import adafruit_mcp3xxx.mcp3004 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn
# create the spi bus
spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)
# create the cs (chip select)
cs = digitalio.DigitalInOut(board.D5)
# create the mcp object
mcp = MCP.MCP3004(spi, cs)
# create a differential ADC channel between Pin 0 and Pin 1
chan = AnalogIn(mcp, MCP.P0, MCP.P1)
print('Differential ADC Value: ', chan.value)
print('Differential ADC Voltage: ' + str(chan.voltage) + 'V')
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mcp3xxx/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_MCP3xxx/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-mcp3xxx",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,mcp3xxx,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/1a/a0/ace29395eee9d67c69efd91786b8657b6b910e197a1b01a4f0cd239f0cd7/adafruit-circuitpython-mcp3xxx-1.4.15.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mcp3xxx/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/mcp3xxx/en/latest/\n :alt: Documentation Status\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.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MCP3xxx/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MCP3xxx/actions/\n :alt: Build Status\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 library for the MCP3xxx series of analog-to-digital converters.\n\nCurrently supports:\n\n* `MCP3008: 8-Channel 10-Bit ADC With SPI Interface <https://www.adafruit.com/product/856>`_\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-mcp3xxx/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-mcp3xxx\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-mcp3xxx\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 .venv/bin/activate\n pip3 install adafruit-circuitpython-mcp3xxx\n\nUsage Example\n=============\n\n\nMCP3008 Single Ended\n---------------------\n\n.. code-block:: python\n\n import busio\n import digitalio\n import board\n import adafruit_mcp3xxx.mcp3008 as MCP\n from adafruit_mcp3xxx.analog_in import AnalogIn\n\n # create the spi bus\n spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)\n\n # create the cs (chip select)\n cs = digitalio.DigitalInOut(board.D5)\n\n # create the mcp object\n mcp = MCP.MCP3008(spi, cs)\n\n # create an analog input channel on pin 0\n chan = AnalogIn(mcp, MCP.P0)\n\n print('Raw ADC Value: ', chan.value)\n print('ADC Voltage: ' + str(chan.voltage) + 'V')\n\n\nMCP3008 Differential\n--------------------\n\n.. code-block:: python\n\n import busio\n import digitalio\n import board\n import adafruit_mcp3xxx.mcp3008 as MCP\n from adafruit_mcp3xxx.analog_in import AnalogIn\n\n # create the spi bus\n spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)\n\n # create the cs (chip select)\n cs = digitalio.DigitalInOut(board.D5)\n\n # create the mcp object\n mcp = MCP.MCP3008(spi, cs)\n\n # create a differential ADC channel between Pin 0 and Pin 1\n chan = AnalogIn(mcp, MCP.P0, MCP.P1)\n\n print('Differential ADC Value: ', chan.value)\n print('Differential ADC Voltage: ' + str(chan.voltage) + 'V')\n\nMCP3004 Single-Ended\n---------------------\n\n.. code-block:: python\n\n import busio\n import digitalio\n import board\n import adafruit_mcp3xxx.mcp3004 as MCP\n from adafruit_mcp3xxx.analog_in import AnalogIn\n\n # create the spi bus\n spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)\n\n # create the cs (chip select)\n cs = digitalio.DigitalInOut(board.D5)\n\n # create the mcp object\n mcp = MCP.MCP3004(spi, cs)\n\n # create an analog input channel on pin 0\n chan = AnalogIn(mcp, MCP.P0)\n\n print('Raw ADC Value: ', chan.value)\n print('ADC Voltage: ' + str(chan.voltage) + 'V')\n\nMCP3004 Differential\n--------------------\n\n.. code-block:: python\n\n import busio\n import digitalio\n import board\n import adafruit_mcp3xxx.mcp3004 as MCP\n from adafruit_mcp3xxx.analog_in import AnalogIn\n\n # create the spi bus\n spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)\n\n # create the cs (chip select)\n cs = digitalio.DigitalInOut(board.D5)\n\n # create the mcp object\n mcp = MCP.MCP3004(spi, cs)\n\n # create a differential ADC channel between Pin 0 and Pin 1\n chan = AnalogIn(mcp, MCP.P0, MCP.P1)\n\n print('Differential ADC Value: ', chan.value)\n print('Differential ADC Voltage: ' + str(chan.voltage) + 'V')\n\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mcp3xxx/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/adafruit_CircuitPython_MCP3xxx/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for the MCP3xxx Analog-to-Digital converters.",
"version": "1.4.15",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MCP3xxx"
},
"split_keywords": [
"adafruit",
"mcp3xxx",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa15d7fd6800a980b51a3ae0474263e7f0f9d05863f01377c187e258d549ee79",
"md5": "db8b87938bcdf4a62f78879ad15bb770",
"sha256": "fb47208bafb77be9a872f1d8161171fec01989f875e7bcf5fe9dc77b37b5e978"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mcp3xxx-1.4.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db8b87938bcdf4a62f78879ad15bb770",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9701,
"upload_time": "2023-06-06T19:40:45",
"upload_time_iso_8601": "2023-06-06T19:40:45.939597Z",
"url": "https://files.pythonhosted.org/packages/fa/15/d7fd6800a980b51a3ae0474263e7f0f9d05863f01377c187e258d549ee79/adafruit_circuitpython_mcp3xxx-1.4.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1aa0ace29395eee9d67c69efd91786b8657b6b910e197a1b01a4f0cd239f0cd7",
"md5": "7befd1f7fc50fe9630532f1375dad17b",
"sha256": "525185ea40b213c1d5c6d503a26b8bd883e7e0ab963cbff7e6261e6a8ecf1fb3"
},
"downloads": -1,
"filename": "adafruit-circuitpython-mcp3xxx-1.4.15.tar.gz",
"has_sig": false,
"md5_digest": "7befd1f7fc50fe9630532f1375dad17b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28437,
"upload_time": "2023-06-06T19:40:47",
"upload_time_iso_8601": "2023-06-06T19:40:47.751067Z",
"url": "https://files.pythonhosted.org/packages/1a/a0/ace29395eee9d67c69efd91786b8657b6b910e197a1b01a4f0cd239f0cd7/adafruit-circuitpython-mcp3xxx-1.4.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-06 19:40:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MCP3xxx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-mcp3xxx"
}
JSON
