AloraSensorKit.h

Go to the documentation of this file.

#ifndef ALORA_ALORASENSORKIT_H
#define ALORA_ALORASENSORKIT_H

#include <Wire.h>
#include <Arduino.h>
#include <Adafruit_Sensor.h>
#include <Adafruit_BME280.h>
#include <ClosedCube_HDC1080.h>
#include <NMEAGPS.h>
#include <Streamers.h>
#include "Adafruit_TSL2591.h"
#include <SparkFunCCS811.h>

#include "GpioExpander.h"

#include <RTClib.h>
#undef SECONDS_PER_DAY

#include "AllAboutEE_MAX11609.h"
using namespace AllAboutEE;

#include "AloraIMULSM9DS1Adapter.h"

#if !defined(ALORA_IMU_SENSOR)
    #define ALORA_IMU_SENSOR AloraIMULSM9DS1Adapter
#endif

#if !defined(ALORA_SENSOR_USE_CCS811)
    #define ALORA_SENSOR_USE_CCS811 1
#endif

#if !defined(ALORA_SENSOR_QUERY_INTERVAL)
    #define ALORA_SENSOR_QUERY_INTERVAL 300
#endif

#if !defined(ALORA_USE_MAX11609)
    #define ALORA_USE_MAX11609 1
#endif

#if !defined(ALORA_USE_AIR_QUALITY_GAS_SENSOR)
    #define ALORA_USE_AIR_QUALITY_GAS_SENSOR 1
#endif

#if !defined(ALORA_USE_IMU_SENSOR)
    #define ALORA_USE_IMU_SENSOR 1
#endif

#if !defined(ALORA_USE_GPIO_EXPANDER)
    #define ALORA_USE_GPIO_EXPANDER 1
#endif

#if !defined(ALORA_USE_HDC1080_SENSOR)
    #define ALORA_USE_HDC1080_SENSOR 1
#endif

#if !defined(ALORA_USE_BME280_SENSOR)
    #define ALORA_USE_BME280_SENSOR 1
#endif

#if !defined(ALORA_USE_TSL2591_SENSOR)
    #define ALORA_USE_TSL2591_SENSOR 1
#endif

#define ALORA_HDC1080_ADDRESS 0x40

#define ALORA_I2C_ADDRESS_CCS811 0x5A

#if ALORA_IMU_SENSOR == ALORA_IMU_SENSOR_LSM9DS1
    #define ALORA_I2C_ADDRESS_IMU_M 0x1E
#elif ALORA_IMU_SENSOR == ALORA_IMU_SENSOR_LSM303AGR
    #define ALORA_I2C_ADDRESS_IMU_M 0x3C
#endif

#if ALORA_IMU_SENSOR == ALORA_IMU_SENSOR_LSM9DS1
    #define ALORA_I2C_ADDRESS_IMU_AG 0x6B
#elif ALORA_IMU_SENSOR == ALORA_IMU_SENSOR_LSM303AGR
    #define ALORA_I2C_ADDRESS_IMU_AG 0x32
#endif

#if !defined(ALORA_MAGNETIC_SENSOR_PIN)
    #define ALORA_MAGNETIC_SENSOR_PIN 35
#endif

#if !defined(ALORA_ADC_GAS_HEATER_PIN)
    #define ALORA_ADC_GAS_HEATER_PIN 13
#endif

#if !defined(ALORA_ADC_GAS_CHANNEL)
    #define ALORA_ADC_GAS_CHANNEL 1
#endif

#if !defined(ALORA_GPS_ENABLE_PIN)
    #define ALORA_GPS_ENABLE_PIN 12
#endif

struct SensorValues {
    float T1;           
    float P;            
    float H1;           
    float T2;           
    float H2;           
    double lux;         
    uint16_t gas;       
    uint16_t co2;       
    float accelX;       
    float accelY;       
    float accelZ;       
    float gyroX;        
    float gyroY;        
    float gyroZ;        
    float magX;         
    float magY;         
    float magZ;         
    float magHeading;   
    int magnetic;       
    float windSpeed;    
    gps_fix gpsFix;     
};


class AloraSensorKit {
public:
    AloraSensorKit(uint8_t enablePin = 16, uint8_t activeLogic = HIGH);
    ~AloraSensorKit();

    void begin();
    void run();
    void turnOff();
    void turnOn();
    void scanAndPrintI2C(Print& print);
    void printSensingTo(Print& print);
    void printSensingTo(String& str);
    uint16_t readADC(uint8_t channel);
    DateTime getDateTime();
    SensorValues& getLastSensorData();
    void initGPS(Stream* gpsStream);
    NMEAGPS* getGPSObject();
    GpioExpander* getIOExpander();
    ALORA_IMU_SENSOR* getIMUSensorAdapter();
    void setCCS811WakeLogic(uint8_t wakeLogic = LOW);

private:
    uint8_t enablePin;                                          
    uint8_t enablePinActiveLogic;                               
    NMEAGPS* gps = NULL;                                        
    Stream* gpsStream = NULL;                                   
    Adafruit_BME280* bme280 = NULL;                             
    ClosedCube_HDC1080* hdc1080 = NULL;                         
    Adafruit_TSL2591* tsl2591 = NULL;                           
    CCS811* ccs811 = NULL;                                      
    ALORA_IMU_SENSOR* imuSensor = NULL;                         
    GpioExpander* ioExpander = NULL;                            
    MAX11609* max11609 = NULL;                                  
    RTC_DS3231* rtc = NULL;                                     
    SensorValues lastSensorData;                                
    uint32_t lastSensorQuerryMs = 0;                            
    uint8_t ccs811WakeLogic;                                    
    void doAllSensing();
    void readBME280(float& T, float& P, float& H);
    void readHDC1080(float& T, float& H);
    void readTSL2591(double& lux);
    void configureTSL2591Sensor();
    void readGas(uint16_t& gas, uint16_t& co2);
    void readAccelerometer(float &ax, float &ay, float &az);
    void readMagnetometer(float &mx, float &my, float &mz, float &mH);
    void readGyro(float &gx, float &gy, float &gz);
    void readMagneticSensor(int& mag);
    void readWindSpeed(float& windspeed);
    void readGPS(gps_fix& fix);
};

#endif