Add Example05

Author: PaulZC

README.md

@@ -10,6 +10,13 @@ SparkFun ADS1219 Arduino Library
     </tr>
 </table>
 
+This is an Arduino Library for the ADS1219 24-bit 4-channel ADC from TI. It allows you to fully configure the ADC.
+Examples are provided to show how to use: single-shot vs. continuous mode; the input multiplexer; gain;
+different sample rates; and alternate I2C addresses. You can read the ADC voltage in millivolts (compensated for gain)
+or as the raw signed value.
+
+Note: this library needs the [SparkFun Toolkit](https://github.com/sparkfun/SparkFun_Toolkit).
+
 Repository Contents
 -------------------
 
@@ -19,6 +26,7 @@ Repository Contents
 
 Documentation
 --------------
+
 * **[Hardware Repository](https://github.com/sparkfunX/SparkX_ADC_ADS1219)** - Hardware repository for the SparkX 24-Bit 4-Channel ADC - ADS1219 (Qwiic).
 
 License Information

examples/Example01_SingleShot/Example01_SingleShot.ino

@@ -28,14 +28,13 @@ SfeADS1219ArdI2C myADC;
 
 void setup()
 {
-
   delay(1000); // Allow time for the microcontroller to start up
 
   Serial.begin(115200); // Begin the Serial console
   while (!Serial)
   {
     delay(100); // Wait for the user to open the Serial Monitor
-  };
+  }
   Serial.println("SparkFun ADS1219 Example");
 
   Wire.begin(); // Begin the I2C bus

examples/Example02_Continuous/Example02_Continuous.ino

@@ -28,14 +28,13 @@ SfeADS1219ArdI2C myADC;
 
 void setup()
 {
-
   delay(1000); // Allow time for the microcontroller to start up
 
   Serial.begin(115200); // Begin the Serial console
   while (!Serial)
   {
     delay(100); // Wait for the user to open the Serial Monitor
-  };
+  }
   Serial.println("SparkFun ADS1219 Example");
 
   Wire.begin(); // Begin the I2C bus

examples/Example03_InputMultiplexer/Example03_InputMultiplexer.ino

@@ -31,14 +31,13 @@ SfeADS1219ArdI2C myADC;
 
 void setup()
 {
-
   delay(1000); // Allow time for the microcontroller to start up
 
   Serial.begin(115200); // Begin the Serial console
   while (!Serial)
   {
     delay(100); // Wait for the user to open the Serial Monitor
-  };
+  }
   Serial.println("SparkFun ADS1219 Example");
 
   Wire.begin(); // Begin the I2C bus

examples/Example04_DataReadyInterrupt/Example04_DataReadyInterrupt.ino

@@ -17,7 +17,7 @@
   Hardware Connections:
   IoT RedBoard --> ADS1219
   QWIIC        --> QWIIC
-  Connect an interrupt-capable IO pin to the DRDY breakout pad, using a jumper wire.
+  Use a jumper wire to connect the DRDY breakout pad to an interrupt-capable I/O pin
 
   Open the serial monitor at 115200 baud to see the voltage.
 
@@ -46,14 +46,13 @@ void dataReadyISR(void)
 
 void setup()
 {
-
   delay(1000); // Allow time for the microcontroller to start up
 
   Serial.begin(115200); // Begin the Serial console
   while (!Serial)
   {
     delay(100); // Wait for the user to open the Serial Monitor
-  };
+  }
   //Serial.println("SparkFun ADS1219 Example"); // Commented for the Serial Plotter
 
   Wire.begin(); // Begin the I2C bus

examples/Example05_AlternateAddress/Example05_AlternateAddress.ino

@@ -0,0 +1,73 @@
+/*
+  Using alternate I2C addresses for the ADS1219 ADC.
+
+  This example shows how to use an alternate address for the ADC.
+
+  The ADS1219 has two address pins: A1 and A0. These can be tied to
+  SCL, SDA, VDD or DGND to provide 16 possible I2C addresses (0x40 - 0x4F).
+  On the SparkX Qwiic ADS1219, split-pad jumpers make this easy.
+  The A0 jumpers are labelled 0,1,2,3. The A1 jumpers are labelled 0,4,8,C.
+  To set the address to 0x4F: open both 0 jumpers, solder 3 and C closed.
+
+  By: Paul Clark
+  SparkFun Electronics
+  Date: 2023/12/11
+  SparkFun code, firmware, and software is released under the MIT License.
+  Please see LICENSE.md for further details.
+
+  Hardware Connections:
+  IoT RedBoard --> ADS1219
+  QWIIC        --> QWIIC
+
+  Open the serial monitor at 115200 baud to see the voltage.
+
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/23455 - Qwiic ADS1219 1x1
+*/
+
+// You will need the SparkFun Toolkit. Click here to get it: http://librarymanager/All#SparkFun_Toolkit
+
+#include <SparkFun_ADS1219.h> // Click here to get the library: http://librarymanager/All#SparkFun_ADS1219
+
+SfeADS1219ArdI2C myADC;
+
+void setup()
+{
+  delay(1000); // Allow time for the microcontroller to start up
+
+  Serial.begin(115200); // Begin the Serial console
+  while (!Serial)
+  {
+    delay(100); // Wait for the user to open the Serial Monitor
+  }
+  Serial.println("SparkFun ADS1219 Example");
+
+  Wire.begin(); // Begin the I2C bus
+
+  bool begun;
+  begun = myADC.begin(Wire, 0x4F); // Initialize the ADC - using a custom bus and address - see notes above
+  begun = myADC.begin(0x4F); // This is also possible. It defaults to Wire
+
+  if (!begun)
+  {
+    Serial.println("ADC not detected! Please check the address and try again...");
+    while (1); // Do nothing more
+  }
+
+  Serial.println("Reading the differential voltage between AIN0 (+) and AIN1 (-)");
+}
+
+void loop()
+{
+  myADC.startSync(); // Start a single-shot conversion.
+
+  while (myADC.dataReady() == false) // Check if the conversion is complete. This will return true if data is ready.
+  {
+    delay(10); // The conversion is not complete. Wait a little to avoid pounding the I2C bus.
+  }
+
+  myADC.readConversion(); // Read the conversion result from the ADC. Store it internally.
+  int32_t sample = myADC.getConversionRaw(); // Get the raw ADC value. Note: this is NOT adjusted for gain.
+  Serial.print("Raw ADC value: ");
+  Serial.println(sample); // Print the raw ADC value
+}