stima-config.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 _STIMA_CONFIG_H
#define _STIMA_CONFIG_H
 
#include <sensors_config.h>
#include <constantdata_config.h>
#include <stima_module.h>
 
/*********************************************************************
* MODULE
*********************************************************************/
#define MODULE_MAIN_VERSION                           (3)
 
#define MODULE_MINOR_VERSION                          (11)
 
#define MODULE_CONFIGURATION_VERSION                  (2)
 
 
#define MODULE_TYPE                                   (STIMA_MODULE_TYPE_REPORT_GSM)
 
#if (MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE)
#define USE_MQTT                                      (false)
#else
#define USE_MQTT                                      (true)
#endif
 
#define USE_LCD                                       (true)
 
#define USE_SDCARD                                    (false | USE_MQTT)
 
#if (MODULE_TYPE != STIMA_MODULE_TYPE_PASSIVE)
#define USE_NTP                                       (true)
#endif
 
#define USE_RTC                                       (true)
 
#define USE_TIMER_1                                   (!USE_RTC)
 
#define USE_RPC_METHOD_CONFIGURE                      (true)
 
#define USE_RPC_METHOD_PREPARE                        (false)
 
#define USE_RPC_METHOD_PREPANDGET                     (false)
 
#define USE_RPC_METHOD_GETJSON                        (false)
 
#define USE_RPC_METHOD_REBOOT                         (true)
 
 
#define USE_RPC_METHOD_RECOVERY                       (true)
 
/*********************************************************************
* CONFIGURATION
*********************************************************************/
#define CONFIGURATION_DEFAULT_TH_ADDRESS              (I2C_TH_DEFAULT_ADDRESS)
 
#define CONFIGURATION_DEFAULT_RAIN_ADDRESS            (I2C_RAIN_DEFAULT_ADDRESS)
 
#define CONFIGURATION_RESET_PIN                       (8)
 
#define CONFIGURATION_DEFAULT_NTP_SERVER              (NTP_DEFAULT_SERVER)
 
#if (USE_MQTT)
#define CONFIGURATION_DEFAULT_MQTT_PORT               (MQTT_DEFAULT_PORT)
 
#define CONFIGURATION_DEFAULT_MQTT_SERVER             (MQTT_DEFAULT_SERVER)
 
#define CONFIGURATION_DEFAULT_MQTT_ROOT_TOPIC         (MQTT_DEFAULT_ROOT_TOPIC)
 
#define CONFIGURATION_DEFAULT_MQTT_MAINT_TOPIC         (MQTT_DEFAULT_MAINT_TOPIC)
 
#define CONFIGURATION_DEFAULT_MQTT_RPC_TOPIC          (MQTT_DEFAULT_RPC_TOPIC)
 
#define CONFIGURATION_DEFAULT_MQTT_USERNAME           (MQTT_DEFAULT_USERNAME)
 
#define CONFIGURATION_DEFAULT_MQTT_PASSWORD           (MQTT_DEFAULT_PASSWORD)
 
#define CONFIGURATION_DEFAULT_STATIONSLUG            (DEFAULT_STATIONSLUG)
 
#define CONFIGURATION_DEFAULT_BOARDSLUG              (DEFAULT_BOARDSLUG)
 
#endif
 
#if (MODULE_TYPE == STIMA_MODULE_TYPE_SAMPLE_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_REPORT_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_ETH)
#define CONFIGURATION_DEFAULT_ETHERNET_DHCP_ENABLE    (ETHERNET_DEFAULT_DHCP_ENABLE)
 
#define CONFIGURATION_DEFAULT_ETHERNET_MAC            (ETHERNET_DEFAULT_MAC)
 
#define CONFIGURATION_DEFAULT_ETHERNET_IP             (ETHERNET_DEFAULT_IP)
 
#define CONFIGURATION_DEFAULT_ETHERNET_NETMASK        (ETHERNET_DEFAULT_NETMASK)
 
#define CONFIGURATION_DEFAULT_ETHERNET_GATEWAY        (ETHERNET_DEFAULT_GATEWAY)
 
#define CONFIGURATION_DEFAULT_ETHERNET_PRIMARY_DNS    (ETHERNET_DEFAULT_PRIMARY_DNS)
 
#elif (MODULE_TYPE == STIMA_MODULE_TYPE_SAMPLE_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_REPORT_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_GSM)
#define CONFIGURATION_DEFAULT_GSM_APN                 (GSM_DEFAULT_APN)
 
#define CONFIGURATION_DEFAULT_GSM_USERNAME            (GSM_DEFAULT_USERNAME)
 
#define CONFIGURATION_DEFAULT_GSM_PASSWORD            (GSM_DEFAULT_PASSWORD)
 
#endif
 
/*********************************************************************
* SENSORS
*********************************************************************/
 
#define SENSOR_ERROR_COUNT_MAX                        (20)
 
/*********************************************************************
* POWER DOWN
*********************************************************************/
#if (MODULE_TYPE == STIMA_MODULE_TYPE_SAMPLE_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_REPORT_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_ETH)
#define USE_POWER_DOWN                                (false)
 
#elif (MODULE_TYPE == STIMA_MODULE_TYPE_SAMPLE_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_REPORT_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE)
#define USE_POWER_DOWN                                (true)
 
#endif
 
#define DEBOUNCING_POWER_DOWN_TIME_MS                 (10)
 
#if (MODULE_TYPE == STIMA_MODULE_TYPE_SAMPLE_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_REPORT_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_ETH)
#define W5500_CHIP_SELECT_PIN                         (10)
 
#elif (MODULE_TYPE == STIMA_MODULE_TYPE_SAMPLE_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_REPORT_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_GSM)
#define GSM_ON_OFF_PIN                                (SIM800_ON_OFF_PIN)
 
#if (USE_SIM_800L)
#define GSM_RESET_PIN                                 (SIM800_RESET_PIN)
#endif
 
#endif
 
#if (USE_SDCARD)
#define SDCARD_CHIP_SELECT_PIN                        (7)
 
#define SDCARD_INFO_FILE_NAME                        ("info.dat")
 
#define SDCARD_LOGGING_FILE_NAME                     ("stima.log")
 
#define SDCARD_CONFIG_FILE_NAME                     ("config.cfg")
 
#define SDCARD_CONFIG_SAVED_FILE_NAME                     ("config.sav")
 
#endif
 
/*********************************************************************
* WATCHDOG
*********************************************************************/
#ifdef ARDUINO_ARCH_AVR
#define WDT_TIMER                                     (WDTO_8S)
#else
#define WDT_TIMER                                     (8)
#endif
 
/*********************************************************************
* RTC
*********************************************************************/
#define RTC_FREQUENCY                                 (PCF8563_CLKOUT_FREQUENCY_SECONDS)
 
#define RTC_INTERRUPT_PIN                             (6)
 
/*********************************************************************
* TIMER1
*********************************************************************/
#define TIMER1_INTERRUPT_TIME_MS                      (1000)
 
#define TIMER1_TCNT1_VALUE                            (0xFFFFUL - (TIMER1_INTERRUPT_TIME_MS*1000UL/(1024 / (F_CPU/1000000)))+1)
 
 
/*********************************************************************
* CONSTANT DATA
*********************************************************************/
#define USE_CONSTANTDATA_COUNT                             (3)
 
/*********************************************************************
* TASKS
*********************************************************************/
#define SENSORS_RETRY_COUNT_MAX                       (3)
 
#define SENSORS_RETRY_DELAY_MS                        (50)
 
#define SENSORS_TESTING_DELAY_S                       (60)
 
#define DATA_PROCESSING_RETRY_COUNT_MAX               (2)
 
#define DATA_PROCESSING_RETRY_DELAY_MS                (500)
 
#define DATA_SAVING_RETRY_COUNT_MAX                   (2)
 
#define DATA_SAVING_DELAY_MS                          (100)
 
#define MQTT_RETRY_COUNT_MAX                          (3)
 
#define MQTT_DELAY_MS                                 (3000)
 
#define IP_STACK_TIMEOUT_MS                           (MQTT_TIMEOUT_MS)
 
#define SUPERVISOR_CONNECTION_RETRY_COUNT_MAX         (3)
 
#define SUPERVISOR_CONNECTION_TIMEOUT_MS              (120000)
 
#if (USE_SDCARD)
#define SDCARD_MQTT_PTR_FILE_NAME                     ("mqtt_ptr.txt")
 
#define SDCARD_MQTT_PTR_RPC_FILE_NAME                 ("rpc_ptr.txt")
 
#endif
 
#define NTP_RETRY_COUNT_MAX                           (5)
 
#define NTP_RETRY_DELAY_MS                            (1000)
 
#define NTP_TIME_FOR_RESYNC_S                         (SECS_PER_DAY)
 
#define NTP_MAX_DIFF_VALID_TIME_S                     (SECS_PER_DAY)
 
#define LCD_TIME_FOR_REINITIALIZE_S                   (SECS_PER_DAY)
 
#define DISPLAY_SET_MAX (2)
 
#if (MODULE_TYPE == STIMA_MODULE_TYPE_SAMPLE_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_REPORT_ETH || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_ETH)
#define ETHERNET_RETRY_COUNT_MAX                      (5)
 
#define ETHERNET_RETRY_DELAY_MS                       (ETHERNET_ATTEMPT_MS)
 
#elif (MODULE_TYPE == STIMA_MODULE_TYPE_SAMPLE_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_REPORT_GSM || MODULE_TYPE == STIMA_MODULE_TYPE_PASSIVE_GSM)
#endif
 
#define DATE_TIME_STRING_LENGTH                       (25)
 
#endif