MQTT JSON Keypad

2024-02-17 12:00:47 +01:00
parent bd28258c72
commit fc767ddfab
5 changed files with 94 additions and 60 deletions
--- a/MqttTopics.h
+++ b/MqttTopics.h
@@ -52,6 +52,7 @@
 #define mqtt_topic_keypad_command_code "/keypad/command/code"
 #define mqtt_topic_keypad_command_enabled "/keypad/command/enabled"
 #define mqtt_topic_keypad_command_result "/keypad/command/commandResult"
+#define mqtt_topic_keypad_json "/keypad/json"

 #define mqtt_topic_presence "/presence/devices"

--- a/Network.cpp
+++ b/Network.cpp
@@ -357,13 +357,13 @@ bool Network::update()
        }
        _lastMaintenanceTs = ts;
    }
-    
+
    if(_preferences->getBool(preference_check_updates))
    {
        if(_lastUpdateCheckTs == 0 || (ts - _lastUpdateCheckTs) > 86400000)
        {
            _lastUpdateCheckTs = ts;
-            
+
            https.useHTTP10(true);
            https.begin(GITHUB_LATEST_RELEASE_API_URL);

@@ -373,16 +373,16 @@ bool Network::update()
                DynamicJsonDocument doc(6144);
                DeserializationError jsonError = deserializeJson(doc, https.getStream());

-                if (!jsonError) {    
+                if (!jsonError) {
                    _latestVersion = doc["tag_name"];
                    publishString(_maintenancePathPrefix, mqtt_topic_info_nuki_hub_latest, _latestVersion);
-                }            
+                }
            }

            https.end();
        }
    }
-    
+
    for(const auto& gpioTs : _gpioTs)
    {
        uint8_t pin = gpioTs.first;
@@ -750,7 +750,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
        json["dev"]["mf"] = "Nuki";
        json["dev"]["mdl"] = deviceType;
        json["dev"]["name"] = name;
-        
+
        String cuUrl = _preferences->getString(preference_mqtt_hass_cu_url);

        if (cuUrl != "")
@@ -761,7 +761,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
        {
            json["dev"]["cu"] = "http://" + _device->localIP();
        }
-        
+
        json["~"] = baseTopic;
        json["name"] = nullptr;
        json["unique_id"] = String(uidString) + "_lock";
@@ -945,11 +945,11 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
                         "",
                         { { "enabled_by_default", "true" },
                           {"ic", "mdi:counter"}});
-                      
+
        if(_preferences->getBool(preference_check_updates))
        {
            // NUKI Hub latest
-            publishHassTopic("sensor", 
+            publishHassTopic("sensor",
                             "nuki_hub_latest",
                             uidString,
                             "_nuki_hub_latest",
@@ -964,13 +964,13 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
                             "",
                             { { "enabled_by_default", "true" },
                               {"ic", "mdi:counter"}});
-                               
+
            // NUKI Hub update
            char latest_version_topic[250];
            _lockPath.toCharArray(latest_version_topic,_lockPath.length() + 1);
            strcat(latest_version_topic, mqtt_topic_info_nuki_hub_latest);

-            publishHassTopic("update", 
+            publishHassTopic("update",
                             "nuki_hub_update",
                             uidString,
                             "_nuki_hub_update",
@@ -986,7 +986,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
                             { { "enabled_by_default", "true" },
                               { "entity_picture", "https://raw.githubusercontent.com/technyon/nuki_hub/master/icon/favicon-32x32.png" },
                               { "release_url", GITHUB_LATEST_RELEASE_URL },
-                               { "latest_version_topic", latest_version_topic }});                               
+                               { "latest_version_topic", latest_version_topic }});
        }
        else
        {
@@ -1050,7 +1050,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
                           { "pl_off", "0" },
                           { "state_on", "1" },
                           { "state_off", "0" }});
- 
+
        // Unlatch
        publishHassTopic("button",
                         "unlatch",
@@ -1066,8 +1066,8 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
                         "",
                         String("~") + mqtt_topic_lock_action,
                         { { "enabled_by_default", "false" },
-                           { "pl_prs", "unlatch" }}); 
-                         
+                           { "pl_prs", "unlatch" }});
+
    }
 }

@@ -1362,7 +1362,7 @@ String Network::createHassTopicPath(const String& mqttDeviceType, const String&
    path.concat("/");
    path.concat(mqttDeviceName);
    path.concat("/config");
-    
+
    return path;
 }

@@ -1387,18 +1387,18 @@ void Network::removeHASSConfig(char* uidString)
        removeHassTopic("lock", "smartlock", uidString);
        removeHassTopic("binary_sensor", "battery_low", uidString);
        removeHassTopic("binary_sensor", "keypad_battery_low", uidString);
-        removeHassTopic("sensor", "battery_voltage", uidString);        
+        removeHassTopic("sensor", "battery_voltage", uidString);
        removeHassTopic("sensor", "trigger", uidString);
        removeHassTopic("binary_sensor", "mqtt_connected", uidString);
-        removeHassTopic("switch", "reset", uidString);        
+        removeHassTopic("switch", "reset", uidString);
        removeHassTopic("sensor", "firmware_version", uidString);
        removeHassTopic("sensor", "hardware_version", uidString);
        removeHassTopic("sensor", "nuki_hub_version", uidString);
        removeHassTopic("sensor", "nuki_hub_latest", uidString);
        removeHassTopic("update", "nuki_hub_update", uidString);
        removeHassTopic("sensor", "nuki_hub_ip", uidString);
-        removeHassTopic("switch", "led_enabled", uidString);  
-        removeHassTopic("switch", "button_enabled", uidString);  
+        removeHassTopic("switch", "led_enabled", uidString);
+        removeHassTopic("switch", "button_enabled", uidString);
        removeHassTopic("button", "unlatch", uidString);
        removeHassTopic("button", "lockngo", uidString);
        removeHassTopic("button", "lockngounlatch", uidString);
@@ -1406,7 +1406,7 @@ void Network::removeHASSConfig(char* uidString)
        removeHassTopic("binary_sensor", "door_sensor", uidString);
        removeHassTopic("binary_sensor", "ring", uidString);
        removeHassTopic("number", "led_brightness", uidString);
-        removeHassTopic("sensor", "sound_level", uidString);        
+        removeHassTopic("sensor", "sound_level", uidString);
        removeHassTopic("number", "sound_level", uidString);
        removeHassTopic("sensor", "last_action_authorization", uidString);
        removeHassTopic("sensor", "keypad_status", uidString);
@@ -1451,17 +1451,17 @@ DynamicJsonDocument Network::createHassJson(const String& uidString,
    {
        json["dev_cla"] = deviceClass;
    }
-    
+
    if(stateTopic != "")
    {
        json["stat_t"] = stateTopic;
    }
-    
+
    if(stateClass != "")
    {
        json["stat_cla"] = stateClass;
    }
-    
+
    if(entityCat != "")
    {
        json["ent_cat"] = entityCat;
@@ -1471,7 +1471,7 @@ DynamicJsonDocument Network::createHassJson(const String& uidString,
    {
        json["cmd_t"] = commandTopic;
    }
-    
+
    json["avty"]["t"] = _lockPath + mqtt_topic_mqtt_connection_state;

    for(const auto& entry : additionalEntries)
@@ -1489,7 +1489,7 @@ DynamicJsonDocument Network::createHassJson(const String& uidString,
            json[entry.first] = entry.second;
        }
    }
-    
+
    return json;
 }

--- a/NetworkLock.cpp
+++ b/NetworkLock.cpp
@@ -268,40 +268,35 @@ void NetworkLock::publishKeyTurnerState(const NukiLock::KeyTurnerState& keyTurne

    json["door_sensor_state"] = str;

-    bool critical = (keyTurnerState.criticalBatteryState & 0b00000001) > 0;
-    bool charging = (keyTurnerState.criticalBatteryState & 0b00000010) > 0;
-    uint8_t level = (keyTurnerState.criticalBatteryState & 0b11111100) >> 1;
-
    if(_firstTunerStatePublish || keyTurnerState.criticalBatteryState != lastKeyTurnerState.criticalBatteryState)
    {
+        bool critical = (keyTurnerState.criticalBatteryState & 0b00000001) > 0;
        publishBool(mqtt_topic_battery_critical, critical);
+
+        bool charging = (keyTurnerState.criticalBatteryState & 0b00000010) > 0;
        publishBool(mqtt_topic_battery_charging, charging);
+
+        uint8_t level = (keyTurnerState.criticalBatteryState & 0b11111100) >> 1;
        publishInt(mqtt_topic_battery_level, level);
    }

-    json["battery_critical"] = critical;
-    json["battery_charging"] = charging;
-    json["battery_level"] = level;
-
-    bool keypadBatteryCritical;
-
-    if ((keyTurnerState.accessoryBatteryState & (1 << 7)) != 0) {
-        keypadBatteryCritical = ((keyTurnerState.accessoryBatteryState & (1 << 6)) != 0);
-    }
-    else
-    {
-        keypadBatteryCritical = false;
-    }
-
    if(_firstTunerStatePublish || keyTurnerState.accessoryBatteryState != lastKeyTurnerState.accessoryBatteryState)
    {
-        publishBool(mqtt_topic_battery_keypad_critical, keypadBatteryCritical);
+        if ((keyTurnerState.accessoryBatteryState & (1 << 7)) != 0) {
+            publishBool(mqtt_topic_battery_keypad_critical, (keyTurnerState.accessoryBatteryState & (1 << 6)) != 0);
+        }
+        else
+        {
+            publishBool(mqtt_topic_battery_keypad_critical, false);
+        }
    }

-    json["keypad_battery_critical"] = keypadBatteryCritical;
    json["auth_id"] = authId;
    json["auth_name"] = authName;

+    serializeJson(json, _buffer, _bufferSize);
+    publishString(mqtt_topic_lock_json, _buffer);
+
    _firstTunerStatePublish = false;
 }

@@ -484,15 +479,35 @@ void NetworkLock::publishBleAddress(const std::string &address)
 void NetworkLock::publishKeypad(const std::list<NukiLock::KeypadEntry>& entries, uint maxKeypadCodeCount)
 {
    uint index = 0;
+
+    DynamicJsonDocument json(_bufferSize);
+
    for(const auto& entry : entries)
    {
        String basePath = mqtt_topic_keypad;
        basePath.concat("/code_");
        basePath.concat(std::to_string(index).c_str());
        publishKeypadEntry(basePath, entry);
+        
+        auto jsonEntry = json.add();

+        jsonEntry["id"] = entry.codeId;
+        jsonEntry["enabled"] = entry.enabled;
+        jsonEntry["name"] = entry.name;
+        jsonEntry["createdYear"] = entry.dateCreatedYear;
+        jsonEntry["createdMonth"] = entry.dateCreatedMonth;
+        jsonEntry["createdDay"] = entry.dateCreatedDay;
+        jsonEntry["createdHour"] = entry.dateCreatedHour;
+        jsonEntry["createdMin"] = entry.dateCreatedMin;
+        jsonEntry["createdSec"] = entry.dateCreatedSec;
+        jsonEntry["lockCount"] = entry.lockCount;
+        
        ++index;
    }
+
+    serializeJson(json, _buffer, _bufferSize);
+    publishString(mqtt_topic_keypad_json, _buffer);
+
    while(index < maxKeypadCodeCount)
    {
        NukiLock::KeypadEntry entry;
--- a/NetworkOpener.cpp
+++ b/NetworkOpener.cpp
@@ -202,14 +202,14 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn
    _currentLockState = keyTurnerState.lockState;

    char str[50];
-    memset(&str, 0, sizeof(str));    
+    memset(&str, 0, sizeof(str));

    DynamicJsonDocument json(_bufferSize);

    lockstateToString(keyTurnerState.lockState, str);

    if((_firstTunerStatePublish || keyTurnerState.lockState != lastKeyTurnerState.lockState || keyTurnerState.nukiState != lastKeyTurnerState.nukiState) && keyTurnerState.lockState != NukiOpener::LockState::Undefined)
-    {        
+    {
        if(keyTurnerState.nukiState == NukiOpener::State::ContinuousMode)
        {
            publishString(mqtt_topic_lock_state, "ContinuousMode");
@@ -224,14 +224,14 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn
            publishBinaryState(keyTurnerState);
        }
    }
-    
+
    json["lock_state"] = str;
-    
+
    if(keyTurnerState.nukiState == NukiOpener::State::ContinuousMode)
    {
-        json["continuous_mode"] = true;
+        json["continuous_mode"] = 1;
    } else {
-        json["continuous_mode"] = false;
+        json["continuous_mode"] = 0;
    }

    memset(&str, 0, sizeof(str));
@@ -241,7 +241,7 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn
    {
        publishString(mqtt_topic_lock_trigger, str);
    }
-    
+
    json["trigger"] = str;

    memset(&str, 0, sizeof(str));
@@ -251,7 +251,7 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn
    {
        publishString(mqtt_topic_lock_completionStatus, str);
    }
-    
+
    json["lock_completion_status"] = str;

    memset(&str, 0, sizeof(str));
@@ -261,19 +261,17 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn
    {
        publishString(mqtt_topic_lock_door_sensor_state, str);
    }
-    
-    json["door_sensor_state"] = str;

-    bool critical = (keyTurnerState.criticalBatteryState & 0b00000001) > 0;
+    json["door_sensor_state"] = str;

    if(_firstTunerStatePublish || keyTurnerState.criticalBatteryState != lastKeyTurnerState.criticalBatteryState)
    {
+        bool critical = (keyTurnerState.criticalBatteryState & 0b00000001) > 0;
        publishBool(mqtt_topic_battery_critical, critical);
    }

-    json["battery_critical"] = critical;
    json["auth_id"] = authId;
-    json["auth_name"] = authName;    
+    json["auth_name"] = authName;

    serializeJson(json, _buffer, _bufferSize);
    publishString(mqtt_topic_lock_json, _buffer);
@@ -538,15 +536,35 @@ void NetworkOpener::removeHASSConfig(char* uidString)
 void NetworkOpener::publishKeypad(const std::list<NukiLock::KeypadEntry>& entries, uint maxKeypadCodeCount)
 {
    uint index = 0;
+
+    DynamicJsonDocument json(_bufferSize);
+
    for(const auto& entry : entries)
    {
        String basePath = mqtt_topic_keypad;
        basePath.concat("/code_");
        basePath.concat(std::to_string(index).c_str());
        publishKeypadEntry(basePath, entry);
+        
+        auto jsonEntry = json.add();
+
+        jsonEntry["id"] = entry.codeId;
+        jsonEntry["enabled"] = entry.enabled;
+        jsonEntry["name"] = entry.name;
+        jsonEntry["createdYear"] = entry.dateCreatedYear;
+        jsonEntry["createdMonth"] = entry.dateCreatedMonth;
+        jsonEntry["createdDay"] = entry.dateCreatedDay;
+        jsonEntry["createdHour"] = entry.dateCreatedHour;
+        jsonEntry["createdMin"] = entry.dateCreatedMin;
+        jsonEntry["createdSec"] = entry.dateCreatedSec;
+        jsonEntry["lockCount"] = entry.lockCount;

        ++index;
    }
+
+    serializeJson(json, _buffer, _bufferSize);
+    publishString(mqtt_topic_keypad_json, _buffer);
+
    while(index < maxKeypadCodeCount)
    {
        NukiLock::KeypadEntry entry;
--- a/WebCfgServer.cpp
+++ b/WebCfgServer.cpp
@@ -1368,4 +1368,4 @@ String WebCfgServer::getPreselectionForGpio(const uint8_t &pin)
    }

    return String((int8_t)PinRole::Disabled);
-}
+}