i2c-radiation-config.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_CONFIG_H
#define _I2C_SOLAR_RADIATION_CONFIG_H
 
#include <sensors_config.h>
 
/*********************************************************************
* MODULE
*********************************************************************/
#define MODULE_MAIN_VERSION                           (3)
 
#define MODULE_MINOR_VERSION                          (18)
 
#define MODULE_CONFIGURATION_VERSION                  (2)
 
#define MODULE_TYPE                                   (STIMA_MODULE_TYPE_SOLAR_RADIATION)
 
/*********************************************************************
* CONFIGURATION
*********************************************************************/
 
#define CONFIGURATION_DEFAULT_ONESHOT              (false)
 
#define CONFIGURATION_DEFAULT_I2C_ADDRESS             (I2C_SOLAR_RADIATION_DEFAULT_ADDRESS)
 
#define CONFIGURATION_RESET_PIN                       (8)
 
/*
 ADS1115 Address Selection
 
The ADS111x have one address pin, ADDR, that configures the I2C
address of the device. This pin can be connected to GND, VDD, SDA, or
SCL, allowing for four different addresses to be selected with one
pin, as shown in Table 4. The state of address pin ADDR is sampled
continuously. Use the GND, VDD and SCL addresses first. If SDA is used
as the device address, hold the SDA line low for at least 100 ns after
the SCL line goes low to make sure the device decodes the address
correctly during I2C communication.
*/
#define ADC_GND_I2C_ADDRESS                             (0x48)  // GND
#define ADC_VDD_I2C_ADDRESS                             (0x49)  // VDD
#define ADC_SCL_I2C_ADDRESS                             (0x4B)  // SCL
#define ADC_SDA_I2C_ADDRESS                             (0x4A)  // SDA
 
#define ADC_I2C_ADDRESS                               ADC_GND_I2C_ADDRESS
 
#define CONFIGURATION_DEFAULT_ADC_VOLTAGE_OFFSET_1    (0.0)
#define CONFIGURATION_DEFAULT_ADC_VOLTAGE_OFFSET_2    (0.0)
#define CONFIGURATION_DEFAULT_ADC_VOLTAGE_GAIN_1      (1.0)
#define CONFIGURATION_DEFAULT_ADC_VOLTAGE_GAIN_2      (1.0)
#define CONFIGURATION_DEFAULT_ADC_VOLTAGE_MIN         (SOLAR_RADIATION_SENSOR_VOLTAGE_MIN)
#define CONFIGURATION_DEFAULT_ADC_VOLTAGE_MAX         (SOLAR_RADIATION_SENSOR_VOLTAGE_MAX)
 
 
#define CONFIGURATION_DEFAULT_ADC_VOLTAGE_OFFSET      (0)
#define CONFIGURATION_DEFAULT_ADC_VOLTAGE_GAIN        (1.0)
#define CONFIGURATION_DEFAULT_SENSOR_VOLTAGE_MAX      (SOLAR_RADIATION_SENSOR_VOLTAGE_MAX)
#define CONFIGURATION_DEFAULT_SENSOR_RADIATION_MAX    (SOLAR_RADIATION_SENSOR_RADIATION_MAX)
 
 
#define ACQUISITION_COUNT_FOR_POWER_RESET             (100)
 
#if (USE_SENSOR_DSR)
#define SOLAR_RADIATION_POWER_PIN                     (5)
 
#define SOLAR_RADIATION_ANALOG_PIN                    (A0)
 
#define ADC_VOLTAGE_MAX                               (5000.0)
#define ADC_VOLTAGE_MIN                               (0.0)
#define ADC_VOLTAGE_OFFSET                            (-20.0)
 
#define ADC_MAX                                       (1023.0)
#define ADC_MIN                                       (0.0)
 
#define SOLAR_RADIATION_VOLTAGE_MAX                   (5000.0)
#define SOLAR_RADIATION_VOLTAGE_MIN                   (1000.0)
 
#define SOLAR_RADIATION_ERROR_VOLTAGE_MAX             (SOLAR_RADIATION_VOLTAGE_MAX + 50.0)
#define SOLAR_RADIATION_ERROR_VOLTAGE_MIN             (SOLAR_RADIATION_VOLTAGE_MIN - 50.0)
 
#define SOLAR_RADIATION_MAX                           (1600.0)
#define SOLAR_RADIATION_MIN                           (0.0)
 
#define SOLAR_RADIATION_ERROR_MAX                     (1600.0)
#define SOLAR_RADIATION_ERROR_MIN                     (8.0)
 
#endif
 
#if (USE_SENSOR_VSR)
#define SOLAR_RADIATION_POWER_PIN                     (5)
 
#define ADC_VOLTAGE_OFFSET                            (0.0)
 
/*
Single-ended signal measurements, where VAINN = 0 V and VAINP = 0 V to +FS, only use
the positive code range from 0000h to 7FFFh. However, because of device offset, the
ADS111x can still output negative codes in case VAINP is close to 0 V
*/
#define ADC_MIN                                       (-32768)
#define ADC_MAX                                       (32767)
 
#define SOLAR_RADIATION_SENSOR_VOLTAGE_MIN            (0.0)
#define SOLAR_RADIATION_SENSOR_VOLTAGE_MAX            (5000.0)
 
#define SOLAR_RADIATION_SENSOR_RADIATION_MIN          (0.0)
#define SOLAR_RADIATION_SENSOR_RADIATION_MAX          (2000.0)
 
#define SOLAR_RADIATION_ERROR_VOLTAGE_MIN             ((SOLAR_RADIATION_SENSOR_VOLTAGE_MAX/100.))
#define SOLAR_RADIATION_ERROR_VOLTAGE_MAX             ((SOLAR_RADIATION_SENSOR_VOLTAGE_MAX/100.))
 
#define SOLAR_RADIATION_ADC_CHANNEL_INPUT             (1)
 
#endif
#define SDCARD_CHIP_SELECT_PIN 7
 
#define SPI_SPEED SD_SCK_MHZ(4)
 
/*********************************************************************
* POWER DOWN
*********************************************************************/
#define USE_POWER_DOWN                                (true)
 
#define DEBOUNCING_POWER_DOWN_TIME_MS                 (10)
 
#define USE_TIMER_1                                   (true)
 
/*********************************************************************
* WATCHDOG
*********************************************************************/
#define WDT_TIMER                                     (WDTO_8S)
 
/*********************************************************************
* RADIATION SENSORS
*********************************************************************/
// observations with processing every 1-10 minutes (minutes for processing sampling)
// report every 5-60 minutes (> OBSERVATIONS_MINUTES)
 
#define SENSORS_SAMPLE_TIME_MS                        (4000)
 
 
#define RMAP_REPORT_SAMPLE_ERROR_MAX_PERC             (10.)
 
 
 
#define RMAP_REPORT_SAMPLE_MIN_TIME                   (60)
 
 
/*********************************************************************
* SENSORS
*********************************************************************/
#define USE_SENSORS_COUNT                             (USE_SENSOR_DSR + USE_SENSOR_VSR)
 
#if (USE_SENSORS_COUNT == 0)
#error No sensor used. Are you sure? If not, enable it in RmapConfig/sensors_config.h
#endif
 
/*********************************************************************
* TIMER1
*********************************************************************/
#define TIMER1_INTERRUPT_TIME_MS                      (SENSORS_SAMPLE_TIME_MS)
 
#if (F_CPU == 8000000L)
#define TIMER1_OVERFLOW_TIME_MS                       (8388)
#elif (F_CPU == 16000000L)
#define TIMER1_OVERFLOW_TIME_MS                       (4194)
#endif
 
#define TIMER1_TCNT1_VALUE                            ((uint16_t)(0xFFFF - (float)(1.0 * 0xFFFF * TIMER1_INTERRUPT_TIME_MS / TIMER1_OVERFLOW_TIME_MS)))
 
#define TIMER_COUNTER_VALUE_MAX_MS                    (SENSORS_SAMPLE_TIME_MS)
#define TIMER_COUNTER_VALUE_MAX_S                     (60)
 
/*********************************************************************
* TASKS
*********************************************************************/
#define SOLAR_RADIATION_READ_DELAY_MS                 (500)
 
#define SOLAR_RADIATION_VALUES_READ_DELAY_MS          (10)
 
#define SOLAR_RADIATION_READ_COUNT                    (20)
 
#define TRANSACTION_TIMEOUT_MS                       (5000)
 
#endif