From c716afb25420b1c1ae271b89659d33221fd55140 Mon Sep 17 00:00:00 2001 From: Luca Oliano Date: Sun, 4 Feb 2024 19:05:26 +0100 Subject: [PATCH 1/9] remove NetworkDevice dependency from MqttLogger library --- lib/MqttLogger/library.properties | 2 +- lib/MqttLogger/src/MqttLogger.cpp | 10 +++++----- lib/MqttLogger/src/MqttLogger.h | 8 ++++---- networkDevices/EthLan8720Device.cpp | 13 ++++++++++++- networkDevices/EthLan8720Device.h | 1 + networkDevices/W5500Device.cpp | 2 +- networkDevices/WifiDevice.cpp | 14 +++++++++++++- networkDevices/WifiDevice.h | 1 + 8 files changed, 38 insertions(+), 13 deletions(-) diff --git a/lib/MqttLogger/library.properties b/lib/MqttLogger/library.properties index 5dd5cc2..a6ac783 100644 --- a/lib/MqttLogger/library.properties +++ b/lib/MqttLogger/library.properties @@ -8,4 +8,4 @@ category=Communication url=https://github.com/androbi-com/MqttLogger architectures=* includes=MqttLogger.h -depends=PubSubClient +depends=espMqttClient diff --git a/lib/MqttLogger/src/MqttLogger.cpp b/lib/MqttLogger/src/MqttLogger.cpp index bae0bf2..ada26d1 100644 --- a/lib/MqttLogger/src/MqttLogger.cpp +++ b/lib/MqttLogger/src/MqttLogger.cpp @@ -7,7 +7,7 @@ MqttLogger::MqttLogger(MqttLoggerMode mode) this->setBufferSize(MQTT_MAX_PACKET_SIZE); } -MqttLogger::MqttLogger(NetworkDevice* client, const char* topic, MqttLoggerMode mode) +MqttLogger::MqttLogger(MqttClient& client, const char* topic, MqttLoggerMode mode) { this->setClient(client); this->setTopic(topic); @@ -19,9 +19,9 @@ MqttLogger::~MqttLogger() { } -void MqttLogger::setClient(NetworkDevice* client) +void MqttLogger::setClient(MqttClient& client) { - this->client = client; + this->client = &client; } void MqttLogger::setTopic(const char* topic) @@ -74,9 +74,9 @@ void MqttLogger::sendBuffer() if (this->bufferCnt > 0) { bool doSerial = this->mode==MqttLoggerMode::SerialOnly || this->mode==MqttLoggerMode::MqttAndSerial; - if (this->mode!=MqttLoggerMode::SerialOnly && this->client != NULL && this->client->mqttConnected()) + if (this->mode!=MqttLoggerMode::SerialOnly && this->client != NULL && this->client->connected()) { - this->client->mqttPublish(topic, 0, true, (uint8_t*)this->buffer, this->bufferCnt); + this->client->publish(topic, 0, true, this->buffer, this->bufferCnt); } else if (this->mode == MqttLoggerMode::MqttAndSerialFallback) { doSerial = true; diff --git a/lib/MqttLogger/src/MqttLogger.h b/lib/MqttLogger/src/MqttLogger.h index 795fd10..2be7d1e 100644 --- a/lib/MqttLogger/src/MqttLogger.h +++ b/lib/MqttLogger/src/MqttLogger.h @@ -11,7 +11,7 @@ #include #include -#include "../../../networkDevices/NetworkDevice.h" +#include #define MQTT_MAX_PACKET_SIZE 1024 @@ -29,16 +29,16 @@ private: uint8_t* buffer; uint8_t* bufferEnd; uint16_t bufferCnt = 0, bufferSize = 0; - NetworkDevice* client; + MqttClient* client; MqttLoggerMode mode; void sendBuffer(); public: MqttLogger(MqttLoggerMode mode=MqttLoggerMode::MqttAndSerialFallback); - MqttLogger(NetworkDevice* client, const char* topic, MqttLoggerMode mode=MqttLoggerMode::MqttAndSerialFallback); + MqttLogger(MqttClient& client, const char* topic, MqttLoggerMode mode=MqttLoggerMode::MqttAndSerialFallback); ~MqttLogger(); - void setClient(NetworkDevice* client); + void setClient(MqttClient& client); void setTopic(const char* topic); void setMode(MqttLoggerMode mode); void setRetained(boolean retained); diff --git a/networkDevices/EthLan8720Device.cpp b/networkDevices/EthLan8720Device.cpp index def7bc6..c7a6b46 100644 --- a/networkDevices/EthLan8720Device.cpp +++ b/networkDevices/EthLan8720Device.cpp @@ -57,7 +57,7 @@ EthLan8720Device::EthLan8720Device(const String& hostname, Preferences* preferen String pathStr = preferences->getString(preference_mqtt_lock_path); pathStr.concat(mqtt_topic_log); strcpy(_path, pathStr.c_str()); - Log = new MqttLogger(this, _path, MqttLoggerMode::MqttAndSerial); + Log = new MqttLogger(*getMqttClient(), _path, MqttLoggerMode::MqttAndSerial); } } @@ -342,3 +342,14 @@ void EthLan8720Device::disableMqtt() _mqttEnabled = false; } +MqttClient *EthLan8720Device::getMqttClient() const +{ + if (_useEncryption) + { + return _mqttClientSecure; + } + else + { + return _mqttClient; + } +} diff --git a/networkDevices/EthLan8720Device.h b/networkDevices/EthLan8720Device.h index 1453e1b..93ca817 100644 --- a/networkDevices/EthLan8720Device.h +++ b/networkDevices/EthLan8720Device.h @@ -69,6 +69,7 @@ public: private: void onDisconnected(); + MqttClient *getMqttClient() const; espMqttClient* _mqttClient = nullptr; espMqttClientSecure* _mqttClientSecure = nullptr; diff --git a/networkDevices/W5500Device.cpp b/networkDevices/W5500Device.cpp index e66b6bd..6a89a3e 100644 --- a/networkDevices/W5500Device.cpp +++ b/networkDevices/W5500Device.cpp @@ -61,7 +61,7 @@ void W5500Device::initialize() _path = new char[pathStr.length() + 1]; memset(_path, 0, sizeof(_path)); strcpy(_path, pathStr.c_str()); - Log = new MqttLogger(this, _path, MqttLoggerMode::MqttAndSerial); + Log = new MqttLogger(_mqttClient, _path, MqttLoggerMode::MqttAndSerial); } reconnect(); diff --git a/networkDevices/WifiDevice.cpp b/networkDevices/WifiDevice.cpp index a90ff82..e57a485 100644 --- a/networkDevices/WifiDevice.cpp +++ b/networkDevices/WifiDevice.cpp @@ -51,7 +51,7 @@ WifiDevice::WifiDevice(const String& hostname, Preferences* preferences, const I String pathStr = preferences->getString(preference_mqtt_lock_path); pathStr.concat(mqtt_topic_log); strcpy(_path, pathStr.c_str()); - Log = new MqttLogger(this, _path, MqttLoggerMode::MqttAndSerial); + Log = new MqttLogger(*getMqttClient(), _path, MqttLoggerMode::MqttAndSerial); } } @@ -367,3 +367,15 @@ void WifiDevice::disableMqtt() _mqttEnabled = false; } + +MqttClient *WifiDevice::getMqttClient() const +{ + if (_useEncryption) + { + return _mqttClientSecure; + } + else + { + return _mqttClient; + } +} diff --git a/networkDevices/WifiDevice.h b/networkDevices/WifiDevice.h index d45b30e..c5f15b4 100644 --- a/networkDevices/WifiDevice.h +++ b/networkDevices/WifiDevice.h @@ -61,6 +61,7 @@ private: static void clearRtcInitVar(WiFiManager*); void onDisconnected(); + MqttClient *getMqttClient() const; WiFiManager _wm; espMqttClient* _mqttClient = nullptr; From 05f2c177129c3cbd05b435c95ed7d348a9cb1d4f Mon Sep 17 00:00:00 2001 From: Luca Oliano Date: Mon, 5 Feb 2024 10:48:18 +0100 Subject: [PATCH 2/9] refactor network devices hierarchy --- networkDevices/EthLan8720Device.cpp | 215 ------------------------- networkDevices/EthLan8720Device.h | 39 ----- networkDevices/NetworkDevice.cpp | 161 +++++++++++++++++++ networkDevices/NetworkDevice.h | 44 ++--- networkDevices/W5500Device.cpp | 92 +---------- networkDevices/W5500Device.h | 35 +--- networkDevices/WifiDevice.cpp | 221 -------------------------- networkDevices/WifiDevice.h | 38 ----- networkDevices/espMqttClientW5500.cpp | 2 +- networkDevices/espMqttClientW5500.h | 4 +- 10 files changed, 195 insertions(+), 656 deletions(-) create mode 100644 networkDevices/NetworkDevice.cpp diff --git a/networkDevices/EthLan8720Device.cpp b/networkDevices/EthLan8720Device.cpp index c7a6b46..d550fbb 100644 --- a/networkDevices/EthLan8720Device.cpp +++ b/networkDevices/EthLan8720Device.cpp @@ -96,12 +96,6 @@ void EthLan8720Device::reconfigure() restartEsp(RestartReason::ReconfigureLAN8720); } -void EthLan8720Device::printError() -{ - Log->print(F("Free Heap: ")); - Log->println(ESP.getFreeHeap()); -} - bool EthLan8720Device::supportsEncryption() { return true; @@ -132,20 +126,6 @@ ReconnectStatus EthLan8720Device::reconnect() return isConnected() ? ReconnectStatus::Success : ReconnectStatus::Failure; } -void EthLan8720Device::update() -{ - if(_mqttEnabled) - { - if (_useEncryption) - { - _mqttClientSecure->loop(); - } else - { - _mqttClient->loop(); - } - } -} - void EthLan8720Device::onDisconnected() { if(millis() > 60000) @@ -158,198 +138,3 @@ int8_t EthLan8720Device::signalStrength() { return -1; } - -void EthLan8720Device::mqttSetClientId(const char *clientId) -{ - if(_useEncryption) - { - _mqttClientSecure->setClientId(clientId); - } - else - { - _mqttClient->setClientId(clientId); - } -} - -void EthLan8720Device::mqttSetCleanSession(bool cleanSession) -{ - if(_useEncryption) - { - _mqttClientSecure->setCleanSession(cleanSession); - } - else - { - _mqttClient->setCleanSession(cleanSession); - } -} - -uint16_t EthLan8720Device::mqttPublish(const char *topic, uint8_t qos, bool retain, const char *payload) -{ - if(_useEncryption) - { - return _mqttClientSecure->publish(topic, qos, retain, payload); - } - else - { - return _mqttClient->publish(topic, qos, retain, payload); - } -} - -uint16_t EthLan8720Device::mqttPublish(const char *topic, uint8_t qos, bool retain, const uint8_t *payload, size_t length) -{ - if(_useEncryption) - { - return _mqttClientSecure->publish(topic, qos, retain, payload, length); - } - else - { - return _mqttClient->publish(topic, qos, retain, payload, length); - } -} - -bool EthLan8720Device::mqttConnected() const -{ - if(_useEncryption) - { - return _mqttClientSecure->connected(); - } - else - { - return _mqttClient->connected(); - } -} - -void EthLan8720Device::mqttSetServer(const char *host, uint16_t port) -{ - if(_useEncryption) - { - _mqttClientSecure->setServer(host, port); - } - else - { - _mqttClient->setServer(host, port); - } -} - -bool EthLan8720Device::mqttConnect() -{ - if(_useEncryption) - { - return _mqttClientSecure->connect(); - } - else - { - return _mqttClient->connect(); - } -} - -bool EthLan8720Device::mqttDisconnect(bool force) -{ - if(_useEncryption) - { - return _mqttClientSecure->disconnect(force); - } - else - { - return _mqttClient->disconnect(force); - } -} - -void EthLan8720Device::setWill(const char *topic, uint8_t qos, bool retain, const char *payload) -{ - if(_useEncryption) - { - _mqttClientSecure->setWill(topic, qos, retain, payload); - } - else - { - _mqttClient->setWill(topic, qos, retain, payload); - } -} - -void EthLan8720Device::mqttSetCredentials(const char *username, const char *password) -{ - if(_useEncryption) - { - _mqttClientSecure->setCredentials(username, password); - } - else - { - _mqttClient->setCredentials(username, password); - } -} - -void EthLan8720Device::mqttOnMessage(espMqttClientTypes::OnMessageCallback callback) -{ - if(_useEncryption) - { - _mqttClientSecure->onMessage(callback); - } - else - { - _mqttClient->onMessage(callback); - } -} - - -void EthLan8720Device::mqttOnConnect(espMqttClientTypes::OnConnectCallback callback) -{ - if(_useEncryption) - { - _mqttClientSecure->onConnect(callback); - } - else - { - _mqttClient->onConnect(callback); - } -} - -void EthLan8720Device::mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback) -{ - if(_useEncryption) - { - _mqttClientSecure->onDisconnect(callback); - } - else - { - _mqttClient->onDisconnect(callback); - } -} - - -uint16_t EthLan8720Device::mqttSubscribe(const char *topic, uint8_t qos) -{ - if(_useEncryption) - { - return _mqttClientSecure->subscribe(topic, qos); - } - else - { - return _mqttClient->subscribe(topic, qos); - } -} - -void EthLan8720Device::disableMqtt() -{ - if (_useEncryption) - { - _mqttClientSecure->disconnect(); - } else - { - _mqttClient->disconnect(); - } - - _mqttEnabled = false; -} - -MqttClient *EthLan8720Device::getMqttClient() const -{ - if (_useEncryption) - { - return _mqttClientSecure; - } - else - { - return _mqttClient; - } -} diff --git a/networkDevices/EthLan8720Device.h b/networkDevices/EthLan8720Device.h index 93ca817..14fb742 100644 --- a/networkDevices/EthLan8720Device.h +++ b/networkDevices/EthLan8720Device.h @@ -28,56 +28,18 @@ public: virtual void initialize(); virtual void reconfigure(); virtual ReconnectStatus reconnect(); - virtual void printError(); bool supportsEncryption() override; - virtual void update(); - virtual bool isConnected(); int8_t signalStrength() override; - void mqttSetClientId(const char *clientId) override; - - void mqttSetCleanSession(bool cleanSession) override; - - uint16_t mqttPublish(const char *topic, uint8_t qos, bool retain, const char *payload) override; - - uint16_t mqttPublish(const char *topic, uint8_t qos, bool retain, const uint8_t *payload, size_t length) override; - - bool mqttConnected() const override; - - void mqttSetServer(const char *host, uint16_t port) override; - - bool mqttConnect() override; - - bool mqttDisconnect(bool force) override; - - void setWill(const char *topic, uint8_t qos, bool retain, const char *payload) override; - - void mqttSetCredentials(const char *username, const char *password) override; - - void mqttOnMessage(espMqttClientTypes::OnMessageCallback callback) override; - - void mqttOnConnect(espMqttClientTypes::OnConnectCallback callback) override; - - void mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback) override; - - uint16_t mqttSubscribe(const char *topic, uint8_t qos) override; - - void disableMqtt() override; - private: void onDisconnected(); - MqttClient *getMqttClient() const; - - espMqttClient* _mqttClient = nullptr; - espMqttClientSecure* _mqttClientSecure = nullptr; bool _restartOnDisconnect = false; bool _startAp = false; char* _path; - bool _useEncryption = false; bool _hardwareInitialized = false; bool _lastConnected = false; @@ -89,7 +51,6 @@ private: eth_phy_type_t _type; eth_clock_mode_t _clock_mode; bool _use_mac_from_efuse; - bool _mqttEnabled = true; char _ca[TLS_CA_MAX_SIZE] = {0}; char _cert[TLS_CERT_MAX_SIZE] = {0}; diff --git a/networkDevices/NetworkDevice.cpp b/networkDevices/NetworkDevice.cpp new file mode 100644 index 0000000..6ca5d30 --- /dev/null +++ b/networkDevices/NetworkDevice.cpp @@ -0,0 +1,161 @@ +#include +#include "NetworkDevice.h" +#include "../Logger.h" + +void NetworkDevice::printError() +{ + Log->print(F("Free Heap: ")); + Log->println(ESP.getFreeHeap()); +} + +void NetworkDevice::update() +{ + if (_mqttEnabled) + { + getMqttClient()->loop(); + } +} + +void NetworkDevice::mqttSetClientId(const char *clientId) +{ + if (_useEncryption) + { + _mqttClientSecure->setClientId(clientId); + } + else + { + _mqttClient->setClientId(clientId); + } +} + +void NetworkDevice::mqttSetCleanSession(bool cleanSession) +{ + if (_useEncryption) + { + _mqttClientSecure->setCleanSession(cleanSession); + } + else + { + _mqttClient->setCleanSession(cleanSession); + } +} + +uint16_t NetworkDevice::mqttPublish(const char *topic, uint8_t qos, bool retain, const char *payload) +{ + return getMqttClient()->publish(topic, qos, retain, payload); +} + +uint16_t NetworkDevice::mqttPublish(const char *topic, uint8_t qos, bool retain, const uint8_t *payload, size_t length) +{ + return getMqttClient()->publish(topic, qos, retain, payload, length); +} + +bool NetworkDevice::mqttConnected() const +{ + return getMqttClient()->connected(); +} + +void NetworkDevice::mqttSetServer(const char *host, uint16_t port) +{ + if (_useEncryption) + { + _mqttClientSecure->setServer(host, port); + } + else + { + _mqttClient->setServer(host, port); + } +} + +bool NetworkDevice::mqttConnect() +{ + return getMqttClient()->connect(); +} + +bool NetworkDevice::mqttDisconnect(bool force) +{ + return getMqttClient()->disconnect(force); +} + +void NetworkDevice::setWill(const char *topic, uint8_t qos, bool retain, const char *payload) +{ + if (_useEncryption) + { + _mqttClientSecure->setWill(topic, qos, retain, payload); + } + else + { + _mqttClient->setWill(topic, qos, retain, payload); + } +} + +void NetworkDevice::mqttSetCredentials(const char *username, const char *password) +{ + if (_useEncryption) + { + _mqttClientSecure->setCredentials(username, password); + } + else + { + _mqttClient->setCredentials(username, password); + } +} + +void NetworkDevice::mqttOnMessage(espMqttClientTypes::OnMessageCallback callback) +{ + if (_useEncryption) + { + _mqttClientSecure->onMessage(callback); + } + else + { + _mqttClient->onMessage(callback); + } +} + +void NetworkDevice::mqttOnConnect(espMqttClientTypes::OnConnectCallback callback) +{ + if(_useEncryption) + { + _mqttClientSecure->onConnect(callback); + } + else + { + _mqttClient->onConnect(callback); + } +} + +void NetworkDevice::mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback) +{ + if (_useEncryption) + { + _mqttClientSecure->onDisconnect(callback); + } + else + { + _mqttClient->onDisconnect(callback); + } +} + +uint16_t NetworkDevice::mqttSubscribe(const char *topic, uint8_t qos) +{ + return getMqttClient()->subscribe(topic, qos); +} + +void NetworkDevice::disableMqtt() +{ + getMqttClient()->disconnect(); + _mqttEnabled = false; +} + +MqttClient *NetworkDevice::getMqttClient() const +{ + if (_useEncryption) + { + return _mqttClientSecure; + } + else + { + return _mqttClient; + } +} \ No newline at end of file diff --git a/networkDevices/NetworkDevice.h b/networkDevices/NetworkDevice.h index a850696..7c945ee 100644 --- a/networkDevices/NetworkDevice.h +++ b/networkDevices/NetworkDevice.h @@ -1,6 +1,6 @@ #pragma once -#include "MqttClient.h" +#include "espMqttClient.h" #include "MqttClientSetup.h" #include "IPConfiguration.h" @@ -24,32 +24,40 @@ public: virtual void initialize() = 0; virtual ReconnectStatus reconnect() = 0; virtual void reconfigure() = 0; - virtual void printError() = 0; + virtual void printError(); virtual bool supportsEncryption() = 0; - virtual void update() = 0; + virtual void update(); virtual bool isConnected() = 0; virtual int8_t signalStrength() = 0; - virtual void mqttSetClientId(const char* clientId) = 0; - virtual void mqttSetCleanSession(bool cleanSession) = 0; - virtual uint16_t mqttPublish(const char* topic, uint8_t qos, bool retain, const char* payload) = 0; - virtual uint16_t mqttPublish(const char* topic, uint8_t qos, bool retain, const uint8_t* payload, size_t length) = 0; - virtual bool mqttConnected() const = 0; - virtual void mqttSetServer(const char* host, uint16_t port) = 0; - virtual bool mqttConnect() = 0; - virtual bool mqttDisconnect(bool force) = 0; - virtual void setWill(const char* topic, uint8_t qos, bool retain, const char* payload) = 0; - virtual void mqttSetCredentials(const char* username, const char* password) = 0; - virtual void mqttOnMessage(espMqttClientTypes::OnMessageCallback callback) = 0; - virtual void mqttOnConnect(espMqttClientTypes::OnConnectCallback callback) = 0; - virtual void mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback) = 0; - virtual void disableMqtt() = 0; + virtual void mqttSetClientId(const char* clientId); + virtual void mqttSetCleanSession(bool cleanSession); + virtual uint16_t mqttPublish(const char* topic, uint8_t qos, bool retain, const char* payload); + virtual uint16_t mqttPublish(const char* topic, uint8_t qos, bool retain, const uint8_t* payload, size_t length); + virtual bool mqttConnected() const; + virtual void mqttSetServer(const char* host, uint16_t port); + virtual bool mqttConnect(); + virtual bool mqttDisconnect(bool force); + virtual void setWill(const char* topic, uint8_t qos, bool retain, const char* payload); + virtual void mqttSetCredentials(const char* username, const char* password); + virtual void mqttOnMessage(espMqttClientTypes::OnMessageCallback callback); + virtual void mqttOnConnect(espMqttClientTypes::OnConnectCallback callback); + virtual void mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback); + virtual void disableMqtt(); - virtual uint16_t mqttSubscribe(const char* topic, uint8_t qos) = 0; + virtual uint16_t mqttSubscribe(const char* topic, uint8_t qos); protected: + espMqttClient *_mqttClient = nullptr; + espMqttClientSecure *_mqttClientSecure = nullptr; + + bool _useEncryption = false; + bool _mqttEnabled = true; + const String _hostname; const IPConfiguration* _ipConfiguration = nullptr; + + MqttClient *getMqttClient() const; }; \ No newline at end of file diff --git a/networkDevices/W5500Device.cpp b/networkDevices/W5500Device.cpp index 6a89a3e..d7b45d3 100644 --- a/networkDevices/W5500Device.cpp +++ b/networkDevices/W5500Device.cpp @@ -26,6 +26,8 @@ W5500Device::W5500Device(const String &hostname, Preferences* preferences, const } } Log->println(); + + _mqttClient = new espMqttClientW5500(); } W5500Device::~W5500Device() @@ -61,7 +63,7 @@ void W5500Device::initialize() _path = new char[pathStr.length() + 1]; memset(_path, 0, sizeof(_path)); strcpy(_path, pathStr.c_str()); - Log = new MqttLogger(_mqttClient, _path, MqttLoggerMode::MqttAndSerial); + Log = new MqttLogger(*getMqttClient(), _path, MqttLoggerMode::MqttAndSerial); } reconnect(); @@ -161,13 +163,6 @@ void W5500Device::resetDevice() delay(50); } - -void W5500Device::printError() -{ - Log->print(F("Free Heap: ")); - Log->println(ESP.getFreeHeap()); -} - bool W5500Device::supportsEncryption() { return false; @@ -218,89 +213,10 @@ void W5500Device::initializeMacAddress(byte *mac) void W5500Device::update() { _maintainResult = Ethernet.maintain(); - if(_mqttEnabled) - { - _mqttClient.loop(); - } + NetworkDevice::update(); } int8_t W5500Device::signalStrength() { return 127; } - -void W5500Device::mqttSetClientId(const char *clientId) -{ - _mqttClient.setClientId(clientId); -} - -void W5500Device::mqttSetCleanSession(bool cleanSession) -{ - _mqttClient.setCleanSession(cleanSession); -} - -uint16_t W5500Device::mqttPublish(const char *topic, uint8_t qos, bool retain, const char *payload) -{ - return _mqttClient.publish(topic, qos, retain, payload); -} - -bool W5500Device::mqttConnected() const -{ - return _mqttClient.connected(); -} - -void W5500Device::mqttSetServer(const char *host, uint16_t port) -{ - _mqttClient.setServer(host, port); -} - -bool W5500Device::mqttConnect() -{ - return _mqttClient.connect(); -} - -bool W5500Device::mqttDisconnect(bool force) -{ - return _mqttClient.disconnect(force); -} - -void W5500Device::setWill(const char *topic, uint8_t qos, bool retain, const char *payload) -{ - _mqttClient.setWill(topic, qos, retain, payload); -} - -void W5500Device::mqttSetCredentials(const char *username, const char *password) -{ - _mqttClient.setCredentials(username, password); -} - -void W5500Device::mqttOnMessage(espMqttClientTypes::OnMessageCallback callback) -{ - _mqttClient.onMessage(callback); -} - -void W5500Device::mqttOnConnect(espMqttClientTypes::OnConnectCallback callback) -{ - _mqttClient.onConnect(callback); -} - -void W5500Device::mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback) -{ - _mqttClient.onDisconnect(callback); -} - -uint16_t W5500Device::mqttSubscribe(const char *topic, uint8_t qos) -{ - return _mqttClient.subscribe(topic, qos); -} - -uint16_t W5500Device::mqttPublish(const char *topic, uint8_t qos, bool retain, const uint8_t *payload, size_t length) -{ - return _mqttClient.publish(topic, qos, retain, payload, length); -} - -void W5500Device::disableMqtt() -{ - _mqttClient.disconnect(); - _mqttEnabled = false; -} diff --git a/networkDevices/W5500Device.h b/networkDevices/W5500Device.h index ca909eb..916198c 100644 --- a/networkDevices/W5500Device.h +++ b/networkDevices/W5500Device.h @@ -23,51 +23,19 @@ public: virtual void initialize(); virtual ReconnectStatus reconnect(); virtual void reconfigure(); - virtual void printError(); bool supportsEncryption() override; - virtual void update(); + virtual void update() override; virtual bool isConnected(); int8_t signalStrength() override; - void mqttSetClientId(const char *clientId) override; - - void mqttSetCleanSession(bool cleanSession) override; - - uint16_t mqttPublish(const char *topic, uint8_t qos, bool retain, const char *payload) override; - - uint16_t mqttPublish(const char *topic, uint8_t qos, bool retain, const uint8_t *payload, size_t length) override; - - bool mqttConnected() const override; - - void mqttSetServer(const char *host, uint16_t port) override; - - bool mqttConnect() override; - - bool mqttDisconnect(bool force) override; - - void setWill(const char *topic, uint8_t qos, bool retain, const char *payload) override; - - void mqttSetCredentials(const char *username, const char *password) override; - - void mqttOnMessage(espMqttClientTypes::OnMessageCallback callback) override; - - void mqttOnConnect(espMqttClientTypes::OnConnectCallback callback) override; - - void mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback) override; - - uint16_t mqttSubscribe(const char *topic, uint8_t qos) override; - - void disableMqtt() override; - private: void resetDevice(); void initializeMacAddress(byte* mac); - espMqttClientW5500 _mqttClient; Preferences* _preferences = nullptr; int _maintainResult = 0; @@ -76,7 +44,6 @@ private: char* _path; W5500Variant _variant; bool _lastConnected = false; - bool _mqttEnabled = true; byte _mac[6]; }; \ No newline at end of file diff --git a/networkDevices/WifiDevice.cpp b/networkDevices/WifiDevice.cpp index e57a485..11139c4 100644 --- a/networkDevices/WifiDevice.cpp +++ b/networkDevices/WifiDevice.cpp @@ -125,18 +125,6 @@ void WifiDevice::reconfigure() restartEsp(RestartReason::ReconfigureWifi); } -void WifiDevice::printError() -{ -// if(_wifiClientSecure != nullptr) -// { -// char lastError[100]; -// _wifiClientSecure->lastError(lastError,100); -// Log->println(lastError); -// } - Log->print(F("Free Heap: ")); - Log->println(ESP.getFreeHeap()); -} - bool WifiDevice::supportsEncryption() { return true; @@ -153,20 +141,6 @@ ReconnectStatus WifiDevice::reconnect() return isConnected() ? ReconnectStatus::Success : ReconnectStatus::Failure; } -void WifiDevice::update() -{ - if(_mqttEnabled) - { - if (_useEncryption) - { - _mqttClientSecure->loop(); - } else - { - _mqttClient->loop(); - } - } -} - void WifiDevice::onDisconnected() { if(millis() > 60000) @@ -184,198 +158,3 @@ void WifiDevice::clearRtcInitVar(WiFiManager *) { memset(WiFiDevice_reconfdetect, 0, sizeof WiFiDevice_reconfdetect); } - -void WifiDevice::mqttSetClientId(const char *clientId) -{ - if(_useEncryption) - { - _mqttClientSecure->setClientId(clientId); - } - else - { - _mqttClient->setClientId(clientId); - } -} - -void WifiDevice::mqttSetCleanSession(bool cleanSession) -{ - if(_useEncryption) - { - _mqttClientSecure->setCleanSession(cleanSession); - } - else - { - _mqttClient->setCleanSession(cleanSession); - } -} - -uint16_t WifiDevice::mqttPublish(const char *topic, uint8_t qos, bool retain, const char *payload) -{ - if(_useEncryption) - { - return _mqttClientSecure->publish(topic, qos, retain, payload); - } - else - { - return _mqttClient->publish(topic, qos, retain, payload); - } -} - -uint16_t WifiDevice::mqttPublish(const char *topic, uint8_t qos, bool retain, const uint8_t *payload, size_t length) -{ - if(_useEncryption) - { - return _mqttClientSecure->publish(topic, qos, retain, payload, length); - } - else - { - return _mqttClient->publish(topic, qos, retain, payload, length); - } -} - -bool WifiDevice::mqttConnected() const -{ - if(_useEncryption) - { - return _mqttClientSecure->connected(); - } - else - { - return _mqttClient->connected(); - } -} - -void WifiDevice::mqttSetServer(const char *host, uint16_t port) -{ - if(_useEncryption) - { - _mqttClientSecure->setServer(host, port); - } - else - { - _mqttClient->setServer(host, port); - } -} - -bool WifiDevice::mqttConnect() -{ - if(_useEncryption) - { - return _mqttClientSecure->connect(); - } - else - { - return _mqttClient->connect(); - } -} - -bool WifiDevice::mqttDisconnect(bool force) -{ - if(_useEncryption) - { - return _mqttClientSecure->disconnect(force); - } - else - { - return _mqttClient->disconnect(force); - } -} - -void WifiDevice::setWill(const char *topic, uint8_t qos, bool retain, const char *payload) -{ - if(_useEncryption) - { - _mqttClientSecure->setWill(topic, qos, retain, payload); - } - else - { - _mqttClient->setWill(topic, qos, retain, payload); - } -} - -void WifiDevice::mqttSetCredentials(const char *username, const char *password) -{ - if(_useEncryption) - { - _mqttClientSecure->setCredentials(username, password); - } - else - { - _mqttClient->setCredentials(username, password); - } -} - -void WifiDevice::mqttOnMessage(espMqttClientTypes::OnMessageCallback callback) -{ - if(_useEncryption) - { - _mqttClientSecure->onMessage(callback); - } - else - { - _mqttClient->onMessage(callback); - } -} - - -void WifiDevice::mqttOnConnect(espMqttClientTypes::OnConnectCallback callback) -{ - if(_useEncryption) - { - _mqttClientSecure->onConnect(callback); - } - else - { - _mqttClient->onConnect(callback); - } -} - -void WifiDevice::mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback) -{ - if(_useEncryption) - { - _mqttClientSecure->onDisconnect(callback); - } - else - { - _mqttClient->onDisconnect(callback); - } -} - - -uint16_t WifiDevice::mqttSubscribe(const char *topic, uint8_t qos) -{ - if(_useEncryption) - { - return _mqttClientSecure->subscribe(topic, qos); - } - else - { - return _mqttClient->subscribe(topic, qos); - } -} - -void WifiDevice::disableMqtt() -{ - if (_useEncryption) - { - _mqttClientSecure->disconnect(); - } else - { - _mqttClient->disconnect(); - } - - _mqttEnabled = false; -} - -MqttClient *WifiDevice::getMqttClient() const -{ - if (_useEncryption) - { - return _mqttClientSecure; - } - else - { - return _mqttClient; - } -} diff --git a/networkDevices/WifiDevice.h b/networkDevices/WifiDevice.h index c5f15b4..952b45f 100644 --- a/networkDevices/WifiDevice.h +++ b/networkDevices/WifiDevice.h @@ -18,61 +18,23 @@ public: virtual void initialize(); virtual void reconfigure(); virtual ReconnectStatus reconnect(); - virtual void printError(); bool supportsEncryption() override; - virtual void update(); - virtual bool isConnected(); int8_t signalStrength() override; - void mqttSetClientId(const char *clientId) override; - - void mqttSetCleanSession(bool cleanSession) override; - - uint16_t mqttPublish(const char *topic, uint8_t qos, bool retain, const char *payload) override; - - uint16_t mqttPublish(const char *topic, uint8_t qos, bool retain, const uint8_t *payload, size_t length) override; - - bool mqttConnected() const override; - - void mqttSetServer(const char *host, uint16_t port) override; - - bool mqttConnect() override; - - bool mqttDisconnect(bool force) override; - - void setWill(const char *topic, uint8_t qos, bool retain, const char *payload) override; - - void mqttSetCredentials(const char *username, const char *password) override; - - void mqttOnMessage(espMqttClientTypes::OnMessageCallback callback) override; - - void mqttOnConnect(espMqttClientTypes::OnConnectCallback callback) override; - - void mqttOnDisconnect(espMqttClientTypes::OnDisconnectCallback callback) override; - - uint16_t mqttSubscribe(const char *topic, uint8_t qos) override; - - void disableMqtt() override; - private: static void clearRtcInitVar(WiFiManager*); void onDisconnected(); - MqttClient *getMqttClient() const; WiFiManager _wm; - espMqttClient* _mqttClient = nullptr; - espMqttClientSecure* _mqttClientSecure = nullptr; Preferences* _preferences = nullptr; bool _restartOnDisconnect = false; bool _startAp = false; char* _path; - bool _useEncryption = false; - bool _mqttEnabled = true; char _ca[TLS_CA_MAX_SIZE] = {0}; char _cert[TLS_CERT_MAX_SIZE] = {0}; diff --git a/networkDevices/espMqttClientW5500.cpp b/networkDevices/espMqttClientW5500.cpp index f4ca520..91bfd5a 100644 --- a/networkDevices/espMqttClientW5500.cpp +++ b/networkDevices/espMqttClientW5500.cpp @@ -1,7 +1,7 @@ #include "espMqttClientW5500.h" espMqttClientW5500::espMqttClientW5500() -: MqttClientSetup(espMqttClientTypes::UseInternalTask::NO), +: espMqttClient(espMqttClientTypes::UseInternalTask::NO), _client() { _transport = &_client; diff --git a/networkDevices/espMqttClientW5500.h b/networkDevices/espMqttClientW5500.h index 55afc59..ba66dd9 100644 --- a/networkDevices/espMqttClientW5500.h +++ b/networkDevices/espMqttClientW5500.h @@ -1,9 +1,9 @@ #pragma once -#include "MqttClientSetup.h" +#include "espMqttClient.h" #include "ClientSyncW5500.h" -class espMqttClientW5500 : public MqttClientSetup { +class espMqttClientW5500 : public espMqttClient { public: #if defined(ARDUINO_ARCH_ESP32) explicit espMqttClientW5500(); From 645f7afa9d8cd8f79b6ea009a2deb1a4e3862346 Mon Sep 17 00:00:00 2001 From: Luca Oliano Date: Mon, 5 Feb 2024 16:15:48 +0100 Subject: [PATCH 3/9] fix build break --- .github/workflows/build.yml | 2 +- CMakeLists.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 169e88e..7ad00f9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -19,7 +19,7 @@ jobs: cd ~/arduino* ./install.sh ./arduino --pref "boardsmanager.additional.urls=https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json" --save-prefs - ./arduino --install-boards esp32:esp32 + ./arduino --install-boards esp32:esp32:2.0.9 - name: Install Arduino CMake Toolchain uses: actions/checkout@v2 with: diff --git a/CMakeLists.txt b/CMakeLists.txt index 5622c28..03c54ca 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -50,6 +50,7 @@ set(SRCFILES NetworkLock.cpp NetworkOpener.cpp networkDevices/NetworkDevice.h + networkDevices/NetworkDevice.cpp networkDevices/WifiDevice.cpp networkDevices/W5500Device.cpp networkDevices/EthLan8720Device.cpp From 0b05f374f54c79aae5e3bc727a1775bdc5a3bd61 Mon Sep 17 00:00:00 2001 From: iranl Date: Fri, 16 Feb 2024 21:30:03 +0100 Subject: [PATCH 4/9] MQTT JSON NukiOpener --- MqttTopics.h | 1 + NetworkOpener.cpp | 47 ++++++++++++++++++++++++++++++++++++----------- 2 files changed, 37 insertions(+), 11 deletions(-) diff --git a/MqttTopics.h b/MqttTopics.h index 78fc7a0..eaa1bcd 100644 --- a/MqttTopics.h +++ b/MqttTopics.h @@ -10,6 +10,7 @@ #define mqtt_topic_battery_keypad_critical "/battery/keypadCritical" #define mqtt_topic_lock_state "/lock/state" +#define mqtt_topic_lock_json "/lock/json" #define mqtt_topic_query_config "/lock/query/config" #define mqtt_topic_query_lockstate "/lock/query/lockstate" #define mqtt_topic_query_keypad "/lock/query/keypad" diff --git a/NetworkOpener.cpp b/NetworkOpener.cpp index 89e5a4f..38dc947 100644 --- a/NetworkOpener.cpp +++ b/NetworkOpener.cpp @@ -202,18 +202,20 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn _currentLockState = keyTurnerState.lockState; char str[50]; + 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) - { - memset(&str, 0, sizeof(str)); - + { if(keyTurnerState.nukiState == NukiOpener::State::ContinuousMode) { publishString(mqtt_topic_lock_state, "ContinuousMode"); } else { - lockstateToString(keyTurnerState.lockState, str); publishString(mqtt_topic_lock_state, str); } @@ -222,35 +224,58 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn publishBinaryState(keyTurnerState); } } + + json["lock_state"] = str; + + if(keyTurnerState.nukiState == NukiOpener::State::ContinuousMode) + { + json["continuous_mode"] = true; + } else { + json["continuous_mode"] = false; + } + + memset(&str, 0, sizeof(str)); + triggerToString(keyTurnerState.trigger, str); if(_firstTunerStatePublish || keyTurnerState.trigger != lastKeyTurnerState.trigger) { - memset(&str, 0, sizeof(str)); - triggerToString(keyTurnerState.trigger, str); publishString(mqtt_topic_lock_trigger, str); } + + json["trigger"] = str; + memset(&str, 0, sizeof(str)); + completionStatusToString(keyTurnerState.lastLockActionCompletionStatus, str); if(_firstTunerStatePublish || keyTurnerState.lastLockActionCompletionStatus != lastKeyTurnerState.lastLockActionCompletionStatus) { - memset(&str, 0, sizeof(str)); - completionStatusToString(keyTurnerState.lastLockActionCompletionStatus, str); publishString(mqtt_topic_lock_completionStatus, str); } + + json["lock_completion_status"] = str; + + memset(&str, 0, sizeof(str)); + NukiOpener::doorSensorStateToString(keyTurnerState.doorSensorState, str); if(_firstTunerStatePublish || keyTurnerState.doorSensorState != lastKeyTurnerState.doorSensorState) { - memset(&str, 0, sizeof(str)); - NukiOpener::doorSensorStateToString(keyTurnerState.doorSensorState, str); publishString(mqtt_topic_lock_door_sensor_state, str); } + + json["door_sensor_state"] = str; + + bool critical = (keyTurnerState.criticalBatteryState & 0b00000001) > 0; if(_firstTunerStatePublish || keyTurnerState.criticalBatteryState != lastKeyTurnerState.criticalBatteryState) { - bool critical = (keyTurnerState.criticalBatteryState & 0b00000001) > 0; publishBool(mqtt_topic_battery_critical, critical); } + json["battery_critical"] = critical; + + serializeJson(json, _buffer, _bufferSize); + publishString(mqtt_topic_lock_json, _buffer); + _firstTunerStatePublish = false; } From 8757197c367181c8f4f5575f304a2c42242b0f0f Mon Sep 17 00:00:00 2001 From: iranl Date: Fri, 16 Feb 2024 21:37:47 +0100 Subject: [PATCH 5/9] MQTT JSON NukiLock --- NetworkLock.cpp | 71 ++++++++++++++++++++++++++++++++--------------- NetworkOpener.cpp | 2 +- 2 files changed, 50 insertions(+), 23 deletions(-) diff --git a/NetworkLock.cpp b/NetworkLock.cpp index 549afc5..59c74d2 100644 --- a/NetworkLock.cpp +++ b/NetworkLock.cpp @@ -209,11 +209,15 @@ void NetworkLock::onMqttDataReceived(const char* topic, byte* payload, const uns void NetworkLock::publishKeyTurnerState(const NukiLock::KeyTurnerState& keyTurnerState, const NukiLock::KeyTurnerState& lastKeyTurnerState) { char str[50]; + memset(&str, 0, sizeof(str)); + + DynamicJsonDocument json(_bufferSize); + + lockstateToString(keyTurnerState.lockState, str); if((_firstTunerStatePublish || keyTurnerState.lockState != lastKeyTurnerState.lockState) && keyTurnerState.lockState != NukiLock::LockState::Undefined) { - memset(&str, 0, sizeof(str)); - lockstateToString(keyTurnerState.lockState, str); + publishString(mqtt_topic_lock_state, str); if(_haEnabled) @@ -222,57 +226,80 @@ void NetworkLock::publishKeyTurnerState(const NukiLock::KeyTurnerState& keyTurne } } + json["lock_state"] = str; + + memset(&str, 0, sizeof(str)); + triggerToString(keyTurnerState.trigger, str); + if(_firstTunerStatePublish || keyTurnerState.trigger != lastKeyTurnerState.trigger) { - memset(&str, 0, sizeof(str)); - triggerToString(keyTurnerState.trigger, str); publishString(mqtt_topic_lock_trigger, str); } + json["trigger"] = str; + + memset(&str, 0, sizeof(str)); + lockactionToString(keyTurnerState.lastLockAction, str); + if(_firstTunerStatePublish || keyTurnerState.lastLockAction != lastKeyTurnerState.lastLockAction) { - memset(&str, 0, sizeof(str)); - lockactionToString(keyTurnerState.lastLockAction, str); publishString(mqtt_topic_lock_last_lock_action, str); } + json["last_lock_action"] = str; + + memset(&str, 0, sizeof(str)); + NukiLock::completionStatusToString(keyTurnerState.lastLockActionCompletionStatus, str); + if(_firstTunerStatePublish || keyTurnerState.lastLockActionCompletionStatus != lastKeyTurnerState.lastLockActionCompletionStatus) { - memset(&str, 0, sizeof(str)); - NukiLock::completionStatusToString(keyTurnerState.lastLockActionCompletionStatus, str); publishString(mqtt_topic_lock_completionStatus, str); } + json["lock_completion_status"] = str; + + memset(&str, 0, sizeof(str)); + NukiLock::doorSensorStateToString(keyTurnerState.doorSensorState, str); + if(_firstTunerStatePublish || keyTurnerState.doorSensorState != lastKeyTurnerState.doorSensorState) { - memset(&str, 0, sizeof(str)); - NukiLock::doorSensorStateToString(keyTurnerState.doorSensorState, str); publishString(mqtt_topic_lock_door_sensor_state, str); } + 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) { - 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); - } + publishBool(mqtt_topic_battery_keypad_critical, keypadBatteryCritical); } + json["keypad_battery_critical"] = keypadBatteryCritical; + _firstTunerStatePublish = false; } diff --git a/NetworkOpener.cpp b/NetworkOpener.cpp index 38dc947..71c6788 100644 --- a/NetworkOpener.cpp +++ b/NetworkOpener.cpp @@ -271,7 +271,7 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn publishBool(mqtt_topic_battery_critical, critical); } - json["battery_critical"] = critical; + json["battery_critical"] = critical; serializeJson(json, _buffer, _bufferSize); publishString(mqtt_topic_lock_json, _buffer); From c2615e537a26382bd17e3b26a7a5ee9530823059 Mon Sep 17 00:00:00 2001 From: iranl Date: Fri, 16 Feb 2024 21:40:44 +0100 Subject: [PATCH 6/9] Update NetworkLock.cpp --- NetworkLock.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/NetworkLock.cpp b/NetworkLock.cpp index 59c74d2..f1026b4 100644 --- a/NetworkLock.cpp +++ b/NetworkLock.cpp @@ -286,7 +286,7 @@ void NetworkLock::publishKeyTurnerState(const NukiLock::KeyTurnerState& keyTurne bool keypadBatteryCritical; if ((keyTurnerState.accessoryBatteryState & (1 << 7)) != 0) { - keypadBatteryCritical = (keyTurnerState.accessoryBatteryState & (1 << 6)) != 0); + keypadBatteryCritical = ((keyTurnerState.accessoryBatteryState & (1 << 6)) != 0); } else { From 7937ec8c65c881aa0c17222210b4812a10b6f0c8 Mon Sep 17 00:00:00 2001 From: iranl Date: Sat, 17 Feb 2024 11:42:03 +0100 Subject: [PATCH 7/9] Add auth info --- NetworkLock.cpp | 4 ++-- NetworkLock.h | 6 ++++-- NetworkOpener.cpp | 4 ++-- NetworkOpener.h | 3 +++ NukiWrapper.cpp | 11 ++++++----- 5 files changed, 17 insertions(+), 11 deletions(-) diff --git a/NetworkLock.cpp b/NetworkLock.cpp index f1026b4..c87ed30 100644 --- a/NetworkLock.cpp +++ b/NetworkLock.cpp @@ -299,6 +299,8 @@ void NetworkLock::publishKeyTurnerState(const NukiLock::KeyTurnerState& keyTurne } json["keypad_battery_critical"] = keypadBatteryCritical; + json["auth_id"] = authId; + json["auth_name"] = authName; _firstTunerStatePublish = false; } @@ -328,8 +330,6 @@ void NetworkLock::publishAuthorizationInfo(const std::list& char str[50]; bool authFound = false; - uint32_t authId = 0; - char authName[33]; memset(authName, 0, sizeof(authName)); DynamicJsonDocument json(_bufferSize); diff --git a/NetworkLock.h b/NetworkLock.h index 95f0e88..866a18a 100644 --- a/NetworkLock.h +++ b/NetworkLock.h @@ -73,14 +73,16 @@ private: bool _firstTunerStatePublish = true; unsigned long _lastMaintenanceTs = 0; - bool _haEnabled= false; + bool _haEnabled = false; bool _reconnected = false; String _keypadCommandName = ""; String _keypadCommandCode = ""; uint _keypadCommandId = 0; int _keypadCommandEnabled = 1; - uint8_t _queryCommands = 0; + uint8_t _queryCommands = 0; + uint32_t authId = 0; + char authName[33]; char* _buffer; size_t _bufferSize; diff --git a/NetworkOpener.cpp b/NetworkOpener.cpp index 71c6788..f5e1e60 100644 --- a/NetworkOpener.cpp +++ b/NetworkOpener.cpp @@ -272,6 +272,8 @@ void NetworkOpener::publishKeyTurnerState(const NukiOpener::OpenerState& keyTurn } json["battery_critical"] = critical; + json["auth_id"] = authId; + json["auth_name"] = authName; serializeJson(json, _buffer, _bufferSize); publishString(mqtt_topic_lock_json, _buffer); @@ -314,8 +316,6 @@ void NetworkOpener::publishAuthorizationInfo(const std::listpublishKeyTurnerState(_keyTurnerState, _lastKeyTurnerState); updateGpioOutputs(); @@ -333,11 +339,6 @@ void NukiWrapper::updateKeyTurnerState() lockstateToString(_keyTurnerState.lockState, lockStateStr); Log->println(lockStateStr); - if(_publishAuthData) - { - updateAuthData(); - } - postponeBleWatchdog(); } From fc767ddfab55398d3ade81f8707c865dffdfab92 Mon Sep 17 00:00:00 2001 From: iranl Date: Sat, 17 Feb 2024 12:00:47 +0100 Subject: [PATCH 8/9] MQTT JSON Keypad --- MqttTopics.h | 1 + Network.cpp | 52 ++++++++++++++++++++++---------------------- NetworkLock.cpp | 55 ++++++++++++++++++++++++++++++----------------- NetworkOpener.cpp | 44 ++++++++++++++++++++++++++----------- WebCfgServer.cpp | 2 +- 5 files changed, 94 insertions(+), 60 deletions(-) diff --git a/MqttTopics.h b/MqttTopics.h index eaa1bcd..2ae0187 100644 --- 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" diff --git a/Network.cpp b/Network.cpp index 5ea1781..428c05a 100644 --- 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; } diff --git a/NetworkLock.cpp b/NetworkLock.cpp index c87ed30..01c877b 100644 --- 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& 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; diff --git a/NetworkOpener.cpp b/NetworkOpener.cpp index f5e1e60..e24751a 100644 --- 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& 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; diff --git a/WebCfgServer.cpp b/WebCfgServer.cpp index daacb29..4103f84 100644 --- a/WebCfgServer.cpp +++ b/WebCfgServer.cpp @@ -1368,4 +1368,4 @@ String WebCfgServer::getPreselectionForGpio(const uint8_t &pin) } return String((int8_t)PinRole::Disabled); -} +} \ No newline at end of file From 2e40e51368583bc6476353e3ec92eeeb0ff6bd4b Mon Sep 17 00:00:00 2001 From: iranl Date: Sat, 17 Feb 2024 16:30:40 +0100 Subject: [PATCH 9/9] Hide GitHub buttons on OTA --- WebCfgServer.cpp | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/WebCfgServer.cpp b/WebCfgServer.cpp index daacb29..413e6a4 100644 --- a/WebCfgServer.cpp +++ b/WebCfgServer.cpp @@ -744,13 +744,13 @@ void WebCfgServer::buildOtaHtml(String &response, bool errored) if(_preferences->getBool(preference_check_updates)) { - response.concat(""); response.concat("

"); + response.concat("'); return false;\">Download latest binary from GitHub"); } response.concat("
Initiating Over-the-air update. This will take about two minutes, please be patient.
You will be forwarded automatically when the update is complete.
"); @@ -760,6 +760,7 @@ void WebCfgServer::buildOtaHtml(String &response, bool errored) response.concat(" button.addEventListener('click',hideshow,false);"); response.concat(" function hideshow() {"); response.concat(" document.getElementById('upform').style.visibility = 'hidden';"); + response.concat(" document.getElementById('gitdiv').style.visibility = 'hidden';"); response.concat(" document.getElementById('msgdiv').style.visibility = 'visible';"); response.concat(" }"); response.concat("});"); @@ -1368,4 +1369,4 @@ String WebCfgServer::getPreselectionForGpio(const uint8_t &pin) } return String((int8_t)PinRole::Disabled); -} +} \ No newline at end of file