add option to publish state as json

MqttTopics.h

@@ -9,6 +9,7 @@
 #define mqtt_topic_battery_lock_distance "/battery/lockDistance"
 
 #define mqtt_topic_lock_state "/lock/state"
+#define mqtt_topic_lock_state_json "/lock/stateJson"
 #define mqtt_topic_lock_binary_state "/lock/binaryState"
 #define mqtt_topic_lock_trigger "/lock/trigger"
 #define mqtt_topic_lock_auth_id "/lock/authorizationId"

NetworkLock.cpp

@@ -210,6 +210,47 @@ void NetworkLock::publishKeyTurnerState(const NukiLock::KeyTurnerState& keyTurne
     _firstTunerStatePublish = false;
 }
 
+void NetworkLock::publishStateAsJson(const char* action, const NukiLock::KeyTurnerState &keyTurnerState, const uint32_t authId, const char *authName)
+{
+    char str[50];
+    String json = "{\n";
+
+    // action
+    json.concat("\"action\": \""); json.concat(action); json.concat("\",\n");
+
+    // state
+    memset(&str, 0, sizeof(str));
+    lockstateToString(keyTurnerState.lockState, str);
+    json.concat("\"state\": \""); json.concat(str); json.concat("\",\n");
+
+    // state
+    memset(&str, 0, sizeof(str));
+    lockstateToString(keyTurnerState.lockState, str);
+    json.concat("\"state\": \""); json.concat(str); json.concat("\",\n");
+
+    // trigger
+    memset(&str, 0, sizeof(str));
+    triggerToString(keyTurnerState.trigger, str);
+    json.concat("\"trigger\": \""); json.concat(str); json.concat("\",\n");
+
+    // completion status
+    memset(&str, 0, sizeof(str));
+    NukiLock::completionStatusToString(keyTurnerState.lastLockActionCompletionStatus, str);
+    json.concat("\"completionStatus\": \""); json.concat(str); json.concat("\",\n");
+
+    // Door sensor state
+    memset(&str, 0, sizeof(str));
+    NukiLock::doorSensorStateToString(keyTurnerState.doorSensorState, str);
+    json.concat("\"doorSensorState\": \""); json.concat(str); json.concat("\",\n");
+
+    // Auth date
+    json.concat("\"authorizationId\": "); json.concat(authId == 0xffff ? 0 : authId); json.concat(",\n");
+    json.concat("\"authorizationName\": \""); json.concat(authName); json.concat("\"\n");
+
+    json.concat("}");
+    publishString(mqtt_topic_lock_state_json, json.c_str());
+}
+
 void NetworkLock::publishBinaryState(NukiLock::LockState lockState)
 {
     switch(lockState)

NetworkLock.h

@@ -21,6 +21,7 @@ public:
     void update();
 
     void publishKeyTurnerState(const NukiLock::KeyTurnerState& keyTurnerState, const NukiLock::KeyTurnerState& lastKeyTurnerState);
+    void publishStateAsJson(const char* action, const NukiLock::KeyTurnerState& keyTurnerState, const uint32_t authId, const char* authName);
     void publishBinaryState(NukiLock::LockState lockState);
     void publishAuthorizationInfo(const uint32_t authId, const char* authName);
     void publishCommandResult(const char* resultStr);

NukiWrapper.cpp

@@ -44,6 +44,7 @@ void NukiWrapper::initialize()
     _intervalKeypad = _preferences->getInt(preference_query_interval_keypad);
     _keypadEnabled = _preferences->getBool(preference_keypad_control_enabled);
     _publishAuthData = _preferences->getBool(preference_publish_authdata);
+    _publishJson = _preferences->getBool(preference_publish_json);
     _maxKeypadCodeCount = _preferences->getUInt(preference_max_keypad_code_count);
 
     if(_intervalLockstate == 0)
@@ -191,6 +192,11 @@ void NukiWrapper::updateKeyTurnerState()
     {
         updateAuthData();
     }
+
+    if(_publishJson)
+    {
+        _network->publishStateAsJson(_lastLockAction, _keyTurnerState, _lastAuthId, _lastAuthName);
+    }
 }
 
 void NukiWrapper::updateBatteryState()
@@ -233,17 +239,20 @@ void NukiWrapper::updateAuthData()
     if(log.size() > 0)
     {
         const Nuki::LogEntry& entry = log.front();
-//        log_d("Log: %d-%d-%d %d:%d:%d %s", entry.timeStampYear, entry.timeStampMonth, entry.timeStampDay,
+
-//              entry.timeStampHour, entry.timeStampMinute, entry.timeStampSecond, entry.name);
         if(entry.authId != _lastAuthId)
         {
             _network->publishAuthorizationInfo(entry.authId, (char *) entry.name);
             _lastAuthId = entry.authId;
+            memset(_lastAuthName, 0, sizeof(_lastAuthName));
+            memcpy(_lastAuthName, entry.name, sizeof(entry.name));
         }
     }
     else
     {
         _network->publishAuthorizationInfo(0, "");
+        _lastAuthId = 0;
+        memset(_lastAuthName, 0, sizeof(_lastAuthName));
     }
 }
 
@@ -277,6 +286,9 @@ void NukiWrapper::updateKeypad()
 
 NukiLock::LockAction NukiWrapper::lockActionToEnum(const char *str)
 {
+    memset(&_lastLockAction, 0, sizeof(_lastLockAction));
+    strcpy(_lastLockAction, str);
+
     if(strcmp(str, "unlock") == 0) return NukiLock::LockAction::Unlock;
     else if(strcmp(str, "lock") == 0) return NukiLock::LockAction::Lock;
     else if(strcmp(str, "unlatch") == 0) return NukiLock::LockAction::Unlatch;

NukiWrapper.h

@@ -67,6 +67,7 @@ private:
     NukiLock::KeyTurnerState _keyTurnerState;
 
     uint32_t _lastAuthId = 0xffff;
+    char _lastAuthName[33] = {0};
 
     NukiLock::BatteryReport _batteryReport;
     NukiLock::BatteryReport _lastBatteryReport;
@@ -81,10 +82,12 @@ private:
     bool _hasKeypad = false;
     bool _keypadEnabled = false;
     bool _configRead = false;
+    bool _publishJson = false;
     uint _maxKeypadCodeCount = 0;
     unsigned long _nextLockStateUpdateTs = 0;
     unsigned long _nextBatteryReportTs = 0;
     unsigned long _nextConfigUpdateTs = 0;
     unsigned long _nextKeypadUpdateTs = 0;
     NukiLock::LockAction _nextLockAction = (NukiLock::LockAction)0xff;
+    char _lastLockAction[15] = { 0 };
 };

PreferencesKeys.h

@@ -23,6 +23,7 @@
 #define preference_query_interval_battery "batInterval"
 #define preference_query_interval_keypad "kpInterval"
 #define preference_keypad_control_enabled "kpEnabled"
+#define preference_publish_json "pubJson"
 #define preference_cred_user "crdusr"
 #define preference_cred_password "crdpass"
 #define preference_publish_authdata "pubauth"

WebCfgServer.cpp

@@ -296,6 +296,11 @@ bool WebCfgServer::processArgs(String& message)
             _preferences->putBool(preference_keypad_control_enabled, (value == "1"));
             configChanged = true;
         }
+        else if(key == "PUBJSON")
+        {
+            _preferences->putBool(preference_publish_json, (value == "1"));
+            configChanged = true;
+        }
         else if(key == "PRDTMO")
         {
             _preferences->putInt(preference_presence_detection_timeout, value.toInt());
@@ -557,7 +562,7 @@ void WebCfgServer::buildMqttConfigHtml(String &response)
 {
     buildHtmlHeader(response);
     response.concat("<FORM ACTION=method=get >");
-    response.concat("<h3>Basic MQTT Configuration</h3>");
+    response.concat("<h3>Basic MQTT and Network Configuration</h3>");
     response.concat("<table>");
     printInputField(response, "HOSTNAME", "Host name", _preferences->getString(preference_hostname).c_str(), 100);
     printInputField(response, "MQTTSERVER", "MQTT Broker", _preferences->getString(preference_mqtt_broker).c_str(), 100);
@@ -566,7 +571,7 @@ void WebCfgServer::buildMqttConfigHtml(String &response)
     printInputField(response, "MQTTPASS", "MQTT Password", "*", 30, true);
     response.concat("</table><br>");
 
-    response.concat("<h3>Advanced MQTT Configuration</h3>");
+    response.concat("<h3>Advanced MQTT and Network Configuration</h3>");
     response.concat("<table>");
     printTextarea(response, "MQTTCA", "MQTT SSL CA Certificate (*, optional)", _preferences->getString(preference_mqtt_ca).c_str(), TLS_CA_MAX_SIZE);
     printTextarea(response, "MQTTCRT", "MQTT SSL Client Certificate (*, optional)", _preferences->getString(preference_mqtt_crt).c_str(), TLS_CERT_MAX_SIZE);
@@ -613,6 +618,7 @@ void WebCfgServer::buildNukiConfigHtml(String &response)
         printInputField(response, "KPINT", "Query interval keypad (seconds)", _preferences->getInt(preference_query_interval_keypad), 10);
         printCheckBox(response, "KPENA", "Enabled keypad control via MQTT", _preferences->getBool(preference_keypad_control_enabled));
     }
+    printCheckBox(response, "PUBJSON", "Publish additional json state", _preferences->getBool(preference_publish_json));
     printCheckBox(response, "PUBAUTH", "Publish auth data (May reduce battery life)", _preferences->getBool(preference_publish_authdata));
     printCheckBox(response, "GPLCK", "Enable control via GPIO", _preferences->getBool(preference_gpio_locking_enabled));
     printInputField(response, "PRDTMO", "Presence detection timeout (seconds; -1 to disable)", _preferences->getInt(preference_presence_detection_timeout), 10);