Specified sizes of many ints

EnviroDIY · Feb 15, 2018 · 9dc18af · 9dc18af
1 parent 6f4b4d7
commit 9dc18af
Show file tree

Hide file tree

Showing 36 changed files with 123 additions and 120 deletions.
diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ To access and get values from a sensor, you must create an instance of the senso
 ```cpp
 #include <DecagonCTD.h>
 const char *CTDSDI12address = "1";  // The SDI-12 Address of the CTD
-const int measurementsToAverage = 10;  // The number of readings to average
+const uint8_t measurementsToAverage = 10;  // The number of readings to average
 const int SDI12Data = 7;  // The pin the CTD is attached to
 const int SDI12Power = 22;  // The sensor power pin (use -1 if not applicable)
 DecagonCTD ctd(*CTDSDI12address, SDI12Power, SDI12Data, measurementsToAverage);
@@ -497,8 +497,8 @@ The main constructor for the sensor object is (called once each for high and low
 
 ```cpp
 #include <CampbellOBS3.h>
-CampbellOBS3 osb3low(OBS3Power, OBSLowPin, OBSLow_A, OBSLow_B, OBSLow_C, ADS1x15_i2cAddress, measurementsToAverage);
-CampbellOBS3 osb3high(OBS3Power, OBSHighPin, OBSHigh_A, OBSHigh_B, OBSHigh_C, ADS1x15_i2cAddress, measurementsToAverage);
+CampbellOBS3 osb3low(OBS3Power, OBSLowPin, OBSLow_x2_coeff_A, OBSLow_x1_coeff_B, OBSLow_x0_coeff_C, ADS1x15_i2cAddress, measurementsToAverage);
+CampbellOBS3 osb3high(OBS3Power, OBSHighPin, OBSHigh_x2_coeff_A, OBSHigh_x1_coeff_B, OBSHigh_x0_coeff_C, ADS1x15_i2cAddress, measurementsToAverage);
 ```
 
 The single available variable is (called once each for high and low range):

diff --git a/sensor_tests/powerOn/powerOn.ino b/sensor_tests/powerOn/powerOn.ino
@@ -1,6 +1,6 @@
 #include <Arduino.h>
 
-int powerPin = 22;
+int8_t powerPin = 22;
 
 void setup(){
   pinMode(powerPin, OUTPUT);

diff --git a/src/AOSongAM2315.cpp b/src/AOSongAM2315.cpp
@@ -25,7 +25,7 @@
 
 
 // The constructor - because this is I2C, only need the power pin
-AOSongAM2315::AOSongAM2315(int powerPin, int measurementsToAverage)
+AOSongAM2315::AOSongAM2315(int8_t powerPin, uint8_t measurementsToAverage)
     : Sensor(F("AOSongAM2315"), AM2315_NUM_VARIABLES,
              AM2315_WARM_UP_TIME_MS, AM2315_STABILIZATION_TIME_MS, AM2315_MEASUREMENT_TIME_MS,
              powerPin, -1, measurementsToAverage)

diff --git a/src/AOSongAM2315.h b/src/AOSongAM2315.h
@@ -50,7 +50,7 @@ class AOSongAM2315 : public Sensor
 {
 public:
     // The constructor - because this is I2C, only need the power pin
-    AOSongAM2315(int powerPin, int measurementsToAverage = 1);
+    AOSongAM2315(int8_t powerPin, uint8_t measurementsToAverage = 1);
 
     String getSensorLocation(void) override;
 

diff --git a/src/AOSongDHT.cpp b/src/AOSongDHT.cpp
@@ -27,7 +27,7 @@
 
 
 // The constructor - need the power pin, data pin, and type of DHT
-AOSongDHT::AOSongDHT(int powerPin, int dataPin, DHTtype type, int measurementsToAverage)
+AOSongDHT::AOSongDHT(int8_t powerPin, int8_t dataPin, DHTtype type, uint8_t measurementsToAverage)
     : Sensor(F("AOSongDHT"), DHT_NUM_VARIABLES,
              DHT_WARM_UP_TIME_MS, DHT_STABILIZATION_TIME_MS, DHT_MEASUREMENT_TIME_MS,
              powerPin, dataPin, measurementsToAverage),

diff --git a/src/AOSongDHT.h b/src/AOSongDHT.h
@@ -72,7 +72,7 @@ class AOSongDHT : public Sensor
 {
 public:
     // The constructor - need the power pin, the data pin, and the sensor type
-    AOSongDHT(int powerPin, int dataPin, DHTtype type, int measurementsToAverage = 1);
+    AOSongDHT(int8_t powerPin, int8_t dataPin, DHTtype type, uint8_t measurementsToAverage = 1);
 
     SENSOR_STATUS setup(void) override;
     String getSensorName(void) override;

diff --git a/src/ApogeeSQ212.cpp b/src/ApogeeSQ212.cpp
@@ -35,7 +35,7 @@
 
 
 // The constructor - need the power pin and the data pin
-ApogeeSQ212::ApogeeSQ212(int powerPin, int dataPin, uint8_t i2cAddress, int measurementsToAverage)
+ApogeeSQ212::ApogeeSQ212(int8_t powerPin, int8_t dataPin, uint8_t i2cAddress, uint8_t measurementsToAverage)
     : Sensor(F("ApogeeSQ212"), SQ212_NUM_VARIABLES,
              SQ212_WARM_UP_TIME_MS, SQ212_STABILIZATION_TIME_MS, SQ212_MEASUREMENT_TIME_MS,
              powerPin, dataPin, measurementsToAverage)

diff --git a/src/ApogeeSQ212.h b/src/ApogeeSQ212.h
@@ -56,7 +56,7 @@ class ApogeeSQ212 : public Sensor
 
 public:
     // The constructor - need the power pin and the data pin
-    ApogeeSQ212(int powerPin, int dataPin, uint8_t i2cAddress = ADS1115_ADDRESS, int measurementsToAverage = 1);
+    ApogeeSQ212(int8_t powerPin, int8_t dataPin, uint8_t i2cAddress = ADS1115_ADDRESS, uint8_t measurementsToAverage = 1);
 
     String getSensorLocation(void) override;
 

diff --git a/src/BoschBME280.cpp b/src/BoschBME280.cpp
@@ -32,7 +32,7 @@
 
 
 // The constructor - because this is I2C, only need the power pin
-BoschBME280::BoschBME280(int powerPin, uint8_t i2cAddressHex, int measurementsToAverage)
+BoschBME280::BoschBME280(int8_t powerPin, uint8_t i2cAddressHex, uint8_t measurementsToAverage)
      : Sensor(F("BoschBME280"), BME280_NUM_VARIABLES,
               BME280_WARM_UP_TIME_MS, BME280_STABILIZATION_TIME_MS, BME280_MEASUREMENT_TIME_MS,
               powerPin, -1, measurementsToAverage)

diff --git a/src/BoschBME280.h b/src/BoschBME280.h
@@ -65,7 +65,7 @@
 class BoschBME280 : public Sensor
 {
 public:
-    BoschBME280(int powerPin, uint8_t i2cAddressHex = 0x76, int measurementsToAverage = 1);
+    BoschBME280(int8_t powerPin, uint8_t i2cAddressHex = 0x76, uint8_t measurementsToAverage = 1);
 
     bool wake(void) override;
     SENSOR_STATUS setup(void) override;

diff --git a/src/CampbellOBS3.cpp b/src/CampbellOBS3.cpp
@@ -16,7 +16,7 @@
  *  Mud: 2% of reading or 1 mg L–1
  *  Sand: 4% of reading or 10 mg L–1
  * Resolution:
- *  16-bit ADC
+ *  16-bit ADC - This is what is supported!
  *      Turbidity: 0.004/0.01 NTU; 0.008/0.03 NTU; 0.01/0.06 NTU
  *  12-bit ADC
  *      Turbidity: 0.06/0.2 NTU; 0.1/0.5 NTU; 0.2/1.0 NTU
@@ -31,15 +31,16 @@
 
 
 // The constructor - need the power pin, the data pin, and the calibration info
-CampbellOBS3::CampbellOBS3(int powerPin, int dataPin, float A, float B, float C,
-                           uint8_t i2cAddress, int measurementsToAverage)
+CampbellOBS3::CampbellOBS3(int8_t powerPin, int8_t dataPin,
+                           float x2_coeff_A, float x1_coeff_B, float x0_coeff_C,
+                           uint8_t i2cAddress, uint8_t measurementsToAverage)
   : Sensor(F("CampbellOBS3"), OBS3_NUM_VARIABLES,
            OBS3_WARM_UP_TIME_MS, OBS3_STABILIZATION_TIME_MS, OBS3_MEASUREMENT_TIME_MS,
            powerPin, dataPin, measurementsToAverage)
 {
-    _Avalue = A;
-    _Bvalue = B;
-    _Cvalue = C;
+    _x2_coeff_A = x2_coeff_A;
+    _x1_coeff_B = x1_coeff_B;
+    _x0_coeff_C = x0_coeff_C;
     _i2cAddress = i2cAddress;
 }
 
@@ -77,7 +78,7 @@ bool CampbellOBS3::addSingleMeasurementResult(void)
 
     // Print out the calibration curve
     MS_DBG(F("Input calibration Curve: "));
-    MS_DBG(_Avalue, F("x^2 + "), _Bvalue, F("x + "), _Cvalue, F("\n"));
+    MS_DBG(_x2_coeff_A, F("x^2 + "), _x1_coeff_B, F("x + "), _x0_coeff_C, F("\n"));
 
     // Read Analog to Digital Converter (ADC)
     // Taking this reading includes the 8ms conversion delay.  Since it is so
@@ -89,7 +90,7 @@ bool CampbellOBS3::addSingleMeasurementResult(void)
     if (adcVoltage < 3.6 and adcVoltage > -0.3)  // Skip results out of range
     {
         // Apply the unique calibration curve for the given sensor
-        calibResult = (_Avalue * sq(adcVoltage)) + (_Bvalue * adcVoltage) + _Cvalue;
+        calibResult = (_x2_coeff_A * sq(adcVoltage)) + (_x1_coeff_B * adcVoltage) + _x0_coeff_C;
         MS_DBG(F("calibResult: "), calibResult, F("\n"));
     }
     else MS_DBG(F("\n"));

diff --git a/src/CampbellOBS3.h b/src/CampbellOBS3.h
@@ -16,7 +16,7 @@
  *  Mud: 2% of reading or 1 mg L–1
  *  Sand: 4% of reading or 10 mg L–1
  * Resolution:
- *  16-bit ADC
+ *  16-bit ADC - This is what is supported!
  *      Turbidity: 0.004/0.01 NTU; 0.008/0.03 NTU; 0.01/0.06 NTU
  *  12-bit ADC
  *      Turbidity: 0.06/0.2 NTU; 0.1/0.5 NTU; 0.2/1.0 NTU
@@ -52,14 +52,16 @@ class CampbellOBS3 : public Sensor
 {
 public:
     // The constructor - need the power pin, the data pin, and the calibration info
-    CampbellOBS3(int powerPin, int dataPin, float A, float B, float C, uint8_t i2cAddress = ADS1115_ADDRESS, int measurementsToAverage = 1);
+    CampbellOBS3(int8_t powerPin, int8_t dataPin,
+                 float x2_coeff_A, float x1_coeff_B, float x0_coeff_C,
+                 uint8_t i2cAddress = ADS1115_ADDRESS, uint8_t measurementsToAverage = 1);
 
     String getSensorLocation(void) override;
 
     bool addSingleMeasurementResult(void) override;
 
 protected:
-    float _Avalue, _Bvalue, _Cvalue;
+    float _x2_coeff_A, _x1_coeff_B, _x0_coeff_C;
     uint8_t _i2cAddress;
 };
 

diff --git a/src/Decagon5TM.h b/src/Decagon5TM.h
@@ -51,17 +51,17 @@ class Decagon5TM : public DecagonSDI12
 {
 public:
     // Constructors with overloads
-    Decagon5TM(char SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    Decagon5TM(char SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("Decagon5TM"), TM_NUM_VARIABLES,
                     TM_WARM_UP_TIME_MS, TM_STABILIZATION_TIME_MS, TM_MEASUREMENT_TIME_MS)
     {}
-    Decagon5TM(char *SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    Decagon5TM(char *SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("Decagon5TM"), TM_NUM_VARIABLES,
                     TM_WARM_UP_TIME_MS, TM_STABILIZATION_TIME_MS, TM_MEASUREMENT_TIME_MS)
     {}
-    Decagon5TM(int SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    Decagon5TM(int SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("Decagon5TM"), TM_NUM_VARIABLES,
                     TM_WARM_UP_TIME_MS, TM_STABILIZATION_TIME_MS, TM_MEASUREMENT_TIME_MS)

diff --git a/src/DecagonCTD.h b/src/DecagonCTD.h
@@ -56,17 +56,17 @@ class DecagonCTD : public DecagonSDI12
 {
 public:
     // Constructors with overloads
-    DecagonCTD(char SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    DecagonCTD(char SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("DecagonCTD"), CTD_NUM_VARIABLES,
                     CTD_WARM_UP_TIME_MS, CTD_STABILIZATION_TIME_MS, CTD_MEASUREMENT_TIME_MS)
     {}
-    DecagonCTD(char *SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    DecagonCTD(char *SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("DecagonCTD"), CTD_NUM_VARIABLES,
                     CTD_WARM_UP_TIME_MS, CTD_STABILIZATION_TIME_MS, CTD_MEASUREMENT_TIME_MS)
     {}
-    DecagonCTD(int SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    DecagonCTD(int SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("DecagonCTD"), CTD_NUM_VARIABLES,
                     CTD_WARM_UP_TIME_MS, CTD_STABILIZATION_TIME_MS, CTD_MEASUREMENT_TIME_MS)

diff --git a/src/DecagonES2.h b/src/DecagonES2.h
@@ -47,17 +47,17 @@ class DecagonES2 : public DecagonSDI12
 {
 public:
     // Constructors with overloads
-    DecagonES2(char SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    DecagonES2(char SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("DecagonES2"), ES2_NUM_VARIABLES,
                     ES2_WARM_UP_TIME_MS, ES2_STABILIZATION_TIME_MS, ES2_MEASUREMENT_TIME_MS)
     {}
-    DecagonES2(char *SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    DecagonES2(char *SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("DecagonES2"), ES2_NUM_VARIABLES,
                     ES2_WARM_UP_TIME_MS, ES2_STABILIZATION_TIME_MS, ES2_MEASUREMENT_TIME_MS)
     {}
-    DecagonES2(int SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1)
+    DecagonES2(int SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1)
      : DecagonSDI12(SDI12address, powerPin, dataPin, measurementsToAverage,
                     F("DecagonES2"), ES2_NUM_VARIABLES,
                     ES2_WARM_UP_TIME_MS, ES2_STABILIZATION_TIME_MS, ES2_MEASUREMENT_TIME_MS)

diff --git a/src/DecagonSDI12.cpp b/src/DecagonSDI12.cpp
@@ -15,8 +15,8 @@
 
 
 // The constructor - need the number of measurements the sensor will return, SDI-12 address, the power pin, and the data pin
-DecagonSDI12::DecagonSDI12(char SDI12address, int powerPin, int dataPin, int measurementsToAverage,
-                           String sensorName, int numReturnedVars,
+DecagonSDI12::DecagonSDI12(char SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage,
+                           String sensorName, uint8_t numReturnedVars,
                            uint32_t warmUpTime_ms, uint32_t stabilizationTime_ms, uint32_t remeasurementTime_ms)
     : Sensor(sensorName, numReturnedVars,
              warmUpTime_ms, stabilizationTime_ms, remeasurementTime_ms,
@@ -25,8 +25,8 @@ DecagonSDI12::DecagonSDI12(char SDI12address, int powerPin, int dataPin, int mea
 {
     _SDI12address = SDI12address;
 }
-DecagonSDI12::DecagonSDI12(char *SDI12address, int powerPin, int dataPin, int measurementsToAverage,
-                           String sensorName, int numReturnedVars,
+DecagonSDI12::DecagonSDI12(char *SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage,
+                           String sensorName, uint8_t numReturnedVars,
                            uint32_t warmUpTime_ms, uint32_t stabilizationTime_ms, uint32_t remeasurementTime_ms)
     : Sensor(sensorName, numReturnedVars,
              warmUpTime_ms, stabilizationTime_ms, remeasurementTime_ms,
@@ -35,8 +35,8 @@ DecagonSDI12::DecagonSDI12(char *SDI12address, int powerPin, int dataPin, int me
 {
     _SDI12address = *SDI12address;
 }
-DecagonSDI12::DecagonSDI12(int SDI12address, int powerPin, int dataPin, int measurementsToAverage,
-                           String sensorName, int numReturnedVars,
+DecagonSDI12::DecagonSDI12(int SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage,
+                           String sensorName, uint8_t numReturnedVars,
                            uint32_t warmUpTime_ms, uint32_t stabilizationTime_ms, uint32_t remeasurementTime_ms)
     : Sensor(sensorName, numReturnedVars,
              warmUpTime_ms, stabilizationTime_ms, remeasurementTime_ms,

diff --git a/src/DecagonSDI12.h b/src/DecagonSDI12.h
@@ -32,14 +32,14 @@ class DecagonSDI12 : public Sensor
 {
 public:
 
-    DecagonSDI12(char SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1,
-                 String sensorName = "SDI12-Sensor", int numReturnedVars = 1,
+    DecagonSDI12(char SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1,
+                 String sensorName = "SDI12-Sensor", uint8_t numReturnedVars = 1,
                  uint32_t warmUpTime_ms = 0, uint32_t stabilizationTime_ms = 0, uint32_t remeasurementTime_ms = 0);
-    DecagonSDI12(char *SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1,
-                 String sensorName = "SDI12-Sensor", int numReturnedVars = 1,
+    DecagonSDI12(char *SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1,
+                 String sensorName = "SDI12-Sensor", uint8_t numReturnedVars = 1,
                  uint32_t warmUpTime_ms = 0, uint32_t stabilizationTime_ms = 0, uint32_t remeasurementTime_ms = 0);
-    DecagonSDI12(int SDI12address, int powerPin, int dataPin, int measurementsToAverage = 1,
-                 String sensorName = "SDI12-Sensor", int numReturnedVars = 1,
+    DecagonSDI12(int SDI12address, int8_t powerPin, int8_t dataPin, uint8_t measurementsToAverage = 1,
+                 String sensorName = "SDI12-Sensor", uint8_t numReturnedVars = 1,
                  uint32_t warmUpTime_ms = 0, uint32_t stabilizationTime_ms = 0, uint32_t remeasurementTime_ms = 0);
 
     String getSensorVendor(void);