i2c-thr.h

Go to the documentation of this file.

 
/*********************************************************************
Copyright (C) 2017  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_THR_H
#define _I2C_THR_H
 
#include "i2c-thr-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>
 
#if (USE_MODULE_THR)
#include <registers-thr.h>
#elif (USE_MODULE_TH)
#include <registers-thr.h>
#elif (USE_MODULE_RAIN)
#include <registers-rain.h>
#endif
 
#include <SensorDriver.h>
#include <debug_config.h>
#include <SdFat.h>
#include <StreamUtils.h>
#include <ArduinoLog.h>
 
/*********************************************************************
* TYPEDEF
*********************************************************************/
typedef struct {
   uint8_t module_type;                      
   uint8_t module_main_version;              
   uint8_t module_configuration_version;     
   uint8_t i2c_address;                      
   bool is_oneshot;                          
   bool is_continuous;                       
 
   #if (USE_MODULE_THR || USE_MODULE_TH)
   uint8_t i2c_temperature_address;          
   uint8_t i2c_humidity_address;             
   #endif
 
   #if (USE_MODULE_THR || USE_MODULE_RAIN)
   uint16_t tipping_bucket_time_ms;          
   uint8_t rain_for_tip;                     
   #endif
} configuration_t;
 
typedef struct {
   float value[SAMPLES_COUNT];        
   uint16_t count;                              
   float *read_ptr;                             
   float *write_ptr;                            
} sample_t;
 
typedef struct {
   float rain_tips;
   float rain;
 
   float sample_temperature;
   float sample_humidity;
 
   float ist_temperature;
   float ist_humidity;
 
   float min_temperature;
   float min_humidity;
 
   float avg_temperature;
   float avg_humidity;
 
   float max_temperature;
   float max_humidity;
 
   float sigma_temperature;
   float sigma_humidity;
} report_t;
 
typedef struct {
   uint8_t module_type;                
   uint8_t module_main_version;        
   uint8_t module_minor_version;       
   report_t thr;
} readable_data_t;
 
typedef struct {
   uint8_t i2c_address;                
   bool is_oneshot;                    
   bool is_continuous;                 
 
   #if (USE_MODULE_THR || USE_MODULE_TH)
   uint8_t i2c_temperature_address;    
   uint8_t i2c_humidity_address;       
   #endif
 
   #if (USE_MODULE_THR || USE_MODULE_RAIN)
   uint16_t tipping_bucket_time_ms;    
   uint8_t rain_for_tip;               
   #endif
} writable_data_t;
 
/*********************************************************************
* TYPEDEF for Finite State Machine
*********************************************************************/
typedef enum {
   INIT,                      
   #if (USE_POWER_DOWN)
   ENTER_POWER_DOWN,          
   #endif
   TASKS_EXECUTION,           
   END                        
} state_t;
 
#if (USE_SENSOR_ADT || USE_SENSOR_HIH || USE_SENSOR_HYT)
typedef enum {
   SENSORS_READING_INIT,            
   SENSORS_READING_SETUP_CHECK,
   SENSORS_READING_PREPARE,         
   SENSORS_READING_IS_PREPARED,     
   SENSORS_READING_GET,             
   SENSORS_READING_IS_GETTED,       
   SENSORS_READING_READ,            
   SENSORS_READING_NEXT,            
   SENSORS_READING_END,             
   SENSORS_READING_WAIT_STATE       
} sensors_reading_state_t;
#endif
 
#if (USE_SENSOR_TBR)
typedef enum {
   TIPPING_BUCKET_INIT,          
   TIPPING_BUCKET_READ,          
   TIPPING_BUCKET_CHECK,         
   TIPPING_BUCKET_END,           
   TIPPING_BUCKET_WAIT_STATE     
} tipping_bucket_state_t;
#endif
 
/*********************************************************************
* GLOBAL VARIABLE
*********************************************************************/
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 i2c_time;
 
volatile uint8_t ready_tasks_count;
 
uint32_t awakened_event_occurred_time_ms;
 
bool is_start;
 
bool is_stop;
 
bool is_oneshot;
 
bool is_continuous;
 
#if (USE_SENSOR_ADT || USE_SENSOR_HYT)
sample_t temperature_samples;
#endif
 
#if (USE_SENSOR_HIH || USE_SENSOR_HYT)
sample_t humidity_samples;
#endif
 
#if (USE_SENSOR_TBR)
uint16_t rain_tips;
#endif
 
volatile uint16_t timer_counter_ms;
 
SensorDriver *sensors[SENSORS_MAX];
 
uint8_t sensors_count;
 
state_t state;
 
#if (USE_SENSOR_ADT || USE_SENSOR_HIH || USE_SENSOR_HYT)
sensors_reading_state_t sensors_reading_state;
#endif
 
#if (USE_SENSOR_TBR)
tipping_bucket_state_t tipping_bucket_state;
#endif
 
#if (ENABLE_SDCARD_LOGGING)
SdFat SD;
 
File logFile;
 
WriteLoggingStream loggingStream(logFile,Serial);
#endif
 
/*********************************************************************
* FUNCTIONS
*********************************************************************/
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_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_samples_buffer(void);
void reset_report_buffer(void);
void reset_buffer(void);
 
void exchange_buffers(void);
 
template<typename buffer_g, typename length_v, typename value_v> value_v bufferRead(buffer_g *buffer, length_v length);
template<typename buffer_g, typename length_v, typename value_v> value_v bufferReadBack(buffer_g *buffer, length_v length);
template<typename buffer_g, typename value_v> void bufferWrite(buffer_g *buffer, value_v value);
template<typename buffer_g> void bufferPtrReset(buffer_g *buffer);
template<typename buffer_g, typename length_v> void bufferPtrResetBack(buffer_g *buffer, length_v length);
template<typename buffer_g, typename length_v> void incrementBuffer(buffer_g *buffer, length_v length);
template<typename buffer_g, typename length_v, typename value_v> void bufferReset(buffer_g *buffer, length_v length);
template<typename buffer_g, typename length_v, typename value_v> void addValue(buffer_g *buffer, length_v length, value_v value);
 
void samples_processing();
void make_report();
void copy_oneshot_data();
 
/*********************************************************************
* TASKS
*********************************************************************/
#if (USE_SENSOR_ADT || USE_SENSOR_HIH || USE_SENSOR_HYT)
volatile bool is_event_sensors_reading;
 
void sensors_reading_task(void);
#endif
 
#if (USE_SENSOR_TBR)
volatile uint32_t rain_tips_event_occurred_time_ms;
 
volatile bool is_event_tipping_bucket;
 
void tipping_bucket_task(void);
#endif
 
volatile bool is_event_command_task;
 
void command_task(void);
 
/*********************************************************************
* INTERRUPTS HANDLER
*********************************************************************/
void i2c_request_interrupt_handler(void);
 
void i2c_receive_interrupt_handler(void);
 
#if (USE_SENSOR_TBR)
void tipping_bucket_interrupt_handler(void);
#endif
 
#endif