FlorianandLeon Kiefer
6e9b170c00
* handle 64 bits values, except for UNO Arduino UNO is not enough powerfull to handle properly uint64_t in terms of memory so differenciate the variable type depending on the board type With this configuration ATMega will not be able to receive with simpleReceiving 64 bits values. Of course Json will work with 64 bits values for this board. * Simplify jsondata.success() condition * Renamings and optimize deduplication functions * replace 2 dimensions array by a structure so as to handle the time with an uint32_t when using an ESP (instead of a uint64_t) * change storeValue and isAduplicate function names * point to the rcswitch revision with the new 40 bits protocol Co-authored-by: Leon Kiefer <leon.k97@gmx.de>
192 lines
8.1 KiB
C
192 lines
8.1 KiB
C
/*
|
|
OpenMQTTGateway - ESP8266 or Arduino program for home automation
|
|
|
|
Act as a wifi or ethernet gateway between your 433mhz/infrared IR signal and a MQTT broker
|
|
Send and receiving command by MQTT
|
|
|
|
This program enables to:
|
|
- receive MQTT data from a topic and send RF 433Mhz signal corresponding to the received MQTT data
|
|
- publish MQTT data to a different topic related to received 433Mhz signal
|
|
- receive MQTT data from a topic and send IR signal corresponding to the received MQTT data
|
|
- publish MQTT data to a different topic related to received IR signal
|
|
- publish MQTT data to a different topic related to BLE devices rssi signal
|
|
|
|
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----------------------*/
|
|
#define OMG_VERSION "version_tag"
|
|
|
|
/*-------------CONFIGURE WIFIMANAGER-------------*/
|
|
/*
|
|
* 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----------------*/
|
|
#ifndef Gateway_Name
|
|
# define Gateway_Name "OpenMQTTGateway"
|
|
#endif
|
|
|
|
#define Base_Topic "home/"
|
|
|
|
/*-------------DEFINE YOUR NETWORK PARAMETERS BELOW----------------*/
|
|
//#define NetworkAdvancedSetup true //uncomment if you want to set advanced network parameters for arduino boards, not uncommented you can set the IP and mac only
|
|
#ifdef NetworkAdvancedSetup // for arduino boards advanced config
|
|
// these values are only used if no dhcp configuration is available
|
|
const byte ip[] = {192, 168, 1, 99}; //ip adress
|
|
const byte gateway[] = {0, 0, 0, 0}; //ip adress, if first value is different from 0 advanced config network will be used and you should fill gateway & dns
|
|
const byte Dns[] = {0, 0, 0, 0}; //ip adress, if first value is different from 0 advanced config network will be used and you should fill gateway & dns
|
|
const byte subnet[] = {255, 255, 255, 0}; //ip adress
|
|
#endif
|
|
|
|
#if defined(ESP8266) || defined(ESP32) // for nodemcu, weemos and esp8266
|
|
//#define ESPWifiManualSetup true //uncomment you don't want to use wifimanager for your credential settings on ESP
|
|
#else // for arduino boards
|
|
const byte ip[] = {192, 168, 1, 99}; //ip adress
|
|
const byte mac[] = {0xDE, 0xED, 0xBA, 0xFE, 0x54, 0x95}; //W5100 ethernet shield mac adress
|
|
#endif
|
|
|
|
#if defined(ESPWifiManualSetup) // for nodemcu, weemos and esp8266
|
|
# define wifi_ssid "wifi ssid"
|
|
# define wifi_password "wifi password"
|
|
#endif
|
|
|
|
#define WifiManager_password "your_password" //this is going to be the WPA2-PSK password for the initial setup access point
|
|
#define WifiManager_ssid Gateway_Name //this is the network name of the initial setup access point
|
|
#define WifiManager_ConfigPortalTimeOut 120
|
|
#define WifiManager_TimeOut 5
|
|
|
|
//#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
|
|
|
|
//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 mqtt_server_name "www.mqtt_broker.com" // instead of defining the server by its IP you can define it by its name, uncomment this line and set the correct MQTT server host name
|
|
#define parameters_size 20
|
|
#define mqtt_topic_max_size 100
|
|
#define mqtt_max_packet_size 128
|
|
char mqtt_user[parameters_size] = "your_username"; // not compulsory only if your broker needs authentication
|
|
char mqtt_pass[parameters_size] = "your_password"; // not compulsory only if your broker needs authentication
|
|
char mqtt_server[parameters_size] = "192.168.1.17";
|
|
char mqtt_port[6] = "1883";
|
|
char mqtt_topic[mqtt_topic_max_size] = Base_Topic;
|
|
char gateway_name[parameters_size * 2] = Gateway_Name;
|
|
|
|
#define version_Topic "/version"
|
|
#define will_Topic "/LWT"
|
|
#define will_QoS 0
|
|
#define will_Retain true
|
|
#define will_Message "Offline"
|
|
#define Gateway_AnnouncementMsg "Online"
|
|
|
|
#define maxMQTTretry 4 //maximum MQTT connection attempts before going to wifi setup
|
|
|
|
/*-------------DEFINE YOUR OTA PARAMETERS BELOW----------------*/
|
|
#define ota_hostname "OTAHOSTNAME"
|
|
#define ota_password "OTAPASSWORD"
|
|
#define ota_port 8266
|
|
/*-------------DEFINE PINs FOR STATUS LEDs----------------*/
|
|
#ifdef ESP8266
|
|
# define led_receive 40
|
|
# define led_send 42
|
|
# define led_info 44
|
|
#elif ESP32
|
|
# define led_receive 40
|
|
# define led_send 42
|
|
# define led_info 44
|
|
#elif __AVR_ATmega2560__ //arduino mega
|
|
# define led_receive 40
|
|
# define led_send 42
|
|
# define led_info 44
|
|
#else //arduino uno/nano
|
|
# define led_receive 40
|
|
# define led_send 42
|
|
# define led_info 44
|
|
#endif
|
|
|
|
// VCC ------------D|-----------/\/\/\/\ ----------------- Arduino PIN
|
|
// LED Resistor 270-510R
|
|
#ifndef TRIGGER_GPIO
|
|
# ifdef ESP8266
|
|
//# define TRIGGER_GPIO 14 // pin D5 as full reset button (long press >10s)
|
|
# elif ESP32
|
|
//# define TRIGGER_GPIO 0 // boot button as full reset button (long press >10s)
|
|
# endif
|
|
#endif
|
|
|
|
/*----------------------------OTHER PARAMETERS-----------------------------*/
|
|
#ifdef ZgatewaySRFB
|
|
# define SERIAL_BAUD 19200
|
|
#else
|
|
# define SERIAL_BAUD 115200
|
|
#endif
|
|
/*-------------------CHANGING THEM IS NOT COMPULSORY-----------------------*/
|
|
/*--------------MQTT general topics-----------------*/
|
|
// global MQTT subject listened by the gateway to execute commands (send RF, IR or others)
|
|
#define subjectMQTTtoX "/commands/#"
|
|
#define subjectMultiGTWKey "toMQTT"
|
|
#define subjectGTWSendKey "MQTTto"
|
|
|
|
// key used for launching commands to the gateway
|
|
#define restartCmd "restart"
|
|
#define eraseCmd "erase"
|
|
|
|
// define if we concatenate the values into the topic
|
|
//#define valueAsASubject true
|
|
|
|
//variables to avoid duplicates
|
|
#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
|
|
|
|
#ifdef ESP32
|
|
//#define multiCore //uncomment to use multicore function of ESP32 for BLE
|
|
#endif
|
|
|
|
#if defined(ESP8266) || defined(ESP32)
|
|
# define JSON_MSG_BUFFER 512 // Json message max buffer size, don't put 1024 or higher it is causing unexpected behaviour on ESP8266
|
|
# define SIGNAL_SIZE_UL_ULL uint64_t
|
|
# define STRTO_UL_ULL strtoull
|
|
#elif defined(__AVR_ATmega2560__) || defined(__AVR_ATmega1280__)
|
|
# define JSON_MSG_BUFFER 512 // Json message max buffer size, don't put 1024 or higher it is causing unexpected behaviour on ESP8266
|
|
# define SIGNAL_SIZE_UL_ULL uint64_t
|
|
# define STRTO_UL_ULL strtoul
|
|
#else // boards with smaller memory
|
|
# define JSON_MSG_BUFFER 64 // Json message max buffer size, don't put 1024 or higher it is causing unexpected behaviour on ESP8266
|
|
# define SIGNAL_SIZE_UL_ULL uint32_t
|
|
# define STRTO_UL_ULL strtoul
|
|
#endif
|
|
|
|
#define TimeBetweenReadingSYS 120000 // time between system readings (like memory)
|
|
#define subjectSYStoMQTT "/SYStoMQTT"
|
|
#define subjectMQTTtoSYSset "/commands/MQTTtoSYS/config"
|
|
|
|
#endif
|