chriz/OpenMQTT-Gateway
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity
Files
4b7d3f658939ec8d46b84a34cc6281edede2f73f
OpenMQTT-Gateway/main/User_config.h
T
FlorianandClaude 4d945851ce [SYS] Add WiFi reconnect watchdog to self-heal from wedged WiFi stack (#2319) 
When the network drops at runtime and the WiFi stack is wedged (e.g. the
ESP32 driver getting stuck after a long uptime, see #2276), the main loop
kept calling wifi_reconnect_bypass() forever with no recovery: the device
stayed stale until a manual reboot. The reboot watchdog only existed in the
ESPWifiManualSetup path, which the default WiFiManager build doesn't compile.

Count consecutive reconnection failures in the runtime loop and ESPRestart(2)
once they exceed maxRetryWatchDog, mirroring the existing manual-setup
watchdog. Gated behind the new WifiReconnectWatchDog flag (default on) so
environments where an unexpected reboot is undesirable can opt out; disabled
for theengs-plug to avoid interrupting the relay state.

Co-authored-by: Claude <noreply@anthropic.com>
2026-06-01 08:50:12 -05:00

721 lines
26 KiB
C++
Raw Blame History

/*
OpenMQTTGateway - ESP8266 or Arduino program for home automation
Act as a gateway between your 433mhz, infrared IR, BLE, LoRa signal and one interface like an MQTT broker
Send and receiving command by MQTT
This program enables to:
- receive MQTT data from a topic and send signals corresponding to the received MQTT data
- publish MQTT data to a different topic related to received signals
Copyright: (c)Florian ROBERT
This file is part of OpenMQTTGateway.
OpenMQTTGateway 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 3 of the License, or
(at your option) any later version.
OpenMQTTGateway 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 user_config_h
#define user_config_h
/*-------------------VERSION----------------------*/
#ifndef OMG_VERSION
# define OMG_VERSION "edge"
#endif
/*-------------CONFIGURE WIFIMANAGER-------------(only ESP8266 & SONOFF RFBridge)*/
/*
* The following parameters are set during the WifiManager setup process:
* - wifi_ssid
* - wifi_password
* - mqtt_user
* - mqtt_pass
* - mqtt_server
* - mqtt_port
*
* To completely disable WifiManager, define ESPWifiManualSetup.
* If you do so, please don't forget to set these variables before compiling
*
* Otherwise you can provide these credentials on the web interface after connecting
* to the access point with your password (SSID: WifiManager_ssid, password: WifiManager_password)
*/
/*-------------DEFINE GATEWAY NAME BELOW IT CAN ALSO BE DEFINED IN platformio.ini----------------*/
// Uncomment to use the MAC address first 4 digits in the format of 5566 as the suffix of the short gateway name.
// Any definition of Gateway_Name will be ignored. The Gateway_Short_name _ MAC will be used as the access point name.
//#define USE_MAC_AS_GATEWAY_NAME
#ifndef Gateway_Name
# define Gateway_Name "OpenMQTTGateway"
#endif
#ifndef Gateway_Short_Name
# define Gateway_Short_Name "OMG" // 3 characters maximum
#endif
#ifndef Base_Topic
# define Base_Topic "home/"
#endif
/*-------------DEFINE YOUR NETWORK PARAMETERS BELOW----------------*/
//#define NetworkAdvancedSetup true //uncomment if you want to set advanced network parameters, not uncommented you can set the IP and MAC only
#ifdef NetworkAdvancedSetup
# ifndef NET_IP
# define NET_IP "192.168.1.99"
# endif
# ifndef NET_MASK
# define NET_MASK "255.255.255.0"
# endif
# ifndef NET_GW
# define NET_GW "192.168.1.1"
# endif
# ifndef NET_DNS
# define NET_DNS "192.168.1.1"
# endif
#endif
//# define ESPWifiManualSetup true //uncomment you don't want to use wifimanager for your credential settings on ESP
//#define ESP32_ETHERNET=true // Uncomment to use Ethernet module on ESP32 Ethernet gateway and adapt the settings to your board below, the default parameter are for OLIMEX ESP32 gateway
#ifdef ESP32_ETHERNET
# ifndef ETH_PHY_ADDR
# define ETH_PHY_ADDR 0
# endif
# ifndef ETH_PHY_TYPE
# define ETH_PHY_TYPE ETH_PHY_LAN8720
# endif
# ifndef ETH_PHY_POWER
# define ETH_PHY_POWER 12
# endif
# ifndef ETH_PHY_MDC
# define ETH_PHY_MDC 23
# endif
# ifndef ETH_PHY_MDIO
# define ETH_PHY_MDIO 18
# endif
# ifndef ETH_CLK_MODE
# define ETH_CLK_MODE ETH_CLOCK_GPIO17_OUT
# endif
#endif
#if defined(ESPWifiManualSetup) // for nodemcu, weemos and esp8266
# ifndef wifi_ssid
# define wifi_ssid "wifi ssid"
# endif
# ifndef wifi_password
# define wifi_password "wifi password"
# endif
#endif
//#define WM_PWD_FROM_MAC true // enable to set the password from the last 8 digits of the ESP MAC address for enhanced security, enabling this option requires to have access to the MAC address, either through a sticker or with serial monitoring
#ifndef WifiManager_ssid
# define WifiManager_ssid Gateway_Name //this is the network name of the initial setup access point
#endif
#ifndef WifiManager_ConfigPortalTimeOut
# define WifiManager_ConfigPortalTimeOut 240 //time in seconds for the setup portal to stay open, default 240s
#endif
#ifndef WiFi_TimeOut
# define WiFi_TimeOut 30
#endif
#ifndef WM_DEBUG // WiFi Manager debug
# define WM_DEBUG 1
#endif
//#define WIFIMNG_HIDE_MQTT_CONFIG //Uncomment so as to hide MQTT setting from Wifi manager page
/*-------------DEFINE YOUR ADVANCED NETWORK PARAMETERS BELOW----------------*/
//#define MDNS_SD //uncomment if you want to use mDNS for discovering automatically your IP server, please note that mDNS with ESP32 can cause the BLE to not work
#define maxConnectionRetryNetwork 5 //maximum Wifi connection attempts with existing credential at start (used to bypass ESP32 issue on wifi connect)
#define maxRetryWatchDog 11 //maximum Wifi or MQTT re-connection attempts before restarting
// WifiReconnectWatchDog: restart the ESP if the network can't be recovered after maxRetryWatchDog
// consecutive reconnection attempts in the main loop. This allows the gateway to self-heal from a
// wedged WiFi stack (e.g. the ESP32 driver getting stuck after a long uptime). Disable it on
// environments where an unexpected reboot is undesirable (e.g. a smart plug that would lose its relay state).
#ifndef WifiReconnectWatchDog
# define WifiReconnectWatchDog true
#endif
//set minimum quality of signal so it ignores AP's under that quality
#define MinimumWifiSignalQuality 8
/*-------------DEFINE YOUR MQTT PARAMETERS BELOW----------------*/
//MQTT Parameters definition
#define parameters_size 65
#define mqtt_topic_max_size 150
#define mqtt_key_max_size 20
#ifdef MQTT_HTTPS_FW_UPDATE
# ifndef CHECK_OTA_UPDATE
# define CHECK_OTA_UPDATE true // enable to check for the presence of a new version for your environment on Github
# endif
#endif
#ifndef JSON_MSG_BUFFER
# if defined(ESP32)
# define JSON_MSG_BUFFER 1024 // adjusted to minimum size covering largest home assistant discovery messages
# if MQTT_SECURE_DEFAULT
# define JSON_MSG_BUFFER_MAX 2048 // Json message buffer size increased to handle certificate changes through MQTT, used for the queue and the coming MQTT messages
# else
# define JSON_MSG_BUFFER_MAX 1024 // Minimum size for the cover MQTT discovery message
# endif
# elif defined(ESP8266)
# define JSON_MSG_BUFFER 512 // Json message max buffer size, don't put 768 or higher it is causing unexpected behaviour on ESP8266, certificates handling with ESP8266 is not tested
# define JSON_MSG_BUFFER_MAX 832 // Minimum size for MQTT discovery message
# endif
#endif
#ifndef mqtt_max_payload_size
# define mqtt_max_payload_size JSON_MSG_BUFFER_MAX + mqtt_topic_max_size + 10 // maximum size of the MQTT payload
#endif
#ifndef MQTT_USER
# define MQTT_USER "your_username"
#endif
#ifndef MQTT_PASS
# define MQTT_PASS "your_password"
#endif
#ifndef MQTT_SERVER
# define MQTT_SERVER "192.168.1.17"
#endif
#ifndef MQTT_PORT
# define MQTT_PORT "1883"
#endif
#ifndef GeneralTimeOut
# define GeneralTimeOut 20 // time out if a task is stuck in seconds (should be more than TimeBetweenReadingRN8209/1000) and more than 3 seconds, the WDT will reset the ESP, used also for MQTT connection
#endif
#ifndef QueueSemaphoreTimeOutTask
# define QueueSemaphoreTimeOutTask 3000 // time out for semaphore retrieval from a task
#endif
#ifndef QueueSemaphoreTimeOutLoop
# define QueueSemaphoreTimeOutLoop 100 // time out for semaphore retrieval from the loop
#endif
// Uncomment to use a device running TheengsGateway to decode BLE data. (https://github.com/theengs/gateway)
// Set the topic to the subscribe topic configured in the TheengGateway
// #define MQTTDecodeTopic "MQTTDecode"
#define ATTEMPTS_BEFORE_BG 10 // Number of wifi connection attempts before going to BG protocol
#define ATTEMPTS_BEFORE_B 20 // Number of wifi connection attempts before going to B protocol
#ifndef NTP_SERVER
# define NTP_SERVER "pool.ntp.org"
#endif
#ifndef MQTT_SECURE_DEFAULT
# define MQTT_SECURE_DEFAULT false
#endif
#ifndef MQTT_CERT_VALIDATE_DEFAULT
# define MQTT_CERT_VALIDATE_DEFAULT false
#endif
#ifndef AWS_IOT
# define AWS_IOT false
#endif
#ifndef MQTT_BROKER_MODE
# define MQTT_BROKER_MODE false
#endif
#if MQTT_BROKER_MODE
// In MQTT broker mode the MQTT web config is not needed
# define WIFIMNG_HIDE_MQTT_CONFIG true
#endif
#define GITHUB_OTA_SERVER_CERT_HASH "d4d211b4553af9fac371f24c2268d59d2b0fec6b9aa0fdbbde068f078d7daf86" // SHA256 fingerprint of the certificate used by the OTA server
#if AWS_IOT
// Enable the use of ALPN for AWS IoT Core with the port 443
# define ALPN_PROTOCOLS \
{ "x-amzn-mqtt-ca", NULL }
#endif
//# define MQTT_HTTPS_FW_UPDATE //uncomment to enable updating via MQTT message.
#ifdef MQTT_HTTPS_FW_UPDATE
// If used, this should be set to the root CA certificate of the server hosting the firmware.
# ifdef PRIVATE_CERTS
# include "certs/private_ota_cert.h"
# else
# include "certs/default_ota_cert.h"
# endif
# ifndef MQTT_HTTPS_FW_UPDATE_USE_PASSWORD
# define MQTT_HTTPS_FW_UPDATE_USE_PASSWORD 1 // Set this to 0 if not using TLS connection to MQTT broker to prevent clear text passwords being sent.
# endif
# if DEVELOPMENTOTA
# define OTA_JSON_URL "https://ota.openmqttgateway.com/binaries/dev/latest_version_dev.json" //OTA url used to discover new versions of the firmware from development nightly builds
# else
# define OTA_JSON_URL "https://ota.openmqttgateway.com/binaries/latest_version.json" //OTA url used to discover new versions of the firmware
# endif
# define ENTITY_PICTURE "https://github.com/1technophile/OpenMQTTGateway/raw/development/docs/img/Openmqttgateway_logo_mini_margins.png"
# define RELEASE_LINK_DEV "https://ota.openmqttgateway.com/binaries/dev/"
# define RELEASE_LINK "https://ota.openmqttgateway.com/binaries/"
#else
static const char* OTAserver_cert = "";
#endif
#ifndef MQTT_SECURE_SIGNED_CLIENT
# define MQTT_SECURE_SIGNED_CLIENT 0 // If using a signed certificate for the broker and using client certificate/key set this to true or 1
#endif
#ifdef PRIVATE_CERTS
# include "certs/private_client_cert.h"
# include "certs/private_client_key.h"
# include "certs/private_server_cert.h"
#else
# include "certs/default_client_cert.h"
# include "certs/default_client_key.h"
# include "certs/default_server_cert.h"
#endif
#include <string>
#ifndef CNT_DEFAULT_INDEX
# define CNT_DEFAULT_INDEX 0 // Default set of connection parameters
#endif
#if !MQTT_BROKER_MODE
struct ss_cnt_parameters {
std::string server_cert;
std::string client_cert;
std::string client_key;
std::string ota_server_cert;
char mqtt_server[parameters_size];
char mqtt_port[6];
char mqtt_user[parameters_size];
char mqtt_pass[parameters_size];
bool isConnectionSecure;
bool isCertValidate;
bool validConnection;
};
# define CNT_PARAMS_ARR \
{ \
{ss_server_cert, ss_client_cert, ss_client_key, OTAserver_cert, MQTT_SERVER, MQTT_PORT, MQTT_USER, MQTT_PASS, MQTT_SECURE_DEFAULT, MQTT_CERT_VALIDATE_DEFAULT, false}, \
{"", "", "", "", MQTT_SERVER, MQTT_PORT, MQTT_USER, MQTT_PASS, MQTT_SECURE_DEFAULT, MQTT_CERT_VALIDATE_DEFAULT, false}, \
{ "", "", "", "", MQTT_SERVER, MQTT_PORT, MQTT_USER, MQTT_PASS, MQTT_SECURE_DEFAULT, MQTT_CERT_VALIDATE_DEFAULT, false } \
}
# define cnt_parameters_array_size 3
extern ss_cnt_parameters cnt_parameters_array[];
#endif
#define MIN_CERT_LENGTH 200 // Minimum length of a certificate to be considered valid
/**
* Ext wake for Deep-sleep for the ESP32.
* Set the wake pin state.
*/
#ifdef ESP32_EXT0_WAKE_PIN
# ifndef ESP32_EXT0_WAKE_PIN_STATE
# define ESP32_EXT0_WAKE_PIN_STATE 1
# endif
#endif
#ifdef ESP32_EXT1_WAKE_PIN
# ifndef ESP32_EXT1_WAKE_PIN_STATE
# define ESP32_EXT1_WAKE_PIN_STATE 1
# endif
#endif
#ifndef DEEP_SLEEP_IN_US
# define DEEP_SLEEP_IN_US 60000000 // 1 minute
#endif
/*------------------DEEP SLEEP parameters ------------------*/
//DEFAULT_LOW_POWER_MODE DEACTIVATED low power mode can't be used on this build to prevent bricking devices that does not support low power mode
//DEFAULT_LOW_POWER_MODE ALWAYS_ON normal mode (no power consumption optimisations)
//DEFAULT_LOW_POWER_MODE INTERVAL to activate deep sleep with intervals and action wake up
//DEFAULT_LOW_POWER_MODE ACTION to activate deep sleep with action wake up
#ifndef DEFAULT_LOW_POWER_MODE
# define DEFAULT_LOW_POWER_MODE DEACTIVATED
#endif
/*-------------DEFINE THE MODULES YOU WANT BELOW----------------*/
//Addons and module management, uncomment the Z line corresponding to the module you want to use
//#define ZgatewayRF "RF" //ESP8266, Arduino, ESP32
//#define ZgatewayIR "IR" //ESP8266, Arduino, Sonoff RF Bridge
//#define ZgatewayLORA "LORA" //ESP8266, Arduino, ESP32
//#define ZgatewayPilight "Pilight" //ESP8266, Arduino, ESP32
//#define ZgatewayWeatherStation "WeatherStation" //ESP8266, Arduino, ESP32
//#define ZgatewayGFSunInverter "GFSunInverter" //ESP32
//#define ZgatewayBT "BT" //ESP8266, ESP32
//#define ZgatewayRF2 "RF2" //ESP8266, Arduino, ESP32
//#define ZgatewaySRFB "SRFB" // Sonoff RF Bridge
//#define Zgateway2G "2G" //ESP8266, Arduino, ESP32
//#define ZgatewayRFM69 "RFM69" //ESP8266, Arduino, ESP32
//#define ZactuatorONOFF "ONOFF" //ESP8266, Arduino, ESP32, Sonoff RF Bridge
//#define ZsensorINA226 "INA226" //ESP8266, Arduino, ESP32
//#define ZsensorHCSR04 "HCSR04" //ESP8266, Arduino, ESP32
//#define ZsensorHCSR501 "HCSR501" //ESP8266, Arduino, ESP32, Sonoff RF Bridge
//#define ZsensorADC "ADC" //ESP8266, Arduino, ESP32
//#define ZsensorBH1750 "BH1750" //ESP8266, Arduino, ESP32
//#define ZsensorMQ2 "MQ2" //ESP8266, Arduino, ESP32
//#define ZsensorTEMT6000 "TEMT6000" //ESP8266
//#define ZsensorTSL2561 "TSL2561" //ESP8266, Arduino, ESP32
//#define ZsensorBME280 "BME280" //ESP8266, Arduino, ESP32
//#define ZsensorHTU21 "HTU21" //ESP8266, Arduino, ESP32
//#define ZsensorLM75 "LM75" //ESP8266, Arduino, ESP32
//#define ZsensorDHT "DHT" //ESP8266, Arduino, ESP32, Sonoff RF Bridge
//#define ZsensorDS1820 "DS1820" //ESP8266, Arduino, ESP32
//#define ZsensorGPIOKeyCode "GPIOKeyCode" //ESP8266, Arduino, ESP32
//#define ZsensorGPIOInput "GPIOInput" //ESP8266, Arduino, ESP32
//#define ZmqttDiscovery "HADiscovery"//ESP8266, Arduino, ESP32, Sonoff RF Bridge
//#define ZactuatorFASTLED "FASTLED" //ESP8266, Arduino, ESP32, Sonoff RF Bridge
//#define ZboardM5STICKC "M5StickC"
//#define ZboardM5STICKCP "M5StickCP"
//#define ZboardM5STACK "M5STACK"
//#define ZboardM5TOUGH "M5TOUGH"
//#define ZradioCC1101 "CC1101" //ESP8266, ESP32
//#define ZactuatorPWM "PWM" //ESP8266, ESP32
//#define ZsensorSHTC3 "SHTC3" //ESP8266, Arduino, ESP32, Sonoff RF Bridge
//#define ZactuatorSomfy "Somfy" //ESP8266, Arduino, ESP32
//#define ZgatewaySERIAL "SERIAL" //ESP8266, Arduino, ESP32
/*-------------DEFINE YOUR MQTT ADVANCED PARAMETERS BELOW----------------*/
#ifndef will_Topic
# define will_Topic "/LWT"
#endif
#ifndef will_QoS
# define will_QoS 0
#endif
#ifndef will_Retain
# define will_Retain true
#endif
#ifndef sensor_Retain
# define sensor_Retain false
#endif
#ifndef will_Message
# define will_Message "offline"
#endif
#ifndef Gateway_AnnouncementMsg
# define Gateway_AnnouncementMsg "online"
#endif
#ifndef jsonPublishing
# define jsonPublishing true //define false if you don't want to use Json publishing (one topic for all the parameters)
#endif
//example home/OpenMQTTGateway_ESP32_DEVKIT/BTtoMQTT/4XXXXXXXXXX4 {"rssi":-63,"servicedata":"fe0000000000000000000000000000000000000000"}
#ifndef jsonReceiving
# define jsonReceiving true //define false if you don't want to use Json reception analysis
#endif
#ifndef simplePublishing
# define simplePublishing false //define true if you want to use simple publishing (one topic for one parameter)
#endif
//example
// home/OpenMQTTGateway_ESP32_DEVKIT/BTtoMQTT/4XXXXXXXXXX4/rssi -63.0
// home/OpenMQTTGateway_ESP32_DEVKIT/BTtoMQTT/4XXXXXXXXXX4/servicedata fe0000000000000000000000000000000000000000
#ifndef simpleReceiving
# define simpleReceiving true //define false if you don't want to use old way reception analysis
#endif
#ifndef message_UTCtimestamp
# define message_UTCtimestamp false //define true if you want messages to be timestamped in ISO8601 UTC format (e.g.: "UTCtime"="2023-12-26T19:10:20Z")
#endif
#ifndef message_unixtimestamp
# define message_unixtimestamp false //define true if you want messages to have an unix timestamp (e.g.: "unixtime"=1679015107)
#endif
/*-------------DEFINE YOUR OTA PARAMETERS BELOW----------------*/
#ifndef ota_hostname
# define ota_hostname Gateway_Name
#endif
#ifndef gw_password
# define gw_password ""
#endif
#ifndef ota_port
# define ota_port 8266
#endif
// timeout for OTA activities
// OTA upload with no activity in this period is considered inactive
// As long as OTA upload is considered "active", we avoid rebooting e.g.
// in case of failures connecting to MQTT
#ifndef ota_timeout_millis
# define ota_timeout_millis 30000
#endif
// LED index depending on state, each state can have a different LED index or be grouped if there is a limited number of LEDs
#ifndef LED_ERROR
# define LED_ERROR 0
#endif
#ifndef LED_PROCESSING
# define LED_PROCESSING 0
#endif
#ifndef LED_BROKER
# define LED_BROKER 0
#endif
#ifndef LED_NETWORK
# define LED_NETWORK 0
#endif
// LED Strip index
#ifndef STRIP_ERROR
# define STRIP_ERROR 0
#endif
#ifndef STRIP_PROCESSING
# define STRIP_PROCESSING 0
#endif
#ifndef STRIP_BROKER
# define STRIP_BROKER 0
#endif
#ifndef STRIP_NETWORK
# define STRIP_NETWORK 0
#endif
#ifndef STRIP_POWER
# define STRIP_POWER 0
#endif
// Single standard LED pin
#ifndef LED_PIN
# ifdef LED_BUILTIN
# define LED_PIN LED_BUILTIN
# endif
#endif
#ifndef LED_PIN_ON
# define LED_PIN_ON HIGH
#endif
#ifndef LED_ACTUATOR_ONOFF
# ifdef LED_BUILTIN
# define LED_ACTUATOR_ONOFF LED_BUILTIN
# endif
#endif
#ifndef DEFAULT_ADJ_BRIGHTNESS
# define DEFAULT_ADJ_BRIGHTNESS 255 // Set Default RGB adjustable brightness
#endif
#ifndef LED_POWER_COLOR
# define LED_POWER_COLOR 0x00FF00 // Green
#endif
#ifndef LED_PROCESSING_COLOR
# define LED_PROCESSING_COLOR 0x0000FF // Blue
#endif
#ifndef LED_WAITING_ONBOARD_COLOR
# define LED_WAITING_ONBOARD_COLOR 0xFFA500 // Orange
#endif
#ifndef LED_ONBOARD_COLOR
# define LED_ONBOARD_COLOR 0xFFFF00 // Yellow
#endif
#ifndef LED_NETWORK_OK_COLOR
# define LED_NETWORK_OK_COLOR 0x00FF00 // Green
#endif
#ifndef LED_NETWORK_ERROR_COLOR
# define LED_NETWORK_ERROR_COLOR 0xFFA500 // Orange
#endif
#ifndef LED_BROKER_OK_COLOR
# define LED_BROKER_OK_COLOR 0x00FF00 // Green
#endif
#ifndef LED_BROKER_ERROR_COLOR
# define LED_BROKER_ERROR_COLOR 0xFFA500 // Orange
#endif
#ifndef LED_OFFLINE_COLOR
# define LED_OFFLINE_COLOR 0x0000FF // Blue
#endif
#ifndef LED_OTA_LOCAL_COLOR
# define LED_OTA_LOCAL_COLOR 0xFF00FF // Magenta
#endif
#ifndef LED_OTA_REMOTE_COLOR
# define LED_OTA_REMOTE_COLOR 0x8000FF // Purple
#endif
#ifndef LED_ERROR_COLOR
# define LED_ERROR_COLOR 0xFF0000 // Red
#endif
#ifndef LED_ACTUATOR_ONOFF_COLOR
# define LED_ACTUATOR_ONOFF_COLOR 0x00FF00 // Green
#endif
#ifndef LED_COLOR_BLACK
# define LED_COLOR_BLACK 0x000000
#endif
#ifdef ESP8266
//# define TRIGGER_GPIO 14 // pin D5 as full reset button (long press >10s)
#elif defined(ESP32)
//# define TRIGGER_GPIO 0 // boot button as full reset button (long press >10s)
//# define NO_INT_TEMP_READING true //Define if we don't want internal temperature reading for the ESP32
#endif
// VCC ------------D|-----------/\/\/\/\ ----------------- Arduino PIN
// LED Resistor 270-510R
/*----------------------------OTHER PARAMETERS-----------------------------*/
/*-------------------CHANGING THEM IS NOT COMPULSORY-----------------------*/
/*----------------------------USER PARAMETERS-----------------------------*/
#ifdef ZgatewaySRFB
# define SERIAL_BAUD 19200
#else
# ifndef SERIAL_BAUD
# define SERIAL_BAUD 115200
# endif
#endif
/*--------------MQTT general topics-----------------*/
// global MQTT subject listened by the gateway to execute commands (send RF, IR or others)
#ifndef subjectMQTTtoX
# define subjectMQTTtoX "/commands/#"
#endif
#ifndef subjectMultiGTWKey
# define subjectMultiGTWKey "toMQTT"
#endif
#ifndef subjectGTWSendKey
# define subjectGTWSendKey "MQTTto"
#endif
// key used for launching commands to the gateway
#define restartCmd "restart"
#define eraseCmd "erase"
#define statusCmd "status"
#ifndef valueAsATopic
# define valueAsATopic false // define true to integrate msg value into the subject when receiving
#endif
#if defined(ZgatewayRF) || defined(ZgatewayIR) || defined(ZgatewaySRFB) || defined(ZgatewayWeatherStation) || defined(ZgatewayRTL_433)
// variable to avoid duplicates
# ifndef time_avoid_duplicate
# define time_avoid_duplicate 3000 // if you want to avoid duplicate MQTT message received set this to > 0, the value is the time in milliseconds during which we don't publish duplicates
# endif
#endif
#ifndef TimeBetweenReadingSYS
# define TimeBetweenReadingSYS 120 // time between (s) system readings (like memory)
#endif
#define TimeBetweenCheckingSYS 3600 // time between (s) system checkings (like updates)
#define TimeLedON 1 // time LED are ON
#define InitialMQTTConnectionTimeout 10 // time estimated (s) before the board is connected to MQTT
#ifndef subjectSYStoMQTT
# define subjectSYStoMQTT "/SYStoMQTT" // system parameters
#endif
#ifndef subjectLOGtoMQTT
# define subjectLOGtoMQTT "/LOGtoMQTT" // log informations
#endif
#ifndef subjectRLStoMQTT
# define subjectRLStoMQTT "/RLStoMQTT" // latest release information
#endif
#ifndef subjectMQTTtoSYSset
# define subjectMQTTtoSYSset "/commands/MQTTtoSYS/config"
#endif
#ifndef subjectMQTTtoSYSupdate
# define subjectMQTTtoSYSupdate "/commands/MQTTtoSYS/firmware_update"
#endif
#define TimeToResetAtStart 5000 // Time we allow the user at start for the reset command by button press
#include <ArduinoLog.h>
/*-------------------DEFINE LOG LEVEL----------------------*/
#ifndef LOG_LEVEL
# define LOG_LEVEL LOG_LEVEL_NOTICE
#endif
/*-------------------SIMPLIFIED LOGGING MACROS----------------------*/
// ArduinoLog levels: SILENT=0, FATAL=1, ERROR=2, WARNING=3, NOTICE=4, TRACE=5, VERBOSE=6
#if LOG_LEVEL >= LOG_LEVEL_VERBOSE
# define THEENGS_LOG_VERBOSE(...) Log.verbose(__VA_ARGS__)
#else
# define THEENGS_LOG_VERBOSE(...) ((void)0)
#endif
#if LOG_LEVEL >= LOG_LEVEL_TRACE
# define THEENGS_LOG_TRACE(...) Log.trace(__VA_ARGS__)
#else
# define THEENGS_LOG_TRACE(...) ((void)0)
#endif
#if LOG_LEVEL >= LOG_LEVEL_NOTICE
# define THEENGS_LOG_NOTICE(...) Log.notice(__VA_ARGS__)
#else
# define THEENGS_LOG_NOTICE(...) ((void)0)
#endif
#if LOG_LEVEL >= LOG_LEVEL_WARNING
# define THEENGS_LOG_WARNING(...) Log.warning(__VA_ARGS__)
#else
# define THEENGS_LOG_WARNING(...) ((void)0)
#endif
#if LOG_LEVEL >= LOG_LEVEL_ERROR
# define THEENGS_LOG_ERROR(...) Log.error(__VA_ARGS__)
#else
# define THEENGS_LOG_ERROR(...) ((void)0)
#endif
#if LOG_LEVEL >= LOG_LEVEL_FATAL
# define LOG_FATAL(...) Log.fatal(__VA_ARGS__)
#else
# define LOG_FATAL(...) ((void)0)
#endif
/*-------------------ESP Wifi band and tx power ---------------------*/
//Certain sensors are sensitive to Wifi which can cause interference with their normal operation
//For example it can cause false triggers on a PIR HC-SR501
//It is reccomended to change Wifi BAND to G and reduce tx power level to 11dBm
//Since the WiFi protocol is persisted in the flash of the ESP you have to run at least once with `WiFiGMode` defined false to get Band N back.
#ifndef WifiGMode
//# define WifiGMode true
#endif
#ifndef WifiPower
//# define WifiPower WIFI_POWER_11dBm //When using an ESP32
//# define WifiPower 11 //When using an ESP8266
#endif
/*-----------PLACEHOLDERS FOR WebUI DISPLAY--------------*/
#define pubWebUI(...) // display the published message onto the WebUI display
/*-----------PLACEHOLDERS FOR OLED/LCD DISPLAY--------------*/
// The real definitions are in config_M5.h / config_SSD1306.h
#define displayPrint(...) // only print if not in low power mode
#define lpDisplayPrint(...) // print in low power mode
/*--------------------Minimum freeHeap--------------------*/
// Below this parameter we trigger a restart, this avoid stuck boards like seen in https://github.com/1technophile/OpenMQTTGateway/issues/1693
#define MinimumMemory 40000
/*----------------CONFIGURABLE PARAMETERS-----------------*/
#ifndef DEFAULT_DISCOVERY
# define DEFAULT_DISCOVERY true
#endif
#ifndef DEFAULT_MQTT
# define DEFAULT_MQTT true
#endif
#ifndef DEFAULT_SERIAL
# define DEFAULT_SERIAL false
#endif
#ifndef DEFAULT_BLUFI
# define DEFAULT_BLUFI true
#endif
#ifndef DEFAULT_OFFLINE
# define DEFAULT_OFFLINE false
#endif
#if defined(ZgatewayRF) || defined(ZgatewayIR) || defined(ZgatewaySRFB) || defined(ZgatewayWeatherStation) || defined(ZgatewayRTL_433)
bool isAduplicateSignal(uint64_t);
void storeSignalValue(uint64_t);
#endif
#ifdef ZgatewayBT
# ifndef BLEDecryptor
# define BLEDecryptor true //true if decrypt encrypted PVVX, BTHome v2 or Victron Energy broadcast data
# ifndef JSON_BLE_AES_CUSTOM_KEYS
# define JSON_BLE_AES_CUSTOM_KEYS 256 // 42 byte BLE Custom Key * 6 rounded up to 256.
# endif
// Runtime default for ble_aes[]. Empty = no default; override at build time
// with -DBLE_AES='"<32-hex-key>"' to ship a stock key.
# ifndef BLE_AES
# define BLE_AES ""
# endif
# endif
#endif
#define convertTemp_CtoF(c) ((c * 1.8) + 32)
#define convertTemp_FtoC(f) ((f - 32) * 5 / 9)
#ifndef QueueSize
# define QueueSize 18
#endif
#endif
Reference in new issue View Git Blame Copy Permalink