SensorWLED.h

Go to the documentation of this file.

 
#ifndef SENSORWLED_H_
#define SENSORWLED_H_
 
// Other includes needed by the contained implementations
#ifndef ARDUINO
#include <cmath>
#include <cstdint>
 
// Add the plog logging framework
#include <plog/Appenders/ConsoleAppender.h>
#include <plog/Formatters/TxtFormatter.h>
#include <plog/Init.h>
#include <plog/Log.h>
 
// <-- statement line will be removed
// <-- statement line will be removed
; // <-- statement line will be removed
 
#else // The SensorWLED library is dependent on the Arduino EEPROM library
#include <EEPROM.h>
#endif
 
#define EEPROM_IDSTART 0xA0 
#define MAXINSTANCES 10     
 
#define EEPROM_ID 0xA5  
#define VERSION_MAJOR 0 
#define VERSION_MINOR 1 
#define VERSION_PATCH 0 
 
#define CRC32_TABLE_SIZE 256 
 
#if !defined(US_ADC_CONVERSION_TIME)
#define US_ADC_CONVERSION_TIME 250
#endif
 
typedef enum : uint16_t {
    bits10 = 1023,  
    bits12 = 4095,  
    bits13 = 8191,  
    bits16 = 65535, 
} AdcResolutionType_e;
 
typedef enum : uint16_t {
    mv_vcc_3v3 = 3300, 
    mv_vcc_5v = 5000,  
} VoltageVccType_e;
 
//-----------------------------------------------------------------------------
typedef enum : uint16_t {
    linear_decay,      
    exponential_decay, 
} DecayModelType_e;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
typedef struct {
    uint16_t magic_id;      
    uint16_t major_version; 
    uint16_t minor_version; 
    uint16_t patch_version; 
} VersionType_t;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
typedef struct {
    uint16_t analog_pin;    
    uint16_t sample_count;  
    uint16_t sample_period; 
    float cal_zero_offset;  
    float cal_slope;        
} CalibrationDataType_t;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
typedef struct {
    AdcResolutionType_e bits_resolution_adc; 
    VoltageVccType_e mv_maxvoltage_adc;      
    uint16_t ms_poll_time;        
    uint16_t ms_hold_time;        
    DecayModelType_e decay_model; 
    float decay_rate;             
} DynamicDataType_t;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class SensorWLED {
 
public:
    // Constructor, default: no calibration or averaging smooting are applied
    SensorWLED(uint16_t analog_pin, float mv_offset = 0.0, float slope = 1.0,
               uint16_t samples = 0);
 
    // Destructor: Restore pinMode to default
    ~SensorWLED(void);
 
    void begin(DynamicDataType_t const &rDynamicParams);
 
    // Call continously (in the loop()) for updated ADC values.
    bool updateAnalogRead(void);
 
    // Maps the input analog value to a value optimized
    // for ADC resolution and max supply voltage.
    double getMappedValue(void);
    double getMappedPeakValue(void);
 
    // Read stored EEPROM Id and program version.
    VersionType_t readVersionEEPROM(void);
 
    bool writeCalibrationEEPROM(uint16_t instance, uint32_t crc32);
    CalibrationDataType_t readCalibrationEEPROM(uint16_t instance);
 
    bool writeDynamicEEPROM(uint16_t instance, uint32_t crc32);
    DynamicDataType_t readDynamicEEPROM(uint16_t instance);
 
    uint32_t
    calculateCalibrationDataCRC32(CalibrationDataType_t CalibrationData);
    uint32_t calculateDynamicParamsCRC32(DynamicDataType_t DynamicParams);
 
    uint32_t cal_crc32; 
    uint32_t dyn_crc32; 
 
    CalibrationDataType_t
        CalibrationData;             
    DynamicDataType_t DynamicParams; 
 
    // -------------------------------------------------------
    //   Common for all class instances (i.e., ADC channels)
    // -------------------------------------------------------
    static uint16_t getInstanceNumber(void);
 
    // Each instance has its own 'emulated eeprom' flash area
    // storing calibration, static, and dynamic parameters.
    // Note: 0x100 is for the first instance, 0x200 for the second,
    // 0x0 is an unused area (reseved for the future).
    inline static uint16_t eeprom_area[MAXINSTANCES + 1] = {
        0,     0x100, 0x200, 0x300, 0x400, 0x500,
        0x600, 0x700, 0x800, 0x900, 0xA00};
 
    // Id and program version is stored at location 'EEPROM_IDSTART'.
    inline static VersionType_t Version = {EEPROM_ID, VERSION_MAJOR,
                                           VERSION_MINOR, VERSION_PATCH};
 
    inline static uint16_t instance_counter = 0; 
 
private:
    void setAnalogPin(uint16_t a_pin, uint16_t mode = INPUT);
    uint32_t applyDecay(uint32_t peak_value);
 
    uint32_t previous_poll_millis_tm; 
    uint32_t previous_hold_millis_tm; 
 
    uint32_t raw_input_value;  
    double mapped_input_value; 
 
    uint32_t pk_raw_input_value;  
    double pk_mapped_input_value; 
 
    // EEPROM and CRC32 methods
    static void generateTableCRC32(uint32_t (&table)[CRC32_TABLE_SIZE]);
    static uint32_t updateCRC32(uint32_t (&table)[CRC32_TABLE_SIZE],
                                uint32_t initial, const void *buf, size_t len);
    static bool writeVersionEEPROM(void);
 
    static bool inline eeprom_version_written_flag =
        false; 
};
/* class SensorWLED */
 
#endif /* SENSORWLED_H_ */