Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ads1x15/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ads1x15/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_ADS1x15/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15/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
Support for the ADS1x15 series of analog-to-digital converters. Available in 12-bit (ADS1015)
and 16-bit (ADS1115) versions.
Installation & 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 can be most easily achieved by downloading and installing
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_ on
your device.
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-ads1x15/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ads1x15
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ads1x15
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-ads1x15
Usage Example
=============
Single Ended
------------
.. code-block:: python
import time
import board
import busio
import adafruit_ads1x15.ads1015 as ADS
from adafruit_ads1x15.analog_in import AnalogIn
# Create the I2C bus
i2c = busio.I2C(board.SCL, board.SDA)
# Create the ADC object using the I2C bus
ads = ADS.ADS1015(i2c)
# Create single-ended input on channel 0
chan = AnalogIn(ads, ADS.P0)
# Create differential input between channel 0 and 1
#chan = AnalogIn(ads, ADS.P0, ADS.P1)
print("{:>5}\t{:>5}".format('raw', 'v'))
while True:
print("{:>5}\t{:>5.3f}".format(chan.value, chan.voltage))
time.sleep(0.5)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ads1x15/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_ADS1x15/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ads1x15",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, ads1x115, adc, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/4a/5f/26347bec841659f094538df3d7965cd97348e9f7ded0489f09be9f22f19e/adafruit_circuitpython_ads1x15-2.4.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ads1x15/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ads1x15/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_ADS1x15/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15/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\nSupport for the ADS1x15 series of analog-to-digital converters. Available in 12-bit (ADS1015)\nand 16-bit (ADS1115) versions.\n\nInstallation & Dependencies\n===========================\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 can be most easily achieved by downloading and installing\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_ on\nyour device.\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-ads1x15/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ads1x15\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ads1x15\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-ads1x15\n\nUsage Example\n=============\n\nSingle Ended\n------------\n\n.. code-block:: python\n\n import time\n import board\n import busio\n import adafruit_ads1x15.ads1015 as ADS\n from adafruit_ads1x15.analog_in import AnalogIn\n\n # Create the I2C bus\n i2c = busio.I2C(board.SCL, board.SDA)\n\n # Create the ADC object using the I2C bus\n ads = ADS.ADS1015(i2c)\n\n # Create single-ended input on channel 0\n chan = AnalogIn(ads, ADS.P0)\n\n # Create differential input between channel 0 and 1\n #chan = AnalogIn(ads, ADS.P0, ADS.P1)\n\n print(\"{:>5}\\t{:>5}\".format('raw', 'v'))\n\n while True:\n print(\"{:>5}\\t{:>5.3f}\".format(chan.value, chan.voltage))\n time.sleep(0.5)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ads1x15/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_ADS1x15/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for controlling an ADS1x15 ADC.",
"version": "2.4.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15"
},
"split_keywords": [
"adafruit",
" ads1x115",
" adc",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e94200e0fe8f626206e1817d83b0f544153f4988dcd6070d2f66a994d779f1f9",
"md5": "a0cd86ba261dea01a93dc6ff8d181c53",
"sha256": "385cee707ed85445061988eb8c9ca181060eb4ea2d5b4f8c3c4d9cc025261950"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ads1x15-2.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0cd86ba261dea01a93dc6ff8d181c53",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11296,
"upload_time": "2024-10-07T21:34:42",
"upload_time_iso_8601": "2024-10-07T21:34:42.108377Z",
"url": "https://files.pythonhosted.org/packages/e9/42/00e0fe8f626206e1817d83b0f544153f4988dcd6070d2f66a994d779f1f9/adafruit_circuitpython_ads1x15-2.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a5f26347bec841659f094538df3d7965cd97348e9f7ded0489f09be9f22f19e",
"md5": "d223c18e33bfbfd594f2a7ef92dc87e8",
"sha256": "0c8177f2d501d1bd7563d91b3d93a249ed1cd4989f2576aacd204b1084742929"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ads1x15-2.4.1.tar.gz",
"has_sig": false,
"md5_digest": "d223c18e33bfbfd594f2a7ef92dc87e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33557,
"upload_time": "2024-10-07T21:34:42",
"upload_time_iso_8601": "2024-10-07T21:34:42.984656Z",
"url": "https://files.pythonhosted.org/packages/4a/5f/26347bec841659f094538df3d7965cd97348e9f7ded0489f09be9f22f19e/adafruit_circuitpython_ads1x15-2.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 21:34:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_ADS1x15",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ads1x15"
}
JSON
