TSL2591.h

Go to the documentation of this file.

#pragma once
#include <iostream>
#include <wiringPiI2C.h>
#include <unistd.h>
#include <stdint.h>
#include <math.h>
#include <string>
#include "BaseComponent.h"
#include "../Data/SensorLevels.h"
 
namespace RumPi
{
    //TSL2591 Constants
    constexpr int TSL2591_ADDR = 0x29;
    constexpr int TSL2591_COMMAND_BIT = 0xA0;
    constexpr int TSL2591_ENABLE_REG = 0x00;
    constexpr int TSL2591_CONTROL_REG = 0x01;
    constexpr int TSL2591_C0DATA_L = 0x14;
    constexpr int TSL2591_C1DATA_L = 0x16;
 
    //Lux Coefficients
    constexpr double TSL2591_LUX_DF = 408.0;
    constexpr double TSL2591_LUX_COEFB = 1.64;
 
    enum class E_TSL2591_IntegrationTime
    {
        ATIME_100MS = 0x00,
        ATIME_200MS = 0x01,
        ATIME_300MS = 0x02,
        ATIME_400MS = 0x03,
        ATIME_500MS = 0x04,
        ATIME_600MS = 0x05
    };
 
    enum class E_TSL2591_AmplificationGain
    {
        GAIN_LOW = 0x00,  // 1x
        GAIN_MED = 0x10,  // 25x
        GAIN_HIGH = 0x20, // 428x
        GAIN_MAX = 0x30   // 9876x
    };
 
    class TSL2591 : public BaseComponent
    {
    private:
        int myFileDescriptor;                       
        uint16_t myRawChannel0Reading;              
        uint16_t myRawChannel1Reading;              
        float myCalculatedLux;                      
        E_TSL2591_IntegrationTime myIntegrationTimeMilliseconds;    
        E_TSL2591_AmplificationGain myAmplificationGain;            
 
        //Lux boundaries for the light-level buckets (ascending). Defaulted in the ctor and overridden from the
        //library config, so the dashboard's light categories can be tuned without a rebuild.
        float myLightCutoffDark;        
        float myLightCutoffVeryDim;     
        float myLightCutoffDim;         
        float myLightCutoffNormal;      
        float myLightCutoffBright;      
 
    public:
        TSL2591(E_TSL2591_IntegrationTime integrationTimeMilliseconds = E_TSL2591_IntegrationTime::ATIME_100MS, E_TSL2591_AmplificationGain amplificationGain = E_TSL2591_AmplificationGain::GAIN_MED);
 
        virtual ~TSL2591();
 
        virtual void TurnOn() override;
 
        virtual void TurnOff() override;
 
        virtual void ProcessRawValues() override;
 
        virtual std::string ToString() const override;
 
        virtual bool AdjustAndValidateSettings(const uint16_t ch0);
 
        virtual float CalculateLux(const uint16_t ch0, const uint16_t ch1);
 
        virtual float GetLux() const;
 
        virtual E_LightLevel CalculateLightLevel() const;
 
        virtual E_LightLevel CalculateLightLevel(const float lux) const;
 
        void SetLightLevelCutoffs(float dark, float veryDim, float dim, float normal, float bright);
 
        virtual std::string DetermineLightCategory() const;
 
        virtual std::string DetermineLightCategory(const float lux) const;
 
        virtual void SetTiming(const E_TSL2591_IntegrationTime integrationTimeMilliseconds, const E_TSL2591_AmplificationGain amplificationGain);
 
        static float ConvertIntegrationTimeToDecimalMilliseconds(const E_TSL2591_IntegrationTime integrationTimeMilliseconds);
 
        static E_TSL2591_IntegrationTime ConvertDecimalMillisecondsToIntegrationTime(const float decimalMilliseconds);
 
        static float ConvertAmplificationGainToDecimalMultiplier(const E_TSL2591_AmplificationGain amplificationGain);
 
        static E_TSL2591_AmplificationGain ConvertDecimalMultiplierToAmplificationGain(const float decimalMultiplier);
    };
} // namespace RumPi