i2c-radiation.h

/*********************************************************************
Copyright (C) 2022  Marco Baldinetti <m.baldinetti@digiteco.it>
authors:
Paolo patruno <p.patruno@iperbole.bologna.it>
Marco Baldinetti <m.baldinetti@digiteco.it>
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
**********************************************************************/
 
#ifndef _I2C_SOLAR_RADIATION_H
#define _I2C_SOLAR_RADIATION_H
 
#include "i2c-radiation-config.h"
#include <debug.h>
#include <i2c_config.h>
#include <avr/sleep.h>
#include <avr/power.h>
#include <avr/wdt.h>
#include <i2c_utility.h>
#include <rmap_utility.h>
#include <sdcard_utility.h>
#if (USE_JSON)
#include <json_utility.h>
#endif
#include <eeprom_utility.h>
#include <Wire.h>
#include <TimeLib.h>
#include <typedef.h>
#include <ADS1115.h>
#include <registers-radiation.h>
#include <debug_config.h>
#include <SdFat.h>
#include <StreamUtils.h>
#include <ArduinoLog.h>
 
/*********************************************************************
* TYPEDEF
*********************************************************************/
typedef struct {
   uint8_t module_main_version;        
   uint8_t module_configuration_version;   
   uint8_t module_type;                
   uint8_t i2c_address;                
   bool is_oneshot;                    
 
   // 10 bit
   float adc_voltage_offset_1;
   float adc_voltage_offset_2;
   float adc_voltage_min;
   float adc_voltage_max;
 
   // 16 bit HR
   float adc_calibration_offset[ADS1115_CHANNEL_COUNT];
   float adc_calibration_gain[ADS1115_CHANNEL_COUNT];
   float sensor_rad_max[ADS1115_CHANNEL_COUNT];
   float sensor_voltage_max[ADS1115_CHANNEL_COUNT];
} configuration_t;
 
typedef struct {
  int16_t sample;
  int16_t avg;
} data_t;
 
typedef struct {
  uint8_t module_type;                
  uint8_t module_main_version;        
  uint8_t module_minor_version;       
  data_t solar_radiation;
} readable_data_t;
 
typedef struct {
   uint8_t i2c_address;                
   bool is_oneshot;                    
 
  /*
   // 10 bit
   float adc_voltage_offset_1;
   float adc_voltage_offset_2;
   float adc_voltage_min;
   float adc_voltage_max;
  */
  
   // 16 bit hr
   float adc_calibration_offset[ADS1115_CHANNEL_COUNT];
   float adc_calibration_gain[ADS1115_CHANNEL_COUNT];
   float sensor_voltage_max[ADS1115_CHANNEL_COUNT];
   float sensor_rad_max[ADS1115_CHANNEL_COUNT];
} writable_data_t;
 
/*********************************************************************
* TYPEDEF for Finite State Machine
*********************************************************************/
typedef enum {
   INIT,                      
   #if (USE_POWER_DOWN)
   ENTER_POWER_DOWN,          
   #endif
   TASKS_EXECUTION,           
   END                        
} state_t;
 
typedef enum {
  SOLAR_RADIATION_INIT,
  SOLAR_RADIATION_READING,
  SOLAR_RADIATION_ELABORATE,
  SOLAR_RADIATION_END,             
  SOLAR_RADIATION_WAIT_STATE       
} solar_radiation_state_t;
 
typedef enum {
  SOLAR_RADIATION_HR_INIT,
  SOLAR_RADIATION_HR_READ,
  SOLAR_RADIATION_HR_EVALUATE,
  SOLAR_RADIATION_HR_PROCESS,
  SOLAR_RADIATION_HR_END,             
  SOLAR_RADIATION_HR_WAIT_STATE       
} solar_radiation_hr_state_t;
 
/*********************************************************************
* GLOBAL VARIABLE
*********************************************************************/
 
#if (ENABLE_SDCARD_LOGGING)   
SdFat SD;
 
File logFile;
 
WriteLoggingStream loggingStream(logFile,Serial);
#endif
 
configuration_t configuration;
 
volatile readable_data_t readable_data_1;
 
volatile readable_data_t readable_data_2;
 
volatile readable_data_t *readable_data_read_ptr;
 
volatile readable_data_t *readable_data_write_ptr;
 
volatile readable_data_t *readable_data_temp_ptr;
 
writable_data_t writable_data;
 
writable_data_t *writable_data_ptr;
 
volatile uint8_t readable_data_address;
 
volatile uint8_t readable_data_length;
 
volatile uint8_t i2c_rx_data[I2C_MAX_DATA_LENGTH];
 
volatile uint8_t i2c_error;
 
volatile uint8_t ready_tasks_count;
 
uint32_t awakened_event_occurred_time_ms;
 
volatile bool inside_transaction;
 
volatile uint16_t transaction_time;
 
volatile uint8_t lastcommand;
 
bool is_start;
 
bool is_stop;
 
bool is_test_read;
 
bool is_oneshot;
 
bool is_continuous;
 
bool is_test;
 
int16_t sample;
int16_t average;
 
 
#if (USE_SENSOR_VSR)
ADS1115 adc1(ADC_I2C_ADDRESS);
float getAdcCalibratedValue (float adc_value, float offset, float gain);
float getAdcAnalogValue (float adc_value, float min, float max);
adsGain_t adsgain;
#endif
 
uint8_t solar_radiation_acquisition_count;
 
uint16_t samples_count;
 
uint16_t samples_error_count;
 
volatile uint16_t timer_counter_ms;
volatile uint16_t timer_counter_s;
 
#if (USE_SENSOR_DSR || USE_SENSOR_VSR)
volatile bool is_solar_radiation_on;
#endif
 
state_t state;
 
solar_radiation_state_t solar_radiation_state;
 
solar_radiation_hr_state_t solar_radiation_hr_state;
 
/*********************************************************************
* FUNCTIONS
*********************************************************************/
 
void init_logging();
 
void init_power_down(uint32_t *time_ms, uint32_t debouncing_ms);
 
void init_wdt(uint8_t wdt_timer);
 
void init_system(void);
 
void init_buffers(void);
 
void init_tasks(void);
 
void init_pins(void);
 
void init_wire(void);
 
void init_spi(void);
 
void init_adc(void);
 
void init_rtc(void);
 
#if (USE_TIMER_1)
void init_timer1(void);
 
void start_timer(void);
 
void stop_timer(void);
#endif
 
void init_sensors(void);
 
void print_configuration(void);
 
void load_configuration(void);
 
void save_configuration(bool);
 
void commands(void);
 
void tests(void);
 
void reset_buffer(void);
 
void exchange_buffers(void);
 
void make_report (bool init=false);
 
 
#if (USE_SENSOR_DSR)
#define solarRadiationRead()          (analogRead(SOLAR_RADIATION_ANALOG_PIN))
#define isSolarRadiationOn()          (is_solar_radiation_on)
#define isSolarRadiationOff()         (!is_solar_radiation_on)
 
void solarRadiationPowerOff(void);
void solarRadiationPowerOn(void);
void solaRadiationOffset(uint8_t count, uint8_t delay_ms, float *offset, float ideal);
float getSolarRadiationMv(float adc_value, float offset_mv);
float getSolarRadiation(float adc_value);
#endif
 
#if (USE_SENSOR_VSR)
void solarRadiationPowerOff(void);
void solarRadiationPowerOn(void);
void solaRadiationOffset(uint8_t count, uint8_t delay_ms, float *offset, float ideal);
float getSolarRadiation(float adc_value, float adc_voltage_min, float adc_voltage_max);
#endif
 
/*********************************************************************
* TASKS
*********************************************************************/
 
volatile bool is_event_solar_radiation_task;
 
void solar_radiation_task(void);
 
void solar_radiation_task_hr(void);
 
volatile bool is_event_command_task;
 
void command_task(void);
 
/*********************************************************************
* INTERRUPTS HANDLER
*********************************************************************/
void i2c_request_interrupt_handler(void);
 
void i2c_receive_interrupt_handler(void);
 
#endif