2021-08-13 07:08:52 -04:00
|
|
|
//
|
|
|
|
// FILE: AGS02MA.cpp
|
2021-08-15 13:35:40 -04:00
|
|
|
// AUTHOR: Rob Tillaart, Viktor Balint
|
2021-08-13 07:08:52 -04:00
|
|
|
// DATE: 2021-08-12
|
2021-08-15 13:35:40 -04:00
|
|
|
// VERSION: 0.1.1
|
2021-08-13 07:08:52 -04:00
|
|
|
// PURPOSE: Arduino library for AGS02MA TVOC
|
|
|
|
// URL: https://github.com/RobTillaart/AGS02MA
|
|
|
|
|
|
|
|
|
|
|
|
#include "AGS02MA.h"
|
|
|
|
|
|
|
|
|
|
|
|
// REGISTERS
|
|
|
|
#define AGS02MA_DATA 0x00
|
|
|
|
#define AGS02MA_CALIBRATION 0x01
|
|
|
|
#define AGS02MA_VERSION 0x11
|
|
|
|
#define AGS02MA_SLAVE_ADDRESS 0x21
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
AGS02MA::AGS02MA(const uint8_t deviceAddress, TwoWire *wire)
|
|
|
|
{
|
2021-08-15 13:35:40 -04:00
|
|
|
_address = deviceAddress;
|
|
|
|
_wire = wire;
|
|
|
|
|
|
|
|
_I2CResetSpeed = 100000;
|
|
|
|
_startTime = 0;
|
|
|
|
_lastRead = 0;
|
|
|
|
_mode = 255;
|
|
|
|
_status = AGS02MA_OK;
|
|
|
|
_error = AGS02MA_OK;
|
2021-08-13 07:08:52 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
#if defined (ESP8266) || defined(ESP32)
|
|
|
|
bool AGS02MA::begin(uint8_t dataPin, uint8_t clockPin)
|
|
|
|
{
|
|
|
|
_startTime = millis(); // PREHEAT
|
|
|
|
_wire = &Wire;
|
|
|
|
if ((dataPin < 255) && (clockPin < 255))
|
|
|
|
{
|
|
|
|
_wire->begin(dataPin, clockPin);
|
|
|
|
} else {
|
|
|
|
_wire->begin();
|
|
|
|
}
|
|
|
|
return isConnected();
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
bool AGS02MA::begin()
|
|
|
|
{
|
|
|
|
_startTime = millis(); // PREHEAT TIMING
|
|
|
|
_wire->begin();
|
|
|
|
return isConnected();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool AGS02MA::isConnected()
|
|
|
|
{
|
|
|
|
#if defined (__AVR__)
|
2021-08-15 13:35:40 -04:00
|
|
|
TWBR = 255;
|
2021-08-13 07:08:52 -04:00
|
|
|
#else
|
|
|
|
_wire->setClock(AGS02MA_I2C_CLOCK);
|
|
|
|
#endif
|
|
|
|
_wire->beginTransmission(_address);
|
2021-08-15 13:35:40 -04:00
|
|
|
bool rv = ( _wire->endTransmission(true) == 0);
|
|
|
|
_wire->setClock(_I2CResetSpeed);
|
2021-08-13 07:08:52 -04:00
|
|
|
return rv;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool AGS02MA::setAddress(const uint8_t deviceAddress)
|
|
|
|
{
|
|
|
|
if (deviceAddress < 10 or deviceAddress > 119) return false;
|
|
|
|
_buffer[2] = _buffer[0] = deviceAddress;
|
|
|
|
_buffer[3] = _buffer[1] = 0xFF ^ deviceAddress;
|
|
|
|
_buffer[4] = _CRC8(_buffer, 4);
|
|
|
|
if (_writeRegister(AGS02MA_SLAVE_ADDRESS))
|
|
|
|
{
|
|
|
|
_address = deviceAddress;
|
|
|
|
}
|
|
|
|
return isConnected();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
uint8_t AGS02MA::getSensorVersion()
|
|
|
|
{
|
|
|
|
uint8_t version = 0xFF;
|
|
|
|
if (_readRegister(AGS02MA_VERSION))
|
|
|
|
{
|
2021-08-15 13:35:40 -04:00
|
|
|
// unclear what the other bytes have for information. (if there is any)
|
2021-08-13 07:08:52 -04:00
|
|
|
version = _buffer[3];
|
|
|
|
if (_CRC8(_buffer, 5) != 0)
|
|
|
|
{
|
|
|
|
_error = AGS02MA_CRC_ERROR;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return version;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool AGS02MA::setPPBMode()
|
|
|
|
{
|
|
|
|
_buffer[0] = 0x00;
|
|
|
|
_buffer[1] = 0xFF;
|
|
|
|
_buffer[2] = 0x00;
|
|
|
|
_buffer[3] = 0xFF;
|
|
|
|
_buffer[4] = 0x30;
|
|
|
|
if (_writeRegister(AGS02MA_DATA))
|
|
|
|
{
|
|
|
|
_mode = 0;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool AGS02MA::setUGM3Mode()
|
|
|
|
{
|
|
|
|
_buffer[0] = 0x02;
|
|
|
|
_buffer[1] = 0xFD;
|
|
|
|
_buffer[2] = 0x02;
|
|
|
|
_buffer[3] = 0xFD;
|
|
|
|
_buffer[4] = 0x00;
|
|
|
|
if (_writeRegister(AGS02MA_DATA))
|
|
|
|
{
|
|
|
|
_mode = 1;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
uint32_t AGS02MA::readPPB()
|
|
|
|
{
|
|
|
|
uint32_t val = 0xFFFFFFFF;
|
|
|
|
_lastRead = millis();
|
|
|
|
if (_readRegister(AGS02MA_DATA))
|
|
|
|
{
|
|
|
|
_status = _buffer[0];
|
|
|
|
val = _buffer[1] * 65536UL;
|
|
|
|
val += _buffer[2] * 256;
|
|
|
|
val += _buffer[3];
|
|
|
|
if (_CRC8(_buffer, 5) != 0)
|
|
|
|
{
|
|
|
|
_error = AGS02MA_CRC_ERROR;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return val;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
uint32_t AGS02MA::readUGM3()
|
|
|
|
{
|
2021-08-15 13:35:40 -04:00
|
|
|
// TODO identical code wise to PPB, can be merged into one.
|
2021-08-13 07:08:52 -04:00
|
|
|
uint32_t val = 0xFFFFFFFF;
|
|
|
|
_lastRead = millis();
|
|
|
|
if (_readRegister(AGS02MA_DATA))
|
|
|
|
{
|
|
|
|
_status = _buffer[0];
|
|
|
|
val = _buffer[1] * 65536UL;
|
|
|
|
val += _buffer[2] * 256;
|
|
|
|
val += _buffer[3];
|
|
|
|
if (_CRC8(_buffer, 5) != 0)
|
|
|
|
{
|
|
|
|
_error = AGS02MA_CRC_ERROR;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return val;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool AGS02MA::zeroCalibration()
|
|
|
|
{
|
|
|
|
_buffer[0] = 0x00;
|
|
|
|
_buffer[1] = 0x0C;
|
|
|
|
_buffer[2] = 0xFF;
|
|
|
|
_buffer[3] = 0xF3;
|
|
|
|
_buffer[4] = 0xFC;
|
|
|
|
return _writeRegister(AGS02MA_CALIBRATION);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
int AGS02MA::lastError()
|
|
|
|
{
|
|
|
|
int e = _error;
|
|
|
|
_error = AGS02MA_OK; // reset error after read
|
|
|
|
return e;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/////////////////////////////////////////////////////////
|
|
|
|
//
|
|
|
|
// PRIVATE
|
|
|
|
//
|
|
|
|
bool AGS02MA::_readRegister(uint8_t reg)
|
|
|
|
{
|
|
|
|
#if defined (__AVR__)
|
2021-08-15 13:35:40 -04:00
|
|
|
TWBR = 255;
|
2021-08-13 07:08:52 -04:00
|
|
|
#else
|
|
|
|
_wire->setClock(AGS02MA_I2C_CLOCK);
|
|
|
|
#endif
|
|
|
|
_wire->beginTransmission(_address);
|
|
|
|
_wire->write(reg);
|
2021-08-15 13:35:40 -04:00
|
|
|
_error = _wire->endTransmission(true);
|
|
|
|
delay(30);
|
2021-08-13 07:08:52 -04:00
|
|
|
if (_wire->requestFrom(_address, (uint8_t)5) != 5)
|
|
|
|
{
|
|
|
|
_error = AGS02MA_ERROR;
|
2021-08-15 13:35:40 -04:00
|
|
|
_wire->setClock(_I2CResetSpeed);
|
2021-08-13 07:08:52 -04:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
for (int i = 0; i < 5; i++)
|
|
|
|
{
|
|
|
|
_buffer[i] = _wire->read();
|
|
|
|
}
|
2021-08-15 13:35:40 -04:00
|
|
|
delay(30);
|
|
|
|
_wire->setClock(_I2CResetSpeed);
|
2021-08-13 07:08:52 -04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
bool AGS02MA::_writeRegister(uint8_t reg)
|
|
|
|
{
|
|
|
|
#if defined (__AVR__)
|
2021-08-15 13:35:40 -04:00
|
|
|
TWBR = 255;
|
2021-08-13 07:08:52 -04:00
|
|
|
#else
|
|
|
|
_wire->setClock(AGS02MA_I2C_CLOCK);
|
|
|
|
#endif
|
|
|
|
_wire->beginTransmission(_address);
|
|
|
|
_wire->write(reg);
|
|
|
|
for (int i = 0; i < 5; i++)
|
|
|
|
{
|
|
|
|
_wire->write(_buffer[i]);
|
|
|
|
}
|
2021-08-15 13:35:40 -04:00
|
|
|
_error = _wire->endTransmission(true);
|
|
|
|
delay(30);
|
|
|
|
_wire->setClock(_I2CResetSpeed);
|
2021-08-13 07:08:52 -04:00
|
|
|
return (_error == 0);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
uint8_t AGS02MA::_CRC8(uint8_t * buf, uint8_t size)
|
|
|
|
{
|
|
|
|
uint8_t crc = 0xFF; // start value
|
|
|
|
for (uint8_t b = 0; b < size; b++)
|
|
|
|
{
|
|
|
|
crc ^= buf[b];
|
|
|
|
for (uint8_t i = 0; i < 8; i++)
|
|
|
|
{
|
|
|
|
if (crc & 0x80) crc = (crc << 1) ^ 0x31;
|
|
|
|
else crc = (crc << 1);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return crc;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// -- END OF FILE --
|