Add Example04. Update readRegisterRegion - needs Toolkit adderr branch

Author: PaulZC

examples/Example04_DataReadyInterrupt/Example04_DataReadyInterrupt.ino

@@ -38,7 +38,7 @@ bool interruptSeen = false; // A global flag to indicate if the DRDY interrupt h
 void dataReadyISR(void)
 {
   // Always keep interrupt Interrupt Service Routines as short as possible.
-  // Do not try to print or perform bus reads and writes inside them.
+  // Do not try to print or perform bus transfers inside them.
   // Here we only set the interruptSeen flag.
   // The ADC conversion result will be read in the loop().
   interruptSeen = true;
@@ -54,10 +54,12 @@ void setup()
   {
     delay(100); // Wait for the user to open the Serial Monitor
   };
-  Serial.println("SparkFun ADS1219 Example");
+  //Serial.println("SparkFun ADS1219 Example"); // Commented for the Serial Plotter
 
   Wire.begin(); // Begin the I2C bus
 
+  Wire.setClock(400000); // We are OK at 100kHz, but 400kHz is better
+
   // Initialize ADC - this also performs a soft reset
   while (myADC.begin() == false)
   {
@@ -68,7 +70,8 @@ void setup()
   // Configure the input multiplexer
   myADC.setInputMultiplexer(ADS1219_CONFIG_MUX_SINGLE_0); // Read the voltage between AIN0 and GND
 
-  // Configure the gain to x4, so we can measuure small voltages with higher resolution
+  // Set the gain to x4, so we can measure small voltages with higher resolution
+  // Note: we are limited to 0.512V max when using a gain of 4 and the internal 2.048V reference
   myADC.setGain(ADS1219_GAIN_4);
 
   // Configure the data rate. The ADC will sample at 1000 samples per second
@@ -91,7 +94,7 @@ void loop()
   {
     interruptSeen = false; // Clear the flag ready for the next interrupt
     myADC.readConversion(); // Read the conversion result from the ADC. Store it internally.
-    int32_t rawADC = myADC.getConversionRaw(); // Just to be different, read the raw ADC value.
-    Serial.println(rawADC); // Print the raw ADC value
+    float milliVolts = myADC.getConversionMillivolts(); // Convert to millivolts.
+    Serial.println(milliVolts, 3); // Print milliVolts with 3 decimal places
   }
 }

src/SparkFun_ADS1219.cpp

@@ -82,7 +82,7 @@ bool SfeADS1219Driver::setInputMultiplexer(const ads1219_input_multiplexer_confi
 
 /// @brief Configure the gain.
 /// @return True if successful, false otherwise.
-bool setGain(const ads1219_gain_config_t gain)
+bool SfeADS1219Driver::setGain(const ads1219_gain_config_t gain)
 {
     sfe_ads1219_reg_cfg_t config;
     if (_theBus->readRegisterByte(kSfeADS1219RegConfigRead, config.byte) != kSTkErrOk) // Read the config register
@@ -94,7 +94,7 @@ bool setGain(const ads1219_gain_config_t gain)
 
 /// @brief Configure the data rate (samples per second).
 /// @return True if successful, false otherwise.
-bool setDataRate(const ads1219_data_rate_config_t rate)
+bool SfeADS1219Driver::setDataRate(const ads1219_data_rate_config_t rate)
 {
     sfe_ads1219_reg_cfg_t config;
     if (_theBus->readRegisterByte(kSfeADS1219RegConfigRead, config.byte) != kSTkErrOk) // Read the config register
@@ -105,7 +105,7 @@ bool setDataRate(const ads1219_data_rate_config_t rate)
 
 /// @brief Configure the voltage reference.
 /// @return True if successful, false otherwise.
-bool setVoltageReference(const ads1219_vref_config_t vRef)
+bool SfeADS1219Driver::setVoltageReference(const ads1219_vref_config_t vRef)
 {
     sfe_ads1219_reg_cfg_t config;
     if (_theBus->readRegisterByte(kSfeADS1219RegConfigRead, config.byte) != kSTkErrOk) // Read the config register
@@ -120,7 +120,9 @@ bool setVoltageReference(const ads1219_vref_config_t vRef)
 bool SfeADS1219Driver::readConversion()
 {
     uint8_t rawBytes[3];
-    bool result = (_theBus->readRegisterRegion(kSfeADS1219CommandReadData, (uint8_t *)rawBytes, 3) == 3);
+    size_t readBytes;
+    bool result = (_theBus->readRegisterRegion(kSfeADS1219CommandReadData, (uint8_t *)rawBytes, 3, readBytes) == kSTkErrOk);
+    result = result && (readBytes == 3); // Check three bytes were returned
     if (result)
     {
         // Data is 3-bytes (24-bits), big-endian (MSB first).
@@ -166,6 +168,24 @@ bool SfeADS1219Driver::dataReady(void)
     return (result && (status.drdy == 1));
 }
 
+/// @brief  Read the ADS1219 Configuration Register into a sfe_ads1219_reg_cfg_t struct.
+/// @param  config Pointer to the sfe_ads1219_reg_cfg_t struct to hold the register contents.
+/// @return True if successful, false otherwise.
+bool SfeADS1219Driver::getConfigurationRegister(sfe_ads1219_reg_cfg_t *config)
+{
+    return (_theBus->readRegisterByte(kSfeADS1219RegConfigRead, config->byte) == kSTkErrOk); // Read the config register
+}
+
+/// @brief  Write a sfe_ads1219_reg_cfg_t struct into the ADS1219 Configuration Register.
+/// @param  config A sfe_ads1219_reg_cfg_t struct holding the register contents.
+/// @return True if successful, false otherwise.
+bool SfeADS1219Driver::setConfigurationRegister(sfe_ads1219_reg_cfg_t config)
+{
+    return (_theBus->writeRegisterByte(kSfeADS1219RegConfigWrite, config.byte) == kSTkErrOk); // Write the config register
+}
+
+/// @brief  PRIVATE: update the local pointer to the I2C bus.
+/// @param  theBus Pointer to the bus object.
 void SfeADS1219Driver::setCommunicationBus(sfeTkArdI2C *theBus)
 {
     _theBus = theBus;

src/SparkFun_ADS1219.h

@@ -210,6 +210,16 @@ class SfeADS1219Driver
     /// @return true if data is ready.
     bool dataReady(void);
 
+    /// @brief  Read the ADS1219 Configuration Register into a sfe_ads1219_reg_cfg_t struct.
+    /// @param  config Pointer to the sfe_ads1219_reg_cfg_t struct to hold the register contents.
+    /// @return True if successful, false otherwise.
+    bool getConfigurationRegister(sfe_ads1219_reg_cfg_t *config);
+
+    /// @brief  Write a sfe_ads1219_reg_cfg_t struct into the ADS1219 Configuration Register.
+    /// @param  config A sfe_ads1219_reg_cfg_t struct holding the register contents.
+    /// @return True if successful, false otherwise.
+    bool setConfigurationRegister(sfe_ads1219_reg_cfg_t config);
+
 protected:
     /// @brief Sets the communication bus to the specified bus.
     /// @param theBus Bus to set as the communication devie.