GY-63_MS5611/libraries/Max44009/max44009.cpp

//
//    FILE: Max44009.cpp
//  AUTHOR: Rob Tillaart
// VERSION: 0.5.0
// PURPOSE: library for MAX44009 lux sensor Arduino
//     URL: https://github.com/RobTillaart/MAX44009
//
//  HISTORY
//
//  0.5.0   2021-06-04  fix exponent math.
//  0.4.4   2021-05-27  arduino-lint
//  0.4.3   2020-12-30  arduino-ci, unit test
//  0.4.2   2020-06-19  fix library.json
//  0.4.1   2020-03-21  #pragma, readme.nd, license.md
//  0.4.0   2020-01-30  remove automatic mode from constructors;
//                      added example code
//  0.3.3   2020-01-27  issue #140 refactor constructors / configure
//  0.3.2   2020-01-21  solve #132 cannot read full range in manual mode.
//                      set automatic mode explicitly in constructors;
//                      added some error checks
//  0.3.1   2020-01-21  issue #133 overflow of the exponent
//  0.3.0   2020-01-20  issue #141 Kudos to Moritz89
//  0.2.0   2019-08-23  solve #127 == redo #118
//  0.1.10  2018-12-08  issue #118 Fix constructor esp8266
//                      (thanks to Bolukan)
//  0.1.9   2018-07-01  issue #108 Fix shift math
//                      (thanks Roland vandecook)
//  0.1.8   2018-05-13  issue #105 Fix read register
//                      (thanks morxGrillmeister)
//  0.1.7   2018-04-02  issue #98 extend constructor for ESP8266
//  0.1.6   2017-07-26  revert double to float 
//  0.1.5   updated history
//  0.1.4   added setAutomaticMode() to max44009.h (thanks debsahu)
//  0.1.03  added configuration
//  0.1.02  added threshold code
//  0.1.01  added interrupt code
//  0.1.00  initial version


#include "Max44009.h"


#if defined(ESP8266) || defined(ESP32)
Max44009::Max44009(const uint8_t address, const uint8_t dataPin, const uint8_t clockPin)
{
  _address = address;
  _data    = 0;
  _error   = MAX44009_OK;
  _wire    = &Wire;

  if ((dataPin < 255) && (clockPin < 255))
  {
    _wire->begin(dataPin, clockPin);
  } else {
    _wire->begin();
  }
}
#endif


Max44009::Max44009(const uint8_t address, const Boolean begin)
{
  Max44009::configure(address, &Wire, begin);
}


Max44009::Max44009(const Boolean begin)
{
  Max44009::configure(MAX44009_DEFAULT_ADDRESS, &Wire, begin);
}


void Max44009::configure(const uint8_t address, TwoWire *wire, const Boolean begin)
{
  _address = address;
  _data    = 0;
  _error   = MAX44009_OK;
  _wire    = wire;

  if (begin == Boolean::True)
  {
    _wire->begin();
  }
}


bool Max44009::isConnected()
{
  _wire->beginTransmission(_address);
  _error = _wire->endTransmission();
  return (_error == 0);
}


float Max44009::getLux(void)
{
  uint8_t datahigh = read(MAX44009_LUX_READING_HIGH);
  if (_error != MAX44009_OK)
  {
    _error = MAX44009_ERROR_HIGH_BYTE;
    return _error;
  }
  uint8_t datalow = read(MAX44009_LUX_READING_LOW);
  if (_error != MAX44009_OK)
  {
    _error = MAX44009_ERROR_LOW_BYTE;
    return _error;
  }
  uint8_t exponent = datahigh >> 4;
  if (exponent == 0x0F)
  {
    _error = MAX44009_ERROR_OVERFLOW;
    return _error;
  }

  float lux = convertToLux(datahigh, datalow);
  return lux;
}


int Max44009::getError()
{
  int err = _error;
  _error = MAX44009_OK;
  return err;
}


bool Max44009::setHighThreshold(const float value)
{
  return setThreshold(MAX44009_THRESHOLD_HIGH, value);
}


float Max44009::getHighThreshold(void)
{
  return getThreshold(MAX44009_THRESHOLD_HIGH);
}


bool Max44009::setLowThreshold(const float value)
{
  return setThreshold(MAX44009_THRESHOLD_LOW, value);
}


float Max44009::getLowThreshold(void)
{
  return getThreshold(MAX44009_THRESHOLD_LOW);
}


void Max44009::setThresholdTimer(const uint8_t value)
{
  write(MAX44009_THRESHOLD_TIMER, value);
}


uint8_t Max44009::getThresholdTimer()
{
  return read(MAX44009_THRESHOLD_TIMER);
}


void Max44009::setConfiguration(const uint8_t value)
{
  write(MAX44009_CONFIGURATION, value);
}


uint8_t Max44009::getConfiguration()
{
  return read(MAX44009_CONFIGURATION);
}


void Max44009::setAutomaticMode()
{
  // CDR & TIM cannot be written in automatic mode
  uint8_t config = read(MAX44009_CONFIGURATION);
  config &= ~MAX44009_CFG_MANUAL;
  write(MAX44009_CONFIGURATION, config);
}


void Max44009::setContinuousMode()
{
  uint8_t config = read(MAX44009_CONFIGURATION);
  config |= MAX44009_CFG_CONTINUOUS;
  write(MAX44009_CONFIGURATION, config);
}


void Max44009::clrContinuousMode()
{
  uint8_t config = read(MAX44009_CONFIGURATION);
  config &= ~MAX44009_CFG_CONTINUOUS;
  write(MAX44009_CONFIGURATION, config);
}


void Max44009::setManualMode(uint8_t CDR, uint8_t TIM)
{
  if (CDR !=0) CDR = 1;    // only 0 or 1 
  if (TIM > 7) TIM = 7;
  uint8_t config = read(MAX44009_CONFIGURATION);
  config |= MAX44009_CFG_MANUAL;
  config &= 0xF0;                     // clear old CDR & TIM bits
  config |= CDR << 3 | TIM;           // set new CDR & TIM bits
  write(MAX44009_CONFIGURATION, config);
}


float Max44009::convertToLux(uint8_t datahigh, uint8_t datalow)
{
  uint8_t  exponent = datahigh >> 4;
  uint32_t mantissa = ((datahigh & 0x0F) << 4) + (datalow & 0x0F);
  float lux = ((0x0001 << exponent) * 0.045) * mantissa;
  return lux;
}


///////////////////////////////////////////////////////////
//
// PRIVATE
//
bool Max44009::setThreshold(const uint8_t reg, const float value)
{
  // CHECK RANGE OF VALUE
  if ((value < 0.0) || (value > 188006)) return false;

  uint32_t mantissa = round(value * 22.2222222);     // was round(value / 0.045);  multiply is faster.
  uint8_t exponent = 0;
  while (mantissa > 255)
  {
    mantissa >>= 1;                // bits get lost
    exponent++;
  };
  mantissa = (mantissa >> 4) & 0x0F;
  exponent <<= 4;
  write(reg, exponent | mantissa);
  return true;
}


float Max44009::getThreshold(uint8_t reg)
{
  uint8_t datahigh = read(reg);
  float lux = convertToLux(datahigh, 0x08);  // 0x08 = correction for lost bits 
  return lux;
}


uint8_t Max44009::read(uint8_t reg)
{
  _wire->beginTransmission(_address);
  _wire->write(reg);
  _error = _wire->endTransmission();
  if (_error != MAX44009_OK)
  {
    return _data; // last value
  }
  if (_wire->requestFrom(_address, (uint8_t) 1) != 1)
  {
    _error = MAX44009_ERROR_WIRE_REQUEST;
    return _data; // last value
  }
  _data = _wire->read();
  return _data;
}


void Max44009::write(uint8_t reg, uint8_t value)
{
  _wire->beginTransmission(_address);
  _wire->write(reg);
  _wire->write(value);
  _error = _wire->endTransmission();
}


// -- END OF FILE --