Skip to main content

CircuitPython library for controlling an ADS1x15 ADC.

Project description

Introduction

Documentation Status Discord Build Status

Support for the ADS1x15 series of analog-to-digital converters. Available in 12-bit (ADS1015) and 16-bit (ADS1115) versions.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

Single Ended

import board
import busio
from adafruit_ads1x15.single_ended import ADS1015

i2c = busio.I2C(board.SCL, board.SDA)
adc = ADS1015(i2c)
while True:
    # channel 0
    print(adc[0].value, adc[0].volts)

Differential

import board
import busio
from adafruit_ads1x15.differential import ADS1015

i2c = busio.I2C(board.SCL, board.SDA)
adc = ADS1015(i2c)
while True:
    # channel 0 - channel 1
    print(adc[(0,1)].value, adc[(0,1)].volts)

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ads1x15 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-ads1x15-0.3.1.tar.gz (21.9 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-ads1x15-0.3.1.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-ads1x15-0.3.1.tar.gz
Algorithm Hash digest
SHA256 97ecc791a34f5099485642b155fd6dfb9ad07512c22941aaf67c38b163718ac9
MD5 374648922a5fc6a5e337bd0c301b4635
BLAKE2b-256 7bd249d19867c01c0cfba3f952f8f90d3ad3ea354e0d3b010183c9b6501e3610

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page