Wifi managers improvements (#503)

* Add parameters to wifi manager: gateway name and base topic
Enable to restart the ESP and erase the parameters by MQTT

Author: 1technophile

docs/.vuepress/config.js

@@ -61,7 +61,8 @@ module.exports = {
           children: [
             'upload/binaries',
             'upload/pio',
-            'upload/arduino-ide'
+            'upload/arduino-ide',
+            'upload/portal'
           ]
         },
         {
@@ -75,7 +76,8 @@ module.exports = {
             'use/gsm',
             'use/rfm69',
             'use/sensors',
-            'use/actuators'
+            'use/actuators',
+            'use/gateway'
           ]
         },
         {

docs/upload/arduino-ide.md

@@ -12,7 +12,7 @@
 *Example for the use of RF gateway*
 ```C++
 #define ZgatewayRF     "RF"       //ESP8266, Arduino, ESP32
-//#define ZgatewayIR     "IR"       //ESP8266, Arduino,         Sonoff RF Bridge
+//#define ZgatewayIR     "IR"       //ESP8266, Arduino, Sonoff RF Bridge
 //#define ZgatewayLORA   "LORA"       //ESP8266, Arduino, ESP32
 //#define ZgatewayPilight "Pilight" //ESP8266, Arduino, ESP32
 //#define ZgatewayBT     "BT"       //ESP8266, ESP32
@@ -24,3 +24,5 @@
 * Open the serial monitor and set 115200 bauds
 * Upload ➡️
 * You should see the logs into the serial monitor
+
+With an ESP if you did not set your network and mqtt parameters manualy you can now open the [web portal configuration](portal.md).

docs/upload/binaries.md

@@ -32,22 +32,6 @@ https://github.com/marcelstoer/nodemcu-pyflasher/releases
 * Click on *FlashNodeMCU*
 The upload details appears.
 
-Note that to reset the wifi and mqtt settings you can check *yes, wipes all data*
-
-Once loaded into your board you have to set your network parameters with wifi manager portal
-From your smartphone search for your OpenMQTTGateway wifi network and connect to it, a web page will appear
-* Select your wifi
-* Set your wifi password
-* Set your MQTT Server IP
-* Set your MQTT Server username (not compulsory)
-* Set your MQTT Server password (not compulsory)
-
-The ESP restart and connect to your network. Note that your credentials are saved into the ESP memory, if you want to redo the configuration you have to erase the ESP memory with the flash download tool.
+With an ESP if you did not set your network and mqtt parameters manualy you can now open the [web portal configuration](portal.md).
 
-_The default password for wifi manager is "your_password"_
-
-Once done the gateway should connect to your network and your broker, you should see it into the broker in the form of the following messages:
-```
-home/OpenMQTTGateway/LWT Online 
-home/OpenMQTTGateway/version
-```
+Note that to reset the wifi and mqtt settings you can check *yes, wipes all data*

docs/upload/pio.md

@@ -111,3 +111,5 @@ If you want to use HASS MQTT discovery you need to have
 `#define ZmqttDiscovery "HADiscovery"`
 uncommented.
 Added to that auto discovery box should be selected into your Home Assistant MQTT integration configuration.
+
+With an ESP if you did not set your network and mqtt parameters manualy you can now open the [web portal configuration](portal.md).

docs/upload/portal.md

@@ -0,0 +1,24 @@
+# Wifi and MQTT configuration portal
+
+Once loaded into your board and if you don't use the manual configuration you have to set your network parameters with wifi manager portal.
+From your smartphone search for your OpenMQTTGateway wifi network and connect to it, a web page will appear
+* Select your wifi
+* Set your wifi password
+* Set your MQTT Server IP
+* Set your MQTT Server username (not compulsory)
+* Set your MQTT Server password (not compulsory)
+* Set your MQTT base topic (you must keep the / at the end)
+* Set your gateway name
+
+The ESP restart and connect to your network. Note that your credentials are saved into the ESP memory, if you want to redo the configuration you have to erase the ESP memory with the flash download tool.
+
+_The default password for wifi manager is "your_password"_
+
+Once done the gateway should connect to your network and your broker, you should see it into the broker in the form of the following messages:
+```
+home/OpenMQTTGateway/LWT Online 
+home/OpenMQTTGateway/version
+```
+
+Note that the web portal appears only on first boot, if you want to configure again the setting you can do a long press on TRIGGER_PIN.
+

docs/use/gateway.md

@@ -0,0 +1,9 @@
+# System commands (ESP only)
+
+## Restart the ESP
+
+`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/set" -m '{"cmd":"restart"}'`
+
+## Erase the ESP settings
+
+`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/set" -m '{"cmd":"erase"}'`

main/User_config.h

@@ -50,6 +50,7 @@
 #ifndef Gateway_Name
   #define Gateway_Name "OpenMQTTGateway"
 #endif
+#define Base_Topic "home/"
 
 /*-------------DEFINE YOUR  NETWORK PARAMETERS BELOW----------------*/
 #if defined(ESP8266)||defined(ESP32)  // for nodemcu, weemos and esp8266
@@ -71,11 +72,14 @@
 /*-------------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
-char mqtt_user[20] = "your_username"; // not compulsory only if your broker needs authentication
-char mqtt_pass[30] = "your_password"; // not compulsory only if your broker needs authentication
-char mqtt_server[40] = "192.168.1.17";
+#define parameters_size 20
+#define mqtt_topic_max_size 100
+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;
 //uncomment the line below to integrate msg value into the subject when receiving
 //#define valueAsASubject true
 
@@ -119,9 +123,8 @@ const byte Dns[] = { 0, 0, 0, 0 }; //ip adress, if first value is different from
 const byte subnet[] = { 255, 255, 255, 0 }; //ip adress
 
 /*-------------DEFINE YOUR MQTT ADVANCED PARAMETERS BELOW----------------*/
-#define Base_Topic "home/"
-#define version_Topic  Base_Topic Gateway_Name "/version"
-#define will_Topic  Base_Topic Gateway_Name "/LWT"
+#define version_Topic  "/version"
+#define will_Topic  "/LWT"
 #define will_QoS 0
 #define will_Retain true
 #define will_Message "offline"
@@ -182,9 +185,16 @@ const byte subnet[] = { 255, 255, 255, 0 }; //ip adress
 #endif
 /*--------------MQTT general topics-----------------*/
 // global MQTT subject listened by the gateway to execute commands (send RF, IR or others)
-#define subjectMQTTtoX  Base_Topic Gateway_Name "/commands/#"
-#define subjectMultiGTWKey "toMQTT"
-#define subjectGTWSendKey "MQTTto"
+#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
@@ -197,9 +207,10 @@ const byte subnet[] = { 255, 255, 255, 0 }; //ip adress
 #endif
 
 #define TimeBetweenReadingSYS 120000 // time between system readings (like memory)
-#define subjectSYStoMQTT  Base_Topic Gateway_Name "/SYStoMQTT"
+#define subjectSYStoMQTT  "/SYStoMQTT"
+#define subjectMQTTtoSYSset "/commands/MQTTtoSYS/set"
 
-//#define subjectTRACEtoMQTT Base_Topic Gateway_Name "/log" //uncomment if you want to see traces on /log topic
+//#define subjectTRACEtoMQTT "OpenMQTTGateway/log" //uncomment if you want to see traces on OpenMQTTGateway/log topic
 
 /*-------------------ACTIVATE TRACES----------------------*/
 #define TRACE 1  // commented =  trace off, uncommented = trace on

main/ZactuatorFASTLED.ino

@@ -127,14 +127,12 @@ void MQTTtoFASTLEDJSON(char *topicOri, JsonObject&  jsonData)
 {
   trc(F("MQTTtoFASTLEDJSON: "));
   currentLEDState = GENERAL;
-  String topic = topicOri;
-  
-  trc(topic);
+  trc(topicOri);
   //number = (long)strtol(&datacallback[1], NULL, 16);
 
 
 
-  if (topic == subjectMQTTtoFASTLEDsetled)
+  if (strstr(topicOri,catToMainTopic(subjectMQTTtoFASTLEDsetled)) != NULL)
   {
       trc(F("JSON parsed"));
       int ledNr = jsonData["led"];
@@ -160,10 +158,9 @@ void MQTTtoFASTLED(char *topicOri, char *datacallback)
 {
   trc(F("MQTTtoFASTLED: "));
   currentLEDState = GENERAL;
-  String topic = topicOri;
   long number = 0;
-  trc(topic);
-  if (topic == subjectMQTTtoFASTLED)
+  trc(topicOri);
+  if (strstr(topicOri,catToMainTopic(subjectMQTTtoFASTLED)) != NULL)
   {
     number = (long)strtol(&datacallback[1], NULL, 16);
     trc(number);
@@ -173,18 +170,18 @@ void MQTTtoFASTLED(char *topicOri, char *datacallback)
     }
     FastLED.show();
   }
-  else if (topic == subjectMQTTtoFASTLEDsetbrightness)
+  else if (strstr(topicOri,catToMainTopic(subjectMQTTtoFASTLEDsetbrightness)) != NULL)
   {
     number = (long)strtol(&datacallback[1], NULL, 16);
     trc(number);
     FastLED.setBrightness(number);
     FastLED.show();
   }
-  else if (topic == subjectMQTTtoFASTLEDsetanimation)
+  else if (strstr(topicOri,catToMainTopic(subjectMQTTtoFASTLEDsetanimation)) != NULL)
   {
     String payload = datacallback;
     trc(payload);
-    if (payload.equals("fire"))
+    if ( strstr(datacallback,"fire") != NULL)
     {
       currentLEDState = FIRE;
       gPal = HeatColors_p;

main/ZactuatorONOFF.ino

@@ -33,7 +33,7 @@
 #ifdef jsonReceiving
 void MQTTtoONOFF(char * topicOri, JsonObject& ONOFFdata){
 
-  if (strcmp(topicOri,subjectMQTTtoONOFF) == 0){
+  if (strstr(topicOri,catToMainTopic(subjectMQTTtoONOFF)) != NULL){
     trc(F("MQTTtoONOFF json data analysis"));
     int boolSWITCHTYPE = ONOFFdata["state"] | 99;
     int pin = ONOFFdata["pin"] | ACTUATOR_ONOFF_PIN;
@@ -55,7 +55,7 @@ void MQTTtoONOFF(char * topicOri, JsonObject& ONOFFdata){
 
 #ifdef simpleReceiving
 void MQTTtoONOFF(char * topicOri, char * datacallback) {
-  if ((strstr(topicOri,subjectMQTTtoONOFF) != NULL) ){
+  if ((strstr(topicOri,catToMainTopic(subjectMQTTtoONOFF)) != NULL) ){
 
     trc(F("MQTTtoONOFF"));
     int pin = strtol(datacallback, NULL, 10); // we will not be able to pass values > 4294967295
@@ -69,7 +69,8 @@ void MQTTtoONOFF(char * topicOri, char * datacallback) {
 
     digitalWrite(pin, ON);
     // we acknowledge the sending by publishing the value to an acknowledgement topic
-    pub(subjectGTWONOFFtoMQTT, ON);
+    char b = ON;
+    pub(subjectGTWONOFFtoMQTT, &b);
   } 
 }
 #endif

main/Zgateway2G.ino

@@ -107,7 +107,7 @@ bool _2GtoMQTT(){
     String data = datacallback;
     String topic = topicOri;
 
-    if (topic == subjectMQTTto2G) {
+    if (strstr(topicOri,catToMainTopic(subjectMQTTto2G)) != NULL) {
       trc(F("MQTTto2G data analysis"));
       // 2G DATA ANALYSIS
       String phone_number = "";
@@ -122,7 +122,7 @@ bool _2GtoMQTT(){
         if (A6l.sendSMS(phone_number,data) == A6_OK ) {
           trc(F("SMS OK"));
           // Acknowledgement to the GTW2G topic
-          pub(subjectGTW2GtoMQTT, datacallback);// we acknowledge the sending by publishing the value to an acknowledgement topic, for the moment even if it is a signal repetition we acknowledge also
+          pub(subjectGTW2GtoMQTT, "SMS OK");// we acknowledge the sending by publishing the value to an acknowledgement topic, for the moment even if it is a signal repetition we acknowledge also
         }else{
           trc(F("SMS KO"));
           // Acknowledgement to the GTW2G topic
@@ -138,7 +138,7 @@ bool _2GtoMQTT(){
 #ifdef jsonReceiving
   void MQTTto2G(char * topicOri, JsonObject& SMSdata) {
 
-   if (strcmp(topicOri,subjectMQTTto2G) == 0){
+   if (strstr(topicOri,catToMainTopic(subjectMQTTto2G)) != NULL){
       const char * sms = SMSdata["message"];
       const char * phone = SMSdata["phone"];
       trc(F("MQTTto2G json data analysis"));
@@ -148,7 +148,7 @@ bool _2GtoMQTT(){
         if (A6l.sendSMS(String(phone),String(sms)) == A6_OK ) {
           trc(F("SMS OK"));
           // Acknowledgement to the GTW2G topic
-          pub(subjectGTW2GtoMQTT, SMSdata);// we acknowledge the sending by publishing the value to an acknowledgement topic, for the moment even if it is a signal repetition we acknowledge also
+          pub(subjectGTW2GtoMQTT, "SMS OK");// we acknowledge the sending by publishing the value to an acknowledgement topic, for the moment even if it is a signal repetition we acknowledge also
         }else{
           trc(F("SMS KO"));
           pub(subjectGTW2GtoMQTT, "SMS KO");// we acknowledge the sending by publishing the value to an acknowledgement topic, for the moment even if it is a signal repetition we acknowledge also

main/ZgatewayBT.ino

@@ -530,7 +530,12 @@ void MiBandDiscovery(char * mac){
       while(true){
           trc(taskMessage);
           delay(BLEinterval);
-          BLEscan();
+          if (client.state() == 0) {
+            BLEscan();
+          }else{
+            trc("MQTT client disconnected no BLE scan");
+            delay(1000);
+          }
       }
     }
 
@@ -993,12 +998,13 @@ void haRoomPresence(JsonObject& HomePresence){
   HomePresence["distance"] = distance;
   trc(F("BLE DISTANCE :"));
   trc(distance);
-  pub(subjectHomePresence,HomePresence);
+  String topic = String(Base_Topic) + "home_presence/" + String(gateway_name);
+  pub_custom_topic((char *)topic.c_str(),HomePresence);
 }
 #endif
 
 void MQTTtoBT(char * topicOri, JsonObject& BTdata) { // json object decoding
- if (strcmp(topicOri,subjectMQTTtoBTset) == 0){
+ if (strstr(topicOri,catToMainTopic(subjectMQTTtoBTset)) != NULL){
     trc(F("MQTTtoBT json set"));
 
     // Black list & white list set

main/ZgatewayIR.ino

@@ -152,7 +152,7 @@ void IRtoMQTT(){
         storeValue(MQTTvalue);
         if (repeatIRwMQTT){
             trc(F("Pub. IR for rpt"));
-            pub(subjectMQTTtoIR,MQTTvalue);
+            pubMQTT(subjectMQTTtoIR,MQTTvalue);
         }
     }
     }
@@ -274,7 +274,7 @@ void IRtoMQTT(){
 #ifdef jsonReceiving
   void MQTTtoIR(char * topicOri, JsonObject& IRdata) {
 
-     if (strcmp(topicOri,subjectMQTTtoIR) == 0){ 
+     if (strstr(topicOri,catToMainTopic(subjectMQTTtoIR)) != NULL){ 
       trc(F("MQTTtoIR json"));
       uint64_t data = IRdata["value"];
       const char * raw = IRdata["raw"];

main/ZgatewayLORA.ino

@@ -87,7 +87,7 @@ void LORAtoMQTT(){
 
 #ifdef jsonReceiving
   void MQTTtoLORA(char * topicOri, JsonObject& LORAdata) { // json object decoding
-   if (strcmp(topicOri,subjectMQTTtoLORA) == 0){
+   if (strstr(topicOri,catToMainTopic(subjectMQTTtoLORA)) != NULL){
       trc(F("MQTTtoLORA json"));
       const char * message = LORAdata["message"];
       int txPower = LORAdata["txpower"]|LORA_TX_POWER;
@@ -120,7 +120,7 @@ void LORAtoMQTT(){
 #endif
 #ifdef simpleReceiving
   void MQTTtoLORA(char * topicOri, char * LORAdata) { // json object decoding
-   if (strcmp(topicOri,subjectMQTTtoLORA) == 0){
+   if (strstr(topicOri,catToMainTopic(subjectMQTTtoLORA)) != NULL){
         LoRa.beginPacket();
         LoRa.print(LORAdata);
         LoRa.endPacket();

main/ZgatewayPilight.ino

@@ -74,7 +74,7 @@ void MQTTtoPilight(char * topicOri, JsonObject& Pilightdata) {
 
   int result = 0;
 
-  if (strcmp(topicOri,subjectMQTTtoPilight) == 0){
+  if (strstr(topicOri,catToMainTopic(subjectMQTTtoPilight)) != NULL){
     trc(F("MQTTtoPilight json data analysis"));
     const char * message = Pilightdata["message"];
     const char * protocol = Pilightdata["protocol"];

main/ZgatewayRF.ino

@@ -132,7 +132,7 @@ void MQTTtoRF(char * topicOri, char * datacallback) {
     trc(valueBITS);
   }
 
-  if ((topic == subjectMQTTtoRF) && (valuePRT == 0) && (valuePLSL  == 0) && (valueBITS == 0)){
+  if ((strstr(topicOri,catToMainTopic(subjectMQTTtoRF)) != NULL) && (valuePRT == 0) && (valuePLSL  == 0) && (valueBITS == 0)){
     trc(F("MQTTtoRF dflt"));
     mySwitch.setProtocol(1,350);
     mySwitch.send(data, 24);
@@ -156,8 +156,7 @@ void MQTTtoRF(char * topicOri, char * datacallback) {
 
 #ifdef jsonReceiving
   void MQTTtoRF(char * topicOri, JsonObject& RFdata) { // json object decoding
-  
-   if (strcmp(topicOri,subjectMQTTtoRF) == 0){
+   if (strstr(topicOri,catToMainTopic(subjectMQTTtoRF)) != NULL){
       trc(F("MQTTtoRF json"));
       unsigned long data = RFdata["value"];
       if (data != 0) {