mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-09-20 00:55:58 -04:00
116 lines
3.2 KiB
C++
116 lines
3.2 KiB
C++
#ifndef MAX44009_H
|
|
#define MAX44009_H
|
|
//
|
|
// FILE: Max44009.h
|
|
// AUTHOR: Rob dot Tillaart at gmail dot com
|
|
// VERSION: 0.3.1
|
|
// PURPOSE: library for MAX44009 lux sensor Arduino
|
|
// HISTORY: See Max440099.cpp
|
|
//
|
|
// Released to the public domain
|
|
//
|
|
|
|
#include "Wire.h"
|
|
|
|
#if defined(ARDUINO) && ARDUINO >= 100
|
|
#include "Arduino.h"
|
|
#else
|
|
#include "WProgram.h"
|
|
#endif
|
|
|
|
#define MAX44009_LIB_VERSION "0.3.1"
|
|
#define MAX44009_DEFAULT_ADDRESS 0x4A
|
|
#define MAX44009_ALT_ADDRESS 0x4B
|
|
|
|
// REGISTERS
|
|
#define MAX44009_INTERRUPT_STATUS 0x00
|
|
#define MAX44009_INTERRUPT_ENABLE 0x01
|
|
#define MAX44009_CONFIGURATION 0x02
|
|
#define MAX44009_LUX_READING_HIGH 0x03
|
|
#define MAX44009_LUX_READING_LOW 0x04
|
|
#define MAX44009_THRESHOLD_HIGH 0x05
|
|
#define MAX44009_THRESHOLD_LOW 0x06
|
|
#define MAX44009_THRESHOLD_TIMER 0x07
|
|
|
|
// CONFIGURATION MASKS
|
|
#define MAX44009_CFG_CONTINUOUS 0x80
|
|
#define MAX44009_CFG_MANUAL 0x40
|
|
#define MAX44009_CFG_CDR 0x08
|
|
#define MAX44009_CFG_TIMER 0x07
|
|
|
|
// ERROR CODES
|
|
#define MAX44009_OK 0
|
|
#define MAX44009_ERROR_WIRE_REQUEST -10
|
|
#define MAX44009_ERROR_OVERFLOW -20
|
|
#define MAX44009_ERROR_HIGH_BYTE -30
|
|
#define MAX44009_ERROR_LOW_BYTE -31
|
|
|
|
|
|
class Max44009
|
|
{
|
|
public:
|
|
// enum class to prevent bool to be implicitly casted to int
|
|
enum class Boolean { True, False };
|
|
|
|
#if defined(ESP8266) || defined(ESP32)
|
|
// dataPin and clockPin can be used for ESP8266
|
|
Max44009(const uint8_t address, const uint8_t dataPin, const uint8_t clockPin);
|
|
#endif
|
|
|
|
// ctor for UNO
|
|
Max44009(const uint8_t address, const Boolean begin = Boolean::True);
|
|
// default ctor with default address 0xCB
|
|
Max44009(const Boolean begin = Boolean::True);
|
|
// Change I2C interface and address
|
|
void configure(const uint8_t address, TwoWire *wire);
|
|
|
|
float getLux();
|
|
int getError();
|
|
|
|
void setHighThreshold(const float);
|
|
float getHighThreshold(void);
|
|
void setLowThreshold(const float);
|
|
float getLowThreshold(void);
|
|
void setThresholdTimer(const uint8_t);
|
|
uint8_t getThresholdTimer();
|
|
|
|
void enableInterrupt() { write(MAX44009_INTERRUPT_ENABLE, 1); };
|
|
void disableInterrupt() { write(MAX44009_INTERRUPT_ENABLE, 0); };
|
|
bool interruptEnabled() { return read(MAX44009_INTERRUPT_ENABLE) & 0x01; };
|
|
uint8_t getInterruptStatus() { return read(MAX44009_INTERRUPT_STATUS) & 0x01; };
|
|
|
|
// check datasheet for detailed behavior
|
|
void setConfiguration(uint8_t);
|
|
uint8_t getConfiguration();
|
|
void setAutomaticMode();
|
|
void setContinuousMode();
|
|
// CDR = Current Divisor Ratio
|
|
// CDR = 1 ==> only 1/8th is measured
|
|
// TIM = Time Integration Measurement (table)
|
|
// 000 800ms
|
|
// 001 400ms
|
|
// 010 200ms
|
|
// 011 100ms
|
|
// 100 50ms manual only
|
|
// 101 25ms manual only
|
|
// 110 12.5ms manual only
|
|
// 111 6.25ms manual only
|
|
void setManualMode(uint8_t CDR, uint8_t TIM);
|
|
|
|
private:
|
|
void setThreshold(uint8_t, float);
|
|
float getThreshold(uint8_t);
|
|
|
|
uint8_t read(uint8_t reg);
|
|
void write(uint8_t, uint8_t);
|
|
|
|
uint8_t _address;
|
|
uint8_t _data;
|
|
int _error;
|
|
|
|
TwoWire* _wire;
|
|
};
|
|
#endif
|
|
|
|
// END OF FILE
|