From 6127fc331e8d740e3f2423cda88925f3e91389fc Mon Sep 17 00:00:00 2001 From: technyon Date: Mon, 16 Jan 2023 20:41:08 +0100 Subject: [PATCH] replace PubSubClient with arduino mqtt lib --- CMakeLists.txt | 5 +- MqttReceiver.h | 2 +- Network.cpp | 147 +- Network.h | 6 +- NetworkLock.cpp | 28 +- NetworkLock.h | 5 +- NetworkOpener.cpp | 24 +- NetworkOpener.h | 5 +- lib/ArduinoMqttClient/.codespellrc | 7 + lib/ArduinoMqttClient/LICENSE.txt | 504 +++++++ lib/ArduinoMqttClient/README.adoc | 10 + .../WiFiAdvancedCallback.ino | 190 +++ .../WiFiAdvancedCallback/arduino_secrets.h | 2 + .../examples/WiFiEcho/WiFiEcho.ino | 146 ++ .../examples/WiFiEcho/arduino_secrets.h | 2 + .../WiFiEchoCallback/WiFiEchoCallback.ino | 151 +++ .../WiFiEchoCallback/arduino_secrets.h | 2 + .../WiFiSimpleReceive/WiFiSimpleReceive.ino | 114 ++ .../WiFiSimpleReceive/arduino_secrets.h | 2 + .../WiFiSimpleReceiveCallback.ino | 121 ++ .../arduino_secrets.h | 2 + .../WiFiSimpleSender/WiFiSimpleSender.ino | 115 ++ .../WiFiSimpleSender/arduino_secrets.h | 2 + lib/ArduinoMqttClient/keywords.txt | 52 + lib/ArduinoMqttClient/library.properties | 10 + lib/ArduinoMqttClient/src/ArduinoMqttClient.h | 25 + lib/ArduinoMqttClient/src/MqttClient.cpp | 1200 +++++++++++++++++ lib/ArduinoMqttClient/src/MqttClient.h | 200 +++ lib/MqttLogger/src/MqttLogger.cpp | 8 +- lib/MqttLogger/src/MqttLogger.h | 10 +- lib/pubsubclient/.travis.yml | 7 - lib/pubsubclient/CHANGES.txt | 85 -- lib/pubsubclient/LICENSE.txt | 20 - lib/pubsubclient/README.md | 50 - .../examples/mqtt_auth/mqtt_auth.ino | 43 - .../examples/mqtt_basic/mqtt_basic.ino | 77 -- .../examples/mqtt_esp8266/mqtt_esp8266.ino | 129 -- .../mqtt_large_message/mqtt_large_message.ino | 179 --- .../mqtt_publish_in_callback.ino | 60 - .../mqtt_reconnect_nonblocking.ino | 67 - .../examples/mqtt_stream/mqtt_stream.ino | 57 - lib/pubsubclient/keywords.txt | 36 - lib/pubsubclient/library.json | 18 - lib/pubsubclient/library.properties | 9 - lib/pubsubclient/src/PubSubClient.cpp | 769 ----------- lib/pubsubclient/src/PubSubClient.h | 184 --- lib/pubsubclient/tests/.gitignore | 4 - lib/pubsubclient/tests/Makefile | 25 - lib/pubsubclient/tests/README.md | 93 -- lib/pubsubclient/tests/src/connect_spec.cpp | 336 ----- lib/pubsubclient/tests/src/keepalive_spec.cpp | 185 --- lib/pubsubclient/tests/src/lib/Arduino.h | 26 - lib/pubsubclient/tests/src/lib/BDDTest.cpp | 50 - lib/pubsubclient/tests/src/lib/BDDTest.h | 23 - lib/pubsubclient/tests/src/lib/Buffer.cpp | 34 - lib/pubsubclient/tests/src/lib/Buffer.h | 23 - lib/pubsubclient/tests/src/lib/Client.h | 21 - lib/pubsubclient/tests/src/lib/IPAddress.cpp | 44 - lib/pubsubclient/tests/src/lib/IPAddress.h | 72 - lib/pubsubclient/tests/src/lib/Print.h | 28 - lib/pubsubclient/tests/src/lib/ShimClient.cpp | 153 --- lib/pubsubclient/tests/src/lib/ShimClient.h | 51 - lib/pubsubclient/tests/src/lib/Stream.cpp | 39 - lib/pubsubclient/tests/src/lib/Stream.h | 22 - lib/pubsubclient/tests/src/lib/trace.h | 10 - lib/pubsubclient/tests/src/publish_spec.cpp | 191 --- lib/pubsubclient/tests/src/receive_spec.cpp | 340 ----- lib/pubsubclient/tests/src/subscribe_spec.cpp | 178 --- lib/pubsubclient/tests/testcases/__init__.py | 0 .../tests/testcases/mqtt_basic.py | 39 - .../testcases/mqtt_publish_in_callback.py | 59 - lib/pubsubclient/tests/testcases/settings.py | 2 - lib/pubsubclient/tests/testsuite.py | 181 --- networkDevices/NetworkDevice.h | 4 +- networkDevices/W5500Device.cpp | 4 +- networkDevices/W5500Device.h | 4 +- networkDevices/WifiDevice.cpp | 6 +- networkDevices/WifiDevice.h | 4 +- 78 files changed, 3042 insertions(+), 4096 deletions(-) create mode 100644 lib/ArduinoMqttClient/.codespellrc create mode 100644 lib/ArduinoMqttClient/LICENSE.txt create mode 100644 lib/ArduinoMqttClient/README.adoc create mode 100644 lib/ArduinoMqttClient/examples/WiFiAdvancedCallback/WiFiAdvancedCallback.ino create mode 100644 lib/ArduinoMqttClient/examples/WiFiAdvancedCallback/arduino_secrets.h create mode 100644 lib/ArduinoMqttClient/examples/WiFiEcho/WiFiEcho.ino create mode 100644 lib/ArduinoMqttClient/examples/WiFiEcho/arduino_secrets.h create mode 100644 lib/ArduinoMqttClient/examples/WiFiEchoCallback/WiFiEchoCallback.ino create mode 100644 lib/ArduinoMqttClient/examples/WiFiEchoCallback/arduino_secrets.h create mode 100644 lib/ArduinoMqttClient/examples/WiFiSimpleReceive/WiFiSimpleReceive.ino create mode 100644 lib/ArduinoMqttClient/examples/WiFiSimpleReceive/arduino_secrets.h create mode 100644 lib/ArduinoMqttClient/examples/WiFiSimpleReceiveCallback/WiFiSimpleReceiveCallback.ino create mode 100644 lib/ArduinoMqttClient/examples/WiFiSimpleReceiveCallback/arduino_secrets.h create mode 100644 lib/ArduinoMqttClient/examples/WiFiSimpleSender/WiFiSimpleSender.ino create mode 100644 lib/ArduinoMqttClient/examples/WiFiSimpleSender/arduino_secrets.h create mode 100644 lib/ArduinoMqttClient/keywords.txt create mode 100644 lib/ArduinoMqttClient/library.properties create mode 100644 lib/ArduinoMqttClient/src/ArduinoMqttClient.h create mode 100644 lib/ArduinoMqttClient/src/MqttClient.cpp create mode 100644 lib/ArduinoMqttClient/src/MqttClient.h delete mode 100644 lib/pubsubclient/.travis.yml delete mode 100755 lib/pubsubclient/CHANGES.txt delete mode 100755 lib/pubsubclient/LICENSE.txt delete mode 100644 lib/pubsubclient/README.md delete mode 100755 lib/pubsubclient/examples/mqtt_auth/mqtt_auth.ino delete mode 100755 lib/pubsubclient/examples/mqtt_basic/mqtt_basic.ino delete mode 100644 lib/pubsubclient/examples/mqtt_esp8266/mqtt_esp8266.ino delete mode 100644 lib/pubsubclient/examples/mqtt_large_message/mqtt_large_message.ino delete mode 100644 lib/pubsubclient/examples/mqtt_publish_in_callback/mqtt_publish_in_callback.ino delete mode 100644 lib/pubsubclient/examples/mqtt_reconnect_nonblocking/mqtt_reconnect_nonblocking.ino delete mode 100644 lib/pubsubclient/examples/mqtt_stream/mqtt_stream.ino delete mode 100755 lib/pubsubclient/keywords.txt delete mode 100644 lib/pubsubclient/library.json delete mode 100644 lib/pubsubclient/library.properties delete mode 100755 lib/pubsubclient/src/PubSubClient.cpp delete mode 100755 lib/pubsubclient/src/PubSubClient.h delete mode 100644 lib/pubsubclient/tests/.gitignore delete mode 100644 lib/pubsubclient/tests/Makefile delete mode 100644 lib/pubsubclient/tests/README.md delete mode 100644 lib/pubsubclient/tests/src/connect_spec.cpp delete mode 100644 lib/pubsubclient/tests/src/keepalive_spec.cpp delete mode 100644 lib/pubsubclient/tests/src/lib/Arduino.h delete mode 100644 lib/pubsubclient/tests/src/lib/BDDTest.cpp delete mode 100644 lib/pubsubclient/tests/src/lib/BDDTest.h delete mode 100644 lib/pubsubclient/tests/src/lib/Buffer.cpp delete mode 100644 lib/pubsubclient/tests/src/lib/Buffer.h delete mode 100644 lib/pubsubclient/tests/src/lib/Client.h delete mode 100644 lib/pubsubclient/tests/src/lib/IPAddress.cpp delete mode 100644 lib/pubsubclient/tests/src/lib/IPAddress.h delete mode 100644 lib/pubsubclient/tests/src/lib/Print.h delete mode 100644 lib/pubsubclient/tests/src/lib/ShimClient.cpp delete mode 100644 lib/pubsubclient/tests/src/lib/ShimClient.h delete mode 100644 lib/pubsubclient/tests/src/lib/Stream.cpp delete mode 100644 lib/pubsubclient/tests/src/lib/Stream.h delete mode 100644 lib/pubsubclient/tests/src/lib/trace.h delete mode 100644 lib/pubsubclient/tests/src/publish_spec.cpp delete mode 100644 lib/pubsubclient/tests/src/receive_spec.cpp delete mode 100644 lib/pubsubclient/tests/src/subscribe_spec.cpp delete mode 100644 lib/pubsubclient/tests/testcases/__init__.py delete mode 100644 lib/pubsubclient/tests/testcases/mqtt_basic.py delete mode 100644 lib/pubsubclient/tests/testcases/mqtt_publish_in_callback.py delete mode 100644 lib/pubsubclient/tests/testcases/settings.py delete mode 100644 lib/pubsubclient/tests/testsuite.py diff --git a/CMakeLists.txt b/CMakeLists.txt index bb3f004..27d4df7 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -30,7 +30,7 @@ include_directories(${PROJECT_NAME} lib/BleScanner/src lib/nuki_ble/src lib/WiFiManager - lib/pubsubclient/src + lib/ArduinoMqttClient/src lib/WebServer/src lib/Ethernet/src lib/MqttLogger/src @@ -72,7 +72,8 @@ file(GLOB SRCFILES lib/nuki_ble/src/NukiOpenerUtils.cpp lib/BleScanner/src/BleInterfaces.h lib/BleScanner/src/BleScanner.cpp - lib/pubsubclient/src/PubSubClient.cpp + lib/ArduinoMqttClient/src/MqttClient.cpp + lib/ArduinoMqttClient/src/ArduinoMqttClient.h lib/MqttLogger/src/MqttLogger.cpp ) diff --git a/MqttReceiver.h b/MqttReceiver.h index 3faada5..3db350d 100644 --- a/MqttReceiver.h +++ b/MqttReceiver.h @@ -5,5 +5,5 @@ class MqttReceiver { public: - virtual void onMqttDataReceived(char*& topic, byte*& payload, unsigned int& length) = 0; + virtual void onMqttDataReceived(const char* topic, byte* payload, const unsigned int length) = 0; }; \ No newline at end of file diff --git a/Network.cpp b/Network.cpp index 44e53cd..4f70187 100644 --- a/Network.cpp +++ b/Network.cpp @@ -127,8 +127,7 @@ void Network::initialize() Log->print(F(":")); Log->println(port); - _device->mqttClient()->setServer(_mqttBrokerAddr, port); - _device->mqttClient()->setCallback(Network::onMqttDataReceivedCallback); +// _device->mqttClient()->connect(_mqttBrokerAddr, port); _networkTimeout = _preferences->getInt(preference_network_timeout); if(_networkTimeout == 0) @@ -225,13 +224,14 @@ int Network::update() _lastMaintenanceTs = ts; } - _device->mqttClient()->loop(); + _device->mqttClient()->poll(); return 0; } bool Network::reconnect() { _mqttConnected = false; + int port = _preferences->getInt(preference_mqtt_broker_port); while (!_device->mqttClient()->connected() && millis() > _nextReconnect) { @@ -241,12 +241,14 @@ bool Network::reconnect() if(strlen(_mqttUser) == 0) { Log->println(F("MQTT: Connecting without credentials")); - success = _device->mqttClient()->connect(_preferences->getString(preference_hostname).c_str()); +// success = _device->mqttClient()->connect(_preferences->getString(preference_hostname).c_str()) > 0; + success = _device->mqttClient()->connect(_mqttBrokerAddr, port); } else { Log->print(F("MQTT: Connecting with user: ")); Log->println(_mqttUser); - success = _device->mqttClient()->connect(_preferences->getString(preference_hostname).c_str(), _mqttUser, _mqttPass); + _device->mqttClient()->setUsernamePassword(_mqttUser, _mqttPass); + success = _device->mqttClient()->connect(_preferences->getString(preference_hostname).c_str()) > 0; } if (success) @@ -254,8 +256,10 @@ bool Network::reconnect() Log->println(F("MQTT connected")); _mqttConnected = true; delay(100); + _device->mqttClient()->onMessage(Network::onMqttDataReceivedCallback); for(const String& topic : _subscribedTopics) { + Serial.println(topic.c_str()); _device->mqttClient()->subscribe(topic.c_str()); } if(_firstConnect) @@ -263,16 +267,18 @@ bool Network::reconnect() _firstConnect = false; for(const auto& it : _initTopics) { - _device->mqttClient()->publish(it.first.c_str(), it.second.c_str(), true); + _device->mqttClient()->beginMessage(it.first, true); + _device->mqttClient()->print(it.second); + _device->mqttClient()->endMessage(); } } } else { Log->print(F("MQTT connect failed, rc=")); - Log->println(_device->mqttClient()->state()); + Log->println(_device->mqttClient()->connectError()); _device->printError(); - _device->mqttClient()->disconnect(); + _device->mqttClient()->stop(); _mqttConnected = false; _nextReconnect = millis() + 5000; } @@ -323,20 +329,33 @@ void Network::registerMqttReceiver(MqttReceiver* receiver) _mqttReceivers.push_back(receiver); } -void Network::onMqttDataReceivedCallback(char *topic, byte *payload, unsigned int length) +void Network::onMqttDataReceivedCallback(int messageSize) { - _inst->onMqttDataReceived(topic, payload, length); + _inst->onMqttDataReceived(messageSize); } -void Network::onMqttDataReceived(char *&topic, byte *&payload, unsigned int &length) +void Network::onMqttDataReceived(int messageSize) { + MqttClient* mqttClient = _device->mqttClient(); + String topic = mqttClient->messageTopic(); + + byte payload[500]; + memset(payload, 0, sizeof(payload)); + + int index = 0; + while (mqttClient->available() && index < sizeof(payload)) + { + payload[index] = mqttClient->read(); + ++index; + } + for(auto receiver : _mqttReceivers) { - receiver->onMqttDataReceived(topic, payload, length); + receiver->onMqttDataReceived(topic.c_str(), payload, index); } } -PubSubClient *Network::mqttClient() +MqttClient *Network::mqttClient() { return _device->mqttClient(); } @@ -370,7 +389,9 @@ void Network::publishFloat(const char* prefix, const char* topic, const float va dtostrf(value, 0, precision, str); char path[200] = {0}; buildMqttPath(prefix, topic, path); - _device->mqttClient()->publish(path, str, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(str); + _device->mqttClient()->endMessage(); } void Network::publishInt(const char* prefix, const char *topic, const int value) @@ -379,7 +400,9 @@ void Network::publishInt(const char* prefix, const char *topic, const int value) itoa(value, str, 10); char path[200] = {0}; buildMqttPath(prefix, topic, path); - _device->mqttClient()->publish(path, str, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(str); + _device->mqttClient()->endMessage(); } void Network::publishUInt(const char* prefix, const char *topic, const unsigned int value) @@ -388,7 +411,9 @@ void Network::publishUInt(const char* prefix, const char *topic, const unsigned utoa(value, str, 10); char path[200] = {0}; buildMqttPath(prefix, topic, path); - _device->mqttClient()->publish(path, str, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(str); + _device->mqttClient()->endMessage(); } void Network::publishULong(const char* prefix, const char *topic, const unsigned long value) @@ -397,7 +422,9 @@ void Network::publishULong(const char* prefix, const char *topic, const unsigned utoa(value, str, 10); char path[200] = {0}; buildMqttPath(prefix, topic, path); - _device->mqttClient()->publish(path, str, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(str); + _device->mqttClient()->endMessage(); } void Network::publishBool(const char* prefix, const char *topic, const bool value) @@ -406,14 +433,19 @@ void Network::publishBool(const char* prefix, const char *topic, const bool valu str[0] = value ? '1' : '0'; char path[200] = {0}; buildMqttPath(prefix, topic, path); - _device->mqttClient()->publish(path, str, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(str); + _device->mqttClient()->endMessage(); } bool Network::publishString(const char* prefix, const char *topic, const char *value) { char path[200] = {0}; buildMqttPath(prefix, topic, path); - return _device->mqttClient()->publish(path, value, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(value); + bool success = _device->mqttClient()->endMessage() > 0; + return success; } void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* name, char* uidString, char* lockAction, char* unlockAction, char* openAction, char* lockedState, char* unlockedState) @@ -455,7 +487,9 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n path.concat(uidString); path.concat("/smartlock/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); // Battery critical configJSON = "{\"dev\":{\"ids\":[\"nuki_"; @@ -479,7 +513,9 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n path.concat(uidString); path.concat("/battery_low/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); // Keypad battery critical configJSON = "{\"dev\":{\"ids\":[\"nuki_"; @@ -503,8 +539,9 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n path.concat(uidString); path.concat("/keypad_battery_low/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); - + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); // Battery voltage configJSON = "{\"dev\":{\"ids\":[\"nuki_"; configJSON.concat(uidString); @@ -529,7 +566,9 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n path.concat(uidString); path.concat("/battery_voltage/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); // Trigger configJSON = "{\"dev\":{\"ids\":[\"nuki_"; @@ -554,7 +593,9 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n path.concat(uidString); path.concat("/trigger/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); } } @@ -590,7 +631,9 @@ void Network::publishHASSConfigBatLevel(char *deviceType, const char *baseTopic, path.concat(uidString); path.concat("/battery_level/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); } } @@ -625,7 +668,9 @@ void Network::publishHASSConfigDoorSensor(char *deviceType, const char *baseTopi path.concat(uidString); path.concat("/door_sensor/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); } } @@ -659,7 +704,9 @@ void Network::publishHASSConfigRingDetect(char *deviceType, const char *baseTopi path.concat(uidString); path.concat("/ring/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); } } @@ -697,7 +744,9 @@ void Network::publishHASSWifiRssiConfig(char *deviceType, const char *baseTopic, path.concat(uidString); path.concat("/wifi_signal_strength/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); } } @@ -730,7 +779,9 @@ void Network::publishHASSBleRssiConfig(char *deviceType, const char *baseTopic, path.concat(uidString); path.concat("/bluetooth_signal_strength/config"); - _device->mqttClient()->publish(path.c_str(), configJSON.c_str(), true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(configJSON); + _device->mqttClient()->endMessage(); } } @@ -744,55 +795,73 @@ void Network::removeHASSConfig(char* uidString) path.concat("/lock/"); path.concat(uidString); path.concat("/smartlock/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); path = discoveryTopic; path.concat("/binary_sensor/"); path.concat(uidString); path.concat("/battery_low/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); path = discoveryTopic; path.concat("/sensor/"); path.concat(uidString); path.concat("/battery_voltage/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); path = discoveryTopic; path.concat("/sensor/"); path.concat(uidString); path.concat("/trigger/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); path = discoveryTopic; path.concat("/sensor/"); path.concat(uidString); path.concat("/battery_level/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); path = discoveryTopic; path.concat("/binary_sensor/"); path.concat(uidString); path.concat("/door_sensor/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); path = discoveryTopic; path.concat("/binary_sensor/"); path.concat(uidString); path.concat("/ring/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); path = discoveryTopic; path.concat("/sensor/"); path.concat(uidString); path.concat("/wifi_signal_strength/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); path = discoveryTopic; path.concat("/sensor/"); path.concat(uidString); path.concat("/bluetooth_signal_strength/config"); - _device->mqttClient()->publish(path.c_str(), NULL, 0U, true); + _device->mqttClient()->beginMessage(path, true); + _device->mqttClient()->print(""); + _device->mqttClient()->endMessage(); } } diff --git a/Network.h b/Network.h index 9ecc6f8..160b449 100644 --- a/Network.h +++ b/Network.h @@ -43,14 +43,14 @@ public: void publishPresenceDetection(char* csv); - PubSubClient* mqttClient(); + MqttClient* mqttClient(); bool isMqttConnected(); const NetworkDeviceType networkDeviceType(); private: - static void onMqttDataReceivedCallback(char* topic, byte* payload, unsigned int length); - void onMqttDataReceived(char*& topic, byte*& payload, unsigned int& length); + static void onMqttDataReceivedCallback(int); + void onMqttDataReceived(int messageSize); void setupDevice(); bool reconnect(); diff --git a/NetworkLock.cpp b/NetworkLock.cpp index ed80674..3c61cba 100644 --- a/NetworkLock.cpp +++ b/NetworkLock.cpp @@ -71,7 +71,7 @@ void NetworkLock::initialize() } } -void NetworkLock::onMqttDataReceived(char *&topic, byte *&payload, unsigned int &length) +void NetworkLock::onMqttDataReceived(const char* topic, byte* payload, const unsigned int length) { char value[50] = {0}; size_t l = min(length, sizeof(value)-1); @@ -120,8 +120,8 @@ void NetworkLock::onMqttDataReceived(char *&topic, byte *&payload, unsigned int publishString(mqtt_topic_keypad_command_action, "--"); } publishInt(mqtt_topic_keypad_command_id, _keypadCommandId); - publishString(mqtt_topic_keypad_command_name, _keypadCommandName.c_str()); - publishString(mqtt_topic_keypad_command_code, _keypadCommandCode.c_str()); + publishString(mqtt_topic_keypad_command_name, _keypadCommandName); + publishString(mqtt_topic_keypad_command_code, _keypadCommandCode); publishInt(mqtt_topic_keypad_command_enabled, _keypadCommandEnabled); } } @@ -341,7 +341,7 @@ void NetworkLock::publishAuthorizationInfo(const std::list& } json.concat("]"); - publishString(mqtt_topic_lock_log, json.c_str()); + publishString(mqtt_topic_lock_log, json); if(authFound) { @@ -390,12 +390,12 @@ void NetworkLock::publishRssi(const int& rssi) void NetworkLock::publishRetry(const std::string& message) { - publishString(mqtt_topic_lock_retry, message.c_str()); + publishString(mqtt_topic_lock_retry, message); } void NetworkLock::publishBleAddress(const std::string &address) { - publishString(mqtt_topic_lock_address, address.c_str()); + publishString(mqtt_topic_lock_address, address); } void NetworkLock::publishKeypad(const std::list& entries, uint maxKeypadCodeCount) @@ -507,6 +507,22 @@ void NetworkLock::publishBool(const char *topic, const bool value) _network->publishBool(_mqttPath, topic, value); } +bool NetworkLock::publishString(const char *topic, const String &value) +{ + char str[value.length() + 1]; + memset(str, 0, sizeof(str)); + memcpy(str, value.begin(), value.length()); + return publishString(topic, str); +} + +bool NetworkLock::publishString(const char *topic, const std::string &value) +{ + char str[value.size() + 1]; + memset(str, 0, sizeof(str)); + memcpy(str, value.data(), value.length()); + return publishString(topic, str); +} + bool NetworkLock::publishString(const char *topic, const char *value) { return _network->publishString(_mqttPath, topic, value); diff --git a/NetworkLock.h b/NetworkLock.h index ca07013..1fffd3e 100644 --- a/NetworkLock.h +++ b/NetworkLock.h @@ -1,6 +1,5 @@ #pragma once -#include #include "networkDevices/NetworkDevice.h" #include "networkDevices/WifiDevice.h" #include "networkDevices/W5500Device.h" @@ -39,7 +38,7 @@ public: void setConfigUpdateReceivedCallback(void (*configUpdateReceivedCallback)(const char* path, const char* value)); void setKeypadCommandReceivedCallback(void (*keypadCommandReceivedReceivedCallback)(const char* command, const uint& id, const String& name, const String& code, const int& enabled)); - void onMqttDataReceived(char*& topic, byte*& payload, unsigned int& length) override; + void onMqttDataReceived(const char* topic, byte* payload, const unsigned int length) override; private: void publishFloat(const char* topic, const float value, const uint8_t precision = 2); @@ -47,6 +46,8 @@ private: void publishUInt(const char* topic, const unsigned int value); void publishULong(const char* topic, const unsigned long value); void publishBool(const char* topic, const bool value); + bool publishString(const char* topic, const String& value); + bool publishString(const char* topic, const std::string& value); bool publishString(const char* topic, const char* value); void publishKeypadEntry(const String topic, NukiLock::KeypadEntry entry); bool comparePrefixedPath(const char* fullPath, const char* subPath); diff --git a/NetworkOpener.cpp b/NetworkOpener.cpp index 38deea6..3000ea6 100644 --- a/NetworkOpener.cpp +++ b/NetworkOpener.cpp @@ -57,7 +57,7 @@ void NetworkOpener::update() } } -void NetworkOpener::onMqttDataReceived(char *&topic, byte *&payload, unsigned int &length) +void NetworkOpener::onMqttDataReceived(const char* topic, byte* payload, const unsigned int length) { char value[50] = {0}; size_t l = min(length, sizeof(value)-1); @@ -309,7 +309,7 @@ void NetworkOpener::publishAuthorizationInfo(const std::listpublishBool(_mqttPath, topic, value); } +void NetworkOpener::publishString(const char *topic, const String &value) +{ + char str[value.length() + 1]; + memset(str, 0, sizeof(str)); + memcpy(str, value.begin(), value.length()); + publishString(topic, str); +} + +void NetworkOpener::publishString(const char *topic, const std::string &value) +{ + char str[value.size() + 1]; + memset(str, 0, sizeof(str)); + memcpy(str, value.data(), value.length()); + publishString(topic, str); +} + void NetworkOpener::publishString(const char* topic, const char* value) { _network->publishString(_mqttPath, topic, value); diff --git a/NetworkOpener.h b/NetworkOpener.h index 489de0d..873a5ee 100644 --- a/NetworkOpener.h +++ b/NetworkOpener.h @@ -1,6 +1,5 @@ #pragma once -#include #include "networkDevices/NetworkDevice.h" #include "networkDevices/WifiDevice.h" #include "networkDevices/W5500Device.h" @@ -37,7 +36,7 @@ public: void setLockActionReceivedCallback(bool (*lockActionReceivedCallback)(const char* value)); void setConfigUpdateReceivedCallback(void (*configUpdateReceivedCallback)(const char* path, const char* value)); - void onMqttDataReceived(char*& topic, byte*& payload, unsigned int& length) override; + void onMqttDataReceived(const char* topic, byte* payload, const unsigned int length) override; private: bool comparePrefixedPath(const char* fullPath, const char* subPath); @@ -46,6 +45,8 @@ private: void publishInt(const char* topic, const int value); void publishUInt(const char* topic, const unsigned int value); void publishBool(const char* topic, const bool value); + void publishString(const char* topic, const String& value); + void publishString(const char* topic, const std::string& value); void publishString(const char* topic, const char* value); void buildMqttPath(const char* path, char* outPath); diff --git a/lib/ArduinoMqttClient/.codespellrc b/lib/ArduinoMqttClient/.codespellrc new file mode 100644 index 0000000..101edae --- /dev/null +++ b/lib/ArduinoMqttClient/.codespellrc @@ -0,0 +1,7 @@ +# See: https://github.com/codespell-project/codespell#using-a-config-file +[codespell] +# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: +ignore-words-list = , +check-filenames = +check-hidden = +skip = ./.git diff --git a/lib/ArduinoMqttClient/LICENSE.txt b/lib/ArduinoMqttClient/LICENSE.txt new file mode 100644 index 0000000..8000a6f --- /dev/null +++ b/lib/ArduinoMqttClient/LICENSE.txt @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/lib/ArduinoMqttClient/README.adoc b/lib/ArduinoMqttClient/README.adoc new file mode 100644 index 0000000..050baca --- /dev/null +++ b/lib/ArduinoMqttClient/README.adoc @@ -0,0 +1,10 @@ +:repository-owner: arduino-libraries +:repository-name: ArduinoMqttClient + += {repository-name} Library for Arduino = + +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"] +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] + +Allows you to send and receive MQTT messages using Arduino. diff --git a/lib/ArduinoMqttClient/examples/WiFiAdvancedCallback/WiFiAdvancedCallback.ino b/lib/ArduinoMqttClient/examples/WiFiAdvancedCallback/WiFiAdvancedCallback.ino new file mode 100644 index 0000000..3aed2c6 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiAdvancedCallback/WiFiAdvancedCallback.ino @@ -0,0 +1,190 @@ +/* + ArduinoMqttClient - WiFi Advanced Callback + + This example connects to a MQTT broker and subscribes to a single topic, + it also publishes a message to another topic every 10 seconds. + When a message is received it prints the message to the Serial Monitor, + it uses the callback functionality of the library. + + It also demonstrates how to set the will message, get/set QoS, + duplicate and retain values of messages. + + The circuit: + - Arduino MKR 1000, MKR 1010 or Uno WiFi Rev2 board + + This example code is in the public domain. +*/ + +#include +#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_AVR_UNO_WIFI_REV2) + #include +#elif defined(ARDUINO_SAMD_MKR1000) + #include +#elif defined(ARDUINO_ARCH_ESP8266) + #include +#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_ARCH_ESP32) + #include +#endif + +#include "arduino_secrets.h" +///////please enter your sensitive data in the Secret tab/arduino_secrets.h +char ssid[] = SECRET_SSID; // your network SSID (name) +char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP) + +// To connect with SSL/TLS: +// 1) Change WiFiClient to WiFiSSLClient. +// 2) Change port value from 1883 to 8883. +// 3) Change broker value to a server with a known SSL/TLS root certificate +// flashed in the WiFi module. + +WiFiClient wifiClient; +MqttClient mqttClient(wifiClient); + +const char broker[] = "test.mosquitto.org"; +int port = 1883; +const char willTopic[] = "arduino/will"; +const char inTopic[] = "arduino/in"; +const char outTopic[] = "arduino/out"; + +const long interval = 10000; +unsigned long previousMillis = 0; + +int count = 0; + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + // attempt to connect to WiFi network: + Serial.print("Attempting to connect to WPA SSID: "); + Serial.println(ssid); + while (WiFi.begin(ssid, pass) != WL_CONNECTED) { + // failed, retry + Serial.print("."); + delay(5000); + } + + Serial.println("You're connected to the network"); + Serial.println(); + + // You can provide a unique client ID, if not set the library uses Arduino-millis() + // Each client must have a unique client ID + // mqttClient.setId("clientId"); + + // You can provide a username and password for authentication + // mqttClient.setUsernamePassword("username", "password"); + + // By default the library connects with the "clean session" flag set, + // you can disable this behaviour by using + // mqttClient.setCleanSession(false); + + // set a will message, used by the broker when the connection dies unexpectedly + // you must know the size of the message beforehand, and it must be set before connecting + String willPayload = "oh no!"; + bool willRetain = true; + int willQos = 1; + + mqttClient.beginWill(willTopic, willPayload.length(), willRetain, willQos); + mqttClient.print(willPayload); + mqttClient.endWill(); + + Serial.print("Attempting to connect to the MQTT broker: "); + Serial.println(broker); + + if (!mqttClient.connect(broker, port)) { + Serial.print("MQTT connection failed! Error code = "); + Serial.println(mqttClient.connectError()); + + while (1); + } + + Serial.println("You're connected to the MQTT broker!"); + Serial.println(); + + // set the message receive callback + mqttClient.onMessage(onMqttMessage); + + Serial.print("Subscribing to topic: "); + Serial.println(inTopic); + Serial.println(); + + // subscribe to a topic + // the second parameter sets the QoS of the subscription, + // the the library supports subscribing at QoS 0, 1, or 2 + int subscribeQos = 1; + + mqttClient.subscribe(inTopic, subscribeQos); + + // topics can be unsubscribed using: + // mqttClient.unsubscribe(inTopic); + + Serial.print("Waiting for messages on topic: "); + Serial.println(inTopic); + Serial.println(); +} + +void loop() { + // call poll() regularly to allow the library to receive MQTT messages and + // send MQTT keep alives which avoids being disconnected by the broker + mqttClient.poll(); + + // to avoid having delays in loop, we'll use the strategy from BlinkWithoutDelay + // see: File -> Examples -> 02.Digital -> BlinkWithoutDelay for more info + unsigned long currentMillis = millis(); + + if (currentMillis - previousMillis >= interval) { + // save the last time a message was sent + previousMillis = currentMillis; + + String payload; + + payload += "hello world!"; + payload += " "; + payload += count; + + Serial.print("Sending message to topic: "); + Serial.println(outTopic); + Serial.println(payload); + + // send message, the Print interface can be used to set the message contents + // in this case we know the size ahead of time, so the message payload can be streamed + + bool retained = false; + int qos = 1; + bool dup = false; + + mqttClient.beginMessage(outTopic, payload.length(), retained, qos, dup); + mqttClient.print(payload); + mqttClient.endMessage(); + + Serial.println(); + + count++; + } +} + +void onMqttMessage(int messageSize) { + // we received a message, print out the topic and contents + Serial.print("Received a message with topic '"); + Serial.print(mqttClient.messageTopic()); + Serial.print("', duplicate = "); + Serial.print(mqttClient.messageDup() ? "true" : "false"); + Serial.print(", QoS = "); + Serial.print(mqttClient.messageQoS()); + Serial.print(", retained = "); + Serial.print(mqttClient.messageRetain() ? "true" : "false"); + Serial.print("', length "); + Serial.print(messageSize); + Serial.println(" bytes:"); + + // use the Stream interface to print the contents + while (mqttClient.available()) { + Serial.print((char)mqttClient.read()); + } + Serial.println(); + + Serial.println(); +} diff --git a/lib/ArduinoMqttClient/examples/WiFiAdvancedCallback/arduino_secrets.h b/lib/ArduinoMqttClient/examples/WiFiAdvancedCallback/arduino_secrets.h new file mode 100644 index 0000000..0c9fdd5 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiAdvancedCallback/arduino_secrets.h @@ -0,0 +1,2 @@ +#define SECRET_SSID "" +#define SECRET_PASS "" diff --git a/lib/ArduinoMqttClient/examples/WiFiEcho/WiFiEcho.ino b/lib/ArduinoMqttClient/examples/WiFiEcho/WiFiEcho.ino new file mode 100644 index 0000000..840f088 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiEcho/WiFiEcho.ino @@ -0,0 +1,146 @@ +/* + ArduinoMqttClient - WiFi Echo + + This example connects to a MQTT broker and subscribes to a single topic, + it also publishes a message to the same topic once a second. + When a message is received it prints the message to the Serial Monitor. + + The circuit: + - Arduino MKR 1000, MKR 1010 or Uno WiFi Rev2 board + + This example code is in the public domain. +*/ + +#include +#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_AVR_UNO_WIFI_REV2) + #include +#elif defined(ARDUINO_SAMD_MKR1000) + #include +#elif defined(ARDUINO_ARCH_ESP8266) + #include +#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_ARCH_ESP32) + #include +#endif + +#include "arduino_secrets.h" +///////please enter your sensitive data in the Secret tab/arduino_secrets.h +char ssid[] = SECRET_SSID; // your network SSID (name) +char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP) + +// To connect with SSL/TLS: +// 1) Change WiFiClient to WiFiSSLClient. +// 2) Change port value from 1883 to 8883. +// 3) Change broker value to a server with a known SSL/TLS root certificate +// flashed in the WiFi module. + +WiFiClient wifiClient; +MqttClient mqttClient(wifiClient); + +const char broker[] = "test.mosquitto.org"; +int port = 1883; + +const char topic[] = "arduino/echo"; + +const long interval = 1000; +unsigned long previousMillis = 0; + +int count = 0; + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + // attempt to connect to WiFi network: + Serial.print("Attempting to connect to WPA SSID: "); + Serial.println(ssid); + while (WiFi.begin(ssid, pass) != WL_CONNECTED) { + // failed, retry + Serial.print("."); + delay(5000); + } + + Serial.println("You're connected to the network"); + Serial.println(); + + // You can provide a unique client ID, if not set the library uses Arduino-millis() + // Each client must have a unique client ID + // mqttClient.setId("clientId"); + + // You can provide a username and password for authentication + // mqttClient.setUsernamePassword("username", "password"); + + Serial.print("Attempting to connect to the MQTT broker: "); + Serial.println(broker); + + if (!mqttClient.connect(broker, port)) { + Serial.print("MQTT connection failed! Error code = "); + Serial.println(mqttClient.connectError()); + + while (1); + } + + Serial.println("You're connected to the MQTT broker!"); + Serial.println(); + + Serial.print("Subscribing to topic: "); + Serial.println(topic); + Serial.println(); + + // subscribe to a topic + mqttClient.subscribe(topic); + + // topics can be unsubscribed using: + // mqttClient.unsubscribe(topic); + + Serial.print("Waiting for messages on topic: "); + Serial.println(topic); + Serial.println(); +} + +void loop() { + // check for incoming messages + int messageSize = mqttClient.parseMessage(); + if (messageSize) { + // we received a message, print out the topic and contents + Serial.print("Received a message with topic '"); + Serial.print(mqttClient.messageTopic()); + Serial.print("', length "); + Serial.print(messageSize); + Serial.println(" bytes:"); + + // use the Stream interface to print the contents + while (mqttClient.available()) { + Serial.print((char)mqttClient.read()); + } + Serial.println(); + + Serial.println(); + } + + // to avoid having delays in loop, we'll use the strategy from BlinkWithoutDelay + // see: File -> Examples -> 02.Digital -> BlinkWithoutDelay for more info + unsigned long currentMillis = millis(); + + if (currentMillis - previousMillis >= interval) { + // save the last time a message was sent + previousMillis = currentMillis; + + Serial.print("Sending message to topic: "); + Serial.println(topic); + Serial.print("echo "); + Serial.println(count); + + // send message, the Print interface can be used to set the message contents + mqttClient.beginMessage(topic); + mqttClient.print("echo "); + mqttClient.print(count); + mqttClient.endMessage(); + + Serial.println(); + + count++; + } +} diff --git a/lib/ArduinoMqttClient/examples/WiFiEcho/arduino_secrets.h b/lib/ArduinoMqttClient/examples/WiFiEcho/arduino_secrets.h new file mode 100644 index 0000000..0c9fdd5 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiEcho/arduino_secrets.h @@ -0,0 +1,2 @@ +#define SECRET_SSID "" +#define SECRET_PASS "" diff --git a/lib/ArduinoMqttClient/examples/WiFiEchoCallback/WiFiEchoCallback.ino b/lib/ArduinoMqttClient/examples/WiFiEchoCallback/WiFiEchoCallback.ino new file mode 100644 index 0000000..8438be3 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiEchoCallback/WiFiEchoCallback.ino @@ -0,0 +1,151 @@ +/* + ArduinoMqttClient - WiFi Echo + + This example connects to a MQTT broker and subscribes to a single topic, + it also publishes a message to the same topic once a second. + When a message is received it prints the message to the Serial Monitor, + it uses the callback functionality of the library. + + The circuit: + - Arduino MKR 1000, MKR 1010 or Uno WiFi Rev2 board + + This example code is in the public domain. +*/ + +#include +#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_AVR_UNO_WIFI_REV2) + #include +#elif defined(ARDUINO_SAMD_MKR1000) + #include +#elif defined(ARDUINO_ARCH_ESP8266) + #include +#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_ARCH_ESP32) + #include +#endif + +#include "arduino_secrets.h" +///////please enter your sensitive data in the Secret tab/arduino_secrets.h +char ssid[] = SECRET_SSID; // your network SSID (name) +char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP) + +// To connect with SSL/TLS: +// 1) Change WiFiClient to WiFiSSLClient. +// 2) Change port value from 1883 to 8883. +// 3) Change broker value to a server with a known SSL/TLS root certificate +// flashed in the WiFi module. + +WiFiClient wifiClient; +MqttClient mqttClient(wifiClient); + +const char broker[] = "test.mosquitto.org"; +int port = 1883; +const char topic[] = "arduino/echo"; + +const long interval = 1000; +unsigned long previousMillis = 0; + +int count = 0; + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + // attempt to connect to WiFi network: + Serial.print("Attempting to connect to WPA SSID: "); + Serial.println(ssid); + while (WiFi.begin(ssid, pass) != WL_CONNECTED) { + // failed, retry + Serial.print("."); + delay(5000); + } + + Serial.println("You're connected to the network"); + Serial.println(); + + // You can provide a unique client ID, if not set the library uses Arduino-millis() + // Each client must have a unique client ID + // mqttClient.setId("clientId"); + + // You can provide a username and password for authentication + // mqttClient.setUsernamePassword("username", "password"); + + Serial.print("Attempting to connect to the MQTT broker: "); + Serial.println(broker); + + if (!mqttClient.connect(broker, port)) { + Serial.print("MQTT connection failed! Error code = "); + Serial.println(mqttClient.connectError()); + + while (1); + } + + Serial.println("You're connected to the MQTT broker!"); + Serial.println(); + + // set the message receive callback + mqttClient.onMessage(onMqttMessage); + + Serial.print("Subscribing to topic: "); + Serial.println(topic); + Serial.println(); + + // subscribe to a topic + mqttClient.subscribe(topic); + + // topics can be unsubscribed using: + // mqttClient.unsubscribe(topic); + + Serial.print("Waiting for messages on topic: "); + Serial.println(topic); + Serial.println(); +} + +void loop() { + // call poll() regularly to allow the library to receive MQTT messages and + // send MQTT keep alives which avoids being disconnected by the broker + mqttClient.poll(); + + // to avoid having delays in loop, we'll use the strategy from BlinkWithoutDelay + // see: File -> Examples -> 02.Digital -> BlinkWithoutDelay for more info + unsigned long currentMillis = millis(); + + if (currentMillis - previousMillis >= interval) { + // save the last time a message was sent + previousMillis = currentMillis; + + Serial.print("Sending message to topic: "); + Serial.println(topic); + Serial.print("echo "); + Serial.println(count); + + // send message, the Print interface can be used to set the message contents + mqttClient.beginMessage(topic); + mqttClient.print("echo "); + mqttClient.print(count); + mqttClient.endMessage(); + + Serial.println(); + + count++; + } +} + +void onMqttMessage(int messageSize) { + // we received a message, print out the topic and contents + Serial.print("Received a message with topic '"); + Serial.print(mqttClient.messageTopic()); + Serial.print("', length "); + Serial.print(messageSize); + Serial.println(" bytes:"); + + // use the Stream interface to print the contents + while (mqttClient.available()) { + Serial.print((char)mqttClient.read()); + } + Serial.println(); + + Serial.println(); +} diff --git a/lib/ArduinoMqttClient/examples/WiFiEchoCallback/arduino_secrets.h b/lib/ArduinoMqttClient/examples/WiFiEchoCallback/arduino_secrets.h new file mode 100644 index 0000000..0c9fdd5 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiEchoCallback/arduino_secrets.h @@ -0,0 +1,2 @@ +#define SECRET_SSID "" +#define SECRET_PASS "" diff --git a/lib/ArduinoMqttClient/examples/WiFiSimpleReceive/WiFiSimpleReceive.ino b/lib/ArduinoMqttClient/examples/WiFiSimpleReceive/WiFiSimpleReceive.ino new file mode 100644 index 0000000..4cb406a --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiSimpleReceive/WiFiSimpleReceive.ino @@ -0,0 +1,114 @@ +/* + ArduinoMqttClient - WiFi Simple Receive + + This example connects to a MQTT broker and subscribes to a single topic. + When a message is received it prints the message to the Serial Monitor. + + The circuit: + - Arduino MKR 1000, MKR 1010 or Uno WiFi Rev2 board + + This example code is in the public domain. +*/ + +#include +#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_AVR_UNO_WIFI_REV2) + #include +#elif defined(ARDUINO_SAMD_MKR1000) + #include +#elif defined(ARDUINO_ARCH_ESP8266) + #include +#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_ARCH_ESP32) + #include +#endif + +#include "arduino_secrets.h" +///////please enter your sensitive data in the Secret tab/arduino_secrets.h +char ssid[] = SECRET_SSID; // your network SSID (name) +char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP) + +// To connect with SSL/TLS: +// 1) Change WiFiClient to WiFiSSLClient. +// 2) Change port value from 1883 to 8883. +// 3) Change broker value to a server with a known SSL/TLS root certificate +// flashed in the WiFi module. + +WiFiClient wifiClient; +MqttClient mqttClient(wifiClient); + +const char broker[] = "test.mosquitto.org"; +int port = 1883; +const char topic[] = "arduino/simple"; + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + // attempt to connect to WiFi network: + Serial.print("Attempting to connect to WPA SSID: "); + Serial.println(ssid); + while (WiFi.begin(ssid, pass) != WL_CONNECTED) { + // failed, retry + Serial.print("."); + delay(5000); + } + + Serial.println("You're connected to the network"); + Serial.println(); + + // You can provide a unique client ID, if not set the library uses Arduino-millis() + // Each client must have a unique client ID + // mqttClient.setId("clientId"); + + // You can provide a username and password for authentication + // mqttClient.setUsernamePassword("username", "password"); + + Serial.print("Attempting to connect to the MQTT broker: "); + Serial.println(broker); + + if (!mqttClient.connect(broker, port)) { + Serial.print("MQTT connection failed! Error code = "); + Serial.println(mqttClient.connectError()); + + while (1); + } + + Serial.println("You're connected to the MQTT broker!"); + Serial.println(); + + Serial.print("Subscribing to topic: "); + Serial.println(topic); + Serial.println(); + + // subscribe to a topic + mqttClient.subscribe(topic); + + // topics can be unsubscribed using: + // mqttClient.unsubscribe(topic); + + Serial.print("Waiting for messages on topic: "); + Serial.println(topic); + Serial.println(); +} + +void loop() { + int messageSize = mqttClient.parseMessage(); + if (messageSize) { + // we received a message, print out the topic and contents + Serial.print("Received a message with topic '"); + Serial.print(mqttClient.messageTopic()); + Serial.print("', length "); + Serial.print(messageSize); + Serial.println(" bytes:"); + + // use the Stream interface to print the contents + while (mqttClient.available()) { + Serial.print((char)mqttClient.read()); + } + Serial.println(); + + Serial.println(); + } +} diff --git a/lib/ArduinoMqttClient/examples/WiFiSimpleReceive/arduino_secrets.h b/lib/ArduinoMqttClient/examples/WiFiSimpleReceive/arduino_secrets.h new file mode 100644 index 0000000..0c9fdd5 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiSimpleReceive/arduino_secrets.h @@ -0,0 +1,2 @@ +#define SECRET_SSID "" +#define SECRET_PASS "" diff --git a/lib/ArduinoMqttClient/examples/WiFiSimpleReceiveCallback/WiFiSimpleReceiveCallback.ino b/lib/ArduinoMqttClient/examples/WiFiSimpleReceiveCallback/WiFiSimpleReceiveCallback.ino new file mode 100644 index 0000000..77a4d93 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiSimpleReceiveCallback/WiFiSimpleReceiveCallback.ino @@ -0,0 +1,121 @@ +/* + ArduinoMqttClient - WiFi Simple Receive Callback + + This example connects to a MQTT broker and subscribes to a single topic. + When a message is received it prints the message to the Serial Monitor, + it uses the callback functionality of the library. + + The circuit: + - Arduino MKR 1000, MKR 1010 or Uno WiFi Rev2 board + + This example code is in the public domain. +*/ + +#include +#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_AVR_UNO_WIFI_REV2) + #include +#elif defined(ARDUINO_SAMD_MKR1000) + #include +#elif defined(ARDUINO_ARCH_ESP8266) + #include +#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_ARCH_ESP32) + #include +#endif + +#include "arduino_secrets.h" +///////please enter your sensitive data in the Secret tab/arduino_secrets.h +char ssid[] = SECRET_SSID; // your network SSID (name) +char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP) + +// To connect with SSL/TLS: +// 1) Change WiFiClient to WiFiSSLClient. +// 2) Change port value from 1883 to 8883. +// 3) Change broker value to a server with a known SSL/TLS root certificate +// flashed in the WiFi module. + +WiFiClient wifiClient; +MqttClient mqttClient(wifiClient); + +const char broker[] = "test.mosquitto.org"; +int port = 1883; +const char topic[] = "arduino/simple"; + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + // attempt to connect to WiFi network: + Serial.print("Attempting to connect to WPA SSID: "); + Serial.println(ssid); + while (WiFi.begin(ssid, pass) != WL_CONNECTED) { + // failed, retry + Serial.print("."); + delay(5000); + } + + Serial.println("You're connected to the network"); + Serial.println(); + + // You can provide a unique client ID, if not set the library uses Arduino-millis() + // Each client must have a unique client ID + // mqttClient.setId("clientId"); + + // You can provide a username and password for authentication + // mqttClient.setUsernamePassword("username", "password"); + + Serial.print("Attempting to connect to the MQTT broker: "); + Serial.println(broker); + + if (!mqttClient.connect(broker, port)) { + Serial.print("MQTT connection failed! Error code = "); + Serial.println(mqttClient.connectError()); + + while (1); + } + + Serial.println("You're connected to the MQTT broker!"); + Serial.println(); + + // set the message receive callback + mqttClient.onMessage(onMqttMessage); + + Serial.print("Subscribing to topic: "); + Serial.println(topic); + Serial.println(); + + // subscribe to a topic + mqttClient.subscribe(topic); + + // topics can be unsubscribed using: + // mqttClient.unsubscribe(topic); + + Serial.print("Waiting for messages on topic: "); + Serial.println(topic); + Serial.println(); +} + +void loop() { + // call poll() regularly to allow the library to receive MQTT messages and + // send MQTT keep alives which avoids being disconnected by the broker + mqttClient.poll(); +} + +void onMqttMessage(int messageSize) { + // we received a message, print out the topic and contents + Serial.println("Received a message with topic '"); + Serial.print(mqttClient.messageTopic()); + Serial.print("', length "); + Serial.print(messageSize); + Serial.println(" bytes:"); + + // use the Stream interface to print the contents + while (mqttClient.available()) { + Serial.print((char)mqttClient.read()); + } + Serial.println(); + + Serial.println(); +} diff --git a/lib/ArduinoMqttClient/examples/WiFiSimpleReceiveCallback/arduino_secrets.h b/lib/ArduinoMqttClient/examples/WiFiSimpleReceiveCallback/arduino_secrets.h new file mode 100644 index 0000000..0c9fdd5 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiSimpleReceiveCallback/arduino_secrets.h @@ -0,0 +1,2 @@ +#define SECRET_SSID "" +#define SECRET_PASS "" diff --git a/lib/ArduinoMqttClient/examples/WiFiSimpleSender/WiFiSimpleSender.ino b/lib/ArduinoMqttClient/examples/WiFiSimpleSender/WiFiSimpleSender.ino new file mode 100644 index 0000000..2513609 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiSimpleSender/WiFiSimpleSender.ino @@ -0,0 +1,115 @@ +/* + ArduinoMqttClient - WiFi Simple Sender + + This example connects to a MQTT broker and publishes a message to + a topic once a second. + + The circuit: + - Arduino MKR 1000, MKR 1010 or Uno WiFi Rev2 board + + This example code is in the public domain. +*/ + +#include +#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_AVR_UNO_WIFI_REV2) + #include +#elif defined(ARDUINO_SAMD_MKR1000) + #include +#elif defined(ARDUINO_ARCH_ESP8266) + #include +#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_ARCH_ESP32) + #include +#endif + +#include "arduino_secrets.h" +///////please enter your sensitive data in the Secret tab/arduino_secrets.h +char ssid[] = SECRET_SSID; // your network SSID (name) +char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP) + +// To connect with SSL/TLS: +// 1) Change WiFiClient to WiFiSSLClient. +// 2) Change port value from 1883 to 8883. +// 3) Change broker value to a server with a known SSL/TLS root certificate +// flashed in the WiFi module. + +WiFiClient wifiClient; +MqttClient mqttClient(wifiClient); + +const char broker[] = "test.mosquitto.org"; +int port = 1883; +const char topic[] = "arduino/simple"; + +const long interval = 1000; +unsigned long previousMillis = 0; + +int count = 0; + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + // attempt to connect to WiFi network: + Serial.print("Attempting to connect to WPA SSID: "); + Serial.println(ssid); + while (WiFi.begin(ssid, pass) != WL_CONNECTED) { + // failed, retry + Serial.print("."); + delay(5000); + } + + Serial.println("You're connected to the network"); + Serial.println(); + + // You can provide a unique client ID, if not set the library uses Arduino-millis() + // Each client must have a unique client ID + // mqttClient.setId("clientId"); + + // You can provide a username and password for authentication + // mqttClient.setUsernamePassword("username", "password"); + + Serial.print("Attempting to connect to the MQTT broker: "); + Serial.println(broker); + + if (!mqttClient.connect(broker, port)) { + Serial.print("MQTT connection failed! Error code = "); + Serial.println(mqttClient.connectError()); + + while (1); + } + + Serial.println("You're connected to the MQTT broker!"); + Serial.println(); +} + +void loop() { + // call poll() regularly to allow the library to send MQTT keep alives which + // avoids being disconnected by the broker + mqttClient.poll(); + + // to avoid having delays in loop, we'll use the strategy from BlinkWithoutDelay + // see: File -> Examples -> 02.Digital -> BlinkWithoutDelay for more info + unsigned long currentMillis = millis(); + + if (currentMillis - previousMillis >= interval) { + // save the last time a message was sent + previousMillis = currentMillis; + + Serial.print("Sending message to topic: "); + Serial.println(topic); + Serial.print("hello "); + Serial.println(count); + + // send message, the Print interface can be used to set the message contents + mqttClient.beginMessage(topic); + mqttClient.print("hello "); + mqttClient.print(count); + mqttClient.endMessage(); + + Serial.println(); + + count++; + } +} diff --git a/lib/ArduinoMqttClient/examples/WiFiSimpleSender/arduino_secrets.h b/lib/ArduinoMqttClient/examples/WiFiSimpleSender/arduino_secrets.h new file mode 100644 index 0000000..0c9fdd5 --- /dev/null +++ b/lib/ArduinoMqttClient/examples/WiFiSimpleSender/arduino_secrets.h @@ -0,0 +1,2 @@ +#define SECRET_SSID "" +#define SECRET_PASS "" diff --git a/lib/ArduinoMqttClient/keywords.txt b/lib/ArduinoMqttClient/keywords.txt new file mode 100644 index 0000000..6c414b6 --- /dev/null +++ b/lib/ArduinoMqttClient/keywords.txt @@ -0,0 +1,52 @@ +############################################ +# Syntax Coloring Map For ArduinoMqttClient +############################################ +# Class +############################################ + +ArduinoMqttClient KEYWORD1 +MqttClient KEYWORD1 + +############################################ +# Methods and Functions +############################################ + +onMessage KEYWORD2 + +parseMessage KEYWORD2 +messageTopic KEYWORD2 +messageDup KEYWORD2 +messageQoS KEYWORD2 +messageRetain KEYWORD2 + +beginMessage KEYWORD2 +endMessage KEYWORD2 +beginWill KEYWORD2 +endWill KEYWORD2 + +subscribe KEYWORD2 +unsubscribe KEYWORD2 + +poll KEYWORD2 + +connect KEYWORD2 +write KEYWORD2 +available KEYWORD2 +read KEYWORD2 +peek KEYWORD2 +flush KEYWORD2 +stop KEYWORD2 +connected KEYWORD2 + +setId KEYWORD2 +setUsernamePassword KEYWORD2 +setCleanSession KEYWORD2 +setKeepAliveInterval KEYWORD2 +setConnectionTimeout KEYWORD2 + +connectError KEYWORD2 +subscribeQoS KEYWORD2 + +############################################ +# Constants +############################################ diff --git a/lib/ArduinoMqttClient/library.properties b/lib/ArduinoMqttClient/library.properties new file mode 100644 index 0000000..79e24de --- /dev/null +++ b/lib/ArduinoMqttClient/library.properties @@ -0,0 +1,10 @@ +name=ArduinoMqttClient +version=0.1.6 +author=Arduino +maintainer=Arduino +sentence=[BETA] Allows you to send and receive MQTT messages using Arduino. +paragraph= +category=Communication +url=https://github.com/arduino-libraries/ArduinoMqttClient +architectures=* +includes=ArduinoMqttClient.h diff --git a/lib/ArduinoMqttClient/src/ArduinoMqttClient.h b/lib/ArduinoMqttClient/src/ArduinoMqttClient.h new file mode 100644 index 0000000..ff0a8cc --- /dev/null +++ b/lib/ArduinoMqttClient/src/ArduinoMqttClient.h @@ -0,0 +1,25 @@ +/* + This file is part of the ArduinoMqttClient library. + Copyright (c) 2019 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _ARDUINO_MQTT_CLIENT_H_ +#define _ARDUINO_MQTT_CLIENT_H_ + +#include "MqttClient.h" + +#endif diff --git a/lib/ArduinoMqttClient/src/MqttClient.cpp b/lib/ArduinoMqttClient/src/MqttClient.cpp new file mode 100644 index 0000000..221b230 --- /dev/null +++ b/lib/ArduinoMqttClient/src/MqttClient.cpp @@ -0,0 +1,1200 @@ +/* + This file is part of the ArduinoMqttClient library. + Copyright (c) 2019 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include "MqttClient.h" + +// #define MQTT_CLIENT_DEBUG + +#ifndef htons + #ifdef __ARM__ + #define htons __REV16 + #else + #define htons(s) ((s<<8) | (s>>8)) + #endif +#endif + +#ifndef TX_PAYLOAD_BUFFER_SIZE + #ifdef __AVR__ + #define TX_PAYLOAD_BUFFER_SIZE 128 + #else + #define TX_PAYLOAD_BUFFER_SIZE 256 + #endif +#endif + +#define MQTT_CONNECT 1 +#define MQTT_CONNACK 2 +#define MQTT_PUBLISH 3 +#define MQTT_PUBACK 4 +#define MQTT_PUBREC 5 +#define MQTT_PUBREL 6 +#define MQTT_PUBCOMP 7 +#define MQTT_SUBSCRIBE 8 +#define MQTT_SUBACK 9 +#define MQTT_UNSUBSCRIBE 10 +#define MQTT_UNSUBACK 11 +#define MQTT_PINGREQ 12 +#define MQTT_PINGRESP 13 +#define MQTT_DISCONNECT 14 + +enum { + MQTT_CLIENT_RX_STATE_READ_TYPE, + MQTT_CLIENT_RX_STATE_READ_REMAINING_LENGTH, + MQTT_CLIENT_RX_STATE_READ_VARIABLE_HEADER, + MQTT_CLIENT_RX_STATE_READ_PUBLISH_TOPIC_LENGTH, + MQTT_CLIENT_RX_STATE_READ_PUBLISH_TOPIC, + MQTT_CLIENT_RX_STATE_READ_PUBLISH_PACKET_ID, + MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD, + MQTT_CLIENT_RX_STATE_DISCARD_PUBLISH_PAYLOAD +}; + +MqttClient::MqttClient(Client* client) : + _client(client), + _onMessage(NULL), + _cleanSession(true), + _keepAliveInterval(60 * 1000L), + _connectionTimeout(30 * 1000L), + _tx_payload_buffer_size(TX_PAYLOAD_BUFFER_SIZE), + _connectError(MQTT_SUCCESS), + _connected(false), + _subscribeQos(0x00), + _rxState(MQTT_CLIENT_RX_STATE_READ_TYPE), + _txBufferIndex(0), + _txPayloadBuffer(NULL), + _txPayloadBufferIndex(0), + _willBuffer(NULL), + _willBufferIndex(0), + _willMessageIndex(0), + _willFlags(0x00) +{ + setTimeout(0); +} + +MqttClient::MqttClient(Client& client) : MqttClient(&client) +{ + +} + +MqttClient::~MqttClient() +{ + if (_willBuffer) { + free(_willBuffer); + + _willBuffer = NULL; + } + + if (_txPayloadBuffer) { + free(_txPayloadBuffer); + + _txPayloadBuffer = NULL; + } +} + +#ifdef MQTT_CLIENT_STD_FUNCTION_CALLBACK +void MqttClient::onMessage(MessageCallback callback) +#else +void MqttClient::onMessage(void(*callback)(int)) +#endif +{ + _onMessage = callback; +} + +int MqttClient::parseMessage() +{ + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + // already had a message, but only partially read, discard the data + _rxState = MQTT_CLIENT_RX_STATE_DISCARD_PUBLISH_PAYLOAD; + } + + poll(); + + if (_rxState != MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + // message not received or not ready + return 0; + } + + return _rxLength; +} + +String MqttClient::messageTopic() const +{ + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + // message received and ready for reading + return _rxMessageTopic; + } + + return ""; +} + +int MqttClient::messageDup() const +{ + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + // message received and ready for reading + return _rxMessageDup; + } + + return -1; +} + +int MqttClient::messageQoS() const +{ + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + // message received and ready for reading + return _rxMessageQoS; + } + + return -1; +} + +int MqttClient::messageRetain() const +{ + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + // message received and ready for reading + return _rxMessageRetain; + } + + return -1; +} + +int MqttClient::beginMessage(const char* topic, unsigned long size, bool retain, uint8_t qos, bool dup) +{ + _txMessageTopic = topic; + _txMessageRetain = retain; + _txMessageQoS = qos; + _txMessageDup = dup; + _txPayloadBufferIndex = 0; + _txStreamPayload = (size != 0xffffffffL); + + if (_txStreamPayload) { + if (!publishHeader(size)) { + stop(); + + return 0; + } + } + + return 1; +} + +int MqttClient::beginMessage(const String& topic, unsigned long size, bool retain, uint8_t qos, bool dup) +{ + return beginMessage(topic.c_str(), size, retain, qos, dup); +} + +int MqttClient::beginMessage(const char* topic, bool retain, uint8_t qos, bool dup) +{ + return beginMessage(topic, 0xffffffffL, retain, qos, dup); +} + +int MqttClient::beginMessage(const String& topic, bool retain, uint8_t qos, bool dup) +{ + return beginMessage(topic.c_str(), retain, qos, dup); +} + +int MqttClient::endMessage() +{ + if (!_txStreamPayload) { + if (!publishHeader(_txPayloadBufferIndex) || + (clientWrite(_txPayloadBuffer, _txPayloadBufferIndex) != _txPayloadBufferIndex)) { + stop(); + + return 0; + } + } + + _txStreamPayload = false; + + if (_txMessageQoS) { + if (_txMessageQoS == 2) { + // wait for PUBREC + _returnCode = -1; + + for (unsigned long start = millis(); ((millis() - start) < _connectionTimeout) && clientConnected();) { + poll(); + + if (_returnCode != -1) { + if (_returnCode == 0) { + break; + } else { + return 0; + } + } + yield(); + } + + // reply with PUBREL + pubrel(_txPacketId); + } + + // wait for PUBACK or PUBCOMP + _returnCode = -1; + + for (unsigned long start = millis(); ((millis() - start) < _connectionTimeout) && clientConnected();) { + poll(); + + if (_returnCode != -1) { + return (_returnCode == 0); + } + yield(); + } + + return 0; + } + + return 1; +} + +int MqttClient::beginWill(const char* topic, unsigned short size, bool retain, uint8_t qos) +{ + int topicLength = strlen(topic); + size_t willLength = (2 + topicLength + 2 + size); + + if (qos > 2) { + // invalid QoS + } + + _willBuffer = (uint8_t*)realloc(_willBuffer, willLength); + + _txBuffer = _willBuffer; + _txBufferIndex = 0; + writeString(topic, topicLength); + write16(0); // dummy size for now + _willMessageIndex = _txBufferIndex; + + _willFlags = (qos << 3) | 0x04; + if (retain) { + _willFlags |= 0x20; + } + + return 0; +} + +int MqttClient::beginWill(const String& topic, unsigned short size, bool retain, uint8_t qos) +{ + return beginWill(topic.c_str(), size, retain, qos); +} + +int MqttClient::beginWill(const char* topic, bool retain, uint8_t qos) +{ + return beginWill(topic, _tx_payload_buffer_size, retain, qos); +} + +int MqttClient::beginWill(const String& topic, bool retain, uint8_t qos) +{ + return beginWill(topic.c_str(), retain, qos); +} + +int MqttClient::endWill() +{ + // update the index + _willBufferIndex = _txBufferIndex; + + // update the will message size + _txBufferIndex = (_willMessageIndex - 2); + write16(_willBufferIndex - _willMessageIndex); + + _txBuffer = NULL; + _willMessageIndex = 0; + + return 1; +} + +int MqttClient::subscribe(const char* topic, uint8_t qos) +{ + int topicLength = strlen(topic); + int remainingLength = topicLength + 5; + + if (qos > 2) { + // invalid QoS + return 0; + } + + _txPacketId++; + + if (_txPacketId == 0) { + _txPacketId = 1; + } + + uint8_t packetBuffer[5 + remainingLength]; + + beginPacket(MQTT_SUBSCRIBE, 0x02, remainingLength, packetBuffer); + write16(_txPacketId); + writeString(topic, topicLength); + write8(qos); + + if (!endPacket()) { + stop(); + + return 0; + } + + _returnCode = -1; + _subscribeQos = 0x80; + + for (unsigned long start = millis(); ((millis() - start) < _connectionTimeout) && clientConnected();) { + poll(); + + if (_returnCode != -1) { + _subscribeQos = _returnCode; + + return (_returnCode >= 0 && _returnCode <= 2); + } + yield(); + } + + stop(); + + return 0; +} + +int MqttClient::subscribe(const String& topic, uint8_t qos) +{ + return subscribe(topic.c_str(), qos); +} + +int MqttClient::unsubscribe(const char* topic) +{ + int topicLength = strlen(topic); + int remainingLength = topicLength + 4; + + _txPacketId++; + + if (_txPacketId == 0) { + _txPacketId = 1; + } + + uint8_t packetBuffer[5 + remainingLength]; + + beginPacket(MQTT_UNSUBSCRIBE, 0x02, remainingLength, packetBuffer); + write16(_txPacketId); + writeString(topic, topicLength); + + if (!endPacket()) { + stop(); + + return 0; + } + + _returnCode = -1; + + for (unsigned long start = millis(); ((millis() - start) < _connectionTimeout) && clientConnected();) { + poll(); + + if (_returnCode != -1) { + return (_returnCode == 0); + } + yield(); + } + + stop(); + + return 0; +} + +int MqttClient::unsubscribe(const String& topic) +{ + return unsubscribe(topic.c_str()); +} + +void MqttClient::poll() +{ + if (clientAvailable() == 0 && !clientConnected()) { + _rxState = MQTT_CLIENT_RX_STATE_READ_TYPE; + _connected = false; + } + + while (clientAvailable()) { + byte b = clientRead(); + _lastRx = millis(); + + switch (_rxState) { + case MQTT_CLIENT_RX_STATE_READ_TYPE: { + _rxType = (b >> 4); + _rxFlags = (b & 0x0f); + _rxLength = 0; + _rxLengthMultiplier = 1; + + _rxState = MQTT_CLIENT_RX_STATE_READ_REMAINING_LENGTH; + break; + } + + case MQTT_CLIENT_RX_STATE_READ_REMAINING_LENGTH: { + _rxLength += (b & 0x7f) * _rxLengthMultiplier; + + _rxLengthMultiplier *= 128; + + if (_rxLengthMultiplier > (128 * 128 * 128L)) { + // malformed + stop(); + + return; + } + + if ((b & 0x80) == 0) { // length done + bool malformedResponse = false; + + if (_rxType == MQTT_CONNACK || + _rxType == MQTT_PUBACK || + _rxType == MQTT_PUBREC || + _rxType == MQTT_PUBCOMP || + _rxType == MQTT_UNSUBACK) { + malformedResponse = (_rxFlags != 0x00 || _rxLength != 2); + } else if (_rxType == MQTT_PUBLISH) { + malformedResponse = ((_rxFlags & 0x06) == 0x06); + } else if (_rxType == MQTT_PUBREL) { + malformedResponse = (_rxFlags != 0x02 || _rxLength != 2); + } else if (_rxType == MQTT_SUBACK) { + malformedResponse = (_rxFlags != 0x00 || _rxLength != 3); + } else if (_rxType == MQTT_PINGRESP) { + malformedResponse = (_rxFlags != 0x00 || _rxLength != 0); + } else { + // unexpected type + malformedResponse = true; + } + + if (malformedResponse) { + stop(); + return; + } + + if (_rxType == MQTT_PUBLISH) { + _rxMessageDup = (_rxFlags & 0x80) != 0; + _rxMessageQoS = (_rxFlags >> 1) & 0x03; + _rxMessageRetain = (_rxFlags & 0x01); + + _rxState = MQTT_CLIENT_RX_STATE_READ_PUBLISH_TOPIC_LENGTH; + } else if (_rxLength == 0) { + _rxState = MQTT_CLIENT_RX_STATE_READ_TYPE; + } else { + _rxState = MQTT_CLIENT_RX_STATE_READ_VARIABLE_HEADER; + } + + _rxMessageIndex = 0; + } + break; + } + + case MQTT_CLIENT_RX_STATE_READ_VARIABLE_HEADER: { + _rxMessageBuffer[_rxMessageIndex++] = b; + + if (_rxMessageIndex == _rxLength) { + _rxState = MQTT_CLIENT_RX_STATE_READ_TYPE; + + if (_rxType == MQTT_CONNACK) { + _returnCode = _rxMessageBuffer[1]; + } else if (_rxType == MQTT_PUBACK || + _rxType == MQTT_PUBREC || + _rxType == MQTT_PUBCOMP || + _rxType == MQTT_UNSUBACK) { + uint16_t packetId = (_rxMessageBuffer[0] << 8) | _rxMessageBuffer[1]; + + if (packetId == _txPacketId) { + _returnCode = 0; + } + } else if (_rxType == MQTT_PUBREL) { + uint16_t packetId = (_rxMessageBuffer[0] << 8) | _rxMessageBuffer[1]; + + if (_txStreamPayload) { + // ignore, can't send as in the middle of a publish + } else { + pubcomp(packetId); + } + } else if (_rxType == MQTT_SUBACK) { + uint16_t packetId = (_rxMessageBuffer[0] << 8) | _rxMessageBuffer[1]; + + if (packetId == _txPacketId) { + _returnCode = _rxMessageBuffer[2]; + } + } + } + break; + } + + case MQTT_CLIENT_RX_STATE_READ_PUBLISH_TOPIC_LENGTH: { + _rxMessageBuffer[_rxMessageIndex++] = b; + + if (_rxMessageIndex == 2) { + _rxMessageTopicLength = (_rxMessageBuffer[0] << 8) | _rxMessageBuffer[1]; + _rxLength -= 2; + + _rxMessageTopic = ""; + _rxMessageTopic.reserve(_rxMessageTopicLength); + + if (_rxMessageQoS) { + if (_rxLength < (_rxMessageTopicLength + 2)) { + stop(); + return; + } + } else { + if (_rxLength < _rxMessageTopicLength) { + stop(); + return; + } + } + + _rxMessageIndex = 0; + _rxState = MQTT_CLIENT_RX_STATE_READ_PUBLISH_TOPIC; + } + + break; + } + + case MQTT_CLIENT_RX_STATE_READ_PUBLISH_TOPIC: { + _rxMessageTopic += (char)b; + + if (_rxMessageTopicLength == _rxMessageTopic.length()) { + _rxLength -= _rxMessageTopicLength; + + if (_rxMessageQoS) { + _rxState = MQTT_CLIENT_RX_STATE_READ_PUBLISH_PACKET_ID; + } else { + _rxState = MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD; + + if (_onMessage) { +#ifdef MQTT_CLIENT_STD_FUNCTION_CALLBACK + _onMessage(this,_rxLength); +#else + _onMessage(_rxLength); +#endif + + if (_rxLength == 0) { + _rxState = MQTT_CLIENT_RX_STATE_READ_TYPE; + } + } + } + } + + break; + } + + case MQTT_CLIENT_RX_STATE_READ_PUBLISH_PACKET_ID: { + _rxMessageBuffer[_rxMessageIndex++] = b; + + if (_rxMessageIndex == 2) { + _rxLength -= 2; + + _rxPacketId = (_rxMessageBuffer[0] << 8) | _rxMessageBuffer[1]; + + _rxState = MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD; + + if (_onMessage) { +#ifdef MQTT_CLIENT_STD_FUNCTION_CALLBACK + _onMessage(this,_rxLength); +#else + _onMessage(_rxLength); +#endif + } + + if (_rxLength == 0) { + // no payload to read, ack zero length message + ackRxMessage(); + + if (_onMessage) { + _rxState = MQTT_CLIENT_RX_STATE_READ_TYPE; + } + } + } + + break; + } + + case MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD: + case MQTT_CLIENT_RX_STATE_DISCARD_PUBLISH_PAYLOAD: { + if (_rxLength > 0) { + _rxLength--; + } + + if (_rxLength == 0) { + _rxState = MQTT_CLIENT_RX_STATE_READ_TYPE; + } else { + _rxState = MQTT_CLIENT_RX_STATE_DISCARD_PUBLISH_PAYLOAD; + } + + break; + } + } + + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + break; + } + } + + if (_connected) { + unsigned long now = millis(); + + if ((now - _lastPingTx) >= _keepAliveInterval) { + _lastPingTx = now; + + ping(); + } else if ((now - _lastRx) >= (_keepAliveInterval * 2)) { + stop(); + } + } +} + +int MqttClient::connect(IPAddress ip, uint16_t port) +{ + return connect(ip, NULL, port); +} + +int MqttClient::connect(const char *host, uint16_t port) +{ + return connect((uint32_t)0, host, port); +} + +size_t MqttClient::write(uint8_t b) +{ + return write(&b, sizeof(b)); +} + +size_t MqttClient::write(const uint8_t *buf, size_t size) +{ + if (_willMessageIndex) { + return writeData(buf, size); + } + + if (_txStreamPayload) { + return clientWrite(buf, size); + } + + if ((_txPayloadBufferIndex + size) >= _tx_payload_buffer_size) { + size = (_tx_payload_buffer_size - _txPayloadBufferIndex); + } + + if (_txPayloadBuffer == NULL) { + _txPayloadBuffer = (uint8_t*)malloc(_tx_payload_buffer_size); + } + + memcpy(&_txPayloadBuffer[_txPayloadBufferIndex], buf, size); + _txPayloadBufferIndex += size; + + return size; +} + +int MqttClient::available() +{ + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + return _rxLength; + } + + return 0; +} + +int MqttClient::read() +{ + byte b; + + if (read(&b, sizeof(b)) != sizeof(b)) { + return -1; + } + + return b; +} + +int MqttClient::read(uint8_t *buf, size_t size) +{ + size_t result = 0; + + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + size_t avail = available(); + + if (size > avail) { + size = avail; + } + + while (result < size) { + int b = clientTimedRead(); + + if (b == -1) { + break; + } + + result++; + *buf++ = b; + } + + if (result > 0) { + _rxLength -= result; + + if (_rxLength == 0) { + ackRxMessage(); + + _rxState = MQTT_CLIENT_RX_STATE_READ_TYPE; + } + } + } + + return result; +} + +int MqttClient::peek() +{ + if (_rxState == MQTT_CLIENT_RX_STATE_READ_PUBLISH_PAYLOAD) { + return clientPeek(); + } + + return -1; +} + +void MqttClient::flush() +{ +} + +void MqttClient::stop() +{ + if (connected()) { + disconnect(); + } + + _connected = false; + _client->stop(); +} + +uint8_t MqttClient::connected() +{ + return clientConnected() && _connected; +} + +MqttClient::operator bool() +{ + return true; +} + +void MqttClient::setId(const char* id) +{ + _id = id; +} + +void MqttClient::setId(const String& id) +{ + _id = id; +} + +void MqttClient::setUsernamePassword(const char* username, const char* password) +{ + _username = username; + _password = password; +} + +void MqttClient::setUsernamePassword(const String& username, const String& password) +{ + _username = username; + _password = password; +} + +void MqttClient::setCleanSession(bool cleanSession) +{ + _cleanSession = cleanSession; +} + +void MqttClient::setKeepAliveInterval(unsigned long interval) +{ + _keepAliveInterval = interval; +} + +void MqttClient::setConnectionTimeout(unsigned long timeout) +{ + _connectionTimeout = timeout; +} + +void MqttClient::setTxPayloadSize(unsigned short size) +{ + if (_txPayloadBuffer) { + free(_txPayloadBuffer); + _txPayloadBuffer = NULL; + _txPayloadBufferIndex = 0; + } + + _tx_payload_buffer_size = size; +} + +int MqttClient::connectError() const +{ + return _connectError; +} + +int MqttClient::subscribeQoS() const +{ + return _subscribeQos; +} + +int MqttClient::connect(IPAddress ip, const char* host, uint16_t port) +{ + if (clientConnected()) { + _client->stop(); + } + _rxState = MQTT_CLIENT_RX_STATE_READ_TYPE; + _connected = false; + _txPacketId = 0x0000; + + if (host) { + if (!_client->connect(host, port)) { + _connectError = MQTT_CONNECTION_REFUSED; + return 0; + } + } else { + if (!_client->connect(ip, port)) { + _connectError = MQTT_CONNECTION_REFUSED; + return 0; + } + } + + _lastRx = millis(); + + String id = _id; + int idLength = id.length(); + int usernameLength = _username.length(); + int passwordLength = _password.length(); + uint8_t flags = 0; + + if (idLength == 0) { + char tempId[17]; + + snprintf(tempId, sizeof(tempId), "Arduino-%.8lx", millis()); + + id = tempId; + idLength = sizeof(tempId) - 1; + } + + struct __attribute__ ((packed)) { + struct { + uint16_t length; + char value[4]; + } protocolName; + uint8_t level; + uint8_t flags; + uint16_t keepAlive; + } connectVariableHeader; + + size_t remainingLength = sizeof(connectVariableHeader) + (2 + idLength) + _willBufferIndex; + + if (usernameLength) { + flags |= 0x80; + + remainingLength += (2 + usernameLength); + } + + if (passwordLength) { + flags |= 0x40; + + remainingLength += (2 + passwordLength); + } + + flags |= _willFlags; + + if (_cleanSession) { + flags |= 0x02; // clean session + } + + connectVariableHeader.protocolName.length = htons(sizeof(connectVariableHeader.protocolName.value)); + memcpy(connectVariableHeader.protocolName.value, "MQTT", sizeof(connectVariableHeader.protocolName.value)); + connectVariableHeader.level = 0x04; + connectVariableHeader.flags = flags; + connectVariableHeader.keepAlive = htons(_keepAliveInterval / 1000); + + uint8_t packetBuffer[5 + remainingLength]; + + beginPacket(MQTT_CONNECT, 0x00, remainingLength, packetBuffer); + writeData(&connectVariableHeader, sizeof(connectVariableHeader)); + writeString(id.c_str(), idLength); + + if (_willBufferIndex) { + writeData(_willBuffer, _willBufferIndex); + } + + if (usernameLength) { + writeString(_username.c_str(), usernameLength); + } + + if (passwordLength) { + writeString(_password.c_str(), passwordLength); + } + + if (!endPacket()) { + _client->stop(); + + _connectError = MQTT_SERVER_UNAVAILABLE; + + return 0; + } + + _returnCode = MQTT_CONNECTION_TIMEOUT; + + for (unsigned long start = millis(); ((millis() - start) < _connectionTimeout) && clientConnected();) { + poll(); + + if (_returnCode != MQTT_CONNECTION_TIMEOUT) { + break; + } + yield(); + } + + _connectError = _returnCode; + + if (_returnCode == MQTT_SUCCESS) { + _connected = true; + + return 1; + } + + _client->stop(); + + return 0; +} + +int MqttClient::publishHeader(size_t length) +{ + int topicLength = _txMessageTopic.length(); + int headerLength = topicLength + 2; + + if (_txMessageQoS > 2) { + // invalid QoS + return 0; + } + + if (_txMessageQoS) { + // add two for packet id + headerLength += 2; + + _txPacketId++; + + if (_txPacketId == 0) { + _txPacketId = 1; + } + } + + // only for packet header + uint8_t packetHeaderBuffer[5 + headerLength]; + + uint8_t flags = 0; + + if (_txMessageRetain) { + flags |= 0x01; + } + + if (_txMessageQoS) { + flags |= (_txMessageQoS << 1); + } + + if (_txMessageDup) { + flags |= 0x08; + } + + beginPacket(MQTT_PUBLISH, flags, headerLength + length, packetHeaderBuffer); + writeString(_txMessageTopic.c_str(), topicLength); + if (_txMessageQoS) { + write16(_txPacketId); + } + + // send packet header + return endPacket(); +} + +void MqttClient::puback(uint16_t id) +{ + uint8_t packetBuffer[4]; + + beginPacket(MQTT_PUBACK, 0x00, 2, packetBuffer); + write16(id); + endPacket(); +} + +void MqttClient::pubrec(uint16_t id) +{ + uint8_t packetBuffer[4]; + + beginPacket(MQTT_PUBREC, 0x00, 2, packetBuffer); + write16(id); + endPacket(); +} + +void MqttClient::pubrel(uint16_t id) +{ + uint8_t packetBuffer[4]; + + beginPacket(MQTT_PUBREL, 0x02, 2, packetBuffer); + write16(id); + endPacket(); +} + +void MqttClient::pubcomp(uint16_t id) +{ + uint8_t packetBuffer[4]; + + beginPacket(MQTT_PUBCOMP, 0x00, 2, packetBuffer); + write16(id); + endPacket(); +} + +void MqttClient::ping() +{ + uint8_t packetBuffer[2]; + + beginPacket(MQTT_PINGREQ, 0, 0, packetBuffer); + endPacket(); +} + +void MqttClient::disconnect() +{ + uint8_t packetBuffer[2]; + + beginPacket(MQTT_DISCONNECT, 0, 0, packetBuffer); + endPacket(); +} + +int MqttClient::beginPacket(uint8_t type, uint8_t flags, size_t length, uint8_t* buffer) +{ + _txBuffer = buffer; + _txBufferIndex = 0; + + write8((type << 4) | flags); + + do { + uint8_t b = length % 128; + length /= 128; + + if(length > 0) { + b |= 0x80; + } + + _txBuffer[_txBufferIndex++] = b; + } while (length > 0); + + return _txBufferIndex; +} + +int MqttClient::writeString(const char* s, uint16_t length) +{ + int result = 0; + + result += write16(length); + result += writeData(s, length); + + return result; +} + +int MqttClient::write8(uint8_t val) +{ + return writeData(&val, sizeof(val)); +} + +int MqttClient::write16(uint16_t val) +{ + val = htons(val); + + return writeData(&val, sizeof(val)); +} + +int MqttClient::writeData(const void* data, size_t length) +{ + memcpy(&_txBuffer[_txBufferIndex], data, length); + _txBufferIndex += length; + + return length; +} + +int MqttClient::endPacket() +{ + int result = (clientWrite(_txBuffer, _txBufferIndex) == _txBufferIndex); + + _txBufferIndex = 0; + + return result; +} + +void MqttClient::ackRxMessage() +{ + if (_rxMessageQoS == 1) { + puback(_rxPacketId); + } else if (_rxMessageQoS == 2) { + pubrec(_rxPacketId); + } +} + +int MqttClient::clientRead() +{ + int result = _client->read(); + +#ifdef MQTT_CLIENT_DEBUG + if (result != -1) { + Serial.print("RX: "); + + if (result < 16) { + Serial.print('0'); + } + + Serial.println(result, HEX); + } +#endif + + return result; +} + +uint8_t MqttClient::clientConnected() +{ + return _client->connected(); +} + +int MqttClient::clientAvailable() +{ + return _client->available(); +} + +int MqttClient::clientTimedRead() +{ + unsigned long startMillis = millis(); + + do { + if (clientAvailable()) { + return clientRead(); + } else if (!clientConnected()) { + return -1; + } + + yield(); + } while((millis() - startMillis) < 1000); + + return -1; +} + +int MqttClient::clientPeek() +{ + return _client->peek(); +} + +size_t MqttClient::clientWrite(const uint8_t *buf, size_t size) +{ +#ifdef MQTT_CLIENT_DEBUG + Serial.print("TX["); + Serial.print(size); + Serial.print("]: "); + for (size_t i = 0; i < size; i++) { + uint8_t b = buf[i]; + + if (b < 16) { + Serial.print('0'); + } + + Serial.print(b, HEX); + Serial.print(' '); + } + Serial.println(); +#endif + + return _client->write(buf, size); +} diff --git a/lib/ArduinoMqttClient/src/MqttClient.h b/lib/ArduinoMqttClient/src/MqttClient.h new file mode 100644 index 0000000..522f023 --- /dev/null +++ b/lib/ArduinoMqttClient/src/MqttClient.h @@ -0,0 +1,200 @@ +/* + This file is part of the ArduinoMqttClient library. + Copyright (c) 2019 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _MQTT_CLIENT_H_ +#define _MQTT_CLIENT_H_ + +#include +#include + +#define MQTT_CONNECTION_REFUSED -2 +#define MQTT_CONNECTION_TIMEOUT -1 +#define MQTT_SUCCESS 0 +#define MQTT_UNACCEPTABLE_PROTOCOL_VERSION 1 +#define MQTT_IDENTIFIER_REJECTED 2 +#define MQTT_SERVER_UNAVAILABLE 3 +#define MQTT_BAD_USER_NAME_OR_PASSWORD 4 +#define MQTT_NOT_AUTHORIZED 5 + +// Make this definition in your application code to use std::functions for onMessage callbacks instead of C-pointers: +// #define MQTT_CLIENT_STD_FUNCTION_CALLBACK + +#ifdef MQTT_CLIENT_STD_FUNCTION_CALLBACK +#include +#endif + +class MqttClient : public Client { +public: + MqttClient(Client* client); + MqttClient(Client& client); + virtual ~MqttClient(); + +#ifdef MQTT_CLIENT_STD_FUNCTION_CALLBACK + typedef std::function MessageCallback; + void onMessage(MessageCallback callback); +#else + inline void setClient(Client& client) { _client = &client; } + void onMessage(void(*)(int)); +#endif + + int parseMessage(); + String messageTopic() const; + int messageDup() const; + int messageQoS() const; + int messageRetain() const; + + int beginMessage(const char* topic, unsigned long size, bool retain = false, uint8_t qos = 0, bool dup = false); + int beginMessage(const String& topic, unsigned long size, bool retain = false, uint8_t qos = 0, bool dup = false); + int beginMessage(const char* topic, bool retain = false, uint8_t qos = 0, bool dup = false); + int beginMessage(const String& topic, bool retain = false, uint8_t qos = 0, bool dup = false); + int endMessage(); + + int beginWill(const char* topic, unsigned short size, bool retain, uint8_t qos); + int beginWill(const String& topic, unsigned short size, bool retain, uint8_t qos); + int beginWill(const char* topic, bool retain, uint8_t qos); + int beginWill(const String& topic, bool retain, uint8_t qos); + int endWill(); + + int subscribe(const char* topic, uint8_t qos = 0); + int subscribe(const String& topic, uint8_t qos = 0); + int unsubscribe(const char* topic); + int unsubscribe(const String& topic); + + void poll(); + + // from Client + virtual int connect(IPAddress ip, uint16_t port = 1883); + virtual int connect(const char *host, uint16_t port = 1883); +#ifdef ESP8266 + virtual int connect(const IPAddress& ip, uint16_t port) { return 0; }; /* ESP8266 core defines this pure virtual in Client.h */ +#endif + virtual size_t write(uint8_t); + virtual size_t write(const uint8_t *buf, size_t size); + virtual int available(); + virtual int read(); + virtual int read(uint8_t *buf, size_t size); + virtual int peek(); + virtual void flush(); + virtual void stop(); + virtual uint8_t connected(); + virtual operator bool(); + + void setId(const char* id); + void setId(const String& id); + + void setUsernamePassword(const char* username, const char* password); + void setUsernamePassword(const String& username, const String& password); + + void setCleanSession(bool cleanSession); + + void setKeepAliveInterval(unsigned long interval); + void setConnectionTimeout(unsigned long timeout); + void setTxPayloadSize(unsigned short size); + + int connectError() const; + int subscribeQoS() const; +#ifdef ESP8266 + virtual bool flush(unsigned int /*maxWaitMs*/) { flush(); return true; } /* ESP8266 core defines this pure virtual in Client.h */ + virtual bool stop(unsigned int /*maxWaitMs*/) { stop(); return true; } /* ESP8266 core defines this pure virtual in Client.h */ +#endif + +private: + int connect(IPAddress ip, const char* host, uint16_t port); + int publishHeader(size_t length); + void puback(uint16_t id); + void pubrec(uint16_t id); + void pubrel(uint16_t id); + void pubcomp(uint16_t id); + void ping(); + void disconnect(); + + int beginPacket(uint8_t type, uint8_t flags, size_t length, uint8_t* buffer); + int writeString(const char* s, uint16_t length); + int write8(uint8_t val); + int write16(uint16_t val); + int writeData(const void* data, size_t length); + int endPacket(); + + void ackRxMessage(); + + uint8_t clientConnected(); + int clientAvailable(); + int clientRead(); + int clientTimedRead(); + int clientPeek(); + size_t clientWrite(const uint8_t *buf, size_t size); + +private: + Client* _client; + +#ifdef MQTT_CLIENT_STD_FUNCTION_CALLBACK + MessageCallback _onMessage; +#else + void (*_onMessage)(int); +#endif + + String _id; + String _username; + String _password; + bool _cleanSession; + + unsigned long _keepAliveInterval; + unsigned long _connectionTimeout; + unsigned short _tx_payload_buffer_size; + + int _connectError; + bool _connected; + int _subscribeQos; + + int _rxState; + uint8_t _rxType; + uint8_t _rxFlags; + size_t _rxLength; + uint32_t _rxLengthMultiplier; + int _returnCode; + + String _rxMessageTopic; + size_t _rxMessageTopicLength; + bool _rxMessageDup; + uint8_t _rxMessageQoS; + bool _rxMessageRetain; + uint16_t _rxPacketId; + uint8_t _rxMessageBuffer[3]; + size_t _rxMessageIndex; + unsigned long _lastRx; + + String _txMessageTopic; + bool _txMessageRetain; + uint8_t _txMessageQoS; + bool _txMessageDup; + uint16_t _txPacketId; + uint8_t* _txBuffer; + size_t _txBufferIndex; + bool _txStreamPayload; + uint8_t* _txPayloadBuffer; + size_t _txPayloadBufferIndex; + unsigned long _lastPingTx; + + uint8_t* _willBuffer; + uint16_t _willBufferIndex; + size_t _willMessageIndex; + uint8_t _willFlags; +}; + +#endif diff --git a/lib/MqttLogger/src/MqttLogger.cpp b/lib/MqttLogger/src/MqttLogger.cpp index 199286f..2b3c12b 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(PubSubClient& client, const char* topic, MqttLoggerMode mode) +MqttLogger::MqttLogger(MqttClient& client, const char* topic, MqttLoggerMode mode) { this->setClient(client); this->setTopic(topic); @@ -19,7 +19,7 @@ MqttLogger::~MqttLogger() { } -void MqttLogger::setClient(PubSubClient& client) +void MqttLogger::setClient(MqttClient& client) { this->client = &client; } @@ -76,7 +76,9 @@ void MqttLogger::sendBuffer() bool doSerial = this->mode==MqttLoggerMode::SerialOnly || this->mode==MqttLoggerMode::MqttAndSerial; if (this->mode!=MqttLoggerMode::SerialOnly && this->client != NULL && this->client->connected()) { - this->client->publish(this->topic, (byte *)this->buffer, this->bufferCnt, 1); + this->client->beginMessage(topic); + this->client->write((byte *)this->buffer, this->bufferCnt); + this->client->endMessage(); } else if (this->mode == MqttLoggerMode::MqttAndSerialFallback) { doSerial = true; diff --git a/lib/MqttLogger/src/MqttLogger.h b/lib/MqttLogger/src/MqttLogger.h index c9dd15d..9a570e4 100644 --- a/lib/MqttLogger/src/MqttLogger.h +++ b/lib/MqttLogger/src/MqttLogger.h @@ -11,7 +11,9 @@ #include #include -#include +#include "MqttClient.h" + +#define MQTT_MAX_PACKET_SIZE 1024 enum MqttLoggerMode { MqttAndSerialFallback = 0, @@ -27,16 +29,16 @@ private: uint8_t* buffer; uint8_t* bufferEnd; uint16_t bufferCnt = 0, bufferSize = 0; - PubSubClient* client; + MqttClient* client; MqttLoggerMode mode; void sendBuffer(); public: MqttLogger(MqttLoggerMode mode=MqttLoggerMode::MqttAndSerialFallback); - MqttLogger(PubSubClient& client, const char* topic, MqttLoggerMode mode=MqttLoggerMode::MqttAndSerialFallback); + MqttLogger(MqttClient& client, const char* topic, MqttLoggerMode mode=MqttLoggerMode::MqttAndSerialFallback); ~MqttLogger(); - void setClient(PubSubClient& client); + void setClient(MqttClient& client); void setTopic(const char* topic); void setMode(MqttLoggerMode mode); void setRetained(boolean retained); diff --git a/lib/pubsubclient/.travis.yml b/lib/pubsubclient/.travis.yml deleted file mode 100644 index e7b28cb..0000000 --- a/lib/pubsubclient/.travis.yml +++ /dev/null @@ -1,7 +0,0 @@ -sudo: false -language: cpp -compiler: - - g++ -script: cd tests && make && make test -os: - - linux diff --git a/lib/pubsubclient/CHANGES.txt b/lib/pubsubclient/CHANGES.txt deleted file mode 100755 index e23d531..0000000 --- a/lib/pubsubclient/CHANGES.txt +++ /dev/null @@ -1,85 +0,0 @@ -2.8 - * Add setBufferSize() to override MQTT_MAX_PACKET_SIZE - * Add setKeepAlive() to override MQTT_KEEPALIVE - * Add setSocketTimeout() to overide MQTT_SOCKET_TIMEOUT - * Added check to prevent subscribe/unsubscribe to empty topics - * Declare wifi mode prior to connect in ESP example - * Use `strnlen` to avoid overruns - * Support pre-connected Client objects - -2.7 - * Fix remaining-length handling to prevent buffer overrun - * Add large-payload API - beginPublish/write/publish/endPublish - * Add yield call to improve reliability on ESP - * Add Clean Session flag to connect options - * Add ESP32 support for functional callback signature - * Various other fixes - -2.4 - * Add MQTT_SOCKET_TIMEOUT to prevent it blocking indefinitely - whilst waiting for inbound data - * Fixed return code when publishing >256 bytes - -2.3 - * Add publish(topic,payload,retained) function - -2.2 - * Change code layout to match Arduino Library reqs - -2.1 - * Add MAX_TRANSFER_SIZE def to chunk messages if needed - * Reject topic/payloads that exceed MQTT_MAX_PACKET_SIZE - -2.0 - * Add (and default to) MQTT 3.1.1 support - * Fix PROGMEM handling for Intel Galileo/ESP8266 - * Add overloaded constructors for convenience - * Add chainable setters for server/callback/client/stream - * Add state function to return connack return code - -1.9 - * Do not split MQTT packets over multiple calls to _client->write() - * API change: All constructors now require an instance of Client - to be passed in. - * Fixed example to match 1.8 api changes - dpslwk - * Added username/password support - WilHall - * Added publish_P - publishes messages from PROGMEM - jobytaffey - -1.8 - * KeepAlive interval is configurable in PubSubClient.h - * Maximum packet size is configurable in PubSubClient.h - * API change: Return boolean rather than int from various functions - * API change: Length parameter in message callback changed - from int to unsigned int - * Various internal tidy-ups around types -1.7 - * Improved keepalive handling - * Updated to the Arduino-1.0 API -1.6 - * Added the ability to publish a retained message - -1.5 - * Added default constructor - * Fixed compile error when used with arduino-0021 or later - -1.4 - * Fixed connection lost handling - -1.3 - * Fixed packet reading bug in PubSubClient.readPacket - -1.2 - * Fixed compile error when used with arduino-0016 or later - - -1.1 - * Reduced size of library - * Added support for Will messages - * Clarified licensing - see LICENSE.txt - - -1.0 - * Only Quality of Service (QOS) 0 messaging is supported - * The maximum message size, including header, is 128 bytes - * The keepalive interval is set to 30 seconds - * No support for Will messages diff --git a/lib/pubsubclient/LICENSE.txt b/lib/pubsubclient/LICENSE.txt deleted file mode 100755 index 12c1689..0000000 --- a/lib/pubsubclient/LICENSE.txt +++ /dev/null @@ -1,20 +0,0 @@ -Copyright (c) 2008-2020 Nicholas O'Leary - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/lib/pubsubclient/README.md b/lib/pubsubclient/README.md deleted file mode 100644 index 2e13171..0000000 --- a/lib/pubsubclient/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# Arduino Client for MQTT - -This library provides a client for doing simple publish/subscribe messaging with -a server that supports MQTT. - -## Examples - -The library comes with a number of example sketches. See File > Examples > PubSubClient -within the Arduino application. - -Full API documentation is available here: https://pubsubclient.knolleary.net - -## Limitations - - - It can only publish QoS 0 messages. It can subscribe at QoS 0 or QoS 1. - - The maximum message size, including header, is **256 bytes** by default. This - is configurable via `MQTT_MAX_PACKET_SIZE` in `PubSubClient.h` or can be changed - by calling `PubSubClient::setBufferSize(size)`. - - The keepalive interval is set to 15 seconds by default. This is configurable - via `MQTT_KEEPALIVE` in `PubSubClient.h` or can be changed by calling - `PubSubClient::setKeepAlive(keepAlive)`. - - The client uses MQTT 3.1.1 by default. It can be changed to use MQTT 3.1 by - changing value of `MQTT_VERSION` in `PubSubClient.h`. - - -## Compatible Hardware - -The library uses the Arduino Ethernet Client api for interacting with the -underlying network hardware. This means it Just Works with a growing number of -boards and shields, including: - - - Arduino Ethernet - - Arduino Ethernet Shield - - Arduino YUN – use the included `YunClient` in place of `EthernetClient`, and - be sure to do a `Bridge.begin()` first - - Arduino WiFi Shield - if you want to send packets > 90 bytes with this shield, - enable the `MQTT_MAX_TRANSFER_SIZE` define in `PubSubClient.h`. - - Sparkfun WiFly Shield – [library](https://github.com/dpslwk/WiFly) - - TI CC3000 WiFi - [library](https://github.com/sparkfun/SFE_CC3000_Library) - - Intel Galileo/Edison - - ESP8266 - - ESP32 - -The library cannot currently be used with hardware based on the ENC28J60 chip – -such as the Nanode or the Nuelectronics Ethernet Shield. For those, there is an -[alternative library](https://github.com/njh/NanodeMQTT) available. - -## License - -This code is released under the MIT License. diff --git a/lib/pubsubclient/examples/mqtt_auth/mqtt_auth.ino b/lib/pubsubclient/examples/mqtt_auth/mqtt_auth.ino deleted file mode 100755 index 3144d17..0000000 --- a/lib/pubsubclient/examples/mqtt_auth/mqtt_auth.ino +++ /dev/null @@ -1,43 +0,0 @@ -/* - Basic MQTT example with Authentication - - - connects to an MQTT server, providing username - and password - - publishes "hello world" to the topic "outTopic" - - subscribes to the topic "inTopic" -*/ - -#include -#include -#include - -// Update these with values suitable for your network. -byte mac[] = { 0xDE, 0xED, 0xBA, 0xFE, 0xFE, 0xED }; -IPAddress ip(172, 16, 0, 100); -IPAddress server(172, 16, 0, 2); - -void callback(char* topic, byte* payload, unsigned int length) { - // handle message arrived -} - -server-> ethClient; -PubSubClient client(server, 1883, callback, ethClient); - -void setup() -{ - Ethernet.begin(mac, ip); - // Note - the default maximum packet size is 128 bytes. If the - // combined length of clientId, username and password exceed this use the - // following to increase the buffer size: - // client.setBufferSize(255); - - if (client.connect("arduinoClient", "testuser", "testpass")) { - client.publish("outTopic","hello world"); - client.subscribe("inTopic"); - } -} - -void loop() -{ - client.loop(); -} diff --git a/lib/pubsubclient/examples/mqtt_basic/mqtt_basic.ino b/lib/pubsubclient/examples/mqtt_basic/mqtt_basic.ino deleted file mode 100755 index f545ade..0000000 --- a/lib/pubsubclient/examples/mqtt_basic/mqtt_basic.ino +++ /dev/null @@ -1,77 +0,0 @@ -/* - Basic MQTT example - - This sketch demonstrates the basic capabilities of the library. - It connects to an MQTT server then: - - publishes "hello world" to the topic "outTopic" - - subscribes to the topic "inTopic", printing out any messages - it receives. NB - it assumes the received payloads are strings not binary - - It will reconnect to the server if the connection is lost using a blocking - reconnect function. See the 'mqtt_reconnect_nonblocking' example for how to - achieve the same result without blocking the main loop. - -*/ - -#include -#include -#include - -// Update these with values suitable for your network. -byte mac[] = { 0xDE, 0xED, 0xBA, 0xFE, 0xFE, 0xED }; -IPAddress ip(172, 16, 0, 100); -IPAddress server(172, 16, 0, 2); - -void callback(char* topic, byte* payload, unsigned int length) { - Serial.print("Message arrived ["); - Serial.print(topic); - Serial.print("] "); - for (int i=0;i Preferences -> Additional Boards Manager URLs": - http://arduino.esp8266.com/stable/package_esp8266com_index.json - - Open the "Tools -> Board -> Board Manager" and click install for the ESP8266" - - Select your ESP8266 in "Tools -> Board" -*/ - -#include -#include - -// Update these with values suitable for your network. - -const char* ssid = "........"; -const char* password = "........"; -const char* mqtt_server = "broker.mqtt-dashboard.com"; - -WiFiClient espClient; -PubSubClient client(espClient); -unsigned long lastMsg = 0; -#define MSG_BUFFER_SIZE (50) -char msg[MSG_BUFFER_SIZE]; -int value = 0; - -void setup_wifi() { - - delay(10); - // We start by connecting to a WiFi network - Serial.println(); - Serial.print("Connecting to "); - Serial.println(ssid); - - WiFi.mode(WIFI_STA); - WiFi.begin(ssid, password); - - while (WiFi.status() != WL_CONNECTED) { - delay(500); - Serial.print("."); - } - - randomSeed(micros()); - - Serial.println(""); - Serial.println("WiFi connected"); - Serial.println("IP address: "); - Serial.println(WiFi.localIP()); -} - -void callback(char* topic, byte* payload, unsigned int length) { - Serial.print("Message arrived ["); - Serial.print(topic); - Serial.print("] "); - for (int i = 0; i < length; i++) { - Serial.print((char)payload[i]); - } - Serial.println(); - - // Switch on the LED if an 1 was received as first character - if ((char)payload[0] == '1') { - digitalWrite(BUILTIN_LED, LOW); // Turn the LED on (Note that LOW is the voltage level - // but actually the LED is on; this is because - // it is active low on the ESP-01) - } else { - digitalWrite(BUILTIN_LED, HIGH); // Turn the LED off by making the voltage HIGH - } - -} - -void reconnect() { - // Loop until we're reconnected - while (!client.connected()) { - Serial.print("Attempting MQTT connection..."); - // Create a random client ID - String clientId = "ESP8266Client-"; - clientId += String(random(0xffff), HEX); - // Attempt to connect - if (client.connect(clientId.c_str())) { - Serial.println("connected"); - // Once connected, publish an announcement... - client.publish("outTopic", "hello world"); - // ... and resubscribe - client.subscribe("inTopic"); - } else { - Serial.print("failed, rc="); - Serial.print(client.state()); - Serial.println(" try again in 5 seconds"); - // Wait 5 seconds before retrying - delay(5000); - } - } -} - -void setup() { - pinMode(BUILTIN_LED, OUTPUT); // Initialize the BUILTIN_LED pin as an output - Serial.begin(115200); - setup_wifi(); - client.setServer(mqtt_server, 1883); - client.setCallback(callback); -} - -void loop() { - - if (!client.connected()) { - reconnect(); - } - client.loop(); - - unsigned long now = millis(); - if (now - lastMsg > 2000) { - lastMsg = now; - ++value; - snprintf (msg, MSG_BUFFER_SIZE, "hello world #%ld", value); - Serial.print("Publish message: "); - Serial.println(msg); - client.publish("outTopic", msg); - } -} diff --git a/lib/pubsubclient/examples/mqtt_large_message/mqtt_large_message.ino b/lib/pubsubclient/examples/mqtt_large_message/mqtt_large_message.ino deleted file mode 100644 index e048c3e..0000000 --- a/lib/pubsubclient/examples/mqtt_large_message/mqtt_large_message.ino +++ /dev/null @@ -1,179 +0,0 @@ -/* - Long message ESP8266 MQTT example - - This sketch demonstrates sending arbitrarily large messages in combination - with the ESP8266 board/library. - - It connects to an MQTT server then: - - publishes "hello world" to the topic "outTopic" - - subscribes to the topic "greenBottles/#", printing out any messages - it receives. NB - it assumes the received payloads are strings not binary - - If the sub-topic is a number, it publishes a "greenBottles/lyrics" message - with a payload consisting of the lyrics to "10 green bottles", replacing - 10 with the number given in the sub-topic. - - It will reconnect to the server if the connection is lost using a blocking - reconnect function. See the 'mqtt_reconnect_nonblocking' example for how to - achieve the same result without blocking the main loop. - - To install the ESP8266 board, (using Arduino 1.6.4+): - - Add the following 3rd party board manager under "File -> Preferences -> Additional Boards Manager URLs": - http://arduino.esp8266.com/stable/package_esp8266com_index.json - - Open the "Tools -> Board -> Board Manager" and click install for the ESP8266" - - Select your ESP8266 in "Tools -> Board" - -*/ - -#include -#include - -// Update these with values suitable for your network. - -const char* ssid = "........"; -const char* password = "........"; -const char* mqtt_server = "broker.mqtt-dashboard.com"; - -WiFiClient espClient; -PubSubClient client(espClient); -long lastMsg = 0; -char msg[50]; -int value = 0; - -void setup_wifi() { - - delay(10); - // We start by connecting to a WiFi network - Serial.println(); - Serial.print("Connecting to "); - Serial.println(ssid); - - WiFi.begin(ssid, password); - - while (WiFi.status() != WL_CONNECTED) { - delay(500); - Serial.print("."); - } - - randomSeed(micros()); - - Serial.println(""); - Serial.println("WiFi connected"); - Serial.println("IP address: "); - Serial.println(WiFi.localIP()); -} - -void callback(char* topic, byte* payload, unsigned int length) { - Serial.print("Message arrived ["); - Serial.print(topic); - Serial.print("] "); - for (int i = 0; i < length; i++) { - Serial.print((char)payload[i]); - } - Serial.println(); - - // Find out how many bottles we should generate lyrics for - String topicStr(topic); - int bottleCount = 0; // assume no bottles unless we correctly parse a value from the topic - if (topicStr.indexOf('/') >= 0) { - // The topic includes a '/', we'll try to read the number of bottles from just after that - topicStr.remove(0, topicStr.indexOf('/')+1); - // Now see if there's a number of bottles after the '/' - bottleCount = topicStr.toInt(); - } - - if (bottleCount > 0) { - // Work out how big our resulting message will be - int msgLen = 0; - for (int i = bottleCount; i > 0; i--) { - String numBottles(i); - msgLen += 2*numBottles.length(); - if (i == 1) { - msgLen += 2*String(" green bottle, standing on the wall\n").length(); - } else { - msgLen += 2*String(" green bottles, standing on the wall\n").length(); - } - msgLen += String("And if one green bottle should accidentally fall\nThere'll be ").length(); - switch (i) { - case 1: - msgLen += String("no green bottles, standing on the wall\n\n").length(); - break; - case 2: - msgLen += String("1 green bottle, standing on the wall\n\n").length(); - break; - default: - numBottles = i-1; - msgLen += numBottles.length(); - msgLen += String(" green bottles, standing on the wall\n\n").length(); - break; - }; - } - - // Now we can start to publish the message - client.beginPublish("greenBottles/lyrics", msgLen, false); - for (int i = bottleCount; i > 0; i--) { - for (int j = 0; j < 2; j++) { - client.print(i); - if (i == 1) { - client.print(" green bottle, standing on the wall\n"); - } else { - client.print(" green bottles, standing on the wall\n"); - } - } - client.print("And if one green bottle should accidentally fall\nThere'll be "); - switch (i) { - case 1: - client.print("no green bottles, standing on the wall\n\n"); - break; - case 2: - client.print("1 green bottle, standing on the wall\n\n"); - break; - default: - client.print(i-1); - client.print(" green bottles, standing on the wall\n\n"); - break; - }; - } - // Now we're done! - client.endPublish(); - } -} - -void reconnect() { - // Loop until we're reconnected - while (!client.connected()) { - Serial.print("Attempting MQTT connection..."); - // Create a random client ID - String clientId = "ESP8266Client-"; - clientId += String(random(0xffff), HEX); - // Attempt to connect - if (client.connect(clientId.c_str())) { - Serial.println("connected"); - // Once connected, publish an announcement... - client.publish("outTopic", "hello world"); - // ... and resubscribe - client.subscribe("greenBottles/#"); - } else { - Serial.print("failed, rc="); - Serial.print(client.state()); - Serial.println(" try again in 5 seconds"); - // Wait 5 seconds before retrying - delay(5000); - } - } -} - -void setup() { - pinMode(BUILTIN_LED, OUTPUT); // Initialize the BUILTIN_LED pin as an output - Serial.begin(115200); - setup_wifi(); - client.setServer(mqtt_server, 1883); - client.setCallback(callback); -} - -void loop() { - - if (!client.connected()) { - reconnect(); - } - client.loop(); -} diff --git a/lib/pubsubclient/examples/mqtt_publish_in_callback/mqtt_publish_in_callback.ino b/lib/pubsubclient/examples/mqtt_publish_in_callback/mqtt_publish_in_callback.ino deleted file mode 100644 index 42afb2a..0000000 --- a/lib/pubsubclient/examples/mqtt_publish_in_callback/mqtt_publish_in_callback.ino +++ /dev/null @@ -1,60 +0,0 @@ -/* - Publishing in the callback - - - connects to an MQTT server - - subscribes to the topic "inTopic" - - when a message is received, republishes it to "outTopic" - - This example shows how to publish messages within the - callback function. The callback function header needs to - be declared before the PubSubClient constructor and the - actual callback defined afterwards. - This ensures the client reference in the callback function - is valid. - -*/ - -#include -#include -#include - -// Update these with values suitable for your network. -byte mac[] = { 0xDE, 0xED, 0xBA, 0xFE, 0xFE, 0xED }; -IPAddress ip(172, 16, 0, 100); -IPAddress server(172, 16, 0, 2); - -// Callback function header -void callback(char* topic, byte* payload, unsigned int length); - -EthernetClient ethClient; -PubSubClient client(server, 1883, callback, ethClient); - -// Callback function -void callback(char* topic, byte* payload, unsigned int length) { - // In order to republish this payload, a copy must be made - // as the orignal payload buffer will be overwritten whilst - // constructing the PUBLISH packet. - - // Allocate the correct amount of memory for the payload copy - byte* p = (byte*)malloc(length); - // Copy the payload to the new buffer - memcpy(p,payload,length); - client.publish("outTopic", p, length); - // Free the memory - free(p); -} - -void setup() -{ - - Ethernet.begin(mac, ip); - if (client.connect("arduinoClient")) { - client.publish("outTopic","hello world"); - client.subscribe("inTopic"); - } -} - -void loop() -{ - client.loop(); -} diff --git a/lib/pubsubclient/examples/mqtt_reconnect_nonblocking/mqtt_reconnect_nonblocking.ino b/lib/pubsubclient/examples/mqtt_reconnect_nonblocking/mqtt_reconnect_nonblocking.ino deleted file mode 100644 index 080b739..0000000 --- a/lib/pubsubclient/examples/mqtt_reconnect_nonblocking/mqtt_reconnect_nonblocking.ino +++ /dev/null @@ -1,67 +0,0 @@ -/* - Reconnecting MQTT example - non-blocking - - This sketch demonstrates how to keep the client connected - using a non-blocking reconnect function. If the client loses - its connection, it attempts to reconnect every 5 seconds - without blocking the main loop. - -*/ - -#include -#include -#include - -// Update these with values suitable for your hardware/network. -byte mac[] = { 0xDE, 0xED, 0xBA, 0xFE, 0xFE, 0xED }; -IPAddress ip(172, 16, 0, 100); -IPAddress server(172, 16, 0, 2); - -void callback(char* topic, byte* payload, unsigned int length) { - // handle message arrived -} - -EthernetClient ethClient; -PubSubClient client(ethClient); - -long lastReconnectAttempt = 0; - -boolean reconnect() { - if (client.connect("arduinoClient")) { - // Once connected, publish an announcement... - client.publish("outTopic","hello world"); - // ... and resubscribe - client.subscribe("inTopic"); - } - return client.connected(); -} - -void setup() -{ - client.setServer(server, 1883); - client.setCallback(callback); - - Ethernet.begin(mac, ip); - delay(1500); - lastReconnectAttempt = 0; -} - - -void loop() -{ - if (!client.connected()) { - long now = millis(); - if (now - lastReconnectAttempt > 5000) { - lastReconnectAttempt = now; - // Attempt to reconnect - if (reconnect()) { - lastReconnectAttempt = 0; - } - } - } else { - // Client connected - - client.loop(); - } - -} diff --git a/lib/pubsubclient/examples/mqtt_stream/mqtt_stream.ino b/lib/pubsubclient/examples/mqtt_stream/mqtt_stream.ino deleted file mode 100644 index 67c2287..0000000 --- a/lib/pubsubclient/examples/mqtt_stream/mqtt_stream.ino +++ /dev/null @@ -1,57 +0,0 @@ -/* - Example of using a Stream object to store the message payload - - Uses SRAM library: https://github.com/ennui2342/arduino-sram - but could use any Stream based class such as SD - - - connects to an MQTT server - - publishes "hello world" to the topic "outTopic" - - subscribes to the topic "inTopic" -*/ - -#include -#include -#include -#include - -// Update these with values suitable for your network. -byte mac[] = { 0xDE, 0xED, 0xBA, 0xFE, 0xFE, 0xED }; -IPAddress ip(172, 16, 0, 100); -IPAddress server(172, 16, 0, 2); - -SRAM sram(4, SRAM_1024); - -void callback(char* topic, byte* payload, unsigned int length) { - sram.seek(1); - - // do something with the message - for(uint8_t i=0; i -maintainer=Nick O'Leary -sentence=A client library for MQTT messaging. -paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows you to send and receive MQTT messages. It supports the latest MQTT 3.1.1 protocol and can be configured to use the older MQTT 3.1 if needed. It supports all Arduino Ethernet Client compatible hardware, including the Intel Galileo/Edison, ESP8266 and TI CC3000. -category=Communication -url=http://pubsubclient.knolleary.net -architectures=* diff --git a/lib/pubsubclient/src/PubSubClient.cpp b/lib/pubsubclient/src/PubSubClient.cpp deleted file mode 100755 index 2b48d2b..0000000 --- a/lib/pubsubclient/src/PubSubClient.cpp +++ /dev/null @@ -1,769 +0,0 @@ -/* - - PubSubClient.cpp - A simple client for MQTT. - Nick O'Leary - http://knolleary.net -*/ - -#include "PubSubClient.h" -#include "Arduino.h" - -PubSubClient::PubSubClient() { - this->_state = MQTT_DISCONNECTED; - this->_client = NULL; - this->stream = NULL; - setCallback(NULL); - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} - -PubSubClient::PubSubClient(Client& client) { - this->_state = MQTT_DISCONNECTED; - setClient(client); - this->stream = NULL; - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} - -PubSubClient::PubSubClient(IPAddress addr, uint16_t port, Client& client) { - this->_state = MQTT_DISCONNECTED; - setServer(addr, port); - setClient(client); - this->stream = NULL; - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(IPAddress addr, uint16_t port, Client& client, Stream& stream) { - this->_state = MQTT_DISCONNECTED; - setServer(addr,port); - setClient(client); - setStream(stream); - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(IPAddress addr, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client) { - this->_state = MQTT_DISCONNECTED; - setServer(addr, port); - setCallback(callback); - setClient(client); - this->stream = NULL; - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(IPAddress addr, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client, Stream& stream) { - this->_state = MQTT_DISCONNECTED; - setServer(addr,port); - setCallback(callback); - setClient(client); - setStream(stream); - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} - -PubSubClient::PubSubClient(uint8_t *ip, uint16_t port, Client& client) { - this->_state = MQTT_DISCONNECTED; - setServer(ip, port); - setClient(client); - this->stream = NULL; - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(uint8_t *ip, uint16_t port, Client& client, Stream& stream) { - this->_state = MQTT_DISCONNECTED; - setServer(ip,port); - setClient(client); - setStream(stream); - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(uint8_t *ip, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client) { - this->_state = MQTT_DISCONNECTED; - setServer(ip, port); - setCallback(callback); - setClient(client); - this->stream = NULL; - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(uint8_t *ip, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client, Stream& stream) { - this->_state = MQTT_DISCONNECTED; - setServer(ip,port); - setCallback(callback); - setClient(client); - setStream(stream); - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} - -PubSubClient::PubSubClient(const char* domain, uint16_t port, Client& client) { - this->_state = MQTT_DISCONNECTED; - setServer(domain,port); - setClient(client); - this->stream = NULL; - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(const char* domain, uint16_t port, Client& client, Stream& stream) { - this->_state = MQTT_DISCONNECTED; - setServer(domain,port); - setClient(client); - setStream(stream); - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(const char* domain, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client) { - this->_state = MQTT_DISCONNECTED; - setServer(domain,port); - setCallback(callback); - setClient(client); - this->stream = NULL; - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} -PubSubClient::PubSubClient(const char* domain, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client, Stream& stream) { - this->_state = MQTT_DISCONNECTED; - setServer(domain,port); - setCallback(callback); - setClient(client); - setStream(stream); - this->bufferSize = 0; - setBufferSize(MQTT_MAX_PACKET_SIZE); - setKeepAlive(MQTT_KEEPALIVE); - setSocketTimeout(MQTT_SOCKET_TIMEOUT); -} - -PubSubClient::~PubSubClient() { - free(this->buffer); -} - -boolean PubSubClient::connect(const char *id) { - return connect(id,NULL,NULL,0,0,0,0,1); -} - -boolean PubSubClient::connect(const char *id, const char *user, const char *pass) { - return connect(id,user,pass,0,0,0,0,1); -} - -boolean PubSubClient::connect(const char *id, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage) { - return connect(id,NULL,NULL,willTopic,willQos,willRetain,willMessage,1); -} - -boolean PubSubClient::connect(const char *id, const char *user, const char *pass, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage) { - return connect(id,user,pass,willTopic,willQos,willRetain,willMessage,1); -} - -boolean PubSubClient::connect(const char *id, const char *user, const char *pass, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage, boolean cleanSession) { - if (!connected()) { - int result = 0; - - - if(_client->connected()) { - result = 1; - } else { - if (domain != NULL) { - result = _client->connect(this->domain, this->port); - } else { - result = _client->connect(this->ip, this->port); - } - } - - if (result == 1) { - nextMsgId = 1; - // Leave room in the buffer for header and variable length field - uint16_t length = MQTT_MAX_HEADER_SIZE; - unsigned int j; - -#if MQTT_VERSION == MQTT_VERSION_3_1 - uint8_t d[9] = {0x00,0x06,'M','Q','I','s','d','p', MQTT_VERSION}; -#define MQTT_HEADER_VERSION_LENGTH 9 -#elif MQTT_VERSION == MQTT_VERSION_3_1_1 - uint8_t d[7] = {0x00,0x04,'M','Q','T','T',MQTT_VERSION}; -#define MQTT_HEADER_VERSION_LENGTH 7 -#endif - for (j = 0;jbuffer[length++] = d[j]; - } - - uint8_t v; - if (willTopic) { - v = 0x04|(willQos<<3)|(willRetain<<5); - } else { - v = 0x00; - } - if (cleanSession) { - v = v|0x02; - } - - if(user != NULL) { - v = v|0x80; - - if(pass != NULL) { - v = v|(0x80>>1); - } - } - this->buffer[length++] = v; - - this->buffer[length++] = ((this->keepAlive) >> 8); - this->buffer[length++] = ((this->keepAlive) & 0xFF); - - CHECK_STRING_LENGTH(length,id) - length = writeString(id,this->buffer,length); - if (willTopic) { - CHECK_STRING_LENGTH(length,willTopic) - length = writeString(willTopic,this->buffer,length); - CHECK_STRING_LENGTH(length,willMessage) - length = writeString(willMessage,this->buffer,length); - } - - if(user != NULL) { - CHECK_STRING_LENGTH(length,user) - length = writeString(user,this->buffer,length); - if(pass != NULL) { - CHECK_STRING_LENGTH(length,pass) - length = writeString(pass,this->buffer,length); - } - } - - write(MQTTCONNECT,this->buffer,length-MQTT_MAX_HEADER_SIZE); - - lastInActivity = lastOutActivity = millis(); - - while (!_client->available()) { - unsigned long t = millis(); - if (t-lastInActivity >= ((int32_t) this->socketTimeout*1000UL)) { - _state = MQTT_CONNECTION_TIMEOUT; - _client->stop(); - return false; - } - } - uint8_t llen; - uint32_t len = readPacket(&llen); - - if (len == 4) { - if (buffer[3] == 0) { - lastInActivity = millis(); - pingOutstanding = false; - _state = MQTT_CONNECTED; - return true; - } else { - _state = buffer[3]; - } - } - _client->stop(); - } else { - _state = MQTT_CONNECT_FAILED; - } - return false; - } - return true; -} - -// reads a byte into result -boolean PubSubClient::readByte(uint8_t * result) { - uint32_t previousMillis = millis(); - while(!_client->available()) { - yield(); - uint32_t currentMillis = millis(); - if(currentMillis - previousMillis >= ((int32_t) this->socketTimeout * 1000)){ - return false; - } - } - *result = _client->read(); - return true; -} - -// reads a byte into result[*index] and increments index -boolean PubSubClient::readByte(uint8_t * result, uint16_t * index){ - uint16_t current_index = *index; - uint8_t * write_address = &(result[current_index]); - if(readByte(write_address)){ - *index = current_index + 1; - return true; - } - return false; -} - -uint32_t PubSubClient::readPacket(uint8_t* lengthLength) { - uint16_t len = 0; - if(!readByte(this->buffer, &len)) return 0; - bool isPublish = (this->buffer[0]&0xF0) == MQTTPUBLISH; - uint32_t multiplier = 1; - uint32_t length = 0; - uint8_t digit = 0; - uint16_t skip = 0; - uint32_t start = 0; - - do { - if (len == 5) { - // Invalid remaining length encoding - kill the connection - _state = MQTT_DISCONNECTED; - _client->stop(); - return 0; - } - if(!readByte(&digit)) return 0; - this->buffer[len++] = digit; - length += (digit & 127) * multiplier; - multiplier <<=7; //multiplier *= 128 - } while ((digit & 128) != 0); - *lengthLength = len-1; - - if (isPublish) { - // Read in topic length to calculate bytes to skip over for Stream writing - if(!readByte(this->buffer, &len)) return 0; - if(!readByte(this->buffer, &len)) return 0; - skip = (this->buffer[*lengthLength+1]<<8)+this->buffer[*lengthLength+2]; - start = 2; - if (this->buffer[0]&MQTTQOS1) { - // skip message id - skip += 2; - } - } - uint32_t idx = len; - - for (uint32_t i = start;istream) { - if (isPublish && idx-*lengthLength-2>skip) { - this->stream->write(digit); - } - } - - if (len < this->bufferSize) { - this->buffer[len] = digit; - len++; - } - idx++; - } - - if (!this->stream && idx > this->bufferSize) { - len = 0; // This will cause the packet to be ignored. - } - return len; -} - -boolean PubSubClient::loop() { - if (connected()) { - unsigned long t = millis(); - if ((t - lastInActivity > this->keepAlive*1000UL) || (t - lastOutActivity > this->keepAlive*1000UL)) { - if (pingOutstanding) { - this->_state = MQTT_CONNECTION_TIMEOUT; - _client->stop(); - return false; - } else { - this->buffer[0] = MQTTPINGREQ; - this->buffer[1] = 0; - _client->write(this->buffer,2); - lastOutActivity = t; - lastInActivity = t; - pingOutstanding = true; - } - } - if (_client->available()) { - uint8_t llen; - uint16_t len = readPacket(&llen); - uint16_t msgId = 0; - uint8_t *payload; - if (len > 0) { - lastInActivity = t; - uint8_t type = this->buffer[0]&0xF0; - if (type == MQTTPUBLISH) { - if (callback) { - uint16_t tl = (this->buffer[llen+1]<<8)+this->buffer[llen+2]; /* topic length in bytes */ - memmove(this->buffer+llen+2,this->buffer+llen+3,tl); /* move topic inside buffer 1 byte to front */ - this->buffer[llen+2+tl] = 0; /* end the topic as a 'C' string with \x00 */ - char *topic = (char*) this->buffer+llen+2; - // msgId only present for QOS>0 - if ((this->buffer[0]&0x06) == MQTTQOS1) { - msgId = (this->buffer[llen+3+tl]<<8)+this->buffer[llen+3+tl+1]; - payload = this->buffer+llen+3+tl+2; - callback(topic,payload,len-llen-3-tl-2); - - this->buffer[0] = MQTTPUBACK; - this->buffer[1] = 2; - this->buffer[2] = (msgId >> 8); - this->buffer[3] = (msgId & 0xFF); - _client->write(this->buffer,4); - lastOutActivity = t; - - } else { - payload = this->buffer+llen+3+tl; - callback(topic,payload,len-llen-3-tl); - } - } - } else if (type == MQTTPINGREQ) { - this->buffer[0] = MQTTPINGRESP; - this->buffer[1] = 0; - _client->write(this->buffer,2); - } else if (type == MQTTPINGRESP) { - pingOutstanding = false; - } - } else if (!connected()) { - // readPacket has closed the connection - return false; - } - } - return true; - } - return false; -} - -boolean PubSubClient::publish(const char* topic, const char* payload) { - return publish(topic,(const uint8_t*)payload, payload ? strnlen(payload, this->bufferSize) : 0,false); -} - -boolean PubSubClient::publish(const char* topic, const char* payload, boolean retained) { - return publish(topic,(const uint8_t*)payload, payload ? strnlen(payload, this->bufferSize) : 0,retained); -} - -boolean PubSubClient::publish(const char* topic, const uint8_t* payload, unsigned int plength) { - return publish(topic, payload, plength, false); -} - -boolean PubSubClient::publish(const char* topic, const uint8_t* payload, unsigned int plength, boolean retained) { - if (connected()) { - if (this->bufferSize < MQTT_MAX_HEADER_SIZE + 2+strnlen(topic, this->bufferSize) + plength) { - // Too long - return false; - } - // Leave room in the buffer for header and variable length field - uint16_t length = MQTT_MAX_HEADER_SIZE; - length = writeString(topic,this->buffer,length); - - // Add payload - uint16_t i; - for (i=0;ibuffer[length++] = payload[i]; - } - - // Write the header - uint8_t header = MQTTPUBLISH; - if (retained) { - header |= 1; - } - return write(header,this->buffer,length-MQTT_MAX_HEADER_SIZE); - } - return false; -} - -boolean PubSubClient::publish_P(const char* topic, const char* payload, boolean retained) { - return publish_P(topic, (const uint8_t*)payload, payload ? strnlen(payload, this->bufferSize) : 0, retained); -} - -boolean PubSubClient::publish_P(const char* topic, const uint8_t* payload, unsigned int plength, boolean retained) { - uint8_t llen = 0; - uint8_t digit; - unsigned int rc = 0; - uint16_t tlen; - unsigned int pos = 0; - unsigned int i; - uint8_t header; - unsigned int len; - int expectedLength; - - if (!connected()) { - return false; - } - - tlen = strnlen(topic, this->bufferSize); - - header = MQTTPUBLISH; - if (retained) { - header |= 1; - } - this->buffer[pos++] = header; - len = plength + 2 + tlen; - do { - digit = len & 127; //digit = len %128 - len >>= 7; //len = len / 128 - if (len > 0) { - digit |= 0x80; - } - this->buffer[pos++] = digit; - llen++; - } while(len>0); - - pos = writeString(topic,this->buffer,pos); - - rc += _client->write(this->buffer,pos); - - for (i=0;iwrite((char)pgm_read_byte_near(payload + i)); - } - - lastOutActivity = millis(); - - expectedLength = 1 + llen + 2 + tlen + plength; - - return (rc == expectedLength); -} - -boolean PubSubClient::beginPublish(const char* topic, unsigned int plength, boolean retained) { - if (connected()) { - // Send the header and variable length field - uint16_t length = MQTT_MAX_HEADER_SIZE; - length = writeString(topic,this->buffer,length); - uint8_t header = MQTTPUBLISH; - if (retained) { - header |= 1; - } - size_t hlen = buildHeader(header, this->buffer, plength+length-MQTT_MAX_HEADER_SIZE); - uint16_t rc = _client->write(this->buffer+(MQTT_MAX_HEADER_SIZE-hlen),length-(MQTT_MAX_HEADER_SIZE-hlen)); - lastOutActivity = millis(); - return (rc == (length-(MQTT_MAX_HEADER_SIZE-hlen))); - } - return false; -} - -int PubSubClient::endPublish() { - return 1; -} - -size_t PubSubClient::write(uint8_t data) { - lastOutActivity = millis(); - return _client->write(data); -} - -size_t PubSubClient::write(const uint8_t *buffer, size_t size) { - lastOutActivity = millis(); - return _client->write(buffer,size); -} - -size_t PubSubClient::buildHeader(uint8_t header, uint8_t* buf, uint16_t length) { - uint8_t lenBuf[4]; - uint8_t llen = 0; - uint8_t digit; - uint8_t pos = 0; - uint16_t len = length; - do { - - digit = len & 127; //digit = len %128 - len >>= 7; //len = len / 128 - if (len > 0) { - digit |= 0x80; - } - lenBuf[pos++] = digit; - llen++; - } while(len>0); - - buf[4-llen] = header; - for (int i=0;i 0) && result) { - bytesToWrite = (bytesRemaining > MQTT_MAX_TRANSFER_SIZE)?MQTT_MAX_TRANSFER_SIZE:bytesRemaining; - rc = _client->write(writeBuf,bytesToWrite); - result = (rc == bytesToWrite); - bytesRemaining -= rc; - writeBuf += rc; - } - return result; -#else - rc = _client->write(buf+(MQTT_MAX_HEADER_SIZE-hlen),length+hlen); - lastOutActivity = millis(); - return (rc == hlen+length); -#endif -} - -boolean PubSubClient::subscribe(const char* topic) { - return subscribe(topic, 0); -} - -boolean PubSubClient::subscribe(const char* topic, uint8_t qos) { - size_t topicLength = strnlen(topic, this->bufferSize); - if (topic == 0) { - return false; - } - if (qos > 1) { - return false; - } - if (this->bufferSize < 9 + topicLength) { - // Too long - return false; - } - if (connected()) { - // Leave room in the buffer for header and variable length field - uint16_t length = MQTT_MAX_HEADER_SIZE; - nextMsgId++; - if (nextMsgId == 0) { - nextMsgId = 1; - } - this->buffer[length++] = (nextMsgId >> 8); - this->buffer[length++] = (nextMsgId & 0xFF); - length = writeString((char*)topic, this->buffer,length); - this->buffer[length++] = qos; - return write(MQTTSUBSCRIBE|MQTTQOS1,this->buffer,length-MQTT_MAX_HEADER_SIZE); - } - return false; -} - -boolean PubSubClient::unsubscribe(const char* topic) { - size_t topicLength = strnlen(topic, this->bufferSize); - if (topic == 0) { - return false; - } - if (this->bufferSize < 9 + topicLength) { - // Too long - return false; - } - if (connected()) { - uint16_t length = MQTT_MAX_HEADER_SIZE; - nextMsgId++; - if (nextMsgId == 0) { - nextMsgId = 1; - } - this->buffer[length++] = (nextMsgId >> 8); - this->buffer[length++] = (nextMsgId & 0xFF); - length = writeString(topic, this->buffer,length); - return write(MQTTUNSUBSCRIBE|MQTTQOS1,this->buffer,length-MQTT_MAX_HEADER_SIZE); - } - return false; -} - -void PubSubClient::disconnect() { - this->buffer[0] = MQTTDISCONNECT; - this->buffer[1] = 0; - _client->write(this->buffer,2); - _state = MQTT_DISCONNECTED; - _client->flush(); - _client->stop(); - lastInActivity = lastOutActivity = millis(); -} - -uint16_t PubSubClient::writeString(const char* string, uint8_t* buf, uint16_t pos) { - const char* idp = string; - uint16_t i = 0; - pos += 2; - while (*idp) { - buf[pos++] = *idp++; - i++; - } - buf[pos-i-2] = (i >> 8); - buf[pos-i-1] = (i & 0xFF); - return pos; -} - - -boolean PubSubClient::connected() { - boolean rc; - if (_client == NULL ) { - rc = false; - } else { - rc = (int)_client->connected(); - if (!rc) { - if (this->_state == MQTT_CONNECTED) { - this->_state = MQTT_CONNECTION_LOST; - _client->flush(); - _client->stop(); - } - } else { - return this->_state == MQTT_CONNECTED; - } - } - return rc; -} - -PubSubClient& PubSubClient::setServer(uint8_t * ip, uint16_t port) { - IPAddress addr(ip[0],ip[1],ip[2],ip[3]); - return setServer(addr,port); -} - -PubSubClient& PubSubClient::setServer(IPAddress ip, uint16_t port) { - this->ip = ip; - this->port = port; - this->domain = NULL; - return *this; -} - -PubSubClient& PubSubClient::setServer(const char * domain, uint16_t port) { - this->domain = domain; - this->port = port; - return *this; -} - -PubSubClient& PubSubClient::setCallback(MQTT_CALLBACK_SIGNATURE) { - this->callback = callback; - return *this; -} - -PubSubClient& PubSubClient::setClient(Client& client){ - this->_client = &client; - return *this; -} - -PubSubClient& PubSubClient::setStream(Stream& stream){ - this->stream = &stream; - return *this; -} - -int PubSubClient::state() { - return this->_state; -} - -boolean PubSubClient::setBufferSize(uint16_t size) { - if (size == 0) { - // Cannot set it back to 0 - return false; - } - if (this->bufferSize == 0) { - this->buffer = (uint8_t*)malloc(size); - } else { - uint8_t* newBuffer = (uint8_t*)realloc(this->buffer, size); - if (newBuffer != NULL) { - this->buffer = newBuffer; - } else { - return false; - } - } - this->bufferSize = size; - return (this->buffer != NULL); -} - -uint16_t PubSubClient::getBufferSize() { - return this->bufferSize; -} -PubSubClient& PubSubClient::setKeepAlive(uint16_t keepAlive) { - this->keepAlive = keepAlive; - return *this; -} -PubSubClient& PubSubClient::setSocketTimeout(uint16_t timeout) { - this->socketTimeout = timeout; - return *this; -} diff --git a/lib/pubsubclient/src/PubSubClient.h b/lib/pubsubclient/src/PubSubClient.h deleted file mode 100755 index fe5ced0..0000000 --- a/lib/pubsubclient/src/PubSubClient.h +++ /dev/null @@ -1,184 +0,0 @@ -/* - PubSubClient.h - A simple client for MQTT. - Nick O'Leary - http://knolleary.net -*/ - -#ifndef PubSubClient_h -#define PubSubClient_h - -#include -#include "IPAddress.h" -#include "Client.h" -#include "Stream.h" - -#define MQTT_VERSION_3_1 3 -#define MQTT_VERSION_3_1_1 4 - -// MQTT_VERSION : Pick the version -//#define MQTT_VERSION MQTT_VERSION_3_1 -#ifndef MQTT_VERSION -#define MQTT_VERSION MQTT_VERSION_3_1_1 -#endif - -// MQTT_MAX_PACKET_SIZE : Maximum packet size. Override with setBufferSize(). -#ifndef MQTT_MAX_PACKET_SIZE -#define MQTT_MAX_PACKET_SIZE 6144 -#endif - -// MQTT_KEEPALIVE : keepAlive interval in Seconds. Override with setKeepAlive() -#ifndef MQTT_KEEPALIVE -#define MQTT_KEEPALIVE 15 -#endif - -// MQTT_SOCKET_TIMEOUT: socket timeout interval in Seconds. Override with setSocketTimeout() -#ifndef MQTT_SOCKET_TIMEOUT -#define MQTT_SOCKET_TIMEOUT 15 -#endif - -// MQTT_MAX_TRANSFER_SIZE : limit how much data is passed to the network client -// in each write call. Needed for the Arduino Wifi Shield. Leave undefined to -// pass the entire MQTT packet in each write call. -//#define MQTT_MAX_TRANSFER_SIZE 80 - -// Possible values for client.state() -#define MQTT_CONNECTION_TIMEOUT -4 -#define MQTT_CONNECTION_LOST -3 -#define MQTT_CONNECT_FAILED -2 -#define MQTT_DISCONNECTED -1 -#define MQTT_CONNECTED 0 -#define MQTT_CONNECT_BAD_PROTOCOL 1 -#define MQTT_CONNECT_BAD_CLIENT_ID 2 -#define MQTT_CONNECT_UNAVAILABLE 3 -#define MQTT_CONNECT_BAD_CREDENTIALS 4 -#define MQTT_CONNECT_UNAUTHORIZED 5 - -#define MQTTCONNECT 1 << 4 // Client request to connect to Server -#define MQTTCONNACK 2 << 4 // Connect Acknowledgment -#define MQTTPUBLISH 3 << 4 // Publish message -#define MQTTPUBACK 4 << 4 // Publish Acknowledgment -#define MQTTPUBREC 5 << 4 // Publish Received (assured delivery part 1) -#define MQTTPUBREL 6 << 4 // Publish Release (assured delivery part 2) -#define MQTTPUBCOMP 7 << 4 // Publish Complete (assured delivery part 3) -#define MQTTSUBSCRIBE 8 << 4 // Client Subscribe request -#define MQTTSUBACK 9 << 4 // Subscribe Acknowledgment -#define MQTTUNSUBSCRIBE 10 << 4 // Client Unsubscribe request -#define MQTTUNSUBACK 11 << 4 // Unsubscribe Acknowledgment -#define MQTTPINGREQ 12 << 4 // PING Request -#define MQTTPINGRESP 13 << 4 // PING Response -#define MQTTDISCONNECT 14 << 4 // Client is Disconnecting -#define MQTTReserved 15 << 4 // Reserved - -#define MQTTQOS0 (0 << 1) -#define MQTTQOS1 (1 << 1) -#define MQTTQOS2 (2 << 1) - -// Maximum size of fixed header and variable length size header -#define MQTT_MAX_HEADER_SIZE 5 - -#if defined(ESP8266) || defined(ESP32) -#include -#define MQTT_CALLBACK_SIGNATURE std::function callback -#else -#define MQTT_CALLBACK_SIGNATURE void (*callback)(char*, uint8_t*, unsigned int) -#endif - -#define CHECK_STRING_LENGTH(l,s) if (l+2+strnlen(s, this->bufferSize) > this->bufferSize) {_client->stop();return false;} - -class PubSubClient : public Print { -private: - Client* _client; - uint8_t* buffer; - uint16_t bufferSize; - uint16_t keepAlive; - uint16_t socketTimeout; - uint16_t nextMsgId; - unsigned long lastOutActivity; - unsigned long lastInActivity; - bool pingOutstanding; - MQTT_CALLBACK_SIGNATURE; - uint32_t readPacket(uint8_t*); - boolean readByte(uint8_t * result); - boolean readByte(uint8_t * result, uint16_t * index); - boolean write(uint8_t header, uint8_t* buf, uint16_t length); - uint16_t writeString(const char* string, uint8_t* buf, uint16_t pos); - // Build up the header ready to send - // Returns the size of the header - // Note: the header is built at the end of the first MQTT_MAX_HEADER_SIZE bytes, so will start - // (MQTT_MAX_HEADER_SIZE - ) bytes into the buffer - size_t buildHeader(uint8_t header, uint8_t* buf, uint16_t length); - IPAddress ip; - const char* domain; - uint16_t port; - Stream* stream; - int _state; -public: - PubSubClient(); - PubSubClient(Client& client); - PubSubClient(IPAddress, uint16_t, Client& client); - PubSubClient(IPAddress, uint16_t, Client& client, Stream&); - PubSubClient(IPAddress, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client); - PubSubClient(IPAddress, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client, Stream&); - PubSubClient(uint8_t *, uint16_t, Client& client); - PubSubClient(uint8_t *, uint16_t, Client& client, Stream&); - PubSubClient(uint8_t *, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client); - PubSubClient(uint8_t *, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client, Stream&); - PubSubClient(const char*, uint16_t, Client& client); - PubSubClient(const char*, uint16_t, Client& client, Stream&); - PubSubClient(const char*, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client); - PubSubClient(const char*, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client, Stream&); - - ~PubSubClient(); - - PubSubClient& setServer(IPAddress ip, uint16_t port); - PubSubClient& setServer(uint8_t * ip, uint16_t port); - PubSubClient& setServer(const char * domain, uint16_t port); - PubSubClient& setCallback(MQTT_CALLBACK_SIGNATURE); - PubSubClient& setClient(Client& client); - PubSubClient& setStream(Stream& stream); - PubSubClient& setKeepAlive(uint16_t keepAlive); - PubSubClient& setSocketTimeout(uint16_t timeout); - - boolean setBufferSize(uint16_t size); - uint16_t getBufferSize(); - - boolean connect(const char* id); - boolean connect(const char* id, const char* user, const char* pass); - boolean connect(const char* id, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage); - boolean connect(const char* id, const char* user, const char* pass, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage); - boolean connect(const char* id, const char* user, const char* pass, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage, boolean cleanSession); - void disconnect(); - boolean publish(const char* topic, const char* payload); - boolean publish(const char* topic, const char* payload, boolean retained); - boolean publish(const char* topic, const uint8_t * payload, unsigned int plength); - boolean publish(const char* topic, const uint8_t * payload, unsigned int plength, boolean retained); - boolean publish_P(const char* topic, const char* payload, boolean retained); - boolean publish_P(const char* topic, const uint8_t * payload, unsigned int plength, boolean retained); - // Start to publish a message. - // This API: - // beginPublish(...) - // one or more calls to write(...) - // endPublish() - // Allows for arbitrarily large payloads to be sent without them having to be copied into - // a new buffer and held in memory at one time - // Returns 1 if the message was started successfully, 0 if there was an error - boolean beginPublish(const char* topic, unsigned int plength, boolean retained); - // Finish off this publish message (started with beginPublish) - // Returns 1 if the packet was sent successfully, 0 if there was an error - int endPublish(); - // Write a single byte of payload (only to be used with beginPublish/endPublish) - virtual size_t write(uint8_t); - // Write size bytes from buffer into the payload (only to be used with beginPublish/endPublish) - // Returns the number of bytes written - virtual size_t write(const uint8_t *buffer, size_t size); - boolean subscribe(const char* topic); - boolean subscribe(const char* topic, uint8_t qos); - boolean unsubscribe(const char* topic); - boolean loop(); - boolean connected(); - int state(); - -}; - - -#endif diff --git a/lib/pubsubclient/tests/.gitignore b/lib/pubsubclient/tests/.gitignore deleted file mode 100644 index 215de78..0000000 --- a/lib/pubsubclient/tests/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -.build -tmpbin -logs -*.pyc diff --git a/lib/pubsubclient/tests/Makefile b/lib/pubsubclient/tests/Makefile deleted file mode 100644 index 1f71636..0000000 --- a/lib/pubsubclient/tests/Makefile +++ /dev/null @@ -1,25 +0,0 @@ -SRC_PATH=./src -OUT_PATH=./bin -TEST_SRC=$(wildcard ${SRC_PATH}/*_spec.cpp) -TEST_BIN= $(TEST_SRC:${SRC_PATH}/%.cpp=${OUT_PATH}/%) -VPATH=${SRC_PATH} -SHIM_FILES=${SRC_PATH}/lib/*.cpp -PSC_FILE=../src/PubSubClient.cpp -CC=g++ -CFLAGS=-I${SRC_PATH}/lib -I../src - -all: $(TEST_BIN) - -${OUT_PATH}/%: ${SRC_PATH}/%.cpp ${PSC_FILE} ${SHIM_FILES} - mkdir -p ${OUT_PATH} - ${CC} ${CFLAGS} $^ -o $@ - -clean: - @rm -rf ${OUT_PATH} - -test: - @bin/connect_spec - @bin/publish_spec - @bin/receive_spec - @bin/subscribe_spec - @bin/keepalive_spec diff --git a/lib/pubsubclient/tests/README.md b/lib/pubsubclient/tests/README.md deleted file mode 100644 index e5700a6..0000000 --- a/lib/pubsubclient/tests/README.md +++ /dev/null @@ -1,93 +0,0 @@ -# Arduino Client for MQTT Test Suite - -This is a regression test suite for the `PubSubClient` library. - -There are two parts: - - - Tests that can be compiled and run on any machine - - Tests that build the example sketches using the Arduino IDE - - -It is a work-in-progress and is subject to complete refactoring as the whim takes -me. - - -## Local tests - -These are a set of executables that can be run to test specific areas of functionality. -They do not require a real Arduino to be attached, nor the use of the Arduino IDE. - -The tests include a set of mock files to stub out the parts of the Arduino environment the library -depends on. - -### Dependencies - - - g++ - -### Running - -Build the tests using the provided `Makefile`: - - $ make - -This will create a set of executables in `./bin/`. Run each of these executables to test the corresponding functionality. - -*Note:* the `connect_spec` and `keepalive_spec` tests involve testing keepalive timers so naturally take a few minutes to run through. - -## Arduino tests - -*Note:* INO Tool doesn't currently play nicely with Arduino 1.5. This has broken this test suite. - -Without a suitable arduino plugged in, the test suite will only check the -example sketches compile cleanly against the library. - -With an arduino plugged in, each sketch that has a corresponding python -test case is built, uploaded and then the tests run. - -### Dependencies - - - Python 2.7+ - - [INO Tool](http://inotool.org/) - this provides command-line build/upload of Arduino sketches - -### Running - -The test suite _does not_ run an MQTT server - it is assumed to be running already. - - $ python testsuite.py - -A summary of activity is printed to the console. More comprehensive logs are written -to the `logs` directory. - -### What it does - -For each sketch in the library's `examples` directory, e.g. `mqtt_basic.ino`, the suite looks for a matching test case -`testcases/mqtt_basic.py`. - -The test case must follow these conventions: - - sub-class `unittest.TestCase` - - provide the class methods `setUpClass` and `tearDownClass` (TODO: make this optional) - - all test method names begin with `test_` - -The suite will call the `setUpClass` method _before_ uploading the sketch. This -allows any test setup to be performed before the sketch runs - such as connecting -a client and subscribing to topics. - - -### Settings - -The file `testcases/settings.py` is used to config the test environment. - - - `server_ip` - the IP address of the broker the client should connect to (the broker port is assumed to be 1883). - - `arduino_ip` - the IP address the arduino should use (when not testing DHCP). - -Before each sketch is compiled, these values are automatically substituted in. To -do this, the suite looks for lines that _start_ with the following: - - byte server[] = { - byte ip[] = { - -and replaces them with the appropriate values. - - - - diff --git a/lib/pubsubclient/tests/src/connect_spec.cpp b/lib/pubsubclient/tests/src/connect_spec.cpp deleted file mode 100644 index e8545c4..0000000 --- a/lib/pubsubclient/tests/src/connect_spec.cpp +++ /dev/null @@ -1,336 +0,0 @@ -#include "PubSubClient.h" -#include "ShimClient.h" -#include "Buffer.h" -#include "BDDTest.h" -#include "trace.h" - - -byte server[] = { 172, 16, 0, 2 }; - -void callback(char* topic, byte* payload, unsigned int length) { - // handle message arrived -} - - -int test_connect_fails_no_network() { - IT("fails to connect if underlying client doesn't connect"); - ShimClient shimClient; - shimClient.setAllowConnect(false); - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_FALSE(rc); - int state = client.state(); - IS_TRUE(state == MQTT_CONNECT_FAILED); - END_IT -} - -int test_connect_fails_on_no_response() { - IT("fails to connect if no response received after 15 seconds"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_FALSE(rc); - int state = client.state(); - IS_TRUE(state == MQTT_CONNECTION_TIMEOUT); - END_IT -} - -int test_connect_properly_formatted() { - IT("sends a properly formatted connect packet and succeeds"); - ShimClient shimClient; - - shimClient.setAllowConnect(true); - byte expectServer[] = { 172, 16, 0, 2 }; - shimClient.expectConnect(expectServer,1883); - byte connect[] = {0x10,0x18,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0x2,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - - shimClient.expect(connect,26); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int state = client.state(); - IS_TRUE(state == MQTT_DISCONNECTED); - - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - state = client.state(); - IS_TRUE(state == MQTT_CONNECTED); - - END_IT -} - -int test_connect_properly_formatted_hostname() { - IT("accepts a hostname"); - ShimClient shimClient; - - shimClient.setAllowConnect(true); - shimClient.expectConnect((char* const)"localhost",1883); - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client((char* const)"localhost", 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - END_IT -} - - -int test_connect_fails_on_bad_rc() { - IT("fails to connect if a bad return code is received"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - byte connack[] = { 0x20, 0x02, 0x00, 0x01 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_FALSE(rc); - - int state = client.state(); - IS_TRUE(state == 0x01); - - END_IT -} - -int test_connect_non_clean_session() { - IT("sends a properly formatted non-clean session connect packet and succeeds"); - ShimClient shimClient; - - shimClient.setAllowConnect(true); - byte expectServer[] = { 172, 16, 0, 2 }; - shimClient.expectConnect(expectServer,1883); - byte connect[] = {0x10,0x18,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0x0,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - - shimClient.expect(connect,26); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int state = client.state(); - IS_TRUE(state == MQTT_DISCONNECTED); - - int rc = client.connect((char*)"client_test1",0,0,0,0,0,0,0); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - state = client.state(); - IS_TRUE(state == MQTT_CONNECTED); - - END_IT -} - -int test_connect_accepts_username_password() { - IT("accepts a username and password"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connect[] = { 0x10,0x24,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0xc2,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31,0x0,0x4,0x75,0x73,0x65,0x72,0x0,0x4,0x70,0x61,0x73,0x73}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.expect(connect,0x26); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1",(char*)"user",(char*)"pass"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_connect_accepts_username_no_password() { - IT("accepts a username but no password"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connect[] = { 0x10,0x1e,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0x82,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31,0x0,0x4,0x75,0x73,0x65,0x72}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.expect(connect,0x20); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1",(char*)"user",0); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - END_IT -} -int test_connect_accepts_username_blank_password() { - IT("accepts a username and blank password"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connect[] = { 0x10,0x20,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0xc2,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31,0x0,0x4,0x75,0x73,0x65,0x72,0x0,0x0}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.expect(connect,0x26); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1",(char*)"user",(char*)"pass"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_connect_ignores_password_no_username() { - IT("ignores a password but no username"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connect[] = {0x10,0x18,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0x2,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.expect(connect,26); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1",0,(char*)"pass"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_connect_with_will() { - IT("accepts a will"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connect[] = {0x10,0x30,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0xe,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31,0x0,0x9,0x77,0x69,0x6c,0x6c,0x54,0x6f,0x70,0x69,0x63,0x0,0xb,0x77,0x69,0x6c,0x6c,0x4d,0x65,0x73,0x73,0x61,0x67,0x65}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.expect(connect,0x32); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1",(char*)"willTopic",1,0,(char*)"willMessage"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_connect_with_will_username_password() { - IT("accepts a will, username and password"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connect[] = {0x10,0x40,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0xce,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31,0x0,0x9,0x77,0x69,0x6c,0x6c,0x54,0x6f,0x70,0x69,0x63,0x0,0xb,0x77,0x69,0x6c,0x6c,0x4d,0x65,0x73,0x73,0x61,0x67,0x65,0x0,0x4,0x75,0x73,0x65,0x72,0x0,0x8,0x70,0x61,0x73,0x73,0x77,0x6f,0x72,0x64}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.expect(connect,0x42); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1",(char*)"user",(char*)"password",(char*)"willTopic",1,0,(char*)"willMessage"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_connect_disconnect_connect() { - IT("connects, disconnects and connects again"); - ShimClient shimClient; - - shimClient.setAllowConnect(true); - byte expectServer[] = { 172, 16, 0, 2 }; - shimClient.expectConnect(expectServer,1883); - byte connect[] = {0x10,0x18,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0x2,0x0,0xf,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - - shimClient.expect(connect,26); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - - int state = client.state(); - IS_TRUE(state == MQTT_DISCONNECTED); - - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - state = client.state(); - IS_TRUE(state == MQTT_CONNECTED); - - byte disconnect[] = {0xE0,0x00}; - shimClient.expect(disconnect,2); - - client.disconnect(); - - IS_FALSE(client.connected()); - IS_FALSE(shimClient.connected()); - IS_FALSE(shimClient.error()); - - state = client.state(); - IS_TRUE(state == MQTT_DISCONNECTED); - - shimClient.expect(connect,28); - shimClient.respond(connack,4); - rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - state = client.state(); - IS_TRUE(state == MQTT_CONNECTED); - - END_IT -} - -int test_connect_custom_keepalive() { - IT("sends a properly formatted connect packet with custom keepalive value"); - ShimClient shimClient; - - shimClient.setAllowConnect(true); - byte expectServer[] = { 172, 16, 0, 2 }; - shimClient.expectConnect(expectServer,1883); - - // Set keepalive to 300secs == 0x01 0x2c - byte connect[] = {0x10,0x18,0x0,0x4,0x4d,0x51,0x54,0x54,0x4,0x2,0x01,0x2c,0x0,0xc,0x63,0x6c,0x69,0x65,0x6e,0x74,0x5f,0x74,0x65,0x73,0x74,0x31}; - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - - shimClient.expect(connect,26); - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int state = client.state(); - IS_TRUE(state == MQTT_DISCONNECTED); - - client.setKeepAlive(300); - - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - - state = client.state(); - IS_TRUE(state == MQTT_CONNECTED); - - END_IT -} - - -int main() -{ - SUITE("Connect"); - - test_connect_fails_no_network(); - test_connect_fails_on_no_response(); - - test_connect_properly_formatted(); - test_connect_non_clean_session(); - test_connect_accepts_username_password(); - test_connect_fails_on_bad_rc(); - test_connect_properly_formatted_hostname(); - - test_connect_accepts_username_no_password(); - test_connect_ignores_password_no_username(); - test_connect_with_will(); - test_connect_with_will_username_password(); - test_connect_disconnect_connect(); - - test_connect_custom_keepalive(); - FINISH -} diff --git a/lib/pubsubclient/tests/src/keepalive_spec.cpp b/lib/pubsubclient/tests/src/keepalive_spec.cpp deleted file mode 100644 index ea643cf..0000000 --- a/lib/pubsubclient/tests/src/keepalive_spec.cpp +++ /dev/null @@ -1,185 +0,0 @@ -#include "PubSubClient.h" -#include "ShimClient.h" -#include "Buffer.h" -#include "BDDTest.h" -#include "trace.h" -#include - -byte server[] = { 172, 16, 0, 2 }; - -void callback(char* topic, byte* payload, unsigned int length) { - // handle message arrived -} - - -int test_keepalive_pings_idle() { - IT("keeps an idle connection alive (takes 1 minute)"); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte pingreq[] = { 0xC0,0x0 }; - shimClient.expect(pingreq,2); - byte pingresp[] = { 0xD0,0x0 }; - shimClient.respond(pingresp,2); - - for (int i = 0; i < 50; i++) { - sleep(1); - if ( i == 15 || i == 31 || i == 47) { - shimClient.expect(pingreq,2); - shimClient.respond(pingresp,2); - } - rc = client.loop(); - IS_TRUE(rc); - } - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_keepalive_pings_with_outbound_qos0() { - IT("keeps a connection alive that only sends qos0 (takes 1 minute)"); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,0xe,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - - for (int i = 0; i < 50; i++) { - TRACE(i<<":"); - shimClient.expect(publish,16); - rc = client.publish((char*)"topic",(char*)"payload"); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - sleep(1); - if ( i == 15 || i == 31 || i == 47) { - byte pingreq[] = { 0xC0,0x0 }; - shimClient.expect(pingreq,2); - byte pingresp[] = { 0xD0,0x0 }; - shimClient.respond(pingresp,2); - } - rc = client.loop(); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - } - - END_IT -} - -int test_keepalive_pings_with_inbound_qos0() { - IT("keeps a connection alive that only receives qos0 (takes 1 minute)"); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,0xe,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - - for (int i = 0; i < 50; i++) { - TRACE(i<<":"); - sleep(1); - if ( i == 15 || i == 31 || i == 47) { - byte pingreq[] = { 0xC0,0x0 }; - shimClient.expect(pingreq,2); - byte pingresp[] = { 0xD0,0x0 }; - shimClient.respond(pingresp,2); - } - shimClient.respond(publish,16); - rc = client.loop(); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - } - - END_IT -} - -int test_keepalive_no_pings_inbound_qos1() { - IT("does not send pings for connections with inbound qos1 (takes 1 minute)"); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x32,0x10,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x12,0x34,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - byte puback[] = {0x40,0x2,0x12,0x34}; - - for (int i = 0; i < 50; i++) { - shimClient.respond(publish,18); - shimClient.expect(puback,4); - sleep(1); - rc = client.loop(); - IS_TRUE(rc); - IS_FALSE(shimClient.error()); - } - - END_IT -} - -int test_keepalive_disconnects_hung() { - IT("disconnects a hung connection (takes 30 seconds)"); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte pingreq[] = { 0xC0,0x0 }; - shimClient.expect(pingreq,2); - - for (int i = 0; i < 32; i++) { - sleep(1); - rc = client.loop(); - } - IS_FALSE(rc); - - int state = client.state(); - IS_TRUE(state == MQTT_CONNECTION_TIMEOUT); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int main() -{ - SUITE("Keep-alive"); - test_keepalive_pings_idle(); - test_keepalive_pings_with_outbound_qos0(); - test_keepalive_pings_with_inbound_qos0(); - test_keepalive_no_pings_inbound_qos1(); - test_keepalive_disconnects_hung(); - - FINISH -} diff --git a/lib/pubsubclient/tests/src/lib/Arduino.h b/lib/pubsubclient/tests/src/lib/Arduino.h deleted file mode 100644 index 2a00f24..0000000 --- a/lib/pubsubclient/tests/src/lib/Arduino.h +++ /dev/null @@ -1,26 +0,0 @@ -#ifndef Arduino_h -#define Arduino_h - -#include -#include -#include -#include -#include "Print.h" - - -extern "C"{ - typedef uint8_t byte ; - typedef uint8_t boolean ; - - /* sketch */ - extern void setup( void ) ; - extern void loop( void ) ; - uint32_t millis( void ); -} - -#define PROGMEM -#define pgm_read_byte_near(x) *(x) - -#define yield(x) {} - -#endif // Arduino_h diff --git a/lib/pubsubclient/tests/src/lib/BDDTest.cpp b/lib/pubsubclient/tests/src/lib/BDDTest.cpp deleted file mode 100644 index a72bf65..0000000 --- a/lib/pubsubclient/tests/src/lib/BDDTest.cpp +++ /dev/null @@ -1,50 +0,0 @@ -#include "BDDTest.h" -#include "trace.h" -#include -#include -#include -#include - -int testCount = 0; -int testPasses = 0; -const char* testDescription; - -std::list failureList; - -void bddtest_suite(const char* name) { - LOG(name << "\n"); -} - -int bddtest_test(const char* file, int line, const char* assertion, int result) { - if (!result) { - LOG("✗\n"); - std::ostringstream os; - os << " ! "<::iterator it = failureList.begin(); it != failureList.end(); it++) { - LOG("\n"); - LOG(*it); - LOG("\n"); - } - - LOG(std::dec << testPasses << "/" << testCount << " tests passed\n\n"); - if (testPasses == testCount) { - return 0; - } - return 1; -} diff --git a/lib/pubsubclient/tests/src/lib/BDDTest.h b/lib/pubsubclient/tests/src/lib/BDDTest.h deleted file mode 100644 index 1197fdd..0000000 --- a/lib/pubsubclient/tests/src/lib/BDDTest.h +++ /dev/null @@ -1,23 +0,0 @@ -#ifndef bddtest_h -#define bddtest_h - -void bddtest_suite(const char* name); -int bddtest_test(const char*, int, const char*, int); -void bddtest_start(const char*); -void bddtest_end(); -int bddtest_summary(); - -#define SUITE(x) { bddtest_suite(x); } -#define TEST(x) { if (!bddtest_test(__FILE__, __LINE__, #x, (x))) return false; } - -#define IT(x) { bddtest_start(x); } -#define END_IT { bddtest_end();return true;} - -#define FINISH { return bddtest_summary(); } - -#define IS_TRUE(x) TEST(x) -#define IS_FALSE(x) TEST(!(x)) -#define IS_EQUAL(x,y) TEST(x==y) -#define IS_NOT_EQUAL(x,y) TEST(x!=y) - -#endif diff --git a/lib/pubsubclient/tests/src/lib/Buffer.cpp b/lib/pubsubclient/tests/src/lib/Buffer.cpp deleted file mode 100644 index f07759a..0000000 --- a/lib/pubsubclient/tests/src/lib/Buffer.cpp +++ /dev/null @@ -1,34 +0,0 @@ -#include "Buffer.h" -#include "Arduino.h" - -Buffer::Buffer() { - this->pos = 0; - this->length = 0; -} - -Buffer::Buffer(uint8_t* buf, size_t size) { - this->pos = 0; - this->length = 0; - this->add(buf,size); -} -bool Buffer::available() { - return this->pos < this->length; -} - -uint8_t Buffer::next() { - if (this->available()) { - return this->buffer[this->pos++]; - } - return 0; -} - -void Buffer::reset() { - this->pos = 0; -} - -void Buffer::add(uint8_t* buf, size_t size) { - uint16_t i = 0; - for (;ibuffer[this->length++] = buf[i]; - } -} diff --git a/lib/pubsubclient/tests/src/lib/Buffer.h b/lib/pubsubclient/tests/src/lib/Buffer.h deleted file mode 100644 index c6a2cb5..0000000 --- a/lib/pubsubclient/tests/src/lib/Buffer.h +++ /dev/null @@ -1,23 +0,0 @@ -#ifndef buffer_h -#define buffer_h - -#include "Arduino.h" - -class Buffer { -private: - uint8_t buffer[2048]; - uint16_t pos; - uint16_t length; - -public: - Buffer(); - Buffer(uint8_t* buf, size_t size); - - virtual bool available(); - virtual uint8_t next(); - virtual void reset(); - - virtual void add(uint8_t* buf, size_t size); -}; - -#endif diff --git a/lib/pubsubclient/tests/src/lib/Client.h b/lib/pubsubclient/tests/src/lib/Client.h deleted file mode 100644 index 9e18c07..0000000 --- a/lib/pubsubclient/tests/src/lib/Client.h +++ /dev/null @@ -1,21 +0,0 @@ -#ifndef client_h -#define client_h -#include "IPAddress.h" - -class Client { -public: - virtual int connect(IPAddress ip, uint16_t port) =0; - virtual int connect(const char *host, uint16_t port) =0; - virtual size_t write(uint8_t) =0; - virtual size_t write(const uint8_t *buf, size_t size) =0; - virtual int available() = 0; - virtual int read() = 0; - virtual int read(uint8_t *buf, size_t size) = 0; - virtual int peek() = 0; - virtual void flush() = 0; - virtual void stop() = 0; - virtual uint8_t connected() = 0; - virtual operator bool() = 0; -}; - -#endif diff --git a/lib/pubsubclient/tests/src/lib/IPAddress.cpp b/lib/pubsubclient/tests/src/lib/IPAddress.cpp deleted file mode 100644 index 610ff4c..0000000 --- a/lib/pubsubclient/tests/src/lib/IPAddress.cpp +++ /dev/null @@ -1,44 +0,0 @@ - -#include -#include - -IPAddress::IPAddress() -{ - memset(_address, 0, sizeof(_address)); -} - -IPAddress::IPAddress(uint8_t first_octet, uint8_t second_octet, uint8_t third_octet, uint8_t fourth_octet) -{ - _address[0] = first_octet; - _address[1] = second_octet; - _address[2] = third_octet; - _address[3] = fourth_octet; -} - -IPAddress::IPAddress(uint32_t address) -{ - memcpy(_address, &address, sizeof(_address)); -} - -IPAddress::IPAddress(const uint8_t *address) -{ - memcpy(_address, address, sizeof(_address)); -} - -IPAddress& IPAddress::operator=(const uint8_t *address) -{ - memcpy(_address, address, sizeof(_address)); - return *this; -} - -IPAddress& IPAddress::operator=(uint32_t address) -{ - memcpy(_address, (const uint8_t *)&address, sizeof(_address)); - return *this; -} - -bool IPAddress::operator==(const uint8_t* addr) -{ - return memcmp(addr, _address, sizeof(_address)) == 0; -} - diff --git a/lib/pubsubclient/tests/src/lib/IPAddress.h b/lib/pubsubclient/tests/src/lib/IPAddress.h deleted file mode 100644 index e75a8fe..0000000 --- a/lib/pubsubclient/tests/src/lib/IPAddress.h +++ /dev/null @@ -1,72 +0,0 @@ -/* - * - * MIT License: - * Copyright (c) 2011 Adrian McEwen - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - * THE SOFTWARE. - * - * adrianm@mcqn.com 1/1/2011 - */ - -#ifndef IPAddress_h -#define IPAddress_h - - -// A class to make it easier to handle and pass around IP addresses - -class IPAddress { -private: - uint8_t _address[4]; // IPv4 address - // Access the raw byte array containing the address. Because this returns a pointer - // to the internal structure rather than a copy of the address this function should only - // be used when you know that the usage of the returned uint8_t* will be transient and not - // stored. - uint8_t* raw_address() { return _address; }; - -public: - // Constructors - IPAddress(); - IPAddress(uint8_t first_octet, uint8_t second_octet, uint8_t third_octet, uint8_t fourth_octet); - IPAddress(uint32_t address); - IPAddress(const uint8_t *address); - - // Overloaded cast operator to allow IPAddress objects to be used where a pointer - // to a four-byte uint8_t array is expected - operator uint32_t() { return *((uint32_t*)_address); }; - bool operator==(const IPAddress& addr) { return (*((uint32_t*)_address)) == (*((uint32_t*)addr._address)); }; - bool operator==(const uint8_t* addr); - - // Overloaded index operator to allow getting and setting individual octets of the address - uint8_t operator[](int index) const { return _address[index]; }; - uint8_t& operator[](int index) { return _address[index]; }; - - // Overloaded copy operators to allow initialisation of IPAddress objects from other types - IPAddress& operator=(const uint8_t *address); - IPAddress& operator=(uint32_t address); - - - friend class EthernetClass; - friend class UDP; - friend class Client; - friend class Server; - friend class DhcpClass; - friend class DNSClient; -}; - - -#endif diff --git a/lib/pubsubclient/tests/src/lib/Print.h b/lib/pubsubclient/tests/src/lib/Print.h deleted file mode 100644 index 02ef77c..0000000 --- a/lib/pubsubclient/tests/src/lib/Print.h +++ /dev/null @@ -1,28 +0,0 @@ -/* - Print.h - Base class that provides print() and println() - Copyright (c) 2008 David A. Mellis. All right reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - */ - -#ifndef Print_h -#define Print_h - -class Print { - public: - virtual size_t write(uint8_t) = 0; -}; - -#endif diff --git a/lib/pubsubclient/tests/src/lib/ShimClient.cpp b/lib/pubsubclient/tests/src/lib/ShimClient.cpp deleted file mode 100644 index f70115f..0000000 --- a/lib/pubsubclient/tests/src/lib/ShimClient.cpp +++ /dev/null @@ -1,153 +0,0 @@ -#include "ShimClient.h" -#include "trace.h" -#include -#include -#include - -extern "C" { - uint32_t millis(void) { - return time(0)*1000; - } -} - -ShimClient::ShimClient() { - this->responseBuffer = new Buffer(); - this->expectBuffer = new Buffer(); - this->_allowConnect = true; - this->_connected = false; - this->_error = false; - this->expectAnything = true; - this->_received = 0; - this->_expectedPort = 0; -} - -int ShimClient::connect(IPAddress ip, uint16_t port) { - if (this->_allowConnect) { - this->_connected = true; - } - if (this->_expectedPort !=0) { - // if (memcmp(ip,this->_expectedIP,4) != 0) { - // TRACE( "ip mismatch\n"); - // this->_error = true; - // } - if (port != this->_expectedPort) { - TRACE( "port mismatch\n"); - this->_error = true; - } - } - return this->_connected; -} -int ShimClient::connect(const char *host, uint16_t port) { - if (this->_allowConnect) { - this->_connected = true; - } - if (this->_expectedPort !=0) { - if (strcmp(host,this->_expectedHost) != 0) { - TRACE( "host mismatch\n"); - this->_error = true; - } - if (port != this->_expectedPort) { - TRACE( "port mismatch\n"); - this->_error = true; - } - - } - return this->_connected; -} -size_t ShimClient::write(uint8_t b) { - this->_received += 1; - TRACE(std::hex << (unsigned int)b); - if (!this->expectAnything) { - if (this->expectBuffer->available()) { - uint8_t expected = this->expectBuffer->next(); - if (expected != b) { - this->_error = true; - TRACE("!=" << (unsigned int)expected); - } - } else { - this->_error = true; - } - } - TRACE("\n"<< std::dec); - return 1; -} -size_t ShimClient::write(const uint8_t *buf, size_t size) { - this->_received += size; - TRACE( "[" << std::dec << (unsigned int)(size) << "] "); - uint16_t i=0; - for (;i0) { - TRACE(":"); - } - TRACE(std::hex << (unsigned int)(buf[i])); - - if (!this->expectAnything) { - if (this->expectBuffer->available()) { - uint8_t expected = this->expectBuffer->next(); - if (expected != buf[i]) { - this->_error = true; - TRACE("!=" << (unsigned int)expected); - } - } else { - this->_error = true; - } - } - } - TRACE("\n"<responseBuffer->available(); -} -int ShimClient::read() { return this->responseBuffer->next(); } -int ShimClient::read(uint8_t *buf, size_t size) { - uint16_t i = 0; - for (;iread(); - } - return size; -} -int ShimClient::peek() { return 0; } -void ShimClient::flush() {} -void ShimClient::stop() { - this->setConnected(false); -} -uint8_t ShimClient::connected() { return this->_connected; } -ShimClient::operator bool() { return true; } - - -ShimClient* ShimClient::respond(uint8_t *buf, size_t size) { - this->responseBuffer->add(buf,size); - return this; -} - -ShimClient* ShimClient::expect(uint8_t *buf, size_t size) { - this->expectAnything = false; - this->expectBuffer->add(buf,size); - return this; -} - -void ShimClient::setConnected(bool b) { - this->_connected = b; -} -void ShimClient::setAllowConnect(bool b) { - this->_allowConnect = b; -} - -bool ShimClient::error() { - return this->_error; -} - -uint16_t ShimClient::received() { - return this->_received; -} - -void ShimClient::expectConnect(IPAddress ip, uint16_t port) { - this->_expectedIP = ip; - this->_expectedPort = port; -} - -void ShimClient::expectConnect(const char *host, uint16_t port) { - this->_expectedHost = host; - this->_expectedPort = port; -} diff --git a/lib/pubsubclient/tests/src/lib/ShimClient.h b/lib/pubsubclient/tests/src/lib/ShimClient.h deleted file mode 100644 index 2e3f874..0000000 --- a/lib/pubsubclient/tests/src/lib/ShimClient.h +++ /dev/null @@ -1,51 +0,0 @@ -#ifndef shimclient_h -#define shimclient_h - -#include "Arduino.h" -#include "Client.h" -#include "IPAddress.h" -#include "Buffer.h" - - -class ShimClient : public Client { -private: - Buffer* responseBuffer; - Buffer* expectBuffer; - bool _allowConnect; - bool _connected; - bool expectAnything; - bool _error; - uint16_t _received; - IPAddress _expectedIP; - uint16_t _expectedPort; - const char* _expectedHost; - -public: - ShimClient(); - virtual int connect(IPAddress ip, uint16_t port); - virtual int connect(const char *host, uint16_t port); - virtual size_t write(uint8_t); - virtual size_t write(const uint8_t *buf, size_t size); - virtual int available(); - virtual int read(); - virtual int read(uint8_t *buf, size_t size); - virtual int peek(); - virtual void flush(); - virtual void stop(); - virtual uint8_t connected(); - virtual operator bool(); - - virtual ShimClient* respond(uint8_t *buf, size_t size); - virtual ShimClient* expect(uint8_t *buf, size_t size); - - virtual void expectConnect(IPAddress ip, uint16_t port); - virtual void expectConnect(const char *host, uint16_t port); - - virtual uint16_t received(); - virtual bool error(); - - virtual void setAllowConnect(bool b); - virtual void setConnected(bool b); -}; - -#endif diff --git a/lib/pubsubclient/tests/src/lib/Stream.cpp b/lib/pubsubclient/tests/src/lib/Stream.cpp deleted file mode 100644 index b0ecbb4..0000000 --- a/lib/pubsubclient/tests/src/lib/Stream.cpp +++ /dev/null @@ -1,39 +0,0 @@ -#include "Stream.h" -#include "trace.h" -#include -#include - -Stream::Stream() { - this->expectBuffer = new Buffer(); - this->_error = false; - this->_written = 0; -} - -size_t Stream::write(uint8_t b) { - this->_written++; - TRACE(std::hex << (unsigned int)b); - if (this->expectBuffer->available()) { - uint8_t expected = this->expectBuffer->next(); - if (expected != b) { - this->_error = true; - TRACE("!=" << (unsigned int)expected); - } - } else { - this->_error = true; - } - TRACE("\n"<< std::dec); - return 1; -} - - -bool Stream::error() { - return this->_error; -} - -void Stream::expect(uint8_t *buf, size_t size) { - this->expectBuffer->add(buf,size); -} - -uint16_t Stream::length() { - return this->_written; -} diff --git a/lib/pubsubclient/tests/src/lib/Stream.h b/lib/pubsubclient/tests/src/lib/Stream.h deleted file mode 100644 index 4e41f86..0000000 --- a/lib/pubsubclient/tests/src/lib/Stream.h +++ /dev/null @@ -1,22 +0,0 @@ -#ifndef Stream_h -#define Stream_h - -#include "Arduino.h" -#include "Buffer.h" - -class Stream { -private: - Buffer* expectBuffer; - bool _error; - uint16_t _written; - -public: - Stream(); - virtual size_t write(uint8_t); - - virtual bool error(); - virtual void expect(uint8_t *buf, size_t size); - virtual uint16_t length(); -}; - -#endif diff --git a/lib/pubsubclient/tests/src/lib/trace.h b/lib/pubsubclient/tests/src/lib/trace.h deleted file mode 100644 index 42eb991..0000000 --- a/lib/pubsubclient/tests/src/lib/trace.h +++ /dev/null @@ -1,10 +0,0 @@ -#ifndef trace_h -#define trace_h -#include - -#include - -#define LOG(x) {std::cout << x << std::flush; } -#define TRACE(x) {if (getenv("TRACE")) { std::cout << x << std::flush; }} - -#endif diff --git a/lib/pubsubclient/tests/src/publish_spec.cpp b/lib/pubsubclient/tests/src/publish_spec.cpp deleted file mode 100644 index ee3d3be..0000000 --- a/lib/pubsubclient/tests/src/publish_spec.cpp +++ /dev/null @@ -1,191 +0,0 @@ -#include "PubSubClient.h" -#include "ShimClient.h" -#include "Buffer.h" -#include "BDDTest.h" -#include "trace.h" - - -byte server[] = { 172, 16, 0, 2 }; - -void callback(char* topic, byte* payload, unsigned int length) { - // handle message arrived -} - -int test_publish() { - IT("publishes a null-terminated string"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,0xe,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - shimClient.expect(publish,16); - - rc = client.publish((char*)"topic",(char*)"payload"); - IS_TRUE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - - -int test_publish_bytes() { - IT("publishes a byte array"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte payload[] = { 0x01,0x02,0x03,0x0,0x05 }; - int length = 5; - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,0xc,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x1,0x2,0x3,0x0,0x5}; - shimClient.expect(publish,14); - - rc = client.publish((char*)"topic",payload,length); - IS_TRUE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - - -int test_publish_retained() { - IT("publishes retained - 1"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte payload[] = { 0x01,0x02,0x03,0x0,0x05 }; - int length = 5; - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x31,0xc,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x1,0x2,0x3,0x0,0x5}; - shimClient.expect(publish,14); - - rc = client.publish((char*)"topic",payload,length,true); - IS_TRUE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_publish_retained_2() { - IT("publishes retained - 2"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x31,0xc,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,'A','B','C','D','E'}; - shimClient.expect(publish,14); - - rc = client.publish((char*)"topic",(char*)"ABCDE",true); - IS_TRUE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_publish_not_connected() { - IT("publish fails when not connected"); - ShimClient shimClient; - - PubSubClient client(server, 1883, callback, shimClient); - - int rc = client.publish((char*)"topic",(char*)"payload"); - IS_FALSE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_publish_too_long() { - IT("publish fails when topic/payload are too long"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - client.setBufferSize(128); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - // 0 1 2 3 4 5 6 7 8 9 0 1 2 - rc = client.publish((char*)"topic",(char*)"123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"); - IS_FALSE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_publish_P() { - IT("publishes using PROGMEM"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte payload[] = { 0x01,0x02,0x03,0x0,0x05 }; - int length = 5; - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x31,0xc,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x1,0x2,0x3,0x0,0x5}; - shimClient.expect(publish,14); - - rc = client.publish_P((char*)"topic",payload,length,true); - IS_TRUE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - - - - -int main() -{ - SUITE("Publish"); - test_publish(); - test_publish_bytes(); - test_publish_retained(); - test_publish_retained_2(); - test_publish_not_connected(); - test_publish_too_long(); - test_publish_P(); - - FINISH -} diff --git a/lib/pubsubclient/tests/src/receive_spec.cpp b/lib/pubsubclient/tests/src/receive_spec.cpp deleted file mode 100644 index 93e909a..0000000 --- a/lib/pubsubclient/tests/src/receive_spec.cpp +++ /dev/null @@ -1,340 +0,0 @@ -#include "PubSubClient.h" -#include "ShimClient.h" -#include "Buffer.h" -#include "BDDTest.h" -#include "trace.h" - - -byte server[] = { 172, 16, 0, 2 }; - -bool callback_called = false; -char lastTopic[1024]; -char lastPayload[1024]; -unsigned int lastLength; - -void reset_callback() { - callback_called = false; - lastTopic[0] = '\0'; - lastPayload[0] = '\0'; - lastLength = 0; -} - -void callback(char* topic, byte* payload, unsigned int length) { - TRACE("Callback received topic=[" << topic << "] length=" << length << "\n") - callback_called = true; - strcpy(lastTopic,topic); - memcpy(lastPayload,payload,length); - lastLength = length; -} - -int test_receive_callback() { - IT("receives a callback message"); - reset_callback(); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,0xe,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - shimClient.respond(publish,16); - - rc = client.loop(); - - IS_TRUE(rc); - - IS_TRUE(callback_called); - IS_TRUE(strcmp(lastTopic,"topic")==0); - IS_TRUE(memcmp(lastPayload,"payload",7)==0); - IS_TRUE(lastLength == 7); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_receive_stream() { - IT("receives a streamed callback message"); - reset_callback(); - - Stream stream; - stream.expect((uint8_t*)"payload",7); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient, stream); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,0xe,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - shimClient.respond(publish,16); - - rc = client.loop(); - - IS_TRUE(rc); - - IS_TRUE(callback_called); - IS_TRUE(strcmp(lastTopic,"topic")==0); - IS_TRUE(lastLength == 7); - - IS_FALSE(stream.error()); - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_receive_max_sized_message() { - IT("receives an max-sized message"); - reset_callback(); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int length = 80; // If this is changed to > 128 then the publish packet below - // is no longer valid as it assumes the remaining length - // is a single-byte. Don't make that mistake like I just - // did and lose a whole evening tracking down the issue. - client.setBufferSize(length); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - - byte publish[] = {0x30,length-2,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - byte bigPublish[length]; - memset(bigPublish,'A',length); - bigPublish[length] = 'B'; - memcpy(bigPublish,publish,16); - shimClient.respond(bigPublish,length); - - rc = client.loop(); - - IS_TRUE(rc); - - IS_TRUE(callback_called); - IS_TRUE(strcmp(lastTopic,"topic")==0); - IS_TRUE(lastLength == length-9); - IS_TRUE(memcmp(lastPayload,bigPublish+9,lastLength)==0); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_receive_oversized_message() { - IT("drops an oversized message"); - reset_callback(); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - int length = 80; // See comment in test_receive_max_sized_message before changing this value - - PubSubClient client(server, 1883, callback, shimClient); - client.setBufferSize(length-1); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,length-2,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - byte bigPublish[length]; - memset(bigPublish,'A',length); - bigPublish[length] = 'B'; - memcpy(bigPublish,publish,16); - shimClient.respond(bigPublish,length); - - rc = client.loop(); - - IS_TRUE(rc); - - IS_FALSE(callback_called); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_drop_invalid_remaining_length_message() { - IT("drops invalid remaining length message"); - reset_callback(); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,0x92,0x92,0x92,0x92,0x01,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - shimClient.respond(publish,20); - - rc = client.loop(); - - IS_FALSE(rc); - - IS_FALSE(callback_called); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_resize_buffer() { - IT("receives a message larger than the default maximum"); - reset_callback(); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - int length = 80; // See comment in test_receive_max_sized_message before changing this value - - PubSubClient client(server, 1883, callback, shimClient); - client.setBufferSize(length-1); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,length-2,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - byte bigPublish[length]; - memset(bigPublish,'A',length); - bigPublish[length] = 'B'; - memcpy(bigPublish,publish,16); - // Send it twice - shimClient.respond(bigPublish,length); - shimClient.respond(bigPublish,length); - - rc = client.loop(); - IS_TRUE(rc); - - // First message fails as it is too big - IS_FALSE(callback_called); - - // Resize the buffer - client.setBufferSize(length); - - rc = client.loop(); - IS_TRUE(rc); - - IS_TRUE(callback_called); - - IS_TRUE(strcmp(lastTopic,"topic")==0); - IS_TRUE(lastLength == length-9); - IS_TRUE(memcmp(lastPayload,bigPublish+9,lastLength)==0); - - IS_FALSE(shimClient.error()); - - END_IT -} - - -int test_receive_oversized_stream_message() { - IT("receive an oversized streamed message"); - reset_callback(); - - Stream stream; - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - int length = 80; // See comment in test_receive_max_sized_message before changing this value - - PubSubClient client(server, 1883, callback, shimClient, stream); - client.setBufferSize(length-1); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x30,length-2,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - - byte bigPublish[length]; - memset(bigPublish,'A',length); - bigPublish[length] = 'B'; - memcpy(bigPublish,publish,16); - - shimClient.respond(bigPublish,length); - stream.expect(bigPublish+9,length-9); - - rc = client.loop(); - - IS_TRUE(rc); - - IS_TRUE(callback_called); - IS_TRUE(strcmp(lastTopic,"topic")==0); - - IS_TRUE(lastLength == length-10); - - IS_FALSE(stream.error()); - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_receive_qos1() { - IT("receives a qos1 message"); - reset_callback(); - - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte publish[] = {0x32,0x10,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x12,0x34,0x70,0x61,0x79,0x6c,0x6f,0x61,0x64}; - shimClient.respond(publish,18); - - byte puback[] = {0x40,0x2,0x12,0x34}; - shimClient.expect(puback,4); - - rc = client.loop(); - - IS_TRUE(rc); - - IS_TRUE(callback_called); - IS_TRUE(strcmp(lastTopic,"topic")==0); - IS_TRUE(memcmp(lastPayload,"payload",7)==0); - IS_TRUE(lastLength == 7); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int main() -{ - SUITE("Receive"); - test_receive_callback(); - test_receive_stream(); - test_receive_max_sized_message(); - test_drop_invalid_remaining_length_message(); - test_receive_oversized_message(); - test_resize_buffer(); - test_receive_oversized_stream_message(); - test_receive_qos1(); - - FINISH -} diff --git a/lib/pubsubclient/tests/src/subscribe_spec.cpp b/lib/pubsubclient/tests/src/subscribe_spec.cpp deleted file mode 100644 index 22dc8a4..0000000 --- a/lib/pubsubclient/tests/src/subscribe_spec.cpp +++ /dev/null @@ -1,178 +0,0 @@ -#include "PubSubClient.h" -#include "ShimClient.h" -#include "Buffer.h" -#include "BDDTest.h" -#include "trace.h" - - -byte server[] = { 172, 16, 0, 2 }; - -void callback(char* topic, byte* payload, unsigned int length) { - // handle message arrived -} - -int test_subscribe_no_qos() { - IT("subscribe without qos defaults to 0"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte subscribe[] = { 0x82,0xa,0x0,0x2,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x0 }; - shimClient.expect(subscribe,12); - byte suback[] = { 0x90,0x3,0x0,0x2,0x0 }; - shimClient.respond(suback,5); - - rc = client.subscribe((char*)"topic"); - IS_TRUE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_subscribe_qos_1() { - IT("subscribes qos 1"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte subscribe[] = { 0x82,0xa,0x0,0x2,0x0,0x5,0x74,0x6f,0x70,0x69,0x63,0x1 }; - shimClient.expect(subscribe,12); - byte suback[] = { 0x90,0x3,0x0,0x2,0x1 }; - shimClient.respond(suback,5); - - rc = client.subscribe((char*)"topic",1); - IS_TRUE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_subscribe_not_connected() { - IT("subscribe fails when not connected"); - ShimClient shimClient; - - PubSubClient client(server, 1883, callback, shimClient); - - int rc = client.subscribe((char*)"topic"); - IS_FALSE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_subscribe_invalid_qos() { - IT("subscribe fails with invalid qos values"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - rc = client.subscribe((char*)"topic",2); - IS_FALSE(rc); - rc = client.subscribe((char*)"topic",254); - IS_FALSE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_subscribe_too_long() { - IT("subscribe fails with too long topic"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - client.setBufferSize(128); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - // max length should be allowed - // 0 1 2 3 4 5 6 7 8 9 0 1 2 - rc = client.subscribe((char*)"12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789"); - IS_TRUE(rc); - - // 0 1 2 3 4 5 6 7 8 9 0 1 2 - rc = client.subscribe((char*)"123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"); - IS_FALSE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - - -int test_unsubscribe() { - IT("unsubscribes"); - ShimClient shimClient; - shimClient.setAllowConnect(true); - - byte connack[] = { 0x20, 0x02, 0x00, 0x00 }; - shimClient.respond(connack,4); - - PubSubClient client(server, 1883, callback, shimClient); - int rc = client.connect((char*)"client_test1"); - IS_TRUE(rc); - - byte unsubscribe[] = { 0xA2,0x9,0x0,0x2,0x0,0x5,0x74,0x6f,0x70,0x69,0x63 }; - shimClient.expect(unsubscribe,12); - byte unsuback[] = { 0xB0,0x2,0x0,0x2 }; - shimClient.respond(unsuback,4); - - rc = client.unsubscribe((char*)"topic"); - IS_TRUE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int test_unsubscribe_not_connected() { - IT("unsubscribe fails when not connected"); - ShimClient shimClient; - - PubSubClient client(server, 1883, callback, shimClient); - - int rc = client.unsubscribe((char*)"topic"); - IS_FALSE(rc); - - IS_FALSE(shimClient.error()); - - END_IT -} - -int main() -{ - SUITE("Subscribe"); - test_subscribe_no_qos(); - test_subscribe_qos_1(); - test_subscribe_not_connected(); - test_subscribe_invalid_qos(); - test_subscribe_too_long(); - test_unsubscribe(); - test_unsubscribe_not_connected(); - FINISH -} diff --git a/lib/pubsubclient/tests/testcases/__init__.py b/lib/pubsubclient/tests/testcases/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/lib/pubsubclient/tests/testcases/mqtt_basic.py b/lib/pubsubclient/tests/testcases/mqtt_basic.py deleted file mode 100644 index f23ef71..0000000 --- a/lib/pubsubclient/tests/testcases/mqtt_basic.py +++ /dev/null @@ -1,39 +0,0 @@ -import unittest -import settings -import time -import mosquitto - - -def on_message(mosq, obj, msg): - obj.message_queue.append(msg) - - -class mqtt_basic(unittest.TestCase): - - message_queue = [] - - @classmethod - def setUpClass(self): - self.client = mosquitto.Mosquitto("pubsubclient_ut", clean_session=True, obj=self) - self.client.connect(settings.server_ip) - self.client.on_message = on_message - self.client.subscribe("outTopic", 0) - - @classmethod - def tearDownClass(self): - self.client.disconnect() - - def test_one(self): - i = 30 - while len(self.message_queue) == 0 and i > 0: - self.client.loop() - time.sleep(0.5) - i -= 1 - self.assertTrue(i > 0, "message receive timed-out") - self.assertEqual(len(self.message_queue), 1, "unexpected number of messages received") - msg = self.message_queue[0] - self.assertEqual(msg.mid, 0, "message id not 0") - self.assertEqual(msg.topic, "outTopic", "message topic incorrect") - self.assertEqual(msg.payload, "hello world") - self.assertEqual(msg.qos, 0, "message qos not 0") - self.assertEqual(msg.retain, False, "message retain flag incorrect") diff --git a/lib/pubsubclient/tests/testcases/mqtt_publish_in_callback.py b/lib/pubsubclient/tests/testcases/mqtt_publish_in_callback.py deleted file mode 100644 index 45b0a85..0000000 --- a/lib/pubsubclient/tests/testcases/mqtt_publish_in_callback.py +++ /dev/null @@ -1,59 +0,0 @@ -import unittest -import settings -import time -import mosquitto - - -def on_message(mosq, obj, msg): - obj.message_queue.append(msg) - - -class mqtt_publish_in_callback(unittest.TestCase): - - message_queue = [] - - @classmethod - def setUpClass(self): - self.client = mosquitto.Mosquitto("pubsubclient_ut", clean_session=True, obj=self) - self.client.connect(settings.server_ip) - self.client.on_message = on_message - self.client.subscribe("outTopic", 0) - - @classmethod - def tearDownClass(self): - self.client.disconnect() - - def test_connect(self): - i = 30 - while len(self.message_queue) == 0 and i > 0: - self.client.loop() - time.sleep(0.5) - i -= 1 - self.assertTrue(i > 0, "message receive timed-out") - self.assertEqual(len(self.message_queue), 1, "unexpected number of messages received") - msg = self.message_queue.pop(0) - self.assertEqual(msg.mid, 0, "message id not 0") - self.assertEqual(msg.topic, "outTopic", "message topic incorrect") - self.assertEqual(msg.payload, "hello world") - self.assertEqual(msg.qos, 0, "message qos not 0") - self.assertEqual(msg.retain, False, "message retain flag incorrect") - - def test_publish(self): - self.assertEqual(len(self.message_queue), 0, "message queue not empty") - payload = "abcdefghij" - self.client.publish("inTopic", payload) - - i = 30 - while len(self.message_queue) == 0 and i > 0: - self.client.loop() - time.sleep(0.5) - i -= 1 - - self.assertTrue(i > 0, "message receive timed-out") - self.assertEqual(len(self.message_queue), 1, "unexpected number of messages received") - msg = self.message_queue.pop(0) - self.assertEqual(msg.mid, 0, "message id not 0") - self.assertEqual(msg.topic, "outTopic", "message topic incorrect") - self.assertEqual(msg.payload, payload) - self.assertEqual(msg.qos, 0, "message qos not 0") - self.assertEqual(msg.retain, False, "message retain flag incorrect") diff --git a/lib/pubsubclient/tests/testcases/settings.py b/lib/pubsubclient/tests/testcases/settings.py deleted file mode 100644 index 4ad8719..0000000 --- a/lib/pubsubclient/tests/testcases/settings.py +++ /dev/null @@ -1,2 +0,0 @@ -server_ip = "172.16.0.2" -arduino_ip = "172.16.0.100" diff --git a/lib/pubsubclient/tests/testsuite.py b/lib/pubsubclient/tests/testsuite.py deleted file mode 100644 index 788fc5d..0000000 --- a/lib/pubsubclient/tests/testsuite.py +++ /dev/null @@ -1,181 +0,0 @@ -#!/usr/bin/env python -import os -import os.path -import sys -import shutil -from subprocess import call -import importlib -import unittest -import re - -from testcases import settings - - -class Workspace(object): - - def __init__(self): - self.root_dir = os.getcwd() - self.build_dir = os.path.join(self.root_dir, "tmpbin") - self.log_dir = os.path.join(self.root_dir, "logs") - self.tests_dir = os.path.join(self.root_dir, "testcases") - self.examples_dir = os.path.join(self.root_dir, "../PubSubClient/examples") - self.examples = [] - self.tests = [] - if not os.path.isdir("../PubSubClient"): - raise Exception("Cannot find PubSubClient library") - try: - return __import__('ino') - except ImportError: - raise Exception("ino tool not installed") - - def init(self): - if os.path.isdir(self.build_dir): - shutil.rmtree(self.build_dir) - os.mkdir(self.build_dir) - if os.path.isdir(self.log_dir): - shutil.rmtree(self.log_dir) - os.mkdir(self.log_dir) - - os.chdir(self.build_dir) - call(["ino", "init"]) - - shutil.copytree("../../PubSubClient", "lib/PubSubClient") - - filenames = [] - for root, dirs, files in os.walk(self.examples_dir): - filenames += [os.path.join(root, f) for f in files if f.endswith(".ino")] - filenames.sort() - for e in filenames: - self.examples.append(Sketch(self, e)) - - filenames = [] - for root, dirs, files in os.walk(self.tests_dir): - filenames += [os.path.join(root, f) for f in files if f.endswith(".ino")] - filenames.sort() - for e in filenames: - self.tests.append(Sketch(self, e)) - - def clean(self): - shutil.rmtree(self.build_dir) - - -class Sketch(object): - def __init__(self, wksp, fn): - self.w = wksp - self.filename = fn - self.basename = os.path.basename(self.filename) - self.build_log = os.path.join(self.w.log_dir, "%s.log" % (os.path.basename(self.filename),)) - self.build_err_log = os.path.join(self.w.log_dir, "%s.err.log" % (os.path.basename(self.filename),)) - self.build_upload_log = os.path.join(self.w.log_dir, "%s.upload.log" % (os.path.basename(self.filename),)) - - def build(self): - sys.stdout.write(" Build: ") - sys.stdout.flush() - - # Copy sketch over, replacing IP addresses as necessary - fin = open(self.filename, "r") - lines = fin.readlines() - fin.close() - fout = open(os.path.join(self.w.build_dir, "src", "sketch.ino"), "w") - for l in lines: - if re.match(r"^byte server\[\] = {", l): - fout.write("byte server[] = { %s };\n" % (settings.server_ip.replace(".", ", "),)) - elif re.match(r"^byte ip\[\] = {", l): - fout.write("byte ip[] = { %s };\n" % (settings.arduino_ip.replace(".", ", "),)) - else: - fout.write(l) - fout.flush() - fout.close() - - # Run build - fout = open(self.build_log, "w") - ferr = open(self.build_err_log, "w") - rc = call(["ino", "build"], stdout=fout, stderr=ferr) - fout.close() - ferr.close() - if rc == 0: - sys.stdout.write("pass") - sys.stdout.write("\n") - return True - else: - sys.stdout.write("fail") - sys.stdout.write("\n") - with open(self.build_err_log) as f: - for line in f: - print(" " + line) - return False - - def upload(self): - sys.stdout.write(" Upload: ") - sys.stdout.flush() - fout = open(self.build_upload_log, "w") - rc = call(["ino", "upload"], stdout=fout, stderr=fout) - fout.close() - if rc == 0: - sys.stdout.write("pass") - sys.stdout.write("\n") - return True - else: - sys.stdout.write("fail") - sys.stdout.write("\n") - with open(self.build_upload_log) as f: - for line in f: - print(" " + line) - return False - - def test(self): - # import the matching test case, if it exists - try: - basename = os.path.basename(self.filename)[:-4] - i = importlib.import_module("testcases." + basename) - except: - sys.stdout.write(" Test: no tests found") - sys.stdout.write("\n") - return - c = getattr(i, basename) - - testmethods = [m for m in dir(c) if m.startswith("test_")] - testmethods.sort() - tests = [] - for m in testmethods: - tests.append(c(m)) - - result = unittest.TestResult() - c.setUpClass() - if self.upload(): - sys.stdout.write(" Test: ") - sys.stdout.flush() - for t in tests: - t.run(result) - print(str(result.testsRun - len(result.failures) - len(result.errors)) + "/" + str(result.testsRun)) - if not result.wasSuccessful(): - if len(result.failures) > 0: - for f in result.failures: - print("-- " + str(f[0])) - print(f[1]) - if len(result.errors) > 0: - print(" Errors:") - for f in result.errors: - print("-- " + str(f[0])) - print(f[1]) - c.tearDownClass() - - -if __name__ == '__main__': - run_tests = True - - w = Workspace() - w.init() - - for e in w.examples: - print("--------------------------------------") - print("[" + e.basename + "]") - if e.build() and run_tests: - e.test() - for e in w.tests: - print("--------------------------------------") - print("[" + e.basename + "]") - if e.build() and run_tests: - e.test() - - w.clean() diff --git a/networkDevices/NetworkDevice.h b/networkDevices/NetworkDevice.h index 560ad4a..b23637b 100644 --- a/networkDevices/NetworkDevice.h +++ b/networkDevices/NetworkDevice.h @@ -1,6 +1,6 @@ #pragma once -#include "PubSubClient.h" +#include "MqttClient.h" enum class ReconnectStatus { @@ -16,7 +16,7 @@ public: : _hostname(hostname) {} - virtual PubSubClient* mqttClient() = 0; + virtual MqttClient* mqttClient() = 0; virtual void initialize() = 0; virtual ReconnectStatus reconnect() = 0; diff --git a/networkDevices/W5500Device.cpp b/networkDevices/W5500Device.cpp index 18454a4..2970420 100644 --- a/networkDevices/W5500Device.cpp +++ b/networkDevices/W5500Device.cpp @@ -39,7 +39,7 @@ void W5500Device::initialize() Ethernet.init(ETHERNET_CS_PIN); _ethClient = new EthernetClient(); - _mqttClient = new PubSubClient(*_ethClient); + _mqttClient = new MqttClient(*_ethClient); if(_preferences->getBool(preference_mqtt_log_enabled)) { @@ -142,7 +142,7 @@ void W5500Device::printError() Log->println(ESP.getFreeHeap()); } -PubSubClient *W5500Device::mqttClient() +MqttClient *W5500Device::mqttClient() { return _mqttClient; } diff --git a/networkDevices/W5500Device.h b/networkDevices/W5500Device.h index 05662ac..b17816e 100644 --- a/networkDevices/W5500Device.h +++ b/networkDevices/W5500Device.h @@ -21,14 +21,14 @@ public: int8_t signalStrength() override; - virtual PubSubClient *mqttClient(); + virtual MqttClient *mqttClient(); private: void resetDevice(); void initializeMacAddress(byte* mac); EthernetClient* _ethClient = nullptr; - PubSubClient* _mqttClient = nullptr; + MqttClient* _mqttClient = nullptr; Preferences* _preferences = nullptr; int _maintainResult = 0; diff --git a/networkDevices/WifiDevice.cpp b/networkDevices/WifiDevice.cpp index d1075ca..844b7f5 100644 --- a/networkDevices/WifiDevice.cpp +++ b/networkDevices/WifiDevice.cpp @@ -31,12 +31,12 @@ WifiDevice::WifiDevice(const String& hostname, Preferences* _preferences) _wifiClientSecure->setCertificate(_cert); _wifiClientSecure->setPrivateKey(_key); } - _mqttClient = new PubSubClient(*_wifiClientSecure); + _mqttClient = new MqttClient(*_wifiClientSecure); } else { Log->println(F("MQTT without TLS.")); _wifiClient = new WiFiClient(); - _mqttClient = new PubSubClient(*_wifiClient); + _mqttClient = new MqttClient(*_wifiClient); } if(_preferences->getBool(preference_mqtt_log_enabled)) @@ -51,7 +51,7 @@ WifiDevice::WifiDevice(const String& hostname, Preferences* _preferences) } } -PubSubClient *WifiDevice::mqttClient() +MqttClient *WifiDevice::mqttClient() { return _mqttClient; } diff --git a/networkDevices/WifiDevice.h b/networkDevices/WifiDevice.h index ab9caec..36a4891 100644 --- a/networkDevices/WifiDevice.h +++ b/networkDevices/WifiDevice.h @@ -22,7 +22,7 @@ public: int8_t signalStrength() override; - virtual PubSubClient *mqttClient(); + virtual MqttClient* mqttClient(); private: static void clearRtcInitVar(WiFiManager*); @@ -32,7 +32,7 @@ private: WiFiManager _wm; WiFiClient* _wifiClient = nullptr; WiFiClientSecure* _wifiClientSecure = nullptr; - PubSubClient* _mqttClient = nullptr; + MqttClient* _mqttClient = nullptr; // SpiffsCookie _cookie; bool _restartOnDisconnect = false; bool _startAp = false;