# SPDX-FileCopyrightText: 2018 Carter Nelson for Adafruit Industries
#
# SPDX-License-Identifier: MIT
"""
`ads1x15`
====================================================
CircuitPython base class driver for ADS1015/1115 ADCs.
* Author(s): Carter Nelson
"""
__version__ = "0.0.0+auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15.git"
import time
from adafruit_bus_device.i2c_device import I2CDevice
from micropython import const
try:
from typing import Dict, List, Optional
from busio import I2C
except ImportError:
pass
_ADS1X15_DEFAULT_ADDRESS = const(0x48)
_ADS1X15_POINTER_CONVERSION = const(0x00)
_ADS1X15_POINTER_CONFIG = const(0x01)
_ADS1X15_POINTER_LO_THRES = const(0x02)
_ADS1X15_POINTER_HI_THRES = const(0x03)
_ADS1X15_CONFIG_OS_SINGLE = const(0x8000)
_ADS1X15_CONFIG_MUX_OFFSET = const(12)
_ADS1X15_CONFIG_COMP_QUEUE = {
0: 0x0003,
1: 0x0000,
2: 0x0001,
4: 0x0002,
}
_ADS1X15_CONFIG_GAIN = {
2 / 3: 0x0000,
1: 0x0200,
2: 0x0400,
4: 0x0600,
8: 0x0800,
16: 0x0A00,
}
[docs]
class Pin:
"""An enum-like class representing possible ADC pins."""
A0 = 0
"""Analog Pin 0"""
A1 = 1
"""Analog Pin 1"""
A2 = 2
"""Analog Pin 2"""
A3 = 3
"""Analog Pin 3"""
[docs]
class Mode:
"""An enum-like class representing possible ADC operating modes."""
# See datasheet "Operating Modes" section
# values here are masks for setting MODE bit in Config Register
CONTINUOUS = 0x0000
"""Continuous Mode"""
SINGLE = 0x0100
"""Single-Shot Mode"""
[docs]
class Comp_Mode:
"""An enum-like class representing possible ADC Comparator operating modes."""
# See datasheet "Operating Modes" section
# values here are masks for setting COMP_MODE bit in Config Register
TRADITIONAL = 0x0000
"""Traditional Compartor Mode activates above high threshold, de-activates below low"""
WINDOW = 0x0010
"""Window Comparator Mode activates when reading is outside of high and low thresholds"""
[docs]
class Comp_Polarity:
"""An enum-like class representing possible ADC Comparator polarity modes."""
# See datasheet "Operating Modes" section
# values here are masks for setting COMP_POL bit in Config Register
ACTIVE_LOW = 0x0000
"""ALERT_RDY pin is LOW when comparator is active"""
ACTIVE_HIGH = 0x0008
"""ALERT_RDY pin is HIGH when comparator is active"""
[docs]
class Comp_Latch:
"""An enum-like class representing possible ADC Comparator latching modes."""
# See datasheet "Operating Modes" section
# values here are masks for setting COMP_LAT bit in Config Register
NONLATCHING = 0x0000
"""ALERT_RDY pin does not latch when asserted"""
LATCHING = 0x0004
"""ALERT_RDY pin remains asserted until data is read by controller"""
[docs]
class ADS1x15:
"""Base functionality for ADS1x15 analog to digital converters.
:param ~busio.I2C i2c: The I2C bus the device is connected to.
:param float gain: The ADC gain.
:param int data_rate: The data rate for ADC conversion in samples per second.
Default value depends on the device.
:param Mode mode: The conversion mode, defaults to `Mode.SINGLE`.
:param int comparator_queue_length: The number of successive conversions exceeding
the comparator threshold before asserting ALERT/RDY pin.
Defaults to 0 (comparator function disabled).
:param int comparator_low_threshold: Voltage limit under which comparator de-asserts
ALERT/RDY pin. Must be lower than high threshold to use comparator
function. Range of -32768 to 32767, default -32768
:param int comparator_high_threshold: Voltage limit over which comparator asserts
ALERT/RDY pin. Must be higher than low threshold to use comparator
function. Range of -32768 to 32767, default 32767
:param Comp_Mode comparator_mode: Configures the comparator as either traditional or window.
Defaults to 'Comp_Mode.TRADITIONAL'
:param Comp_Polarity comparator_polarity: Configures the comparator output as either active
low or active high. Defaults to 'Comp_Polarity.ACTIVE_LOW'
:param Comp_Latch comparator_latch: Configures the comparator output to only stay asserted while
readings exceed threshold or latch on assertion until data is read.
Defaults to 'Comp_Latch.NONLATCHING'
:param int address: The I2C address of the device.
"""
def __init__(
self,
i2c: "I2C",
gain: float = 1,
data_rate: Optional[int] = None,
mode: int = Mode.SINGLE,
comparator_queue_length: int = 0,
comparator_low_threshold: int = -32768,
comparator_high_threshold: int = 32767,
comparator_mode: int = Comp_Mode.TRADITIONAL,
comparator_polarity: int = Comp_Polarity.ACTIVE_LOW,
comparator_latch: int = Comp_Latch.NONLATCHING,
address: int = _ADS1X15_DEFAULT_ADDRESS,
):
self._last_pin_read = None
self.buf = bytearray(3)
self.initialized = False # Prevents writing to ADC until all values are initialized
self.i2c_device = I2CDevice(i2c, address)
self.gain = gain
self.data_rate = self._data_rate_default() if data_rate is None else data_rate
self.mode = mode
self.comparator_queue_length = comparator_queue_length
self.comparator_low_threshold = comparator_low_threshold
self.comparator_high_threshold = comparator_high_threshold
self.comparator_mode = comparator_mode
self.comparator_polarity = comparator_polarity
self.comparator_latch = comparator_latch
self.initialized = True
self._write_config()
@property
def bits(self) -> int:
"""The ADC bit resolution."""
raise NotImplementedError("Subclass must implement bits property.")
@property
def data_rate(self) -> int:
"""The data rate for ADC conversion in samples per second."""
return self._data_rate
@data_rate.setter
def data_rate(self, rate: int) -> None:
possible_rates = self.rates
if rate not in possible_rates:
raise ValueError(f"Data rate must be one of: {possible_rates}")
self._data_rate = rate
if self.initialized:
self._write_config()
@property
def rates(self) -> List[int]:
"""Possible data rate settings."""
raise NotImplementedError("Subclass must implement rates property.")
@property
def rate_config(self) -> Dict[int, int]:
"""Rate configuration masks."""
raise NotImplementedError("Subclass must implement rate_config property.")
@property
def gain(self) -> float:
"""The ADC gain."""
return self._gain
@gain.setter
def gain(self, gain: float) -> None:
possible_gains = self.gains
if gain not in possible_gains:
raise ValueError(f"Gain must be one of: {possible_gains}")
self._gain = gain
if self.initialized:
self._write_config()
@property
def gains(self) -> List[float]:
"""Possible gain settings."""
g = list(_ADS1X15_CONFIG_GAIN.keys())
g.sort()
return g
@property
def comparator_queue_length(self) -> int:
"""The ADC comparator queue length."""
return self._comparator_queue_length
@comparator_queue_length.setter
def comparator_queue_length(self, comparator_queue_length: int) -> None:
possible_comp_queue_lengths = self.comparator_queue_lengths
if comparator_queue_length not in possible_comp_queue_lengths:
raise ValueError(f"Comparator Queue must be one of: {possible_comp_queue_lengths}")
self._comparator_queue_length = comparator_queue_length
if self.initialized:
self._write_config()
@property
def comparator_queue_lengths(self) -> List[int]:
"""Possible comparator queue length settings."""
g = list(_ADS1X15_CONFIG_COMP_QUEUE.keys())
g.sort()
return g
@property
def comparator_low_threshold(self) -> int:
"""The ADC Comparator Lower Limit Threshold."""
return self._comparator_low_threshold
@property
def comparator_high_threshold(self) -> int:
"""The ADC Comparator Higher Limit Threshold."""
return self._comparator_high_threshold
@comparator_low_threshold.setter
def comparator_low_threshold(self, value: int) -> None:
"""Set comparator low threshold value for ADS1x15 ADC
:param int value: 16-bit signed integer to write to register
"""
if value < -32768 or value > 32767:
raise ValueError("Comparator Threshold value must be between -32768 and 32767")
self._comparator_low_threshold = value
self._write_register(_ADS1X15_POINTER_LO_THRES, self.comparator_low_threshold)
@comparator_high_threshold.setter
def comparator_high_threshold(self, value: int) -> None:
"""Set comparator high threshold value for ADS1x15 ADC
:param int value: 16-bit signed integer to write to register
"""
if value < -32768 or value > 32767:
raise ValueError("Comparator Threshold value must be between -32768 and 32767")
self._comparator_high_threshold = value
self._write_register(_ADS1X15_POINTER_HI_THRES, self.comparator_high_threshold)
@property
def mode(self) -> int:
"""The ADC conversion mode."""
return self._mode
@mode.setter
def mode(self, mode: int) -> None:
if mode not in {Mode.CONTINUOUS, Mode.SINGLE}:
raise ValueError("Unsupported mode.")
self._mode = mode
if self.initialized:
self._write_config()
@property
def comparator_mode(self) -> int:
"""The ADC comparator mode."""
return self._comparator_mode
@comparator_mode.setter
def comparator_mode(self, comp_mode: int) -> None:
if comp_mode not in {Comp_Mode.TRADITIONAL, Comp_Mode.WINDOW}:
raise ValueError("Unsupported mode.")
self._comparator_mode = comp_mode
if self.initialized:
self._write_config()
@property
def comparator_polarity(self) -> int:
"""The ADC comparator polarity mode."""
return self._comparator_polarity
@comparator_polarity.setter
def comparator_polarity(self, comp_pol: int) -> None:
if comp_pol not in {Comp_Polarity.ACTIVE_LOW, Comp_Polarity.ACTIVE_HIGH}:
raise ValueError("Unsupported mode.")
self._comparator_polarity = comp_pol
if self.initialized:
self._write_config()
@property
def comparator_latch(self) -> int:
"""The ADC comparator latching mode."""
return self._comparator_latch
@comparator_latch.setter
def comparator_latch(self, comp_latch: int) -> None:
if comp_latch not in {Comp_Latch.NONLATCHING, Comp_Latch.LATCHING}:
raise ValueError("Unsupported mode.")
self._comparator_latch = comp_latch
if self.initialized:
self._write_config()
[docs]
def read(self, pin: int) -> int:
"""I2C Interface for ADS1x15-based ADCs reads.
:param int pin: individual or differential pin.
:param bool is_differential: single-ended or differential read.
"""
return self._read(pin)
def _data_rate_default(self) -> int:
"""Retrieve the default data rate for this ADC (in samples per second).
Should be implemented by subclasses.
"""
raise NotImplementedError("Subclasses must implement _data_rate_default!")
def _conversion_value(self, raw_adc: int) -> int:
"""Subclasses should override this function that takes the 16 raw ADC
values of a conversion result and returns a signed integer value.
"""
raise NotImplementedError("Subclass must implement _conversion_value function!")
def _read(self, pin: int) -> int:
"""Perform an ADC read. Returns the signed integer result of the read."""
# Immediately return conversion register result if in CONTINUOUS mode
# and pin has not changed
if self.mode == Mode.CONTINUOUS and self._last_pin_read == pin:
return self._conversion_value(self.get_last_result(True))
# Assign last pin read if in SINGLE mode or first sample in CONTINUOUS mode on this pin
self._last_pin_read = pin
# Configure ADC every time before a conversion in SINGLE mode
# or changing channels in CONTINUOUS mode
self._write_config(pin)
# Wait for conversion to complete
# ADS1x1x devices settle within a single conversion cycle
if self.mode == Mode.SINGLE:
# Continuously poll conversion complete status bit
while not self._conversion_complete():
pass
else:
# Can't poll registers in CONTINUOUS mode
# Wait expected time for two conversions to complete
time.sleep(2 / self.data_rate)
return self._conversion_value(self.get_last_result(False))
def _conversion_complete(self) -> int:
"""Return status of ADC conversion."""
# OS is bit 15
# OS = 0: Device is currently performing a conversion
# OS = 1: Device is not currently performing a conversion
return self._read_register(_ADS1X15_POINTER_CONFIG) & 0x8000
[docs]
def get_last_result(self, fast: bool = False) -> int:
"""Read the last conversion result when in continuous conversion mode.
Will return a signed integer value. If fast is True, the register
pointer is not updated as part of the read. This reduces I2C traffic
and increases possible read rate.
"""
return self._read_register(_ADS1X15_POINTER_CONVERSION, fast)
def _write_register(self, reg: int, value: int):
"""Write 16 bit value to register."""
self.buf[0] = reg
self.buf[1] = (value >> 8) & 0xFF
self.buf[2] = value & 0xFF
with self.i2c_device as i2c:
i2c.write(self.buf)
def _read_register(self, reg: int, fast: bool = False) -> int:
"""Read 16 bit register value. If fast is True, the pointer register
is not updated.
"""
with self.i2c_device as i2c:
if fast:
i2c.readinto(self.buf, end=2)
else:
i2c.write_then_readinto(bytearray([reg]), self.buf, in_end=2)
return self.buf[0] << 8 | self.buf[1]
def _write_config(self, pin_config: Optional[int] = None) -> None:
"""Write to configuration register of ADC. If the optional
`pin_config` parameter is used then an ADC conversion is also initiated.
:param int pin_config: setting for MUX value in config register
"""
config = 0
if pin_config is not None and self.mode == Mode.SINGLE:
# set OS bit as needed to initiate a conversion
config = _ADS1X15_CONFIG_OS_SINGLE
else:
# read current mux setting from config register
pin_config = (
self._read_register(_ADS1X15_POINTER_CONFIG) & 0x7000
) >> _ADS1X15_CONFIG_MUX_OFFSET
# OR everything together and write result to config register
config |= (pin_config & 0x07) << _ADS1X15_CONFIG_MUX_OFFSET
config |= _ADS1X15_CONFIG_GAIN[self.gain]
config |= self.mode
config |= self.rate_config[self.data_rate]
config |= self.comparator_mode
config |= self.comparator_polarity
config |= self.comparator_latch
config |= _ADS1X15_CONFIG_COMP_QUEUE[self.comparator_queue_length]
self._write_register(_ADS1X15_POINTER_CONFIG, config)
def _read_config(self) -> None:
"""Reads Config Register and sets all properties accordingly"""
config_value = self._read_register(_ADS1X15_POINTER_CONFIG)
self.gain = next(
key for key, value in _ADS1X15_CONFIG_GAIN.items() if value == (config_value & 0x0E00)
)
self.data_rate = next(
key for key, value in self.rate_config.items() if value == (config_value & 0x00E0)
)
self.comparator_queue_length = next(
key
for key, value in _ADS1X15_CONFIG_COMP_QUEUE.items()
if value == (config_value & 0x0003)
)
self.mode = Mode.SINGLE if config_value & 0x0100 else Mode.CONTINUOUS
self.comparator_mode = Comp_Mode.WINDOW if config_value & 0x0010 else Comp_Mode.TRADITIONAL
self.comparator_polarity = (
Comp_Polarity.ACTIVE_HIGH if config_value & 0x0008 else Comp_Polarity.ACTIVE_LOW
)
self.comparator_latch = (
Comp_Latch.LATCHING if config_value & 0x0004 else Comp_Latch.NONLATCHING
)