MQTT report setting for buttons: send action events, all events or state

code/espurna/button.ino

@@ -23,13 +23,18 @@ typedef struct {
 
 std::vector<button_t> _buttons;
 
+#define BUTTONS_MAX 8u
+
 #if MQTT_SUPPORT
 
-void buttonMQTT(unsigned char id, uint8_t event) {
+uint8_t _button_mqtt_mask_events {BUTTON_MQTT_MASK_EVENTS};
+uint8_t _button_mqtt_mask_pressed {BUTTON_MQTT_MASK_PRESSED};
+
+void buttonMQTT(unsigned char id, uint8_t event, bool optional_retain = false) {
     if (id >= _buttons.size()) return;
     char payload[2];
     itoa(event, payload, 10);
-    mqttSend(MQTT_TOPIC_BUTTON, id, payload, false, false); // 1st bool = force, 2nd = retain
+    mqttSend(MQTT_TOPIC_BUTTON, id, payload, false, optional_retain ? mqttRetain() : false); // 1st bool = force, 2nd = retain
 }
 
 #endif
@@ -100,9 +105,18 @@ void buttonEvent(unsigned int id, unsigned char event) {
     unsigned char action = buttonAction(id, event);
 
     #if MQTT_SUPPORT
-       if (action != BUTTON_MODE_NONE || BUTTON_MQTT_SEND_ALL_EVENTS) {
-           buttonMQTT(id, event);
-       }
+    {
+        uint8_t id_bit = (1 << ((BUTTONS_MAX - 1) - id));
+
+        if (_button_mqtt_mask_pressed & id_bit) {
+            buttonMQTT(id, buttonState(id), true);
+            return;
+        }
+
+        if ((BUTTON_MODE_NONE != action) || (_button_mqtt_mask_events & id_bit)) {
+            buttonMQTT(id, event);
+        }
+    }
     #endif
 
     if (BUTTON_MODE_TOGGLE == action) {
@@ -246,6 +260,22 @@ void buttonSetup() {
         wsOnReceiveRegister(_buttonWebSocketOnReceive);
     #endif
 
+    #if MQTT_SUPPORT
+        _button_mqtt_mask_events = getSetting("btnMaskEvents", BUTTON_MQTT_MASK_EVENTS).toInt();
+        if (_button_mqtt_mask_events > 0) {
+            char buffer[16];
+            itoa(_button_mqtt_mask_events, buffer, 2);
+            DEBUG_MSG_P(PSTR("[BUTTON] MQTT Events mask: %s\n"), buffer);
+        }
+
+        _button_mqtt_mask_pressed = getSetting("btnMaskPressed", BUTTON_MQTT_MASK_PRESSED).toInt();
+        if (_button_mqtt_mask_pressed > 0) {
+            char buffer[16];
+            itoa(_button_mqtt_mask_pressed, buffer, 2);
+            DEBUG_MSG_P(PSTR("[BUTTON] MQTT pressed mask: %s\n"), buffer);
+        }
+    #endif
+
     // Register loop
     espurnaRegisterLoop(buttonLoop);
 

code/espurna/config/general.h

@@ -322,9 +322,16 @@
 #define BUTTON_LNGLNGCLICK_DELAY    10000       // Time in ms holding the button down to get a long-long click
 #endif
 
-#ifndef BUTTON_MQTT_SEND_ALL_EVENTS
-#define BUTTON_MQTT_SEND_ALL_EVENTS 0           // 0 - to send only events the are bound to actions
-                                                // 1 - to send all button events to MQTT
+// Button event filter for MQTT represented as bitset (unsigned)
+// 0 - to send only events the are bound to actions
+// 1 - to send all button events to MQTT
+#ifndef BUTTON_MQTT_MASK_EVENTS
+#define BUTTON_MQTT_MASK_EVENTS     0b00000000u
+#endif
+
+// Bitset for PUSHBUTTONs that can directly send pressed() status, instead of event
+#ifndef BUTTON_MQTT_MASK_PRESSED
+#define BUTTON_MQTT_MASK_PRESSED    0b00000000u
 #endif
 
 //------------------------------------------------------------------------------

code/espurna/config/types.h

@@ -51,7 +51,6 @@
 #define BUTTON_MODE_DIM_UP          10
 #define BUTTON_MODE_DIM_DOWN        11
 
-
 // Needed for ESP8285 boards under Windows using PlatformIO (?)
 #ifndef BUTTON_PUSHBUTTON
 #define BUTTON_PUSHBUTTON           0

code/espurna/mqtt.ino

@@ -755,6 +755,10 @@ bool mqttConnected() {
     return _mqtt.connected();
 }
 
+bool mqttRetain() {
+    return _mqtt_retain;
+}
+
 void mqttDisconnect() {
     if (_mqtt.connected()) {
         DEBUG_MSG_P(PSTR("[MQTT] Disconnecting\n"));