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.5.0.tar.gz (22.0 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: adafruit-circuitpython-ads1x15-0.5.0.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3

File hashes

Hashes for adafruit-circuitpython-ads1x15-0.5.0.tar.gz
Algorithm Hash digest
SHA256 4a341523af2781c865d4358237a82e1c5cf38cb345dd6cdc50fab132b3f6b7a7
MD5 2e11bf667d9c720fa7db820edff1c7fb
BLAKE2b-256 4354f45a08f75791b1a5e35da2f827982b6fb57297c9c076b1c056c2679d991f

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