Merge pull request #71 from FabLab-Luenen/development

Version Bump to 3.1.0

Arduino/McLighting/McLighting.ino

@@ -271,11 +271,9 @@ void initMqtt() {
   mqtt_intopic[sizeof(mqtt_intopic) - 1] = 0x00;
   snprintf(mqtt_outtopic, sizeof(mqtt_outtopic), "%s/out", mqtt_clientid);
   mqtt_outtopic[sizeof(mqtt_outtopic) - 1] = 0x00;
-  #if defined(ENABLE_HOMEASSISTANT)
+  #if defined(MQTT_HOME_ASSISTANT_SUPPORT)
-    #if defined(MQTT_HOMEASSISTANT_SUPPORT)
     snprintf(mqtt_ha_config, sizeof(mqtt_ha_config), "homeassistant/light/%s/config", mqtt_clientid);
     mqtt_ha_config[sizeof(mqtt_ha_config) - 1] = 0x00;
-    #endif
     snprintf(mqtt_ha_state_in,  sizeof(mqtt_ha_state_in),   "home/%s_ha/state/in",  mqtt_clientid);
     mqtt_ha_state_in[sizeof(mqtt_ha_state_in) - 1] = 0x00;
     snprintf(mqtt_ha_state_out, sizeof(mqtt_ha_state_out),  "home/%s_ha/state/out", mqtt_clientid);
@@ -657,6 +655,9 @@ void loop() {
 
   if (State.mode == OFF) {
     if (prevmode != State.mode) {
+      #if defined(ENABLE_MQTT)
+         snprintf(mqtt_buf, sizeof(mqtt_buf), "OK =off", "");
+      #endif
       #if defined(POWER_SUPPLY)
          digitalWrite(POWER_SUPPLY, !POWER_ON); // power off -> external power supply
       #endif
@@ -673,9 +674,19 @@ void loop() {
 
   if (State.mode == SET) {
     State.mode = HOLD;
+    // Segment
+    if (prevsegment != State.segment) {
+      #if defined(ENABLE_MQTT)
+        snprintf(mqtt_buf, sizeof(mqtt_buf), "OK Ss%i", State.segment);
+      #endif
+      //prevsegment = State.segment;
+    }
     // Mode
-    if ((segState.mode[State.segment] != fx_mode) || prevmode == OFF) {
+    if (segState.mode[State.segment] != fx_mode) {
       segState.mode[State.segment] = fx_mode;
+      #if defined(ENABLE_MQTT)
+        snprintf(mqtt_buf, sizeof(mqtt_buf), "OK /%i", segState.mode[State.segment]);
+      #endif
       strip->strip_off();
       autoCount[State.segment] = 0;
       autoDelay[State.segment] = 0;
@@ -690,10 +701,13 @@ void loop() {
     }*/
     // Brightness
     if (strip->getBrightness() != State.brightness) {
+      #if defined(ENABLE_MQTT)
+        snprintf(mqtt_buf, sizeof(mqtt_buf), "OK %%%i", State.brightness);
+      #endif
       brightness_trans = State.brightness;
     }
     // Speed
-    if (fx_speed != segState.speed[prevsegment]) {
+    if (fx_speed != segState.speed[State.segment]) {
       #if defined(ENABLE_MQTT)
         snprintf(mqtt_buf, sizeof(mqtt_buf), "OK ?%i", segState.speed[prevsegment]);
       #endif
@@ -725,9 +739,15 @@ void loop() {
     }
     //strip->setBrightness(brightness_actual);
     #if defined(ENABLE_MQTT)
+      #if ENABLE_MQTT == 0
+        mqtt_client->publish(mqtt_outtopic, mqtt_buf);
+      #endif
+      #if ENABLE_MQTT == 1
+        mqtt_client->publish(mqtt_outtopic, qospub, false, mqtt_buf);
+      #endif
       #if defined(ENABLE_HOMEASSISTANT)
         if(ha_send_data.active()) ha_send_data.detach();
-        ha_send_data.once(DELAY_MQTT_HA_MESSAGE, tickerSendState);
+        ha_send_data.once(5, tickerSendState);
       #endif
     #endif
   }

Arduino/McLighting/definitions.h

@@ -19,8 +19,8 @@ char HOSTNAME[65] = "McLightingRGBW"; // Friedly hostname  is configurable just
 //#define ENABLE_MQTT_HOSTNAME_CHIPID   // Uncomment/comment to add ESPChipID to end of MQTT hostname
 //#define ENABLE_MQTT_INCLUDE_IP        // uncomment/comment to add the IP-adress to the MQTT message
 #define ENABLE_HOMEASSISTANT          // If defined, enable Homeassistant integration, ENABLE_MQTT must be active
-#define MQTT_HOMEASSISTANT_SUPPORT   // If defined, use AMQTT and select Tools -> IwIP Variant -> Higher Bandwidth
+#define MQTT_HOME_ASSISTANT_SUPPORT   // If defined, use AMQTT and select Tools -> IwIP Variant -> Higher Bandwidth
-#define DELAY_MQTT_HA_MESSAGE 5       // HA Status is send after DELAY_MQTT_HA_MESSAGE seconds, to save bandwith
+//#define DISABLE_MQTT_OUT_ON_MQTT_IN   // If defined, McLighting will not send back MQTT-out on MQTT-in regarding issue #67, does not change anything at the moment
 
 //#define ENABLE_BUTTON 14              // If defined, enable button handling code, see: https://github.com/toblum/McLighting/wiki/Button-control, the value defines the input pin (14 / D5) for switching the LED strip on / off, connect this PIN to ground to trigger button.
 //#define ENABLE_BUTTON_GY33 12         // If defined, enable button handling code for GY-33 color sensor to scan color. The value defines the input pin (12 / D6) for read color data with RGB sensor, connect this PIN to ground to trigger button.
@@ -28,7 +28,7 @@ char HOSTNAME[65] = "McLightingRGBW"; // Friedly hostname  is configurable just
 #if defined(POWER_SUPPLY)
   #define POWER_ON   HIGH           // Define the output state to turn on the power supply, either HIGH or LOW.  Opposite will be uses for power off.
 #endif
-//#define ENABLE_REMOTE 13              // If defined, enable Remote Control via TSOP31238. The value defines the input pin (13 / D7) for TSOP31238 Out
+#define ENABLE_REMOTE 13              // If defined, enable Remote Control via TSOP31238. The value defines the input pin (13 / D7) for TSOP31238 Out
 
 #if defined(ENABLE_BUTTON_GY33)
   #define GAMMA 2.5                   // Gamma correction for GY-33 sensor
@@ -74,7 +74,7 @@ uint8_t  prevsegment        = 0;
   uint8_t _sn[4] = {255,255,255,0};
 #endif
 
-#if defined(MQTT_HOMEASSISTANT_SUPPORT)
+#if defined(MQTT_HOME_ASSISTANT_SUPPORT)
   #define MQTT_HOME_ASSISTANT_0_87_SUPPORT // Comment if using HA version < 0.87
 #endif
 
@@ -93,7 +93,7 @@ uint8_t  prevsegment        = 0;
 #if defined(ENABLE_HOMEASSISTANT) and !defined(ENABLE_MQTT)
 #error "To use HA, you have to either enable PubCubClient or AsyncMQTT"
 #endif
-#if !defined(ENABLE_HOMEASSISTANT) and defined(MQTT_HOMEASSISTANT_SUPPORT)
+#if !defined(ENABLE_HOMEASSISTANT) and defined(MQTT_HOME_ASSISTANT_SUPPORT)
 #error "To use HA support, you have to either enable Homeassistant component"
 #endif
 
@@ -178,10 +178,10 @@ struct {
       uint8_t pin = 3;
     #endif
     #if USE_WS2812FX_DMA == 1
-      uint8_t pin = 1;
+      uint8_t pin = 2;
     #endif
     #if USE_WS2812FX_DMA == 2
-      uint8_t pin = 2;
+      uint8_t pin = 1;
     #endif
   #else
     uint8_t pin = LED_PIN;

Arduino/McLighting/helper_functions.h

@@ -321,15 +321,3 @@ uint32_t trans(uint32_t _newcolor, uint32_t _oldcolor, uint8_t _level, uint8_t _
   _oldcolor = scale_wrgb(_oldcolor, 255-_level);
   return _newcolor + _oldcolor;
 }
-
-#if defined(ENABLE_MQTT)
-  void sendmqtt() {
-      #if ENABLE_MQTT == 0
-        mqtt_client->publish(mqtt_outtopic, mqtt_buf);
-      #endif
-      #if ENABLE_MQTT == 1
-        mqtt_client->publish(mqtt_outtopic, qospub, false, mqtt_buf);
-      #endif
-      memset(mqtt_buf,0,sizeof(mqtt_buf));
-  }
-#endif

Arduino/McLighting/request_handlers.h

@@ -199,25 +199,9 @@ void handleSetWS2812FXMode(uint8_t * mypayload) {
     fx_mode = (uint8_t) strtol((const char *) &mypayload[1], NULL, 10);
     fx_mode = constrain(fx_mode, 0, strip->getModeCount() - 1);
     State.mode = SET;
-    #if defined(ENABLE_MQTT)
-      snprintf(mqtt_buf, sizeof(mqtt_buf), "OK /%i", fx_mode);
-      sendmqtt();
-    #endif
   } else  {
     if (strcmp((char *) &mypayload[1], "off") == 0) {
-      if (State.mode == OFF) {
+      if (State.mode == OFF) { State.mode = SET; } else { State.mode = OFF; };
-        State.mode = SET;
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK /%i", segState.mode[State.segment]);
-          sendmqtt();
-        #endif
-      } else {
-        State.mode = OFF;
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK /off", "");
-          sendmqtt();
-        #endif
-      }
     }
     if (strcmp((char *) &mypayload[1], "on") == 0) {
       State.mode = SET;
@@ -292,11 +276,7 @@ void checkpayload(uint8_t * _payload, bool mqtt = false, uint8_t num = 0) {
         //memcpy(hexcolors_trans, segState.colors[State.segment], sizeof(hexcolors_trans));
         _updateState = true;
         Dbg_Prefix(mqtt, num);
-        DBG_OUTPUT_PORT.printf("Set segment to: [%u]\r\n", _seg);
+        DBG_OUTPUT_PORT.printf("Set segment to: [%u]\r\n", State.segment);
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK Ss%i", _seg);
-          sendmqtt();
-        #endif
       }
     }
     // / ==> Set segment first LED
@@ -309,10 +289,6 @@ void checkpayload(uint8_t * _payload, bool mqtt = false, uint8_t num = 0) {
         setSegmentSize();
         Dbg_Prefix(mqtt, num);
         DBG_OUTPUT_PORT.printf("Set segment start to: [%u]\r\n", _seg_start);
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK S[%i", _seg_start);
-          sendmqtt();
-        #endif
       }
     }
     // / ==> Set segment last LED
@@ -325,25 +301,18 @@ void checkpayload(uint8_t * _payload, bool mqtt = false, uint8_t num = 0) {
         setSegmentSize();
         Dbg_Prefix(mqtt, num);
         DBG_OUTPUT_PORT.printf("Set segment stop to: [%u]\r\n", _seg_stop);
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK S]%i", _seg_stop);
-          sendmqtt();
-        #endif
       }
     }
     if (_payload[1] == 'o') {
-      uint8_t _fx_options = (uint8_t) strtol((const char *) &_payload[2], NULL, 10);
+      char _fx_options[4];
-      _fx_options = ((constrain(server.arg("fxopt").toInt(), 0, 255)>>1)<<1);
+      snprintf(_fx_options, sizeof(_fx_options), "%s", &_payload[2]);
-      if (_fx_options != segState.options) {
+      _fx_options[3] = 0x00;
-        segState.options= _fx_options;
+      if (((constrain(atoi(_fx_options), 0, 255)>>1)<<1) != segState.options) {
+        segState.options= ((constrain(atoi(_fx_options), 0, 255)>>1)<<1);
         _updateSegState = true;
         strip->setOptions(State.segment, segState.options);
         Dbg_Prefix(mqtt, num);
-        DBG_OUTPUT_PORT.printf("Set segment options to: [%u]\r\n", _fx_options);
+        DBG_OUTPUT_PORT.printf("Set segment options to: [%u]\r\n", segState.options);
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK So%i", _fx_options);
-          sendmqtt();
-        #endif
       }
     }
     char * buffer = listSegmentStateJSON(State.segment);
@@ -404,16 +373,11 @@ void checkpayload(uint8_t * _payload, bool mqtt = false, uint8_t num = 0) {
   // ? ==> Set speed
   if (_payload[0] == '?') {
     uint16_t _fx_speed = (uint16_t) strtol((const char *) &_payload[1], NULL, 10);
-    _fx_speed = constrain(_fx_speed, SPEED_MIN, SPEED_MAX );
+    segState.speed[State.segment] = constrain(_fx_speed, SPEED_MIN, SPEED_MAX );
-    //if (segState.speed[State.segment] != _fx_speed) {}
+    State.mode = SET;
-    segState.speed[State.segment] = _fx_speed;
     _updateSegState = true;
     Dbg_Prefix(mqtt, num);
-    DBG_OUTPUT_PORT.printf("Set speed to: [%u]\r\n", _fx_speed);
+    DBG_OUTPUT_PORT.printf("Set speed to: [%u]\r\n", segState.speed[State.segment]);
-    #if defined(ENABLE_MQTT)
-      snprintf(mqtt_buf, sizeof(mqtt_buf), "OK ?%i", _fx_speed);
-      sendmqtt();
-    #endif
   }
 
   // % ==> Set brightness
@@ -421,13 +385,10 @@ void checkpayload(uint8_t * _payload, bool mqtt = false, uint8_t num = 0) {
     uint8_t b = (uint8_t) strtol((const char *) &_payload[1], NULL, 10);
     State.brightness = constrain(b, 0, 255);
     if (strip->getBrightness() != State.brightness) {
+      State.mode = SET;
       Dbg_Prefix(mqtt, num);
       DBG_OUTPUT_PORT.printf("Set brightness to: [%u]\r\n", State.brightness);
       _updateState = true;
-      #if defined(ENABLE_MQTT)
-        snprintf(mqtt_buf, sizeof(mqtt_buf), "OK %%%i", State.brightness);
-        sendmqtt();
-      #endif
     }
   }
 
@@ -471,7 +432,6 @@ void checkpayload(uint8_t * _payload, bool mqtt = false, uint8_t num = 0) {
   }
 #if defined(ENABLE_STATE_SAVE)
   if (_updateState) {
-    State.mode = SET;
     if(save_state.active()) save_state.detach();
     save_state.once(3, tickerSaveState);
   }
@@ -783,15 +743,11 @@ void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght
          root["effect"] = strip->getModeName(strip->getMode());
        }
        #endif
-      uint16_t msg_len = measureJson(root) + 1;
+      char buffer[measureJson(root) + 1];
-      char buffer[msg_len];
       serializeJson(root, buffer, sizeof(buffer));
       jsonBuffer.clear();
       #if ENABLE_MQTT == 0
-      //mqtt_client->publish(mqtt_ha_state_out, buffer, true);
+      mqtt_client->publish(mqtt_ha_state_out, buffer, true);
-      mqtt_client->beginPublish(mqtt_ha_state_out, msg_len-1, true);
-      mqtt_client->write((const uint8_t*)buffer, msg_len-1);
-      mqtt_client->endPublish();
       DBG_OUTPUT_PORT.printf("MQTT: Send [%s]: %s\r\n", mqtt_ha_state_out, buffer);
       #endif
       #if ENABLE_MQTT == 1
@@ -945,7 +901,7 @@ void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght
           return;
         }
         if(ha_send_data.active()) ha_send_data.detach();
-        ha_send_data.once(DELAY_MQTT_HA_MESSAGE, tickerSendState);
+        ha_send_data.once(5, tickerSendState);
       } else if (strcmp(topic, mqtt_intopic) == 0) {
     #endif
 
@@ -980,8 +936,8 @@ void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght
         #if defined(ENABLE_HOMEASSISTANT)
           ha_send_data.detach();
           mqtt_client->subscribe(mqtt_ha_state_in, qossub);
-          ha_send_data.once(DELAY_MQTT_HA_MESSAGE, tickerSendState);
+          ha_send_data.once(5, tickerSendState);
-          #if defined(MQTT_HOMEASSISTANT_SUPPORT)
+          #if defined(MQTT_HOME_ASSISTANT_SUPPORT)
             const size_t bufferSize = JSON_ARRAY_SIZE(strip->getModeCount()+ 4) + JSON_OBJECT_SIZE(11) + 1500;
             DynamicJsonDocument jsonBuffer(bufferSize);
             JsonObject root = jsonBuffer.to<JsonObject>();
@@ -1087,7 +1043,7 @@ void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght
         ha_send_data.detach();
         uint16_t packetIdSub2 = mqtt_client->subscribe((char *)mqtt_ha_state_in, qossub);
         DBG_OUTPUT_PORT.printf("Subscribing at QoS %d, packetId: ", qossub); DBG_OUTPUT_PORT.println(packetIdSub2);
-        #if defined(MQTT_HOMEASSISTANT_SUPPORT)
+        #if defined(MQTT_HOME_ASSISTANT_SUPPORT)
           const size_t bufferSize = JSON_ARRAY_SIZE(strip->getModeCount()+ 4) + JSON_OBJECT_SIZE(11) + 1500;
           DynamicJsonDocument jsonBuffer(bufferSize);
           JsonObject root = jsonBuffer.to<JsonObject>();

Arduino/McLighting/rest_api.h

@@ -319,19 +319,7 @@ server.on("/config", []() {
 });
 
 server.on("/off", []() {
- if (State.mode == OFF) {
+  if (State.mode == OFF) { State.mode = SET; } else { State.mode = OFF; };
-    State.mode = SET;
-    #if defined(ENABLE_MQTT)
-      snprintf(mqtt_buf, sizeof(mqtt_buf), "OK /%i", segState.mode[State.segment]);
-      sendmqtt();
-    #endif
-  } else {
-    State.mode = OFF;
-    #if defined(ENABLE_MQTT)
-      snprintf(mqtt_buf, sizeof(mqtt_buf), "OK /off", "");
-      sendmqtt();
-    #endif
-  }
   getACK("OK");
   #if defined(ENABLE_STATE_SAVE)
     if(save_state.active()) save_state.detach();
@@ -342,10 +330,6 @@ server.on("/off", []() {
 server.on("/on", []() {
   if (prevmode == OFF) {
     State.mode = SET;
-    #if defined(ENABLE_MQTT)
-      snprintf(mqtt_buf, sizeof(mqtt_buf), "OK /%i", segState.mode[State.segment]);
-      sendmqtt();
-    #endif
     getACK("OK");
     #if defined(ENABLE_STATE_SAVE)
       if(save_state.active()) save_state.detach();
@@ -370,10 +354,6 @@ server.on("/set", []() {
         //memcpy(hexcolors_trans, segState.colors[State.segment], sizeof(hexcolors_trans));     
         State.mode = SET;
         _updateState = true;
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK Ss%i", _seg);
-          sendmqtt();
-        #endif
       }      
   }
   if ((server.arg("start") != "") && (server.arg("start").toInt() >= 0) && (server.arg("start").toInt() <= segState.stop)) { 
@@ -383,10 +363,6 @@ server.on("/set", []() {
         segState.start = _seg_start;
         setSegmentSize();
         _updateSegState = true;
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK S[%i", _seg_start);
-          sendmqtt();
-        #endif
       }
   }
   if ((server.arg("stop") != "") && (server.arg("stop").toInt() >= segState.start) && (server.arg("stop").toInt() <= Config.stripSize)) { 
@@ -396,10 +372,6 @@ server.on("/set", []() {
         segState.stop = _seg_stop;
         setSegmentSize();
         _updateSegState = true;
-        #if defined(ENABLE_MQTT)
-          snprintf(mqtt_buf, sizeof(mqtt_buf), "OK S]%i", _seg_stop);
-          sendmqtt();
-        #endif
       }
   }
 
@@ -409,10 +381,6 @@ server.on("/set", []() {
       segState.options = _fx_options;
       strip->setOptions(State.segment, segState.options);
       _updateSegState = true;
-      #if defined(ENABLE_MQTT)
-        snprintf(mqtt_buf, sizeof(mqtt_buf), "OK So%i", _fx_options);
-        sendmqtt();
-      #endif
     }
   }
   //color wrgb
@@ -507,24 +475,14 @@ server.on("/set", []() {
   
   // Speed
   if ((server.arg("s") != "") && (server.arg("s").toInt() >= 0) && (server.arg("s").toInt() <= 255)) {
-    uint8_t _fx_speed = constrain(server.arg("s").toInt(), 0, 255);
+    segState.speed[State.segment] = constrain(server.arg("s").toInt(), 0, 255);
-    segState.speed[State.segment] = _fx_speed;
     _updateSegState = true;
-    #if defined(ENABLE_MQTT)
-      snprintf(mqtt_buf, sizeof(mqtt_buf), "OK ?%i", _fx_speed);
-      sendmqtt();
-    #endif
   }
-  
   //Mode
   if ((server.arg("m") != "") && (server.arg("m").toInt() >= 0) && (server.arg("m").toInt() <= strip->getModeCount())) {
     fx_mode = constrain(server.arg("m").toInt(), 0, strip->getModeCount() - 1);
     if (fx_mode !=  segState.mode[State.segment]) {
       _updateSegState = true;
-      #if defined(ENABLE_MQTT)
-        snprintf(mqtt_buf, sizeof(mqtt_buf), "OK /%i", fx_mode);
-        sendmqtt();
-      #endif
     }
   }
   
@@ -537,10 +495,6 @@ server.on("/set", []() {
   if (strip->getBrightness() != State.brightness) {
     State.mode = SET;
     _updateState = true;
-    #if defined(ENABLE_MQTT)
-      snprintf(mqtt_buf, sizeof(mqtt_buf), "OK %%%i", State.brightness);
-      sendmqtt();
-    #endif
   }
   //DBG_OUTPUT_PORT.printf("Get Args: %s\r\n", listStateJSONfull()); //possibly causing heap problems
   getACK("OK");

Arduino/McLighting/version.h

@@ -1 +1 @@
-#define SKETCH_VERSION "3.1.2"
+#define SKETCH_VERSION "3.1.0"

Arduino/McLighting/version_info.ino

@@ -257,13 +257,4 @@
  * Version Bump to 3.1.0
  * bugfixes
  * E1.31 is now working for multi segments
- * 
- * 18 April 2020
- * Version Bump to 3.1.1
- * bugfixes regarding issue #80
- * 
- * 19 April 2020
- * Version Bump to 3.1.2
- * Almost finished: bugfixes regarding issue #80
- * ToDo: bugfixes regarding issue #70
  */