move common network code to seperate class

This commit is contained in:
technyon
2022-07-02 12:04:03 +02:00
parent cb35eae2f7
commit beb87a959f
12 changed files with 549 additions and 411 deletions

View File

@@ -5,75 +5,26 @@
#include "PreferencesKeys.h"
#include "Pins.h"
NetworkLock* nwInst;
NetworkLock::NetworkLock(const NetworkDeviceType networkDevice, Preferences* preferences)
: _preferences(preferences)
NetworkLock::NetworkLock(Network* network, Preferences* preferences)
: _network(network),
_preferences(preferences)
{
nwInst = this;
_hostname = _preferences->getString(preference_hostname);
setupDevice(networkDevice);
_configTopics.reserve(5);
_configTopics.push_back(mqtt_topic_config_button_enabled);
_configTopics.push_back(mqtt_topic_config_led_enabled);
_configTopics.push_back(mqtt_topic_config_led_brightness);
_configTopics.push_back(mqtt_topic_config_auto_unlock);
_configTopics.push_back(mqtt_topic_config_auto_lock);
_network->registerMqttReceiver(this);
}
NetworkLock::~NetworkLock()
{
if(_device != nullptr)
{
delete _device;
_device = nullptr;
}
}
void NetworkLock::setupDevice(const NetworkDeviceType hardware)
{
switch(hardware)
{
case NetworkDeviceType::W5500:
Serial.println(F("Network device: W5500"));
_device = new W5500Device(_hostname, _preferences);
break;
case NetworkDeviceType::WiFi:
Serial.println(F("Network device: Builtin WiFi"));
_device = new WifiDevice(_hostname, _preferences);
break;
default:
Serial.println(F("Unknown network device type, defaulting to WiFi"));
_device = new WifiDevice(_hostname, _preferences);
break;
}
}
void NetworkLock::initialize()
{
if(_hostname == "")
{
_hostname = "nukihub";
_preferences->putString(preference_hostname, _hostname);
}
_device->initialize();
Serial.print(F("Host name: "));
Serial.println(_hostname);
const char* brokerAddr = _preferences->getString(preference_mqtt_broker).c_str();
strcpy(_mqttBrokerAddr, brokerAddr);
int port = _preferences->getInt(preference_mqtt_broker_port);
if(port == 0)
{
port = 1883;
_preferences->putInt(preference_mqtt_broker_port, port);
}
String mqttPath = _preferences->getString(preference_mqtt_lock_path);
if(mqttPath.length() > 0)
{
@@ -89,122 +40,15 @@ void NetworkLock::initialize()
_preferences->putString(preference_mqtt_lock_path, _mqttPath);
}
String mqttUser = _preferences->getString(preference_mqtt_user);
if(mqttUser.length() > 0)
_network->subscribe(_mqttPath, mqtt_topic_lock_action);
for(const auto& topic : _configTopics)
{
size_t len = mqttUser.length();
for(int i=0; i < len; i++)
{
_mqttUser[i] = mqttUser.charAt(i);
}
_network->subscribe(_mqttPath, topic);
}
String mqttPass = _preferences->getString(preference_mqtt_password);
if(mqttPass.length() > 0)
{
size_t len = mqttPass.length();
for(int i=0; i < len; i++)
{
_mqttPass[i] = mqttPass.charAt(i);
}
}
Serial.print(F("MQTT Broker: "));
Serial.print(_mqttBrokerAddr);
Serial.print(F(":"));
Serial.println(port);
_device->mqttClient()->setServer(_mqttBrokerAddr, port);
_device->mqttClient()->setCallback(NetworkLock::onMqttDataReceivedCallback);
_networkTimeout = _preferences->getInt(preference_network_timeout);
if(_networkTimeout == 0)
{
_networkTimeout = -1;
_preferences->putInt(preference_network_timeout, _networkTimeout);
}
}
bool NetworkLock::reconnect()
{
_mqttConnected = false;
while (!_device->mqttClient()->connected() && millis() > _nextReconnect)
{
Serial.println(F("Attempting MQTT connection"));
bool success = false;
if(strlen(_mqttUser) == 0)
{
Serial.println(F("MQTT: Connecting without credentials"));
success = _device->mqttClient()->connect(_preferences->getString(preference_hostname).c_str());
}
else
{
Serial.print(F("MQTT: Connecting with user: ")); Serial.println(_mqttUser);
success = _device->mqttClient()->connect(_preferences->getString(preference_hostname).c_str(), _mqttUser, _mqttPass);
}
if (success)
{
Serial.println(F("MQTT connected"));
_mqttConnected = true;
delay(100);
subscribe(mqtt_topic_lock_action);
for(auto topic : _configTopics)
{
subscribe(topic);
}
}
else
{
Serial.print(F("MQTT connect failed, rc="));
Serial.println(_device->mqttClient()->state());
_device->printError();
_device->mqttClient()->disconnect();
_mqttConnected = false;
_nextReconnect = millis() + 5000;
}
}
return _mqttConnected;
}
void NetworkLock::update()
{
long ts = millis();
_device->update();
if(!_device->isConnected())
{
Serial.println(F("Network not connected. Trying reconnect."));
bool success = _device->reconnect();
Serial.println(success ? F("Reconnect successful") : F("Reconnect failed"));
}
if(!_device->isConnected())
{
if(_networkTimeout > 0 && (ts - _lastConnectedTs > _networkTimeout * 1000))
{
Serial.println("Network timeout has been reached, restarting ...");
delay(200);
ESP.restart();
}
return;
}
_lastConnectedTs = ts;
if(!_device->mqttClient()->connected())
{
bool success = reconnect();
if(!success)
{
return;
}
}
if(_presenceCsv != nullptr && strlen(_presenceCsv) > 0)
{
bool success = publishString(mqtt_topic_presence, _presenceCsv);
@@ -215,13 +59,6 @@ void NetworkLock::update()
}
_presenceCsv = nullptr;
}
_device->mqttClient()->loop();
}
void NetworkLock::onMqttDataReceivedCallback(char *topic, byte *payload, unsigned int length)
{
nwInst->onMqttDataReceived(topic, payload, length);
}
void NetworkLock::onMqttDataReceived(char *&topic, byte *&payload, unsigned int &length)
@@ -349,97 +186,6 @@ void NetworkLock::publishPresenceDetection(char *csv)
_presenceCsv = csv;
}
void NetworkLock::publishHASSConfig(char* deviceType, const char* baseTopic, char* name, char* uidString, char* lockAction, char* unlockAction, char* openAction, char* lockedState, char* unlockedState)
{
String discoveryTopic = _preferences->getString(preference_mqtt_hass_discovery);
if(discoveryTopic != "")
{
String configJSON = "{\"dev\":{\"ids\":[\"nuki_";
configJSON.concat(uidString);
configJSON.concat("\"],\"mf\":\"Nuki\",\"mdl\":\"");
configJSON.concat(deviceType);
configJSON.concat("\",\"name\":\"");
configJSON.concat(name);
configJSON.concat("\"},\"~\":\"");
configJSON.concat(baseTopic);
configJSON.concat("\",\"name\":\"");
configJSON.concat(name);
configJSON.concat("\",\"unique_id\":\"");
configJSON.concat(uidString);
configJSON.concat("_lock\",\"cmd_t\":\"~");
configJSON.concat(mqtt_topic_lock_action);
configJSON.concat("\",\"pl_lock\":\"");
configJSON.concat(lockAction);
configJSON.concat("\",\"pl_unlk\":\"");
configJSON.concat(unlockAction);
configJSON.concat("\",\"pl_open\":\"");
configJSON.concat(openAction);
configJSON.concat("\",\"stat_t\":\"~");
configJSON.concat(mqtt_topic_lock_state);
configJSON.concat("\",\"stat_locked\":\"");
configJSON.concat(lockedState);
configJSON.concat("\",\"stat_unlocked\":\"");
configJSON.concat(unlockedState);
configJSON.concat("\",\"opt\":\"false\"}");
String path = discoveryTopic;
path.concat("/lock/");
path.concat(uidString);
path.concat("/smartlock/config");
Serial.println("HASS Config:");
Serial.println(configJSON);
_device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true);
configJSON = "{\"dev\":{\"ids\":[\"nuki_";
configJSON.concat(uidString);
configJSON.concat("\"],\"mf\":\"Nuki\",\"mdl\":\"");
configJSON.concat(deviceType);
configJSON.concat("\",\"name\":\"");
configJSON.concat(name);
configJSON.concat("\"},\"~\":\"");
configJSON.concat(baseTopic);
configJSON.concat("\",\"name\":\"");
configJSON.concat(name);
configJSON.concat(" battery low\",\"unique_id\":\"");
configJSON.concat(uidString);
configJSON.concat("_battery_low\",\"dev_cla\":\"battery\",\"ent_cat\":\"diagnostic\",\"pl_off\":\"0\",\"pl_on\":\"1\",\"stat_t\":\"~");
configJSON.concat(mqtt_topic_battery_critical);
configJSON.concat("\"}");
path = discoveryTopic;
path.concat("/binary_sensor/");
path.concat(uidString);
path.concat("/battery_low/config");
_device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true);
}
}
void NetworkLock::removeHASSConfig(char* uidString)
{
String discoveryTopic = _preferences->getString(preference_mqtt_hass_discovery);
if(discoveryTopic != "")
{
String path = discoveryTopic;
path.concat("/lock/");
path.concat(uidString);
path.concat("/smartlock/config");
_device->mqttClient()->publish(path.c_str(), NULL, 0U, true);
path = discoveryTopic;
path.concat("/binary_sensor/");
path.concat(uidString);
path.concat("/battery_low/config");
_device->mqttClient()->publish(path.c_str(), NULL, 0U, true);
}
}
void NetworkLock::setLockActionReceivedCallback(bool (*lockActionReceivedCallback)(const char *))
{
_lockActionReceivedCallback = lockActionReceivedCallback;
@@ -455,54 +201,6 @@ void NetworkLock::setMqttDataReceivedForwardCallback(void (*callback)(char *, ui
_mqttTopicReceivedForwardCallback = callback;
}
void NetworkLock::publishFloat(const char* topic, const float value, const uint8_t precision)
{
char str[30];
dtostrf(value, 0, precision, str);
char path[200] = {0};
buildMqttPath(topic, path);
_device->mqttClient()->publish(path, str, true);
}
void NetworkLock::publishInt(const char *topic, const int value)
{
char str[30];
itoa(value, str, 10);
char path[200] = {0};
buildMqttPath(topic, path);
_device->mqttClient()->publish(path, str, true);
}
void NetworkLock::publishUInt(const char *topic, const unsigned int value)
{
char str[30];
utoa(value, str, 10);
char path[200] = {0};
buildMqttPath(topic, path);
_device->mqttClient()->publish(path, str, true);
}
void NetworkLock::publishBool(const char *topic, const bool value)
{
char str[2] = {0};
str[0] = value ? '1' : '0';
char path[200] = {0};
buildMqttPath(topic, path);
_device->mqttClient()->publish(path, str, true);
}
bool NetworkLock::publishString(const char *topic, const char *value)
{
char path[200] = {0};
buildMqttPath(topic, path);
return _device->mqttClient()->publish(path, value, true);
}
bool NetworkLock::isMqttConnected()
{
return _mqttConnected;
}
void NetworkLock::buildMqttPath(const char* path, char* outPath)
{
int offset = 0;
@@ -525,16 +223,10 @@ void NetworkLock::buildMqttPath(const char* path, char* outPath)
outPath[i+1] = 0x00;
}
void NetworkLock::subscribe(const char *path)
{
char prefixedPath[500];
buildMqttPath(path, prefixedPath);
_device->mqttClient()->subscribe(prefixedPath);
}
void NetworkLock::restartAndConfigureWifi()
{
_device->reconfigure();
_network->reconfigureDevice();
}
bool NetworkLock::comparePrefixedPath(const char *fullPath, const char *subPath)
@@ -544,7 +236,39 @@ bool NetworkLock::comparePrefixedPath(const char *fullPath, const char *subPath)
return strcmp(fullPath, prefixedPath) == 0;
}
NetworkDevice *NetworkLock::device()
void
NetworkLock::publishHASSConfig(char *deviceType, const char *baseTopic, char *name, char *uidString, char *lockAction,
char *unlockAction, char *openAction, char *lockedState, char *unlockedState)
{
return _device;
_network->publishHASSConfig(deviceType, baseTopic, name, uidString, lockAction, unlockAction, openAction, lockedState, unlockedState);
}
void NetworkLock::removeHASSConfig(char *uidString)
{
_network->removeHASSConfig(uidString);
}
void NetworkLock::publishFloat(const char *topic, const float value, const uint8_t precision)
{
_network->publishFloat(_mqttPath, topic, value, precision);
}
void NetworkLock::publishInt(const char *topic, const int value)
{
_network->publishInt(_mqttPath, topic, value);
}
void NetworkLock::publishUInt(const char *topic, const unsigned int value)
{
_network->publishUInt(_mqttPath, topic, value);
}
void NetworkLock::publishBool(const char *topic, const bool value)
{
_network->publishBool(_mqttPath, topic, value);
}
bool NetworkLock::publishString(const char *topic, const char *value)
{
return _network->publishString(_mqttPath, topic, value);
}