config.h

Go to the documentation of this file.

 
#ifndef CONFIG_H
#define CONFIG_H
 
//--------------------------------------------------------------------------------------------------
//#define RF_PRESENT  /**< this line must be commented out if the RFM12B module is not present */
#define ENABLE_DEBUG 
//--------------------------------------------------------------------------------------------------
 
#include "config_system.h"
#include "debug.h"
#include "types.h"
 
#include "utils_dualtariff.h"
#include "utils_relay.h"
 
// Serial output type - Human readable for initial setup and commissioning
inline constexpr SerialOutputType SERIAL_OUTPUT_TYPE = SerialOutputType::HumanReadable;
 
//--------------------------------------------------------------------------------------------------
// Basic Configuration
//
inline constexpr uint8_t NO_OF_DUMPLOADS{ 3 }; 
 
// Feature toggles - Basic setup without advanced features
inline constexpr bool EMONESP_CONTROL{ false };
inline constexpr bool DIVERSION_PIN_PRESENT{ false };                   
inline constexpr RotationModes PRIORITY_ROTATION{ RotationModes::OFF }; 
inline constexpr bool OVERRIDE_PIN_PRESENT{ true };                     
 
inline constexpr bool WATCHDOG_PIN_PRESENT{ false }; 
inline constexpr bool RELAY_DIVERSION{ false };      
inline constexpr bool DUAL_TARIFF{ false };          
inline constexpr bool TEMP_SENSOR_PRESENT{ false };  
 
#include "utils_temp.h"
 
// ----------- Pinout Assignments -----------
//
// ANALOG pins:
// - All analog pins are reserved and hard-wired on the PCB.
//
// DIGITAL pins:
// - D0 & D1: Reserved for the Serial interface.
//
// RFM12B Module (if present):
// - D2: Used for the RFM12B module.
// - D10: Used for the RFM12B module.
// - D11: Used for the RFM12B module.
// - D12: Used for the RFM12B module.
// - D13: Used for the RFM12B module.
//
// SPI Interface:
// - D10: Chip Select (CS).
// - D11: Master Out Slave In (MOSI).
// - D12: Master In Slave Out (MISO).
// - D13: Serial Clock (SCK).
//
// Expansion Board:
// Digital Input Pins (D10-D13) are wired to the expansion board and it's intended
// to configure them as digital inputs
// They allow external control from Home Assistant for functions such as:
//   * Forced operation mode
//   * Diversion enable/disable
//   * Priority rotation triggering
//   * Manual load control
//
// D3 is wired to the expansion board too and is intended for taking control of the temperature sensor.
//
// Note: When using these pins for Home Assistant integration, ensure the ESP32
// counterpart is properly configured to send the appropriate signals.
 
inline constexpr uint8_t physicalLoadPin[NO_OF_DUMPLOADS]{ 5, 6, 7 };         
inline constexpr uint8_t loadPrioritiesAtStartup[NO_OF_DUMPLOADS]{ 0, 1, 2 }; 
 
// Set the value to 'unused_pin' when the pin is not needed (feature deactivated)
inline constexpr uint8_t dualTariffPin{ unused_pin }; 
inline constexpr uint8_t diversionPin{ unused_pin };  
inline constexpr uint8_t rotationPin{ unused_pin };   
inline constexpr uint8_t watchDogPin{ unused_pin };   
 
//--------------------------------------------------------------------------------------------------
// EWMA Filter Tuning for Cloud Immunity
//
// The RELAY_FILTER_DELAY parameter controls how aggressively the EWMA filter smooths
// power measurements before making relay decisions. This directly affects cloud immunity vs responsiveness.
//
// 🌤️ Quick Reference by Climate:
// - Clear sky regions (desert, dry):     1 minute  (fast response, minimal clouds)
// - Mixed conditions (most locations):   2 minutes (recommended default)
// - Frequently cloudy (coastal):         3 minutes (enhanced stability)
// - Very cloudy (mountain, tropical):    4 minutes (maximum stability)
//
// 🧪 Scientific Tuning:
// Run cloud pattern analysis tests to determine optimal setting for your climate:
//   cd Mk2_3phase_RFdatalog_temp && pio test -e native --filter="test_cloud_patterns" -v
//
// 📖 Full guide: docs/Cloud_Pattern_Tuning_Guide.md
//--------------------------------------------------------------------------------------------------
inline constexpr uint8_t RELAY_FILTER_DELAY{ 2 }; 
 
// Relay configuration with tunable EWMA filter
// For battery systems, use negative import threshold (turn OFF when surplus < abs(threshold))
// Examples:
//   Normal installation:  { pin, 1000, 200, 5, 5 }   // Turn OFF when importing > 200W
//   Battery installation: { pin, 1000, -50, 5, 5 }   // Turn OFF when surplus < 50W
inline constexpr RelayEngine relays{ MINUTES(RELAY_FILTER_DELAY),
                                     { { unused_pin, 100, 200, 1, 1 },
                                       { unused_pin, 300, 400, 1, 1 },
                                       { unused_pin, 500, 600, 1, 1 } } }; 
 
#include "utils_override.h"
 
// This is an example of override pin configuration.
// You can modify the pin numbers and associated loads/relays as needed.
// Ensure that the pins used do not conflict with other functionalities in your setup.
// This example does not make any sense, that's just to show how to use the class OverridePins
// inline constexpr OverridePins overridePins{ { { 3, { RELAY(1), LOAD(1) } },
//                                               { 4, ALL_LOADS() },
//                                               { 11, { 1, LOAD(1), LOAD(2) } },
//                                               { 12, { RELAY(0), 9, RELAY(2) } },
//                                               { 13, ALL_LOADS_AND_RELAYS() } } }; /**< list of override pin/loads-relays pairs */
 
inline constexpr OverridePins overridePins{ { { 4, ALL_LOADS() } } }; 
 
inline constexpr uint8_t ul_OFF_PEAK_DURATION{ 8 };                        
inline constexpr pairForceLoad rg_ForceLoad[NO_OF_DUMPLOADS]{ { -3, 2 } }; 
 
inline constexpr int16_t iTemperatureThreshold{ 100 }; 
 
inline constexpr TemperatureSensing temperatureSensing{ unused_pin,
                                                        { { 0x28, 0xBE, 0x41, 0x6B, 0x09, 0x00, 0x00, 0xA4 },
                                                          { 0x28, 0x1B, 0xD7, 0x6A, 0x09, 0x00, 0x00, 0xB7 } } }; 
 
inline constexpr uint32_t ROTATION_AFTER_SECONDS{ 8UL * 3600UL }; 
 
/* --------------------------------------
   RF configuration (for the RFM12B module)
   frequency options are RF12_433MHZ, RF12_868MHZ or RF12_915MHZ
*/
#ifdef RF_PRESENT
 
#define RF69_COMPAT 0  // for the RFM12B
// #define RF69_COMPAT 1 // for the RF69
 
#define FREQ RF12_868MHZ
 
inline constexpr int nodeID{ 10 };        
inline constexpr int networkGroup{ 210 }; 
inline constexpr int UNO{ 1 };            
 
#endif  // RF_PRESENT
 
#endif  // CONFIG_H