0.3.11 ADS1x15

Author: RobTillaart

libraries/ADS1x15/ADS1X15.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: ADS1X15.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.10
+// VERSION: 0.3.11
 //    DATE: 2013-03-24
 // PUPROSE: Arduino library for ADS1015 and ADS1115
 //     URL: https://github.com/RobTillaart/ADS1X15
@@ -173,19 +173,6 @@ bool ADS1X15::begin()
 }
 
 
-bool ADS1X15::isBusy()
-{
-  return isReady() == false;
-}
-
-
-bool ADS1X15::isReady()
-{
-  uint16_t val = _readRegister(_address, ADS1X15_REG_CONFIG);
-  return ((val & ADS1X15_OS_NOT_BUSY) > 0);
-}
-
-
 bool ADS1X15::isConnected()
 {
   _wire->beginTransmission(_address);
@@ -307,15 +294,17 @@ int16_t ADS1X15::readADC(uint8_t pin)
 }
 
 
-void  ADS1X15::requestADC_Differential_0_1()
+int16_t ADS1X15::readADC_Differential_0_1()
 {
-  _requestADC(ADS1X15_MUX_DIFF_0_1);
+  return _readADC(ADS1X15_MUX_DIFF_0_1);
 }
 
 
-int16_t ADS1X15::readADC_Differential_0_1()
+int16_t ADS1X15::getValue()
 {
-  return _readADC(ADS1X15_MUX_DIFF_0_1);
+  int16_t raw = _readRegister(_address, ADS1X15_REG_CONVERT);
+  if (_bitShift) raw >>= _bitShift;  //  Shift 12-bit results
+  return raw;
 }
 
 
@@ -327,18 +316,77 @@ void ADS1X15::requestADC(uint8_t pin)
 }
 
 
-int16_t ADS1X15::getValue()
+void  ADS1X15::requestADC_Differential_0_1()
 {
-  int16_t raw = _readRegister(_address, ADS1X15_REG_CONVERT);
-  if (_bitShift) raw >>= _bitShift;  //  Shift 12-bit results
-  return raw;
+  _requestADC(ADS1X15_MUX_DIFF_0_1);
+}
+
+
+bool ADS1X15::isBusy()
+{
+  return isReady() == false;
+}
+
+
+bool ADS1X15::isReady()
+{
+  uint16_t val = _readRegister(_address, ADS1X15_REG_CONFIG);
+  return ((val & ADS1X15_OS_NOT_BUSY) > 0);
+}
+
+
+void ADS1X15::setComparatorMode(uint8_t mode)
+{
+  _compMode = mode == 0 ? 0 : 1;
+}
+
+
+uint8_t ADS1X15::getComparatorMode()
+{
+  return _compMode;
+}
+
+
+void ADS1X15::setComparatorPolarity(uint8_t pol)
+{
+  _compPol = pol ? 0 : 1;
+}
+
+
+uint8_t ADS1X15::getComparatorPolarity()
+{
+  return _compPol;
+}
+
+
+void ADS1X15::setComparatorLatch(uint8_t latch)
+{
+  _compLatch = latch ? 0 : 1;
+}
+
+
+uint8_t ADS1X15::getComparatorLatch()
+{
+  return _compLatch;
+}
+
+
+void ADS1X15::setComparatorQueConvert(uint8_t mode)
+{
+  _compQueConvert = (mode < 3) ? mode : 3;
+}
+
+
+uint8_t ADS1X15::getComparatorQueConvert()
+{
+  return _compQueConvert;
 }
 
 
 void ADS1X15::setComparatorThresholdLow(int16_t lo)
 {
   _writeRegister(_address, ADS1X15_REG_LOW_THRESHOLD, lo);
-};
+}
 
 
 int16_t ADS1X15::getComparatorThresholdLow()
@@ -367,17 +415,16 @@ int8_t ADS1X15::getError()
 }
 
 
+//////////////////////////////////////////////////////
+//
+//  EXPERIMENTAL
+//
 void ADS1X15::setWireClock(uint32_t clockSpeed)
 {
   _clockSpeed = clockSpeed;
   _wire->setClock(_clockSpeed);
 }
 
-
-//////////////////////////////////////////////////////
-//
-//  EXPERIMENTAL
-//
 //  see https://github.com/RobTillaart/ADS1X15/issues/22
 //      https://github.com/arduino/Arduino/issues/11457
 //  TODO: get the real clock speed from the I2C interface if possible.
@@ -396,7 +443,7 @@ uint32_t ADS1X15::getWireClock()
 //  not supported.
 //  return -1;
 
-#else  // best effort is remembering it
+#else  //  best effort is remembering it
   return _clockSpeed;
 #endif
 }

libraries/ADS1x15/ADS1X15.h

@@ -2,7 +2,7 @@
 //
 //    FILE: ADS1X15.H
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.10
+// VERSION: 0.3.11
 //    DATE: 2013-03-24
 // PUPROSE: Arduino library for ADS1015 and ADS1115
 //     URL: https://github.com/RobTillaart/ADS1X15
@@ -12,7 +12,7 @@
 #include "Arduino.h"
 #include "Wire.h"
 
-#define ADS1X15_LIB_VERSION               (F("0.3.10"))
+#define ADS1X15_LIB_VERSION               (F("0.3.11"))
 
 //  allow compile time default address
 //  address in { 0x48, 0x49, 0x4A, 0x4B }, no test...
@@ -39,7 +39,7 @@ class ADS1X15
 #if defined (ESP8266) || defined(ESP32)
   bool     begin(int sda, int scl);
 #elif defined (ARDUINO_ARCH_RP2040) && !defined(__MBED__)
-  bool    begin(int sda, int scl);
+  bool     begin(int sda, int scl);
 #endif
 
   bool     begin();
@@ -94,25 +94,25 @@ class ADS1X15
   //  COMPARATOR
   //  0    = TRADITIONAL   > high          => on      < low   => off
   //  else = WINDOW        > high or < low => on      between => off
-  void     setComparatorMode(uint8_t mode) { _compMode = mode == 0 ? 0 : 1; };
-  uint8_t  getComparatorMode()             { return _compMode; };
+  void     setComparatorMode(uint8_t mode);
+  uint8_t  getComparatorMode();
 
   //  0    = LOW (default)
   //  else = HIGH
-  void     setComparatorPolarity(uint8_t pol) { _compPol = pol ? 0 : 1; };
-  uint8_t  getComparatorPolarity()            { return _compPol; };
+  void     setComparatorPolarity(uint8_t pol);
+  uint8_t  getComparatorPolarity();
 
   //  0    = NON LATCH
   //  else = LATCH
-  void     setComparatorLatch(uint8_t latch) { _compLatch = latch ? 0 : 1; };
-  uint8_t  getComparatorLatch()              { return _compLatch; };
+  void     setComparatorLatch(uint8_t latch);
+  uint8_t  getComparatorLatch();
 
   //  0   = trigger alert after 1 conversion
   //  1   = trigger alert after 2 conversions
   //  2   = trigger alert after 4 conversions
   //  3   = Disable comparator =  default, also for all other values.
-  void     setComparatorQueConvert(uint8_t mode) { _compQueConvert = (mode < 3) ? mode : 3; };
-  uint8_t  getComparatorQueConvert()             { return _compQueConvert; };
+  void     setComparatorQueConvert(uint8_t mode);
+  uint8_t  getComparatorQueConvert();
 
   void     setComparatorThresholdLow(int16_t lo);
   int16_t  getComparatorThresholdLow();
@@ -129,6 +129,7 @@ class ADS1X15
   //  not necessary the actual value
   uint32_t getWireClock();
 
+
 protected:
   ADS1X15();
 

libraries/ADS1x15/CHANGELOG.md

@@ -8,12 +8,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - update and add examples
 
 
+## [0.3.11] - 2023-08-31
+- update readme.md
+- move code from .h to .cpp
+- reordered code in .cpp to follow .h
+- minor edits
+
+
 ## [0.3.10] - 2023-06-07
 - fix NANO RP2040
 - update and add examples
 - minor edits
 
-
 ## [0.3.9] - 2023-01-21
 - update GitHub actions
 - update license 2023
@@ -25,7 +31,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - simplified changelog.md
 
 ## [0.3.7] - 2022-06-21
-- fix ESP32 Wire.begin datatype
+- fix ESP32 Wire.begin data type
 
 ## [0.3.6] - 2022-03-10
 

libraries/ADS1x15/README.md

@@ -2,8 +2,11 @@
 [![Arduino CI](https://github.com/RobTillaart/ADS1X15/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/ADS1X15/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/ADS1X15/actions/workflows/arduino-lint.yml)
 [![JSON check](https://github.com/RobTillaart/ADS1X15/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/ADS1X15/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/ADS1X15.svg)](https://github.com/RobTillaart/ADS1X15/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/ADS1X15/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/ADS1X15.svg?maxAge=3600)](https://github.com/RobTillaart/ADS1X15/releases)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/ADS1X15.svg)](https://registry.platformio.org/libraries/robtillaart/ADS1X15)
 
 
 # ADS1X15
@@ -29,9 +32,18 @@ although not all sensors support all functionality.
 |  ADS1115  |      4     |       16     |    860    |       Y      |        Y      |  Tested  |
 
 
-As the 1015 and the 1115 are both 4 channels these are the most
+As the ADS1015 and the ADS1115 are both 4 channels these are the most
 interesting from functionality point of view as these can also do
-differential measurement.
+differential measurements.
+
+
+#### Related
+
+- https://github.com/RobTillaart/MCP_ADC  (10 & 12 bit ADC, SPI, fast)
+- https://github.com/RobTillaart/PCF8591  (8 bit ADC + 1 bit DAC)
+
+
+## I2C Address
 
 The address of the ADS1113/4/5 is determined by to which pin the **ADDR**
 is connected to:
@@ -52,7 +64,7 @@ is connected to:
 
 #### Initializing
 
-To initialize the library you must call constructor as described below.
+To initialize the library you must call a constructor as described below.
 
 - **ADS1x15()** base constructor, should not be used.
 - **ADS1013(uint8_t address, TwoWire \*wire = &Wire)** Constructor with device address,
@@ -105,7 +117,7 @@ better the Arduino Wire lib should support this call (ESP32 does).
 
 See - https://github.com/arduino/Arduino/issues/11457
 
-Question: should this functionality be in this library?
+Question: Should this functionality be in this library?
 
 
 #### Programmable Gain
@@ -287,6 +299,27 @@ Instead you can configure the threshold registers to allow the **ALERT/RDY**
 pin to trigger an interrupt signal when conversion data ready.
 
 
+#### Switching mode or channel during continuous mode
+
+When switching the operating mode or the ADC channel in continuous mode, be aware that 
+the device will always finish the running conversion.
+This implies that after switching the mode or channel the first sample you get is probably 
+the last sample with the previous settings, e.g. channel.
+This might be a problem for your project as this value can be in an "unexpected" range (outlier).
+
+The robust way to change mode or channel therefore seems to be:
+
+1. stop continuous mode,
+1. wait for running conversion to be ready,
+1. reject the last conversion or process it "under old settings",
+1. change the settings,
+1. restart (continuous mode) with the new settings.
+
+This explicit stop takes extra time, however it should prevent "incorrect" readings.
+
+(need to be verified with different models)
+
+
 #### Threshold registers
 
 If the thresholdHigh is set to 0x0100 and the thresholdLow to 0x0000
@@ -381,7 +414,7 @@ mean something different see - Comparator Mode above or datasheet.
 
 - **bool begin(int sda, int scl)** begin communication with the ADC.
 It has the parameter for selecting on which pins the communication should happen.
-wireUsed is optional. Check RP2040 Pinout for compatible pins.
+Check RP2040 Pinout for compatible pins.
 If, "Wire1" is used, you need to add "&Wire1" in the constructor.
 
 
@@ -390,7 +423,6 @@ If, "Wire1" is used, you need to add "&Wire1" in the constructor.
 #### Must
 
 - Improve documentation (always)
-- move code from .h to .cpp  (0.4.0)
 
 
 #### Should
@@ -400,9 +432,20 @@ If, "Wire1" is used, you need to add "&Wire1" in the constructor.
 
 - More examples ?
 - SMB alert command (00011001) on I2C bus?
-- constructor for ADS1X15 ?
+- sync order .h / .cpp
+
 
 #### Wont (unless requested)
 
 - type flag?
+- constructor for ADS1X15?
+
+
+## Support
+
+If you appreciate my libraries, you can support the development and maintenance.
+Improve the quality of the libraries by providing issues and Pull Requests, or
+donate through PayPal or GitHub sponsors.
+
+Thank you,
 

libraries/ADS1x15/library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/ADS1X15"
   },
-  "version": "0.3.10",
+  "version": "0.3.11",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

libraries/ADS1x15/library.properties

@@ -1,5 +1,5 @@
 name=ADS1X15
-version=0.3.10
+version=0.3.11
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Arduino library for ADS1015 - I2C 12 bit ADC and ADS1115 I2C 16 bit ADC