i2c-leaf.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_LEAF_H
#define _I2C_LEAF_H
 
#include "i2c-leaf-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>
#if (USE_JSON)
#include <json_utility.h>
#endif
#include <eeprom_utility.h>
#include <Wire.h>
#include <TimeLib.h>
#include <typedef.h>
#include <registers-leaf.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;                    
  uint16_t leaf_calibration_threshold;
} configuration_t;
 
typedef struct {
  uint32_t time;                      
} leaf_wetness_t;
 
typedef struct {
  uint8_t module_type;                
  uint8_t module_main_version;        
  uint8_t module_minor_version;       
  leaf_wetness_t leaf_wetness;        
} readable_data_t;
 
typedef struct {
  uint8_t i2c_address;                
  bool is_oneshot;                    
  uint16_t leaf_calibration_threshold;
} 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 {
  LEAF_READING_INIT,            
  LEAF_READING_READ,
  LEAF_READING_END,             
  LEAF_READING_WAIT_STATE       
} leaf_reading_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 lastcommand;
 
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_test_read;
 
bool is_leaf_init;
bool is_leaf_wet;
 
uint8_t samples_count;
 
bool do_buffers_reset;
 
volatile uint16_t timer_counter_ms;
 
state_t state;
 
leaf_reading_state_t leaf_reading_state;
 
volatile bool inside_transaction;
 
volatile uint16_t transaction_time;
 
/*********************************************************************
* 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_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 reset_samples_buffer(void);
void reset_report_buffer(void);
void reset_buffer(void);
 
// void reset_observations_buffer(void);
 
void exchange_buffers(void);
 
template<typename sample_g, typename observation_g, typename value_v> void addSample(sample_g *sample, observation_g *observation, value_v value);
 
template<typename observation_g, typename value_v> value_v readCurrentObservation(observation_g *buffer);
template<typename observation_g, typename value_v> void writeCurrentObservation(observation_g *buffer, value_v value);
template<typename observation_g, typename length_v> void resetObservation(observation_g *buffer, length_v length);
template<typename observation_g, typename length_v> void resetBackPmObservation(observation_g *buffer, length_v length);
template<typename observation_g, typename length_v> void incrementObservation(observation_g *buffer, length_v length);
template<typename observation_g, typename length_v, typename value_v> void addObservation(observation_g *buffer, length_v length, value_v value);
template<typename observation_g, typename length_v, typename value_v> value_v readBackObservation(observation_g *buffer, length_v length);
 
 
void samples_processing(bool is_force_processing);
 
/*********************************************************************
* TASKS
*********************************************************************/
volatile bool is_event_leaf_reading;
 
void leaf_reading_task(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