updated arduino mqtt from 2.3.1 to 2.3.3

Author: HendrikVE

libraries/arduino-mqtt-2.3.1/src/lwmqtt/packet.c

@@ -4,16 +4,16 @@ env:
     - IDE_VERSION=1.8.5
   matrix:
     - EXAMPLE="AdafruitHuzzahESP8266" BOARD="esp8266:esp8266:huzzah:FlashSize=4M3M,CpuFrequency=80"
-    - EXAMPLE="AdafruitHuzzahESP8266_SSL" BOARD="esp8266:esp8266:huzzah:FlashSize=4M3M,CpuFrequency=80"
+    - EXAMPLE="AdafruitHuzzahESP8266Secure" BOARD="esp8266:esp8266:huzzah:FlashSize=4M3M,CpuFrequency=80"
     - EXAMPLE="ArduinoEthernetShield" BOARD="arduino:avr:uno"
     - EXAMPLE="ArduinoMKRGSM1400" BOARD="arduino:samd:mkrgsm1400"
-    - EXAMPLE="ArduinoMKRGSM1400_SSL" BOARD="arduino:samd:mkrgsm1400"
-    - EXAMPLE="ArduinoWiFi101_SSL" BOARD="arduino:avr:uno"
+    - EXAMPLE="ArduinoMKRGSM1400Secure" BOARD="arduino:samd:mkrgsm1400"
+    - EXAMPLE="ArduinoWiFi101Secure" BOARD="arduino:avr:uno"
     - EXAMPLE="ArduinoWiFiShield" BOARD="arduino:avr:uno"
     - EXAMPLE="ArduinoYun" BOARD="arduino:avr:yun"
-    - EXAMPLE="ArduinoYun_SSL" BOARD="arduino:avr:yun"
+    - EXAMPLE="ArduinoYunSecure" BOARD="arduino:avr:yun"
     - EXAMPLE="ESP32DevelopmentBoard" BOARD="espressif:esp32:esp32:FlashFreq=80"
-    - EXAMPLE="ESP32DevelopmentBoard_SSL" BOARD="espressif:esp32:esp32:FlashFreq=80"
+    - EXAMPLE="ESP32DevelopmentBoardSecure" BOARD="espressif:esp32:esp32:FlashFreq=80"
 before_install:
   - /sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16
   - sleep 3

libraries/arduino-mqtt-2.3.1/src/lwmqtt/packet.h

@@ -20,17 +20,17 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
 
 set(SOURCE_FILES
     examples/AdafruitHuzzahESP8266/AdafruitHuzzahESP8266.ino
-    examples/AdafruitHuzzahESP8266_SSL/AdafruitHuzzahESP8266_SSL.ino
+        examples/AdafruitHuzzahESP8266Secure/AdafruitHuzzahESP8266Secure.ino
     examples/ArduinoEthernetShield/ArduinoEthernetShield.ino
     examples/ArduinoMKRGSM1400/ArduinoMKRGSM1400.ino
-    examples/ArduinoMKRGSM1400_SSL/ArduinoMKRGSM1400_SSL.ino
+        examples/ArduinoMKRGSM1400Secure/ArduinoMKRGSM1400Secure.ino
     examples/ArduinoWiFi101/ArduinoWiFi101.ino
-    examples/ArduinoWiFi101_SSL/ArduinoWiFi101_SSL.ino
+        examples/ArduinoWiFi101Secure/ArduinoWiFi101Secure.ino
     examples/ArduinoWiFiShield/ArduinoWiFiShield.ino
     examples/ArduinoYun/ArduinoYun.ino
-    examples/ArduinoYun_SSL/ArduinoYun_SSL.ino
+        examples/ArduinoYunSecure/ArduinoYunSecure.ino
     examples/ESP32DevelopmentBoard/ESP32DevelopmentBoard.ino
-    examples/ESP32DevelopmentBoard_SSL/ESP32DevelopmentBoard_SSL.ino
+        examples/ESP32DevelopmentBoardSecure/ESP32DevelopmentBoardSecure.ino
     src/lwmqtt
     src/MQTT.h
     src/MQTTClient.h

libraries/arduino-mqtt-2.3.1/.editorconfig renamed to libraries/arduino-mqtt-2.3.3/.editorconfig

@@ -5,7 +5,7 @@ fmt:
 
 update:
 	rm -rf ./lwmqtt
-	git clone --branch v0.5.6 https://github.com/256dpi/lwmqtt.git ./lwmqtt
+	git clone --branch v0.6.1 https://github.com/256dpi/lwmqtt.git ./lwmqtt
 	mkdir -p ./src/lwmqtt
 	cp -r ./lwmqtt/src/*.c ./src/lwmqtt/
 	cp -r ./lwmqtt/src/*.h ./src/lwmqtt/

libraries/arduino-mqtt-2.3.1/.gitignore renamed to libraries/arduino-mqtt-2.3.3/.gitignore

@@ -13,13 +13,13 @@ The library is also available on [PlatformIO](https://platformio.org/lib/show/61
 
 The following examples show how you can use the library with various Arduino compatible hardware:
 
-- [Arduino Yun & Yun-Shield](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoYun/ArduinoYun.ino) ([SSL](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoYun_SSL/ArduinoYun_SSL.ino))
+- [Arduino Yun & Yun-Shield](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoYun/ArduinoYun.ino) ([Secure](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoYunSecure/ArduinoYunSecure.ino))
 - [Arduino Ethernet Shield](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoEthernetShield/ArduinoEthernetShield.ino)    
 - [Arduino WiFi Shield](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoWiFiShield/ArduinoWiFiShield.ino)
-- [Adafruit HUZZAH ESP8266](https://github.com/256dpi/arduino-mqtt/blob/master/examples/AdafruitHuzzahESP8266/AdafruitHuzzahESP8266.ino) ([SSL](https://github.com/256dpi/arduino-mqtt/blob/master/examples/AdafruitHuzzahESP8266_SSL/AdafruitHuzzahESP8266_SSL.ino))
-- [Arduino/Genuino WiFi101 Shield](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoWiFi101/ArduinoWiFi101.ino) ([SSL](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoWiFi101_SSL/ArduinoWiFi101_SSL.ino))
-- [Arduino MKR GSM 1400](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoMKRGSM1400/ArduinoMKRGSM1400.ino) ([SSL](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoMKRGSM1400_SSL/ArduinoMKRGSM1400_SSL.ino))
-- [ESP32 Development Board](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ESP32DevelopmentBoard/ESP32DevelopmentBoard.ino) ([SSL](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ESP32DevelopmentBoard_SSL/ESP32DevelopmentBoard_SSL.ino))
+- [Adafruit HUZZAH ESP8266](https://github.com/256dpi/arduino-mqtt/blob/master/examples/AdafruitHuzzahESP8266/AdafruitHuzzahESP8266.ino) ([Secure](https://github.com/256dpi/arduino-mqtt/blob/master/examples/AdafruitHuzzahESP8266Secure/AdafruitHuzzahESP8266Secure.ino))
+- [Arduino/Genuino WiFi101 Shield](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoWiFi101/ArduinoWiFi101.ino) ([Secure](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoWiFi101Secure/ArduinoWiFi101Secure.ino))
+- [Arduino MKR GSM 1400](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoMKRGSM1400/ArduinoMKRGSM1400.ino) ([Secure](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ArduinoMKRGSM1400Secure/ArduinoMKRGSM1400Secure.ino))
+- [ESP32 Development Board](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ESP32DevelopmentBoard/ESP32DevelopmentBoard.ino) ([Secure](https://github.com/256dpi/arduino-mqtt/blob/master/examples/ESP32DevelopmentBoardSecure/ESP32DevelopmentBoardSecure.ino))
 
 Other shields and boards should also work if they provide a [Client](https://www.arduino.cc/en/Reference/ClientConstructor) based network implementation.
 
@@ -107,7 +107,7 @@ void begin(const char hostname[], Client &client);
 void begin(const char hostname[], int port, Client &client);
 ```
 
-- Specify port `8883` when using SSL clients for secure connections.
+- Specify port `8883` when using secure clients for encrypted connections.
 - Local domain names (e.g. `Computer.local` on OSX) are not supported by Arduino. You need to set the IP address directly.
 
 The hostname and port can also be changed after calling `begin()`:
@@ -117,7 +117,7 @@ void setHost(const char hostname[]);
 void setHost(const char hostname[], int port);
 ```
 
-Set a will message (last testament) that gets registered on the broker after connecting:
+Set a will message (last testament) that gets registered on the broker after connecting. `setWill()` has to be called before calling `connect()`:
 
 ```c++
 void setWill(const char topic[]);
@@ -144,7 +144,7 @@ Set more advanced options:
 void setOptions(int keepAlive, bool cleanSession, int timeout);
 ```
 
-- The `keepAlive` option controls the keep alive interval (default: 10).
+- The `keepAlive` option controls the keep alive interval in seconds (default: 10).
 - The `cleanSession` option controls the session retention on the broker side (default: true).
 - The `timeout` option controls the default timeout for all commands in milliseconds (default: 1000). 
 

libraries/arduino-mqtt-2.3.1/.travis.yml renamed to libraries/arduino-mqtt-2.3.3/.travis.yml

@@ -1,5 +1,5 @@
 name=MQTT
-version=2.3.1
+version=2.3.3
 author=Joel Gaehwiler <[email protected]>
 maintainer=Joel Gaehwiler <[email protected]>
 sentence=MQTT library for Arduino

libraries/arduino-mqtt-2.3.1/CMakeLists.txt renamed to libraries/arduino-mqtt-2.3.3/CMakeLists.txt

@@ -2,9 +2,7 @@
 
 #include "helpers.h"
 
-uint8_t lwmqtt_read_bits(uint8_t byte, int pos, int num) {
-  return (byte & (uint8_t)((~(0xFF << num)) << pos)) >> pos;
-}
+uint8_t lwmqtt_read_bits(uint8_t byte, int pos, int num) { return (byte & (uint8_t)((~(0xFF << num)) << pos)) >> pos; }
 
 void lwmqtt_write_bits(uint8_t *byte, uint8_t value, int pos, int num) {
   *byte = (*byte & ~(uint8_t)((~(0xFF << num)) << pos)) | (value << pos);

libraries/arduino-mqtt-2.3.1/LICENSE.md renamed to libraries/arduino-mqtt-2.3.3/LICENSE.md

@@ -7,6 +7,10 @@
 
 /**
  * The error type used by all exposed APIs.
+ *
+ * If a function returns an error that operates on a connected client (e.g publish, keep_alive, etc.) the caller should
+ * switch into a disconnected state, close and cleanup the current connection and start over by creating a new
+ * connection.
  */
 typedef enum {
   LWMQTT_SUCCESS = 0,
@@ -345,11 +349,12 @@ lwmqtt_err_t lwmqtt_disconnect(lwmqtt_client_t *client, uint32_t timeout);
 /**
  * Will yield control to the client and receive incoming packets from the network.
  *
- * Applications may peek on the network if there is data available to read before calling yield and potentially block
- * until the timeout is reached. Furthermore, applications may specify the amount of bytes available to read in order
- * to constrain the yield to only receive packets that are already inflight.
+ * Single-threaded applications may peek on the network and assess if data is available to read before calling yield and
+ * potentially block until the timeout is reached. Multi-threaded applications may select on the socket and block until
+ * data is available and then yield to the client if data is available. All applications may specify the amount of bytes
+ * available to read in order to constrain the yield to only receive packets that are already in-flight.
  *
- * If no availability data is given the yield will return after one packet has been successfully read or the deadline
+ * If no availability info is given the yield will return after one packet has been successfully read or the deadline
  * has been reached but no single bytes has been received.
  *
  * Note: The message callback might be called with incoming messages as part of this call.
@@ -364,6 +369,9 @@ lwmqtt_err_t lwmqtt_yield(lwmqtt_client_t *client, size_t available, uint32_t ti
 /**
  * Will yield control to the client to keep the connection alive.
  *
+ * This functions must be called at a rate slightly lower than 25% of the configured keep alive. If keep alive is zero,
+ * the function must not be called at all.
+ *
  * @param client - The client object.
  * @param timeout - The command timeout.
  * @return An error value.

libraries/arduino-mqtt-2.3.1/Makefile renamed to libraries/arduino-mqtt-2.3.3/Makefile

@@ -132,11 +132,11 @@ lwmqtt_err_t lwmqtt_encode_connect(uint8_t *buf, size_t buf_len, size_t *len, lw
 
   // set username flag if present
   if (options.username.len > 0) {
-    lwmqtt_write_bits(&flags, 1, 6, 1);
+    lwmqtt_write_bits(&flags, 1, 7, 1);
 
     // set password flag if present
     if (options.password.len > 0) {
-      lwmqtt_write_bits(&flags, 1, 7, 1);
+      lwmqtt_write_bits(&flags, 1, 6, 1);
     }
   }