0.1.1 ACD3100

Author: RobTillaart

libraries/ACD3100/ACD3100.cpp

@@ -2,8 +2,8 @@
 //    FILE: ACD3100.cpp
 //  AUTHOR: Rob Tillaart
 //    DATE: 2024-10-29
-// VERSION: 0.1.0
-// PURPOSE: Arduino library for for I2C ACD3100 CO2 sensor
+// VERSION: 0.1.1
+// PURPOSE: Arduino library for I2C ACD3100 CO2 sensor
 //     URL: https://github.com/RobTillaart/ACD3100
 //          http://www.aosong.com/products-220.html
 
@@ -181,32 +181,6 @@ uint8_t ACD3100::getRequestTime()
 //
 //  CALIBRATION
 //
-bool ACD3100::setCalibrationMode(uint8_t mode)
-{
-  if (mode > 1) return false;
-  uint8_t buf[5] = { 0x53, 0x06, 0x00, 0x00, 0x00 };
-  buf[3] = mode;
-  buf[4] = _crc8(&buf[2], 2);
-  //  Serial.println(buf[4], HEX);
-  _command(buf, 5);
-  return true;
-}
-
-
-uint8_t ACD3100::readCallibrationMode()
-{
-  uint8_t buf[3] = { 0x53, 0x06, 0x00 };
-  _command(buf, 2);
-  _request(buf, 3);
-  // if (buf[2] != _crc8(&buf[0], 2))
-  // {
-    // Serial.print(__FUNCTION__);
-    // Serial.println(": CRC error");
-  // }
-  return buf[1];
-}
-
-
 bool ACD3100::setManualCalibration(uint16_t value)
 {
   if ((value < 400) || (value > 5000)) return false;
@@ -255,7 +229,7 @@ bool ACD3100::readFactorySet()
     // Serial.print(__FUNCTION__);
     // Serial.println(": CRC error");
   // }
-  return (buf[1] == 0x01);
+  return ((buf[0] == 0) && (buf[1] == 0x01));
 }
 
 

libraries/ACD3100/ACD3100.h

@@ -3,8 +3,8 @@
 //    FILE: ACD3100.h
 //  AUTHOR: Rob Tillaart
 //    DATE: 2024-10-29
-// VERSION: 0.1.0
-// PURPOSE: Arduino library for for I2C ACD3100 CO2 sensor
+// VERSION: 0.1.1
+// PURPOSE: Arduino library for I2C ACD3100 CO2 sensor
 //     URL: https://github.com/RobTillaart/ACD3100
 //          http://www.aosong.com/products-220.html
 
@@ -13,7 +13,7 @@
 #include "Wire.h"
 
 
-#define ACD3100_LIB_VERSION         (F("0.1.0"))
+#define ACD3100_LIB_VERSION         (F("0.1.1"))
 #define ACD3100_DEFAULT_ADDRESS     0x2A          //  0x54 ?
 
 //  ERROR CODES
@@ -50,9 +50,6 @@ class ACD3100
 
 
   //       CALIBRATION  (! read datasheet)
-  //       0 = manual  1 = auto
-  bool     setCalibrationMode(uint8_t mode);
-  uint8_t  readCallibrationMode();
   bool     setManualCalibration(uint16_t value);
   uint16_t readManualCalibration();
 

libraries/ACD3100/CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.1.1] - 2024-10-29
+- fix #4, remove calibration mode (not supported as in ACD10)
+- fix #2, update documentation
+- fix **readFactorySet()** test
+
 ## [0.1.0] - 2024-10-29
 - initial version
 

libraries/ACD3100/README.md

@@ -81,11 +81,11 @@ and any other applications that may cause personal injury due to the product's f
 ```
              TOPVIEW ACD3100
          +--------------------+
-   pin 6 | o                  |
-   pin 5 | o                o |  pin 1
-         |                  o |  pin 2
-         |                  o |  pin 3
-         |                  o |  pin 4
+   pin 5 | o                  |
+         | o                o |  pin 1
+         | o                o |  pin 2
+         | o                o |  pin 3
+         | o                o |  pin 4
          |                    |
          +--------------------+
 ```
@@ -235,9 +235,6 @@ Use 5~10 milliseconds above the minimal value the sensor still works.
 Read the datasheet about calibration process (twice).
 Incorrect calibration leads to incorrect output.
 
-- **bool setCalibrationMode(uint8_t mode)** 0 = manual mode, 1 = automatic mode.
-Returns false if mode out of range ( > 1).
-- **uint8_t readCallibrationMode()** return set mode. 
 - **void setManualCalibration(uint16_t value)** as the range of the device is 
 from 400 to 5000, the parameter value should be in this range.
 - **uint16_t readManualCalibration()** read back the set manual calibration value.
@@ -250,9 +247,9 @@ Note: One should wait 5 milliseconds between the calibration calls (see datashee
 - **void factoryReset()** idem.
 - **bool readFactorySet()** Read back if factory reset was successful.
 - **uint32_t readFirmwareVersion(char \* arr)** copies firmware version in array.
-Minimum length is 11.
+Minimum length off arr is 11.
 - **uint32_t readSensorCode(char \* arr)** copies sensor code in array.
-Minimum length is 11.
+Minimum length of arr is 11.
 
 
 #### Debug
@@ -265,19 +262,14 @@ Minimum length is 11.
 #### Must
 
 - improve documentation
-- get hardware to test
+- get hardware to test (See ACD10 #11)
 
 #### Should
 
-- investigate the acquisition time of 80 milliseconds
-  - can it be made shorter by default?
-- improve error handling
+- keep in sync with ACD10 where possible.
 
 #### Could
 
-- rethink function names?
-- create unit tests if possible
-
 #### Wont
 
 

libraries/ACD3100/library.json

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

libraries/ACD3100/library.properties

@@ -1,5 +1,5 @@
 name=ACD3100
-version=0.1.0
+version=0.1.1
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Arduino library for the ACD3100 CO2 sensor.