Merge pull request #177 from adafruit/actionci

Moved to actions, no doxygen

.github/workflows/githubci.yml

@@ -0,0 +1,26 @@
+name: Arduino Library CI
+
+on: [pull_request, push, repository_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2
+      with:
+         repository: adafruit/ci-arduino
+         path: ci
+
+    - name: pre-install
+      run: bash ci/actions_install.sh
+
+    - name: test platforms
+      run: python3 ci/build_platform.py esp8266 zero
+
+    - name: clang
+      run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r . 

.travis.yml

@@ -1,14 +0,0 @@
-language: c
-sudo: false
-before_install:
-  - source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/install.sh)
-install:
-  - arduino --install-library "Adafruit SleepyDog Library","Adafruit FONA Library"
-script:
-  - build_platform esp8266
-  - arduino --install-library "WiFi101"
-  - build_platform zero
-notifications:
-  email:
-    on_success: change
-    on_failure: change

Adafruit_MQTT.cpp

@@ -9,8 +9,8 @@
 // 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
+// The above copyright notice and this permission notice shall be included in
-// copies or substantial portions of the Software.
+// 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,
@@ -21,8 +21,10 @@
 // SOFTWARE.
 #include "Adafruit_MQTT.h"
 
-#if defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_SAMD_MKR1000) || defined(ARDUINO_ARCH_SAMD)
+#if defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_SAMD_MKR1000) ||             \
-static char *dtostrf (double val, signed char width, unsigned char prec, char *sout) {
+    defined(ARDUINO_ARCH_SAMD)
+static char *dtostrf(double val, signed char width, unsigned char prec,
+                     char *sout) {
   char fmt[20];
   sprintf(fmt, "%%%d.%df", width, prec);
   sprintf(sout, fmt, val);
@@ -44,7 +46,6 @@ int strncasecmp(const char * str1, const char * str2, int len) {
 }
 #endif
 
-
 void printBuffer(uint8_t *buffer, uint16_t len) {
   DEBUG_PRINTER.print('\t');
   for (uint16_t i = 0; i < len; i++) {
@@ -87,20 +88,18 @@ static uint8_t *stringprint(uint8_t *p, const char *s, uint16_t maxlen=0) {
     Serial.write(pgm_read_byte(s+i));
   }
   */
-  p[0] = len >> 8; p++;
+  p[0] = len >> 8;
-  p[0] = len & 0xFF; p++;
+  p++;
+  p[0] = len & 0xFF;
+  p++;
   strncpy((char *)p, s, len);
   return p + len;
 }
 
-
 // Adafruit_MQTT Definition ////////////////////////////////////////////////////
 
-Adafruit_MQTT::Adafruit_MQTT(const char *server,
+Adafruit_MQTT::Adafruit_MQTT(const char *server, uint16_t port, const char *cid,
-                             uint16_t port,
+                             const char *user, const char *pass) {
-                             const char *cid,
-                             const char *user,
-                             const char *pass) {
   servername = server;
   portnum = port;
   clientid = cid;
@@ -118,14 +117,10 @@ Adafruit_MQTT::Adafruit_MQTT(const char *server,
   will_retain = 0;
 
   packet_id_counter = 0;
-
 }
 
-
+Adafruit_MQTT::Adafruit_MQTT(const char *server, uint16_t port,
-Adafruit_MQTT::Adafruit_MQTT(const char *server,
+                             const char *user, const char *pass) {
-                             uint16_t port,
-                             const char *user,
-                             const char *pass) {
   servername = server;
   portnum = port;
   clientid = "";
@@ -143,7 +138,6 @@ Adafruit_MQTT::Adafruit_MQTT(const char *server,
   will_retain = 0;
 
   packet_id_counter = 0;
-
 }
 
 int8_t Adafruit_MQTT::connect() {
@@ -168,12 +162,15 @@ int8_t Adafruit_MQTT::connect() {
   // Setup subscriptions once connected.
   for (uint8_t i = 0; i < MAXSUBSCRIPTIONS; i++) {
     // Ignore subscriptions that aren't defined.
-    if (subscriptions[i] == 0) continue;
+    if (subscriptions[i] == 0)
+      continue;
 
     boolean success = false;
-    for (uint8_t retry=0; (retry<3) && !success; retry++) { // retry until we get a suback    
+    for (uint8_t retry = 0; (retry < 3) && !success;
+         retry++) { // retry until we get a suback
       // Construct and send subscription packet.
-      uint8_t len = subscribePacket(buffer, subscriptions[i]->topic, subscriptions[i]->qos);
+      uint8_t len = subscribePacket(buffer, subscriptions[i]->topic,
+                                    subscriptions[i]->qos);
       if (!sendPacket(buffer, len))
         return -1;
 
@@ -181,8 +178,9 @@ int8_t Adafruit_MQTT::connect() {
         break;
 
       // Check for SUBACK if using MQTT 3.1.1 or higher
-      // TODO: The Server is permitted to start sending PUBLISH packets matching the
+      // TODO: The Server is permitted to start sending PUBLISH packets matching
-      // Subscription before the Server sends the SUBACK Packet. (will really need to use callbacks - ada)
+      // the Subscription before the Server sends the SUBACK Packet. (will
+      // really need to use callbacks - ada)
 
       // Serial.println("\t**looking for suback");
       if (processPacketsUntil(buffer, MQTT_CTRL_SUBACK, SUBACK_TIMEOUT_MS)) {
@@ -190,20 +188,22 @@ int8_t Adafruit_MQTT::connect() {
         break;
       }
     }
-    if (! success) return -2; // failed to sub for some reason
+    if (!success)
+      return -2; // failed to sub for some reason
   }
 
   return 0;
 }
 
-int8_t Adafruit_MQTT::connect(const char *user, const char *pass)
+int8_t Adafruit_MQTT::connect(const char *user, const char *pass) {
-{
   username = user;
   password = pass;
   return connect();
 }
 
-uint16_t Adafruit_MQTT::processPacketsUntil(uint8_t *buffer, uint8_t waitforpackettype, uint16_t timeout) {
+uint16_t Adafruit_MQTT::processPacketsUntil(uint8_t *buffer,
+                                            uint8_t waitforpackettype,
+                                            uint16_t timeout) {
   uint16_t len;
 
   while (true) {
@@ -213,19 +213,17 @@ uint16_t Adafruit_MQTT::processPacketsUntil(uint8_t *buffer, uint8_t waitforpack
       break;
     }
 
-    if ((buffer[0] >> 4) == waitforpackettype)
+    if ((buffer[0] >> 4) == waitforpackettype) {
-    {
       return len;
-    }
+    } else {
-    else
-    {
       ERROR_PRINTLN(F("Dropped a packet"));
     }
   }
   return 0;
 }
 
-uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16_t timeout) {
+uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize,
+                                       uint16_t timeout) {
   // will read a packet and Do The Right Thing with length
   uint8_t *pbuff = buffer;
 
@@ -233,9 +231,11 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16
 
   // read the packet type:
   rlen = readPacket(pbuff, 1, timeout);
-  if (rlen != 1) return 0;
+  if (rlen != 1)
+    return 0;
 
-  DEBUG_PRINT(F("Packet Type:\t")); DEBUG_PRINTBUFFER(pbuff, rlen);
+  DEBUG_PRINT(F("Packet Type:\t"));
+  DEBUG_PRINTBUFFER(pbuff, rlen);
   pbuff++;
 
   uint32_t value = 0;
@@ -244,7 +244,8 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16
 
   do {
     rlen = readPacket(pbuff, 1, timeout);
-    if (rlen != 1) return 0;
+    if (rlen != 1)
+      return 0;
     encodedByte = pbuff[0]; // save the last read val
     pbuff++;                // get ready for reading the next byte
     uint32_t intermediate = encodedByte & 0x7F;
@@ -257,7 +258,8 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16
     }
   } while (encodedByte & 0x80);
 
-  DEBUG_PRINT(F("Packet Length:\t")); DEBUG_PRINTLN(value);
+  DEBUG_PRINT(F("Packet Length:\t"));
+  DEBUG_PRINTLN(value);
 
   if (value > (maxsize - (pbuff - buffer) - 1)) {
     DEBUG_PRINTLN(F("Packet too big for buffer"));
@@ -272,16 +274,29 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16
 
 const __FlashStringHelper *Adafruit_MQTT::connectErrorString(int8_t code) {
   switch (code) {
-      case 1: return F("The Server does not support the level of the MQTT protocol requested");
+  case 1:
-      case 2: return F("The Client identifier is correct UTF-8 but not allowed by the Server");
+    return F(
-      case 3: return F("The MQTT service is unavailable");
+        "The Server does not support the level of the MQTT protocol requested");
-      case 4: return F("The data in the user name or password is malformed");
+  case 2:
-      case 5: return F("Not authorized to connect");
+    return F(
-      case 6: return F("Exceeded reconnect rate limit. Please try again later.");
+        "The Client identifier is correct UTF-8 but not allowed by the Server");
-      case 7: return F("You have been banned from connecting. Please contact the MQTT server administrator for more details.");
+  case 3:
-      case -1: return F("Connection failed");
+    return F("The MQTT service is unavailable");
-      case -2: return F("Failed to subscribe");
+  case 4:
-      default: return F("Unknown error");
+    return F("The data in the user name or password is malformed");
+  case 5:
+    return F("Not authorized to connect");
+  case 6:
+    return F("Exceeded reconnect rate limit. Please try again later.");
+  case 7:
+    return F("You have been banned from connecting. Please contact the MQTT "
+             "server administrator for more details.");
+  case -1:
+    return F("Connection failed");
+  case -2:
+    return F("Failed to subscribe");
+  default:
+    return F("Unknown error");
   }
 }
 
@@ -293,15 +308,14 @@ bool Adafruit_MQTT::disconnect() {
     DEBUG_PRINTLN(F("Unable to send disconnect packet"));
 
   return disconnectServer();
-
 }
 
-
 bool Adafruit_MQTT::publish(const char *topic, const char *data, uint8_t qos) {
   return publish(topic, (uint8_t *)(data), strlen(data), qos);
 }
 
-bool Adafruit_MQTT::publish(const char *topic, uint8_t *data, uint16_t bLen, uint8_t qos) {
+bool Adafruit_MQTT::publish(const char *topic, uint8_t *data, uint16_t bLen,
+                            uint8_t qos) {
   // Construct and send publish packet.
   uint16_t len = publishPacket(buffer, topic, data, bLen, qos);
   if (!sendPacket(buffer, len))
@@ -320,7 +334,8 @@ bool Adafruit_MQTT::publish(const char *topic, uint8_t *data, uint16_t bLen, uin
     packnum <<= 8;
     packnum |= buffer[3];
 
-    // we increment the packet_id_counter right after publishing so inc here too to match
+    // we increment the packet_id_counter right after publishing so inc here too
+    // to match
     packnum++;
     if (packnum != packet_id_counter)
       return false;
@@ -329,7 +344,8 @@ bool Adafruit_MQTT::publish(const char *topic, uint8_t *data, uint16_t bLen, uin
   return true;
 }
 
-bool Adafruit_MQTT::will(const char *topic, const char *payload, uint8_t qos, uint8_t retain) {
+bool Adafruit_MQTT::will(const char *topic, const char *payload, uint8_t qos,
+                         uint8_t retain) {
 
   if (connected()) {
     DEBUG_PRINT(F("Will defined after connect"));
@@ -342,7 +358,6 @@ bool Adafruit_MQTT::will(const char *topic, const char *payload, uint8_t qos, ui
   will_retain = retain;
 
   return true;
-
 }
 
 bool Adafruit_MQTT::subscribe(Adafruit_MQTT_Subscribe *sub) {
@@ -357,7 +372,8 @@ bool Adafruit_MQTT::subscribe(Adafruit_MQTT_Subscribe *sub) {
   if (i == MAXSUBSCRIPTIONS) { // add to subscriptionlist
     for (i = 0; i < MAXSUBSCRIPTIONS; i++) {
       if (subscriptions[i] == 0) {
-        DEBUG_PRINT(F("Added sub ")); DEBUG_PRINTLN(i);
+        DEBUG_PRINT(F("Added sub "));
+        DEBUG_PRINTLN(i);
         subscriptions[i] = sub;
         return true;
       }
@@ -376,7 +392,8 @@ bool Adafruit_MQTT::unsubscribe(Adafruit_MQTT_Subscribe *sub) {
 
     if (subscriptions[i] == sub) {
 
-      DEBUG_PRINTLN(F("Found matching subscription and attempting to unsubscribe."));
+      DEBUG_PRINTLN(
+          F("Found matching subscription and attempting to unsubscribe."));
 
       // Construct and send unsubscribe packet.
       uint8_t len = unsubscribePacket(buffer, subscriptions[i]->topic);
@@ -402,12 +419,10 @@ bool Adafruit_MQTT::unsubscribe(Adafruit_MQTT_Subscribe *sub) {
       subscriptions[i] = 0;
       return true;
     }
-
   }
 
   // subscription not found, so we are unsubscribed
   return true;
-
 }
 
 void Adafruit_MQTT::processPackets(int16_t timeout) {
@@ -422,25 +437,27 @@ void Adafruit_MQTT::processPackets(int16_t timeout) {
         // huh lets do the callback in integer mode
         uint32_t data = 0;
         data = atoi((char *)sub->lastread);
-	//Serial.print("*** calling int callback with : "); Serial.println(data);
+        // Serial.print("*** calling int callback with : ");
+        // Serial.println(data);
         sub->callback_uint32t(data);
-      } 
+      } else if (sub->callback_double != NULL) {
-      else if (sub->callback_double != NULL) {
         // huh lets do the callback in doublefloat mode
         double data = 0;
         data = atof((char *)sub->lastread);
-	//Serial.print("*** calling double callback with : "); Serial.println(data);
+        // Serial.print("*** calling double callback with : ");
+        // Serial.println(data);
         sub->callback_double(data);
-      }
+      } else if (sub->callback_buffer != NULL) {
-      else if (sub->callback_buffer != NULL) {
         // huh lets do the callback in buffer mode
-	//Serial.print("*** calling buffer callback with : "); Serial.println((char *)sub->lastread);
+        // Serial.print("*** calling buffer callback with : ");
+        // Serial.println((char *)sub->lastread);
         sub->callback_buffer((char *)sub->lastread, sub->datalen);
-      }
+      } else if (sub->callback_io != NULL) {
-      else if (sub->callback_io != NULL) {
         // huh lets do the callback in io mode
-        //Serial.print("*** calling io instance callback with : "); Serial.println((char *)sub->lastread);
+        // Serial.print("*** calling io instance callback with : ");
-        ((sub->io_mqtt)->*(sub->callback_io))((char *)sub->lastread, sub->datalen);
+        // Serial.println((char *)sub->lastread);
+        ((sub->io_mqtt)->*(sub->callback_io))((char *)sub->lastread,
+                                              sub->datalen);
       }
     }
 
@@ -457,18 +474,23 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
   uint16_t i, topiclen, datalen;
 
   // Check if data is available to read.
-  uint16_t len = readFullPacket(buffer, MAXBUFFERSIZE, timeout); // return one full packet
+  uint16_t len =
+      readFullPacket(buffer, MAXBUFFERSIZE, timeout); // return one full packet
   if (!len)
     return NULL; // No data available, just quit.
-  DEBUG_PRINT("Packet len: "); DEBUG_PRINTLN(len); 
+  DEBUG_PRINT("Packet len: ");
+  DEBUG_PRINTLN(len);
   DEBUG_PRINTBUFFER(buffer, len);
 
-	if (len<3) return NULL;
+  if (len < 3)
-	if ((buffer[0] & 0xF0) != (MQTT_CTRL_PUBLISH) << 4) return NULL;
+    return NULL;
+  if ((buffer[0] & 0xF0) != (MQTT_CTRL_PUBLISH) << 4)
+    return NULL;
 
   // Parse out length of packet.
   topiclen = buffer[3];
-  DEBUG_PRINT(F("Looking for subscription len ")); DEBUG_PRINTLN(topiclen);
+  DEBUG_PRINT(F("Looking for subscription len "));
+  DEBUG_PRINTLN(topiclen);
 
   // Find subscription associated with this packet.
   for (i = 0; i < MAXSUBSCRIPTIONS; i++) {
@@ -479,13 +501,16 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
         continue;
       // Stop if the subscription topic matches the received topic. Be careful
       // to make comparison case insensitive.
-      if (strncasecmp((char*)buffer+4, subscriptions[i]->topic, topiclen) == 0) {
+      if (strncasecmp((char *)buffer + 4, subscriptions[i]->topic, topiclen) ==
-        DEBUG_PRINT(F("Found sub #")); DEBUG_PRINTLN(i);
+          0) {
+        DEBUG_PRINT(F("Found sub #"));
+        DEBUG_PRINTLN(i);
         break;
       }
     }
   }
-  if (i==MAXSUBSCRIPTIONS) return NULL; // matching sub not found ???
+  if (i == MAXSUBSCRIPTIONS)
+    return NULL; // matching sub not found ???
 
   uint8_t packet_id_len = 0;
   uint16_t packetid = 0;
@@ -505,10 +530,13 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
     datalen = SUBSCRIPTIONDATALEN - 1; // cut it off
   }
   // extract out just the data, into the subscription object itself
-  memmove(subscriptions[i]->lastread, buffer+4+topiclen+packet_id_len, datalen);
+  memmove(subscriptions[i]->lastread, buffer + 4 + topiclen + packet_id_len,
+          datalen);
   subscriptions[i]->datalen = datalen;
-  DEBUG_PRINT(F("Data len: ")); DEBUG_PRINTLN(datalen);
+  DEBUG_PRINT(F("Data len: "));
-  DEBUG_PRINT(F("Data: ")); DEBUG_PRINTLN((char *)subscriptions[i]->lastread);
+  DEBUG_PRINTLN(datalen);
+  DEBUG_PRINT(F("Data: "));
+  DEBUG_PRINTLN((char *)subscriptions[i]->lastread);
 
   if ((MQTT_PROTOCOL_LEVEL > 3) && (buffer[0] & 0x6) == 0x2) {
     uint8_t ackpacket[4];
@@ -526,7 +554,8 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
 void Adafruit_MQTT::flushIncoming(uint16_t timeout) {
   // flush input!
   DEBUG_PRINTLN(F("Flushing input buffer"));
-  while (readPacket(buffer, MAXBUFFERSIZE, timeout));
+  while (readPacket(buffer, MAXBUFFERSIZE, timeout))
+    ;
 }
 
 bool Adafruit_MQTT::ping(uint8_t num) {
@@ -589,7 +618,6 @@ uint8_t Adafruit_MQTT::connectPacket(uint8_t *packet) {
 
     if (will_retain == 1)
       p[0] |= MQTT_CONN_WILLRETAIN;
-
   }
 
   if (pgm_read_byte(username) != 0)
@@ -637,10 +665,11 @@ uint8_t Adafruit_MQTT::connectPacket(uint8_t *packet) {
   return len;
 }
 
-
+// as per
-// as per http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718040
+// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718040
 uint16_t Adafruit_MQTT::publishPacket(uint8_t *packet, const char *topic,
-                                     uint8_t *data, uint16_t bLen, uint8_t qos) {
+                                      uint8_t *data, uint16_t bLen,
+                                      uint8_t qos) {
   uint8_t *p = packet;
   uint16_t len = 0;
 
@@ -718,8 +747,6 @@ uint8_t Adafruit_MQTT::subscribePacket(uint8_t *packet, const char *topic,
   return len;
 }
 
-
-
 uint8_t Adafruit_MQTT::unsubscribePacket(uint8_t *packet, const char *topic) {
 
   uint8_t *p = packet;
@@ -744,7 +771,6 @@ uint8_t Adafruit_MQTT::unsubscribePacket(uint8_t *packet, const char *topic) {
   DEBUG_PRINTLN(F("MQTT unsubscription packet:"));
   DEBUG_PRINTBUFFER(buffer, len);
   return len;
-
 }
 
 uint8_t Adafruit_MQTT::pingPacket(uint8_t *packet) {
@@ -794,7 +820,8 @@ bool Adafruit_MQTT_Publish::publish(uint32_t i) {
 }
 
 bool Adafruit_MQTT_Publish::publish(double f, uint8_t precision) {
-  char payload[41];  // Need to technically hold float max, 39 digits and minus sign.
+  char payload[41]; // Need to technically hold float max, 39 digits and minus
+                    // sign.
   dtostrf(f, 0, precision, payload);
   return mqtt->publish(topic, payload, qos);
 }
@@ -809,7 +836,6 @@ bool Adafruit_MQTT_Publish::publish(uint8_t *payload, uint16_t bLen) {
   return mqtt->publish(topic, payload, bLen, qos);
 }
 
-
 // Adafruit_MQTT_Subscribe Definition //////////////////////////////////////////
 
 Adafruit_MQTT_Subscribe::Adafruit_MQTT_Subscribe(Adafruit_MQTT *mqttserver,
@@ -837,7 +863,8 @@ void Adafruit_MQTT_Subscribe::setCallback(SubscribeCallbackBufferType cb) {
   callback_buffer = cb;
 }
 
-void Adafruit_MQTT_Subscribe::setCallback(AdafruitIO_MQTT *io, SubscribeCallbackIOType cb) {
+void Adafruit_MQTT_Subscribe::setCallback(AdafruitIO_MQTT *io,
+                                          SubscribeCallbackIOType cb) {
   callback_io = cb;
   io_mqtt = io;
 }

Adafruit_MQTT.h

@@ -9,8 +9,8 @@
 // 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
+// The above copyright notice and this permission notice shall be included in
-// copies or substantial portions of the Software.
+// 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,
@@ -44,23 +44,35 @@
 
 // Define actual debug output functions when necessary.
 #ifdef MQTT_DEBUG
-  #define DEBUG_PRINT(...) { DEBUG_PRINTER.print(__VA_ARGS__); }
+#define DEBUG_PRINT(...)                                                       \
-  #define DEBUG_PRINTLN(...) { DEBUG_PRINTER.println(__VA_ARGS__); }
+  { DEBUG_PRINTER.print(__VA_ARGS__); }
-  #define DEBUG_PRINTBUFFER(buffer, len) { printBuffer(buffer, len); }
+#define DEBUG_PRINTLN(...)                                                     \
+  { DEBUG_PRINTER.println(__VA_ARGS__); }
+#define DEBUG_PRINTBUFFER(buffer, len)                                         \
+  { printBuffer(buffer, len); }
 #else
-  #define DEBUG_PRINT(...) {}
+#define DEBUG_PRINT(...)                                                       \
-  #define DEBUG_PRINTLN(...) {}
+  {}
-  #define DEBUG_PRINTBUFFER(buffer, len) {}
+#define DEBUG_PRINTLN(...)                                                     \
+  {}
+#define DEBUG_PRINTBUFFER(buffer, len)                                         \
+  {}
 #endif
 
 #ifdef MQTT_ERROR
-  #define ERROR_PRINT(...) { DEBUG_PRINTER.print(__VA_ARGS__); }
+#define ERROR_PRINT(...)                                                       \
-  #define ERROR_PRINTLN(...) { DEBUG_PRINTER.println(__VA_ARGS__); }
+  { DEBUG_PRINTER.print(__VA_ARGS__); }
-  #define ERROR_PRINTBUFFER(buffer, len) { printBuffer(buffer, len); }
+#define ERROR_PRINTLN(...)                                                     \
+  { DEBUG_PRINTER.println(__VA_ARGS__); }
+#define ERROR_PRINTBUFFER(buffer, len)                                         \
+  { printBuffer(buffer, len); }
 #else
-  #define ERROR_PRINT(...) {}
+#define ERROR_PRINT(...)                                                       \
-  #define ERROR_PRINTLN(...) {}
+  {}
-  #define ERROR_PRINTBUFFER(buffer, len) {}
+#define ERROR_PRINTLN(...)                                                     \
+  {}
+#define ERROR_PRINTBUFFER(buffer, len)                                         \
+  {}
 #endif
 
 // Use 3 (MQTT 3.0) or 4 (MQTT 3.1.1)
@@ -124,7 +136,8 @@ typedef void (*SubscribeCallbackDoubleType)(double);
 // returns a chunk of raw data
 typedef void (*SubscribeCallbackBufferType)(char *str, uint16_t len);
 // returns an io data wrapper instance
-typedef void (AdafruitIO_MQTT::*SubscribeCallbackIOType)(char *str, uint16_t len);
+typedef void (AdafruitIO_MQTT::*SubscribeCallbackIOType)(char *str,
+                                                         uint16_t len);
 
 extern void printBuffer(uint8_t *buffer, uint16_t len);
 
@@ -132,15 +145,10 @@ class Adafruit_MQTT_Subscribe;  // forward decl
 
 class Adafruit_MQTT {
 public:
-  Adafruit_MQTT(const char *server,
+  Adafruit_MQTT(const char *server, uint16_t port, const char *cid,
-                uint16_t port,
+                const char *user, const char *pass);
-                const char *cid,
-                const char *user,
-                const char *pass);
 
-  Adafruit_MQTT(const char *server,
+  Adafruit_MQTT(const char *server, uint16_t port, const char *user = "",
-                uint16_t port,
-                const char *user = "",
                 const char *pass = "");
   virtual ~Adafruit_MQTT() {}
 
@@ -173,12 +181,14 @@ class Adafruit_MQTT {
   // Set MQTT last will topic, payload, QOS, and retain. This needs
   // to be called before connect() because it is sent as part of the
   // connect control packet.
-  bool will(const char *topic, const char *payload, uint8_t qos = 0, uint8_t retain = 0);
+  bool will(const char *topic, const char *payload, uint8_t qos = 0,
+            uint8_t retain = 0);
 
   // Publish a message to a topic using the specified QoS level.  Returns true
   // if the message was published, false otherwise.
   bool publish(const char *topic, const char *payload, uint8_t qos = 0);
-  bool publish(const char *topic, uint8_t *payload, uint16_t bLen, uint8_t qos = 0);
+  bool publish(const char *topic, uint8_t *payload, uint16_t bLen,
+               uint8_t qos = 0);
 
   // Add a subscription to receive messages for a topic.  Returns true if the
   // subscription could be added or was already present, false otherwise.
@@ -190,9 +200,10 @@ class Adafruit_MQTT {
   bool unsubscribe(Adafruit_MQTT_Subscribe *sub);
 
   // Check if any subscriptions have new messages.  Will return a reference to
-  // an Adafruit_MQTT_Subscribe object which has a new message.  Should be called
+  // an Adafruit_MQTT_Subscribe object which has a new message.  Should be
-  // in the sketch's loop function to ensure new messages are recevied.  Note
+  // called in the sketch's loop function to ensure new messages are recevied.
-  // that subscribe should be called first for each topic that receives messages!
+  // Note that subscribe should be called first for each topic that receives
+  // messages!
   Adafruit_MQTT_Subscribe *readSubscription(int16_t timeout = 0);
 
   void processPackets(int16_t timeout);
@@ -206,7 +217,8 @@ class Adafruit_MQTT {
   // Connect to the server and return true if successful, false otherwise.
   virtual bool connectServer() = 0;
 
-  // Disconnect from the MQTT server.  Returns true if disconnected, false otherwise.
+  // Disconnect from the MQTT server.  Returns true if disconnected, false
+  // otherwise.
   virtual bool disconnectServer() = 0; // Subclasses need to fill this in!
 
   // Send data to the server specified by the buffer and length of data.
@@ -215,12 +227,14 @@ class Adafruit_MQTT {
   // Read MQTT packet from the server.  Will read up to maxlen bytes and store
   // the data in the provided buffer.  Waits up to the specified timeout (in
   // milliseconds) for data to be available.
-  virtual uint16_t readPacket(uint8_t *buffer, uint16_t maxlen, int16_t timeout) = 0;
+  virtual uint16_t readPacket(uint8_t *buffer, uint16_t maxlen,
+                              int16_t timeout) = 0;
 
   // Read a full packet, keeping note of the correct length
   uint16_t readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16_t timeout);
   // Properly process packets until you get to one you want
-  uint16_t processPacketsUntil(uint8_t *buffer, uint8_t waitforpackettype, uint16_t timeout);
+  uint16_t processPacketsUntil(uint8_t *buffer, uint8_t waitforpackettype,
+                               uint16_t timeout);
 
   // Shared state that subclasses can use:
   const char *servername;
@@ -243,26 +257,29 @@ class Adafruit_MQTT {
   // Functions to generate MQTT packets.
   uint8_t connectPacket(uint8_t *packet);
   uint8_t disconnectPacket(uint8_t *packet);
-  uint16_t publishPacket(uint8_t *packet, const char *topic, uint8_t *payload, uint16_t bLen, uint8_t qos);
+  uint16_t publishPacket(uint8_t *packet, const char *topic, uint8_t *payload,
+                         uint16_t bLen, uint8_t qos);
   uint8_t subscribePacket(uint8_t *packet, const char *topic, uint8_t qos);
   uint8_t unsubscribePacket(uint8_t *packet, const char *topic);
   uint8_t pingPacket(uint8_t *packet);
   uint8_t pubackPacket(uint8_t *packet, uint16_t packetid);
 };
 
-
 class Adafruit_MQTT_Publish {
 public:
-  Adafruit_MQTT_Publish(Adafruit_MQTT *mqttserver, const char *feed, uint8_t qos = 0);
+  Adafruit_MQTT_Publish(Adafruit_MQTT *mqttserver, const char *feed,
+                        uint8_t qos = 0);
 
   bool publish(const char *s);
-  bool publish(double f, uint8_t precision=2);  // Precision controls the minimum number of digits after decimal.
+  bool publish(
+      double f,
+      uint8_t precision =
+          2); // Precision controls the minimum number of digits after decimal.
               // This might be ignored and a higher precision value sent.
   bool publish(int32_t i);
   bool publish(uint32_t i);
   bool publish(uint8_t *b, uint16_t bLen);
 
-
 private:
   Adafruit_MQTT *mqtt;
   const char *topic;
@@ -271,7 +288,8 @@ private:
 
 class Adafruit_MQTT_Subscribe {
 public:
-  Adafruit_MQTT_Subscribe(Adafruit_MQTT *mqttserver, const char *feedname, uint8_t q=0);
+  Adafruit_MQTT_Subscribe(Adafruit_MQTT *mqttserver, const char *feedname,
+                          uint8_t q = 0);
 
   void setCallback(SubscribeCallbackUInt32Type callb);
   void setCallback(SubscribeCallbackDoubleType callb);
@@ -298,5 +316,4 @@ class Adafruit_MQTT_Subscribe {
   Adafruit_MQTT *mqtt;
 };
 
-
 #endif

Adafruit_MQTT_Client.cpp

@@ -9,8 +9,8 @@
 // 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
+// The above copyright notice and this permission notice shall be included in
-// copies or substantial portions of the Software.
+// 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,
@@ -21,15 +21,16 @@
 // SOFTWARE.
 #include "Adafruit_MQTT_Client.h"
 
-
 bool Adafruit_MQTT_Client::connectServer() {
   // Grab server name from flash and copy to buffer for name resolution.
   memset(buffer, 0, sizeof(buffer));
   strcpy((char *)buffer, servername);
-  DEBUG_PRINT(F("Connecting to: ")); DEBUG_PRINTLN((char *)buffer);
+  DEBUG_PRINT(F("Connecting to: "));
+  DEBUG_PRINTLN((char *)buffer);
   // Connect and check for success (0 result).
   int r = client->connect((char *)buffer, portnum);
-  DEBUG_PRINT(F("Connect result: ")); DEBUG_PRINTLN(r);
+  DEBUG_PRINT(F("Connect result: "));
+  DEBUG_PRINTLN(r);
   return r != 0;
 }
 
@@ -49,11 +50,11 @@ bool Adafruit_MQTT_Client::connected() {
 
 uint16_t Adafruit_MQTT_Client::readPacket(uint8_t *buffer, uint16_t maxlen,
                                           int16_t timeout) {
-  /* Read data until either the connection is closed, or the idle timeout is reached. */
+  /* Read data until either the connection is closed, or the idle timeout is
+   * reached. */
   uint16_t len = 0;
   int16_t t = timeout;
 
-
   while (client->connected() && (timeout >= 0)) {
     // DEBUG_PRINT('.');
     while (client->available()) {
@@ -90,7 +91,8 @@ bool Adafruit_MQTT_Client::sendPacket(uint8_t *buffer, uint16_t len) {
       uint16_t sendlen = len > 250 ? 250 : len;
       // Serial.print("Sending: "); Serial.println(sendlen);
       ret = client->write(buffer, sendlen);
-      DEBUG_PRINT(F("Client sendPacket returned: ")); DEBUG_PRINTLN(ret);
+      DEBUG_PRINT(F("Client sendPacket returned: "));
+      DEBUG_PRINTLN(ret);
       len -= ret;
 
       if (ret != sendlen) {

Adafruit_MQTT_Client.h

@@ -9,8 +9,8 @@
 // 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
+// The above copyright notice and this permission notice shall be included in
-// copies or substantial portions of the Software.
+// 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,
@@ -22,30 +22,24 @@
 #ifndef _ADAFRUIT_MQTT_CLIENT_H_
 #define _ADAFRUIT_MQTT_CLIENT_H_
 
-#include "Client.h"
 #include "Adafruit_MQTT.h"
-
+#include "Client.h"
 
 // How long to delay waiting for new data to be available in readPacket.
 #define MQTT_CLIENT_READINTERVAL_MS 10
 
-
 // MQTT client implementation for a generic Arduino Client interface.  Can work
 // with almost all Arduino network hardware like ethernet shield, wifi shield,
 // and even other platforms like ESP8266.
 class Adafruit_MQTT_Client : public Adafruit_MQTT {
 public:
   Adafruit_MQTT_Client(Client *client, const char *server, uint16_t port,
-                       const char *cid, const char *user, const char *pass):
+                       const char *cid, const char *user, const char *pass)
-    Adafruit_MQTT(server, port, cid, user, pass),
+      : Adafruit_MQTT(server, port, cid, user, pass), client(client) {}
-    client(client)
-  {}
 
   Adafruit_MQTT_Client(Client *client, const char *server, uint16_t port,
-                       const char *user="", const char *pass=""):
+                       const char *user = "", const char *pass = "")
-    Adafruit_MQTT(server, port, user, pass),
+      : Adafruit_MQTT(server, port, user, pass), client(client) {}
-    client(client)
-  {}
 
   bool connectServer();
   bool disconnectServer();
@@ -57,5 +51,4 @@ class Adafruit_MQTT_Client : public Adafruit_MQTT {
   Client *client;
 };
 
-
 #endif

Adafruit_MQTT_FONA.h

@@ -9,8 +9,8 @@
 // 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
+// The above copyright notice and this permission notice shall be included in
-// copies or substantial portions of the Software.
+// 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,
@@ -22,13 +22,12 @@
 #ifndef _ADAFRUIT_MQTT_FONA_H_
 #define _ADAFRUIT_MQTT_FONA_H_
 
-#include <Adafruit_FONA.h>
 #include "Adafruit_MQTT.h"
+#include <Adafruit_FONA.h>
 
 #define MQTT_FONA_INTERAVAILDELAY 100
 #define MQTT_FONA_QUERYDELAY 500
 
-
 // FONA-specific version of the Adafruit_MQTT class.
 // Note that this is defined as a header-only class to prevent issues with using
 // the library on non-FONA platforms (since Arduino will include all .cpp files
@@ -36,16 +35,12 @@
 class Adafruit_MQTT_FONA : public Adafruit_MQTT {
 public:
   Adafruit_MQTT_FONA(Adafruit_FONA *f, const char *server, uint16_t port,
-                       const char *cid, const char *user, const char *pass):
+                     const char *cid, const char *user, const char *pass)
-    Adafruit_MQTT(server, port, cid, user, pass),
+      : Adafruit_MQTT(server, port, cid, user, pass), fona(f) {}
-    fona(f)
-  {}
 
   Adafruit_MQTT_FONA(Adafruit_FONA *f, const char *server, uint16_t port,
-                     const char *user="", const char *pass=""):
+                     const char *user = "", const char *pass = "")
-    Adafruit_MQTT(server, port, user, pass),
+      : Adafruit_MQTT(server, port, user, pass), fona(f) {}
-    fona(f)
-  {}
 
   bool connectServer() {
     char server[40];
@@ -59,9 +54,7 @@ class Adafruit_MQTT_FONA : public Adafruit_MQTT {
     return fona->TCPconnect(server, portnum);
   }
 
-  bool disconnectServer() {
+  bool disconnectServer() { return fona->TCPclose(); }
-    return fona->TCPclose();
-  }
 
   bool connected() {
     // Return true if connected, false if not connected.
@@ -72,10 +65,11 @@ class Adafruit_MQTT_FONA : public Adafruit_MQTT {
     uint8_t *buffp = buffer;
     DEBUG_PRINTLN(F("Reading data.."));
 
-    if (!fona->TCPconnected()) return 0;
+    if (!fona->TCPconnected())
+      return 0;
 
-
+    /* Read data until either the connection is closed, or the idle timeout is
-    /* Read data until either the connection is closed, or the idle timeout is reached. */
+     * reached. */
     uint16_t len = 0;
     int16_t t = timeout;
     uint16_t avail;
@@ -87,11 +81,13 @@ class Adafruit_MQTT_FONA : public Adafruit_MQTT {
 
         if (len + avail > maxlen) {
           avail = maxlen - len;
-	  if (avail == 0) return len;
+          if (avail == 0)
+            return len;
         }
 
         // try to read the data into the end of the pointer
-        if (! fona->TCPread(buffp, avail)) return len;
+        if (!fona->TCPread(buffp, avail))
+          return len;
 
         // read it! advance pointer
         buffp += avail;
@@ -110,7 +106,8 @@ class Adafruit_MQTT_FONA : public Adafruit_MQTT {
       Watchdog.reset();
 #endif
       timeout -= MQTT_FONA_INTERAVAILDELAY;
-      timeout -= MQTT_FONA_QUERYDELAY; // this is how long it takes to query the FONA for avail()
+      timeout -= MQTT_FONA_QUERYDELAY; // this is how long it takes to query the
+                                       // FONA for avail()
       delay(MQTT_FONA_INTERAVAILDELAY);
     }
 
@@ -138,5 +135,4 @@ class Adafruit_MQTT_FONA : public Adafruit_MQTT {
   Adafruit_FONA *fona;
 };
 
-
 #endif

README.md

@@ -1,4 +1,4 @@
-# Adafruit MQTT Library [![Build Status](https://travis-ci.com/adafruit/Adafruit_MQTT_Library.svg?branch=master)](https://travis-ci.com/adafruit/Adafruit_MQTT_Library)
+# Adafruit MQTT Library [![Build Status](https://github.com/adafruit/Adafruit_MQTT_Library/workflows/Arduino%20Library%20CI/badge.svg)](https://github.com/adafruit/Adafruit_MQTT_Library/actions)
 
 Arduino library for MQTT support, including access to Adafruit IO.  Works with
 the Adafruit FONA, Arduino Yun, ESP8266 Arduino platforms, and anything that supports

examples/mqtt_fona/fonahelper.cpp

@@ -1,13 +1,20 @@
+#include "Adafruit_FONA.h"
 #include <Adafruit_SleepyDog.h>
 #include <SoftwareSerial.h>
-#include "Adafruit_FONA.h"
 
-#define halt(s) { Serial.println(F( s )); while(1);  }
+#define halt(s)                                                                \
+  {                                                                            \
+    Serial.println(F(s));                                                      \
+    while (1)                                                                  \
+      ;                                                                        \
+  }
 
 extern Adafruit_FONA fona;
 extern SoftwareSerial fonaSS;
 
-boolean FONAconnect(const __FlashStringHelper *apn, const __FlashStringHelper *username, const __FlashStringHelper *password) {
+boolean FONAconnect(const __FlashStringHelper *apn,
+                    const __FlashStringHelper *username,
+                    const __FlashStringHelper *password) {
   Watchdog.reset();
 
   Serial.println(F("Initializing FONA....(May take 3 seconds)"));

library.properties

@@ -1,5 +1,5 @@
 name=Adafruit MQTT Library
-version=1.0.3
+version=1.1.0
 author=Adafruit
 maintainer=Adafruit <info@adafruit.com>
 sentence=MQTT library that supports the FONA, ESP8266, Yun, and generic Arduino Client hardware.
@@ -7,3 +7,4 @@ paragraph=Simple MQTT library that supports the bare minimum to publish and subs
 category=Communication
 url=https://github.com/adafruit/Adafruit_MQTT_Library
 architectures=*
+depends=Adafruit SleepyDog Library, Adafruit FONA Library, WiFi101