add Wire1 support ESP32 (#24)

- add Wire1 support for ESP32
- update readme.md
- minor edits

Author: RobTillaart

AGS02MA.cpp

@@ -2,7 +2,7 @@
 //    FILE: AGS02MA.cpp
 //  AUTHOR: Rob Tillaart, Viktor Balint, Beanow
 //    DATE: 2021-08-12
-// VERSION: 0.3.3
+// VERSION: 0.3.4
 // PURPOSE: Arduino library for AGS02MA TVOC sensor
 //     URL: https://github.com/RobTillaart/AGS02MA
 
@@ -29,8 +29,7 @@ AGS02MA::AGS02MA(const uint8_t deviceAddress, TwoWire *wire)
 #if defined (ESP8266) || defined(ESP32)
 bool AGS02MA::begin(uint8_t dataPin, uint8_t clockPin)
 {
-  _startTime = millis();  // PREHEAT
-  _wire      = &Wire;
+  _startTime = millis();  //  PREHEAT
   if ((dataPin < 255) && (clockPin < 255))
   {
     _wire->begin(dataPin, clockPin);
@@ -54,8 +53,8 @@ bool AGS02MA::isConnected()
 {
 #if defined (__AVR__)
   //  TWBR = 255;    //  == 30.4 KHz with TWSR = 0x00
-  TWBR = 78;         //  == 25.0 KHZ 
-  TWSR = 0x01;       //  prescaler = 4
+  TWBR = 78;         //  == 25.0 KHZ
+  TWSR = 0x01;       //  pre-scaler = 4
 #else
   _wire->setClock(AGS02MA_I2C_CLOCK);
 #endif
@@ -303,8 +302,8 @@ bool AGS02MA::_readRegister(uint8_t reg)
 
 #if defined (__AVR__)
   //  TWBR = 255;    //  == 30.4 KHz with TWSR = 0x00
-  TWBR = 78;         //  == 25.0 KHZ 
-  TWSR = 0x01;       //  prescaler = 4
+  TWBR = 78;         //  == 25.0 KHZ
+  TWSR = 0x01;       //  pre-scaler = 4
 #else
   _wire->setClock(AGS02MA_I2C_CLOCK);
 #endif
@@ -320,7 +319,7 @@ bool AGS02MA::_readRegister(uint8_t reg)
   {
     _error = AGS02MA_ERROR_READ;
 #if defined (__AVR__)
-    TWSR = 0x00;   //  reset prescaler = 1
+    TWSR = 0x00;   //  reset pre-scaler = 1
 #endif
     _wire->setClock(_I2CResetSpeed);
     return false;
@@ -330,7 +329,7 @@ bool AGS02MA::_readRegister(uint8_t reg)
     _buffer[i] = _wire->read();
   }
 #if defined (__AVR__)
-  TWSR = 0x00;   //  reset prescaler = 1
+  TWSR = 0x00;   //  reset pre-scaler = 1
 #endif
   _wire->setClock(_I2CResetSpeed);
   return true;
@@ -344,8 +343,8 @@ bool AGS02MA::_writeRegister(uint8_t reg)
 
 #if defined (__AVR__)
   //  TWBR = 255;    //  == 30.4 KHz with TWSR = 0x00
-  TWBR = 78;         //  == 25.0 KHZ 
-  TWSR = 0x01;       //  prescaler = 4
+  TWBR = 78;         //  == 25.0 KHZ
+  TWSR = 0x01;       //  pre-scaler = 4
 #else
   _wire->setClock(AGS02MA_I2C_CLOCK);
 #endif

AGS02MA.h

@@ -3,7 +3,7 @@
 //    FILE: AGS02MA.h
 //  AUTHOR: Rob Tillaart, Viktor Balint, Beanow
 //    DATE: 2021-08-12
-// VERSION: 0.3.3
+// VERSION: 0.3.4
 // PURPOSE: Arduino library for AGS02MA TVOC sensor
 //     URL: https://github.com/RobTillaart/AGS02MA
 //
@@ -13,7 +13,7 @@
 #include "Wire.h"
 
 
-#define AGS02MA_LIB_VERSION         (F("0.3.3"))
+#define AGS02MA_LIB_VERSION         (F("0.3.4"))
 
 #define AGS02MA_OK                  0
 #define AGS02MA_ERROR               -10

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.4] - 2023-09-25
+- add Wire1 support for ESP32
+- update readme.md
+- minor edits
+
+
 ## [0.3.3] - 2023-01-21
 - update GitHub actions
 - update license 2023
@@ -14,7 +20,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - minor edit code
 - add CHANGELOG.md (for real)
 
-
 ## [0.3.2] - 2022-10-26
 - add CHANGELOG.md
 - add RP2040 in build

README.md

@@ -2,8 +2,11 @@
 [![Arduino CI](https://github.com/RobTillaart/AGS02MA/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/AGS02MA/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/AGS02MA/actions/workflows/arduino-lint.yml)
 [![JSON check](https://github.com/RobTillaart/AGS02MA/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/AGS02MA/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/AGS02MA.svg)](https://github.com/RobTillaart/AGS02MA/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/AGS02MA/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/AGS02MA.svg?maxAge=3600)](https://github.com/RobTillaart/AGS02MA/releases)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/AGS02MA.svg)](https://registry.platformio.org/libraries/robtillaart/AGS02MA)
 
 
 # AGS02MA
@@ -94,6 +97,10 @@ with the sensor and this (or other) library.
 
 ## Interface
 
+```cpp
+#include "AGS02MA.h"
+```
+
 
 #### Constructor
 
@@ -269,11 +276,11 @@ Read datasheet or table below for details. A new read is needed to update this.
 
 #### Must
 
+- improve documentation
+  - add indicative table for PPB health zone (source)
 
 #### Should
 
-- improve documentation
-  - add indicative table for PPB health zone (source)
 - put the I2C speed code in 2 inline functions
   - less repeating conditional code places
   - setLowSpeed() + setNormalSpeed()
@@ -292,3 +299,12 @@ Read datasheet or table below for details. A new read is needed to update this.
 
 #### Wont
 
+
+## 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,
+

keywords.txt

@@ -47,6 +47,7 @@ dataReady	KEYWORD2
 
 readRegister	KEYWORD2
 
+
 # Constants (	LITERAL1)
 AGS02MA_LIB_VERSION	LITERAL1
 

library.json

@@ -21,9 +21,9 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/AGS02MA.git"
   },
-  "version": "0.3.3",
+  "version": "0.3.4",
   "license": "MIT",
-  "frameworks": "arduino",
+  "frameworks": "*",
   "platforms": "*",
   "headers": "AGS02MA.h"
 }

library.properties

@@ -1,5 +1,5 @@
 name=AGS02MA
-version=0.3.3
+version=0.3.4
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Arduino library for AGS02MA - TVOC sensor