mathieu/Adafruit_MQTT_Library
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Compare commits

base: mathieu:support_retain
Branches Tags
mathieu:master_upstream
mathieu:support_retain
mathieu:retain_rebase
mathieu:0.20.3
mathieu:0.20.2
mathieu:0.20.1
mathieu:0.20.0
mathieu:0.2.0
mathieu:0.17.0
mathieu:0.16.2
mathieu:0.16.1
mathieu:0.16.0
mathieu:0.15.0
mathieu:0.14.3
mathieu:0.14.2
mathieu:0.14.1
mathieu:0.14.0
mathieu:0.13.3
mathieu:0.13.2
mathieu:0.13.1
mathieu:0.13.0
mathieu:0.12.3
mathieu:0.12.2
mathieu:0.12.1
mathieu:0.12.0
mathieu:0.11.1
mathieu:0.11.0
mathieu:0.10.0
mathieu:0.9.2
mathieu:0.9.1
mathieu:0.9.0
..
compare: mathieu:master_upstream
Branches Tags
mathieu:support_retain
mathieu:retain_rebase
mathieu:master_upstream
mathieu:0.20.3
mathieu:0.20.2
mathieu:0.20.1
mathieu:0.20.0
mathieu:0.2.0
mathieu:0.17.0
mathieu:0.16.2
mathieu:0.16.1
mathieu:0.16.0
mathieu:0.15.0
mathieu:0.14.3
mathieu:0.14.2
mathieu:0.14.1
mathieu:0.14.0
mathieu:0.13.3
mathieu:0.13.2
mathieu:0.13.1
mathieu:0.13.0
mathieu:0.12.3
mathieu:0.12.2
mathieu:0.12.1
mathieu:0.12.0
mathieu:0.11.1
mathieu:0.11.0
mathieu:0.10.0
mathieu:0.9.2
mathieu:0.9.1
mathieu:0.9.0

No commits in common. "support_retain" and "master_upstream" have entirely different histories.
support_re ... master_ups

32 changed files with 435 additions and 968 deletions
Show Stats Expand all files Collapse all files

26
.github/workflows/githubci.yml vendored
View File

@ -1,26 +0,0 @@
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 .

12
.travis.yml Normal file
View File

@ -0,0 +1,12 @@
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,Adafruit CC3000 Library,Adafruit_WINC1500"
script:
- build_main_platforms
notifications:
email:
on_success: change
on_failure: change

378
Adafruit_MQTT.cpp
View File

@ -9,8 +9,8 @@
// copies of the Software, and to permit persons to whom the Software is // copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions: // furnished to do so, subject to the following conditions:
// //
// The above copyright notice and this permission notice shall be included in // The above copyright notice and this permission notice shall be included in all
// all copies or substantial portions of the Software. // copies or substantial portions of the Software.
// //
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@ -21,10 +21,8 @@
// SOFTWARE. // SOFTWARE.
#include "Adafruit_MQTT.h" #include "Adafruit_MQTT.h"
#if defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_SAMD_MKR1000) || \ #if defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_SAMD_MKR1000)
defined(ARDUINO_SAMD_MKR1010) || defined(ARDUINO_ARCH_SAMD) static char *dtostrf (double val, signed char width, unsigned char prec, char *sout) {
static char *dtostrf(double val, signed char width, unsigned char prec,
char *sout) {
char fmt[20]; char fmt[20];
sprintf(fmt, "%%%d.%df", width, prec); sprintf(fmt, "%%%d.%df", width, prec);
sprintf(sout, fmt, val); sprintf(sout, fmt, val);
@ -46,6 +44,7 @@ int strncasecmp(const char *str1, const char *str2, int len) {
} }
#endif #endif
void printBuffer(uint8_t *buffer, uint16_t len) { void printBuffer(uint8_t *buffer, uint16_t len) {
DEBUG_PRINTER.print('\t'); DEBUG_PRINTER.print('\t');
for (uint16_t i=0; i<len; i++) { for (uint16_t i=0; i<len; i++) {
@ -88,34 +87,20 @@ static uint8_t *stringprint(uint8_t *p, const char *s, uint16_t maxlen = 0) {
Serial.write(pgm_read_byte(s+i)); Serial.write(pgm_read_byte(s+i));
} }
*/ */
p[0] = len >> 8; p[0] = len >> 8; p++;
p++; p[0] = len & 0xFF; p++;
p[0] = len & 0xFF;
p++;
strncpy((char *)p, s, len); strncpy((char *)p, s, len);
return p+len; return p+len;
} }
// packetAdditionalLen is a helper function used to figure out
// how bigger the payload needs to be in order to account for
// its variable length field. As per
// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Table_2.4_Size
// See also readFullPacket
static uint16_t packetAdditionalLen(uint32_t currLen) {
/* Increase length field based on current length */
if (currLen < 128) // 7-bits
return 0;
if (currLen < 16384) // 14-bits
return 1;
if (currLen < 2097152) // 21-bits
return 2;
return 3;
}
// Adafruit_MQTT Definition //////////////////////////////////////////////////// // Adafruit_MQTT Definition ////////////////////////////////////////////////////
Adafruit_MQTT::Adafruit_MQTT(const char *server, uint16_t port, const char *cid, Adafruit_MQTT::Adafruit_MQTT(const char *server,
const char *user, const char *pass) { uint16_t port,
const char *cid,
const char *user,
const char *pass) {
servername = server; servername = server;
portnum = port; portnum = port;
clientid = cid; clientid = cid;
@ -132,13 +117,15 @@ Adafruit_MQTT::Adafruit_MQTT(const char *server, uint16_t port, const char *cid,
will_qos = 0; will_qos = 0;
will_retain = 0; will_retain = 0;
keepAliveInterval = MQTT_CONN_KEEPALIVE;
packet_id_counter = 0; packet_id_counter = 0;
} }
Adafruit_MQTT::Adafruit_MQTT(const char *server, uint16_t port,
const char *user, const char *pass) { Adafruit_MQTT::Adafruit_MQTT(const char *server,
uint16_t port,
const char *user,
const char *pass) {
servername = server; servername = server;
portnum = port; portnum = port;
clientid = ""; clientid = "";
@ -155,9 +142,8 @@ Adafruit_MQTT::Adafruit_MQTT(const char *server, uint16_t port,
will_qos = 0; will_qos = 0;
will_retain = 0; will_retain = 0;
keepAliveInterval = MQTT_CONN_KEEPALIVE;
packet_id_counter = 0; packet_id_counter = 0;
} }
int8_t Adafruit_MQTT::connect() { int8_t Adafruit_MQTT::connect() {
@ -172,27 +158,22 @@ int8_t Adafruit_MQTT::connect() {
// Read connect response packet and verify it // Read connect response packet and verify it
len = readFullPacket(buffer, MAXBUFFERSIZE, CONNECT_TIMEOUT_MS); len = readFullPacket(buffer, MAXBUFFERSIZE, CONNECT_TIMEOUT_MS);
if (len != 4) { if (len != 4)
return -1; return -1;
} if ((buffer[0] != (MQTT_CTRL_CONNECTACK << 4)) || (buffer[1] != 2))
if ((buffer[0] != (MQTT_CTRL_CONNECTACK << 4)) || (buffer[1] != 2)) {
return -1; return -1;
}
if (buffer[3] != 0) if (buffer[3] != 0)
return buffer[3]; return buffer[3];
// Setup subscriptions once connected. // Setup subscriptions once connected.
for (uint8_t i=0; i<MAXSUBSCRIPTIONS; i++) { for (uint8_t i=0; i<MAXSUBSCRIPTIONS; i++) {
// Ignore subscriptions that aren't defined. // Ignore subscriptions that aren't defined.
if (subscriptions[i] == 0) if (subscriptions[i] == 0) continue;
continue;
boolean success = false; boolean success = false;
for (uint8_t retry = 0; (retry < 3) && !success; for (uint8_t retry=0; (retry<3) && !success; retry++) { // retry until we get a suback
retry++) { // retry until we get a suback
// Construct and send subscription packet. // Construct and send subscription packet.
uint8_t len = subscribePacket(buffer, subscriptions[i]->topic, uint8_t len = subscribePacket(buffer, subscriptions[i]->topic, subscriptions[i]->qos);
subscriptions[i]->qos);
if (!sendPacket(buffer, len)) if (!sendPacket(buffer, len))
return -1; return -1;
@ -200,68 +181,57 @@ int8_t Adafruit_MQTT::connect() {
break; break;
// Check for SUBACK if using MQTT 3.1.1 or higher // Check for SUBACK if using MQTT 3.1.1 or higher
// TODO: The Server is permitted to start sending PUBLISH packets matching // TODO: The Server is permitted to start sending PUBLISH packets matching the
// the Subscription before the Server sends the SUBACK Packet. (will // Subscription before the Server sends the SUBACK Packet. (will really need to use callbacks - ada)
// really need to use callbacks - ada)
//Serial.println("\t**looking for suback");
if (processPacketsUntil(buffer, MQTT_CTRL_SUBACK, SUBACK_TIMEOUT_MS)) { if (processPacketsUntil(buffer, MQTT_CTRL_SUBACK, SUBACK_TIMEOUT_MS)) {
success = true; success = true;
break; break;
} }
//Serial.println("\t**failed, retrying!");
} }
if (!success) if (! success) return -2; // failed to sub for some reason
return -2; // failed to sub for some reason
} }
return 0; 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; username = user;
password = pass; password = pass;
return connect(); return connect();
} }
uint16_t Adafruit_MQTT::processPacketsUntil(uint8_t *buffer, uint16_t Adafruit_MQTT::processPacketsUntil(uint8_t *buffer, uint8_t waitforpackettype, uint16_t timeout) {
uint8_t waitforpackettype,
uint16_t timeout) {
uint16_t len; uint16_t len;
while (len = readFullPacket(buffer, MAXBUFFERSIZE, timeout)) {
while (true) { //DEBUG_PRINT("Packet read size: "); DEBUG_PRINTLN(len);
len = readFullPacket(buffer, MAXBUFFERSIZE, timeout); // TODO: add subscription reading & call back processing here
if (len == 0) { if ((buffer[0] >> 4) == waitforpackettype) {
break; //DEBUG_PRINTLN(F("Found right packet"));
}
uint8_t packetType = (buffer[0] >> 4);
if (packetType == waitforpackettype) {
return len; return len;
} else {
if (packetType == MQTT_CTRL_PUBLISH) {
handleSubscriptionPacket(len);
} else { } else {
ERROR_PRINTLN(F("Dropped a packet")); ERROR_PRINTLN(F("Dropped a packet"));
} }
} }
}
return 0; return 0;
} }
uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16_t timeout) {
uint16_t timeout) {
// will read a packet and Do The Right Thing with length // will read a packet and Do The Right Thing with length
uint8_t *pbuff = buffer; uint8_t *pbuff = buffer;
uint16_t rlen; uint8_t rlen;
// read the packet type: // read the packet type:
rlen = readPacket(pbuff, 1, timeout); rlen = readPacket(pbuff, 1, timeout);
if (rlen != 1) if (rlen != 1) return 0;
return 0;
DEBUG_PRINT(F("Packet Type:\t")); DEBUG_PRINT(F("Packet Type:\t")); DEBUG_PRINTBUFFER(pbuff, rlen);
DEBUG_PRINTBUFFER(pbuff, rlen);
pbuff++; pbuff++;
uint32_t value = 0; uint32_t value = 0;
@ -270,8 +240,7 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize,
do { do {
rlen = readPacket(pbuff, 1, timeout); rlen = readPacket(pbuff, 1, timeout);
if (rlen != 1) if (rlen != 1) return 0;
return 0;
encodedByte = pbuff[0]; // save the last read val encodedByte = pbuff[0]; // save the last read val
pbuff++; // get ready for reading the next byte pbuff++; // get ready for reading the next byte
uint32_t intermediate = encodedByte & 0x7F; uint32_t intermediate = encodedByte & 0x7F;
@ -284,11 +253,9 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize,
} }
} while (encodedByte & 0x80); } while (encodedByte & 0x80);
DEBUG_PRINT(F("Packet Length:\t")); DEBUG_PRINT(F("Packet Length:\t")); DEBUG_PRINTLN(value);
DEBUG_PRINTLN(value);
// maxsize is limited to 65536 by 16-bit unsigned if (value > (maxsize - (pbuff-buffer) - 1)) {
if (value > uint32_t(maxsize - (pbuff - buffer) - 1)) {
DEBUG_PRINTLN(F("Packet too big for buffer")); DEBUG_PRINTLN(F("Packet too big for buffer"));
rlen = readPacket(pbuff, (maxsize - (pbuff-buffer) - 1), timeout); rlen = readPacket(pbuff, (maxsize - (pbuff-buffer) - 1), timeout);
} else { } else {
@ -301,29 +268,16 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize,
const __FlashStringHelper* Adafruit_MQTT::connectErrorString(int8_t code) { const __FlashStringHelper* Adafruit_MQTT::connectErrorString(int8_t code) {
switch (code) { switch (code) {
case 1: case 1: return F("The Server does not support the level of the MQTT protocol requested");
return F( case 2: return F("The Client identifier is correct UTF-8 but not allowed by the Server");
"The Server does not support the level of the MQTT protocol requested"); case 3: return F("The MQTT service is unavailable");
case 2: case 4: return F("The data in the user name or password is malformed");
return F( case 5: return F("Not authorized to connect");
"The Client identifier is correct UTF-8 but not allowed by the Server"); case 6: return F("Exceeded reconnect rate limit. Please try again later.");
case 3: case 7: return F("You have been banned from connecting. Please contact the MQTT server administrator for more details.");
return F("The MQTT service is unavailable"); case -1: return F("Connection failed");
case 4: case -2: return F("Failed to subscribe");
return F("The data in the user name or password is malformed"); default: return F("Unknown error");
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");
} }
} }
@ -335,35 +289,34 @@ bool Adafruit_MQTT::disconnect() {
DEBUG_PRINTLN(F("Unable to send disconnect packet")); DEBUG_PRINTLN(F("Unable to send disconnect packet"));
return disconnectServer(); return disconnectServer();
} }
bool Adafruit_MQTT::publish(const char *topic, const char *data, uint8_t qos, uint8_t retain) {
return publish(topic, (uint8_t *)(data), strlen(data), qos, retain); 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, bool Adafruit_MQTT::publish(const char *topic, uint8_t *data, uint16_t bLen, uint8_t qos) {
uint8_t qos, uint8_t retain) {
// Construct and send publish packet. // Construct and send publish packet.
uint16_t len = uint16_t len = publishPacket(buffer, topic, data, bLen, qos);
publishPacket(buffer, topic, data, bLen, qos, (uint16_t)sizeof(buffer), retain);
if (!sendPacket(buffer, len)) if (!sendPacket(buffer, len))
return false; return false;
// If QOS level is high enough verify the response packet. // If QOS level is high enough verify the response packet.
if (qos > 0) { if (qos > 0) {
len = processPacketsUntil(buffer, MQTT_CTRL_PUBACK, PUBLISH_TIMEOUT_MS); len = readFullPacket(buffer, MAXBUFFERSIZE, PUBLISH_TIMEOUT_MS);
DEBUG_PRINT(F("Publish QOS1+ reply:\t")); DEBUG_PRINT(F("Publish QOS1+ reply:\t"));
DEBUG_PRINTBUFFER(buffer, len); DEBUG_PRINTBUFFER(buffer, len);
if (len != 4) if (len != 4)
return false; return false;
if ((buffer[0] >> 4) != MQTT_CTRL_PUBACK)
return false;
uint16_t packnum = buffer[2]; uint16_t packnum = buffer[2];
packnum <<= 8; packnum <<= 8;
packnum |= buffer[3]; packnum |= buffer[3];
// we increment the packet_id_counter right after publishing so inc here too // we increment the packet_id_counter right after publishing so inc here too to match
// to match
packnum++; packnum++;
if (packnum != packet_id_counter) if (packnum != packet_id_counter)
return false; return false;
@ -372,8 +325,7 @@ bool Adafruit_MQTT::publish(const char *topic, uint8_t *data, uint16_t bLen,
return true; return true;
} }
bool Adafruit_MQTT::will(const char *topic, const char *payload, uint8_t qos, bool Adafruit_MQTT::will(const char *topic, const char *payload, uint8_t qos, uint8_t retain) {
uint8_t retain) {
if (connected()) { if (connected()) {
DEBUG_PRINT(F("Will defined after connect")); DEBUG_PRINT(F("Will defined after connect"));
@ -386,25 +338,7 @@ bool Adafruit_MQTT::will(const char *topic, const char *payload, uint8_t qos,
will_retain = retain; will_retain = retain;
return true; return true;
}
/***************************************************************************/
/*!
@brief Sets the connect packet's KeepAlive Interval, in seconds. This
function MUST be called prior to connect().
@param keepAlive
Maximum amount of time without communication between the
client and the MQTT broker, in seconds.
@returns True if called prior to connect(), False otherwise.
*/
/***************************************************************************/
bool Adafruit_MQTT::setKeepAliveInterval(uint16_t keepAlive) {
if (connected()) {
DEBUG_PRINT(F("keepAlive defined after connection established."));
return false;
}
keepAliveInterval = keepAlive;
return true;
} }
bool Adafruit_MQTT::subscribe(Adafruit_MQTT_Subscribe *sub) { bool Adafruit_MQTT::subscribe(Adafruit_MQTT_Subscribe *sub) {
@ -419,8 +353,7 @@ bool Adafruit_MQTT::subscribe(Adafruit_MQTT_Subscribe *sub) {
if (i==MAXSUBSCRIPTIONS) { // add to subscriptionlist if (i==MAXSUBSCRIPTIONS) { // add to subscriptionlist
for (i=0; i<MAXSUBSCRIPTIONS; i++) { for (i=0; i<MAXSUBSCRIPTIONS; i++) {
if (subscriptions[i] == 0) { if (subscriptions[i] == 0) {
DEBUG_PRINT(F("Added sub ")); DEBUG_PRINT(F("Added sub ")); DEBUG_PRINTLN(i);
DEBUG_PRINTLN(i);
subscriptions[i] = sub; subscriptions[i] = sub;
return true; return true;
} }
@ -439,8 +372,7 @@ bool Adafruit_MQTT::unsubscribe(Adafruit_MQTT_Subscribe *sub) {
if (subscriptions[i] == sub) { if (subscriptions[i] == sub) {
DEBUG_PRINTLN( DEBUG_PRINTLN(F("Found matching subscription and attempting to unsubscribe."));
F("Found matching subscription and attempting to unsubscribe."));
// Construct and send unsubscribe packet. // Construct and send unsubscribe packet.
uint8_t len = unsubscribePacket(buffer, subscriptions[i]->topic); uint8_t len = unsubscribePacket(buffer, subscriptions[i]->topic);
@ -466,36 +398,46 @@ bool Adafruit_MQTT::unsubscribe(Adafruit_MQTT_Subscribe *sub) {
subscriptions[i] = 0; subscriptions[i] = 0;
return true; return true;
} }
} }
// subscription not found, so we are unsubscribed // subscription not found, so we are unsubscribed
return true; return true;
} }
void Adafruit_MQTT::processPackets(int16_t timeout) { void Adafruit_MQTT::processPackets(int16_t timeout) {
uint16_t len;
uint32_t elapsed = 0, endtime, starttime = millis(); uint32_t elapsed = 0, endtime, starttime = millis();
while (elapsed < (uint32_t)timeout) { while (elapsed < (uint32_t)timeout) {
Adafruit_MQTT_Subscribe *sub = readSubscription(timeout - elapsed); Adafruit_MQTT_Subscribe *sub = readSubscription(timeout - elapsed);
if (sub) { if (sub) {
//Serial.println("**** sub packet received");
if (sub->callback_uint32t != NULL) { if (sub->callback_uint32t != NULL) {
// huh lets do the callback in integer mode // huh lets do the callback in integer mode
uint32_t data = 0; uint32_t data = 0;
data = atoi((char *)sub->lastread); data = atoi((char *)sub->lastread);
//Serial.print("*** calling int callback with : "); Serial.println(data);
sub->callback_uint32t(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 // huh lets do the callback in doublefloat mode
double data = 0; double data = 0;
data = atof((char *)sub->lastread); data = atof((char *)sub->lastread);
//Serial.print("*** calling double callback with : "); Serial.println(data);
sub->callback_double(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 // huh lets do the callback in buffer mode
//Serial.print("*** calling buffer callback with : "); Serial.println((char *)sub->lastread);
sub->callback_buffer((char *)sub->lastread, sub->datalen); 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 // huh lets do the callback in io mode
((sub->io_mqtt)->*(sub->callback_io))((char *)sub->lastread, //Serial.print("*** calling io instance callback with : "); Serial.println((char *)sub->lastread);
sub->datalen); ((sub->io_mqtt)->*(sub->callback_io))((char *)sub->lastread, sub->datalen);
} }
} }
@ -507,58 +449,20 @@ void Adafruit_MQTT::processPackets(int16_t timeout) {
elapsed += (endtime - starttime); elapsed += (endtime - starttime);
} }
} }
Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) { Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
// Sync or Async subscriber with message
Adafruit_MQTT_Subscribe *s = 0;
// Check if are unread messages
for (uint8_t i = 0; i < MAXSUBSCRIPTIONS; i++) {
if (subscriptions[i] && subscriptions[i]->new_message) {
s = subscriptions[i];
break;
}
}
// not unread message
if (!s) {
// Check if data is available to read.
uint16_t len = readFullPacket(buffer, MAXBUFFERSIZE,
timeout); // return one full packet
s = handleSubscriptionPacket(len);
}
// it there is a message, mark it as not pending
if (s) {
s->new_message = false;
}
return s;
}
Adafruit_MQTT_Subscribe *Adafruit_MQTT::handleSubscriptionPacket(uint16_t len) {
uint16_t i, topiclen, datalen; uint16_t i, topiclen, datalen;
if (!len) { // Check if data is available to read.
uint16_t len = readFullPacket(buffer, MAXBUFFERSIZE, timeout); // return one full packet
if (!len)
return NULL; // No data available, just quit. 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); DEBUG_PRINTBUFFER(buffer, len);
if (len < 3) {
return NULL;
}
if ((buffer[0] & 0xF0) != (MQTT_CTRL_PUBLISH) << 4) {
return NULL;
}
// Parse out length of packet. // Parse out length of packet.
uint16_t const topicoffset = packetAdditionalLen(len); topiclen = buffer[3];
uint16_t const topicstart = topicoffset + 4; DEBUG_PRINT(F("Looking for subscription len ")); DEBUG_PRINTLN(topiclen);
topiclen = buffer[3 + topicoffset];
DEBUG_PRINT(F("Looking for subscription len "));
DEBUG_PRINTLN(topiclen);
// Find subscription associated with this packet. // Find subscription associated with this packet.
for (i=0; i<MAXSUBSCRIPTIONS; i++) { for (i=0; i<MAXSUBSCRIPTIONS; i++) {
@ -569,48 +473,36 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::handleSubscriptionPacket(uint16_t len) {
continue; continue;
// Stop if the subscription topic matches the received topic. Be careful // Stop if the subscription topic matches the received topic. Be careful
// to make comparison case insensitive. // to make comparison case insensitive.
if (strncasecmp((char *)buffer + topicstart, subscriptions[i]->topic, if (strncasecmp((char*)buffer+4, subscriptions[i]->topic, topiclen) == 0) {
topiclen) == 0) { DEBUG_PRINT(F("Found sub #")); DEBUG_PRINTLN(i);
DEBUG_PRINT(F("Found sub #"));
DEBUG_PRINTLN(i);
if (subscriptions[i]->new_message) {
DEBUG_PRINTLN(F("Lost previous message"));
} else {
subscriptions[i]->new_message = true;
}
break; break;
} }
} }
} }
if (i == MAXSUBSCRIPTIONS) if (i==MAXSUBSCRIPTIONS) return NULL; // matching sub not found ???
return NULL; // matching sub not found ???
uint8_t packet_id_len = 0; uint8_t packet_id_len = 0;
uint16_t packetid = 0; uint16_t packetid;
// Check if it is QoS 1, TODO: we dont support QoS 2 // Check if it is QoS 1, TODO: we dont support QoS 2
if ((buffer[0] & 0x6) == 0x2) { if ((buffer[0] & 0x6) == 0x2) {
packet_id_len = 2; packet_id_len = 2;
packetid = buffer[topiclen + topicstart]; packetid = buffer[topiclen+4];
packetid <<= 8; packetid <<= 8;
packetid |= buffer[topiclen + topicstart + 1]; packetid |= buffer[topiclen+5];
} }
// zero out the old data // zero out the old data
memset(subscriptions[i]->lastread, 0, SUBSCRIPTIONDATALEN); memset(subscriptions[i]->lastread, 0, SUBSCRIPTIONDATALEN);
datalen = len - topiclen - packet_id_len - topicstart; datalen = len - topiclen - packet_id_len - 4;
if (datalen > SUBSCRIPTIONDATALEN) { if (datalen > SUBSCRIPTIONDATALEN) {
datalen = SUBSCRIPTIONDATALEN-1; // cut it off datalen = SUBSCRIPTIONDATALEN-1; // cut it off
} }
// extract out just the data, into the subscription object itself // extract out just the data, into the subscription object itself
memmove(subscriptions[i]->lastread, memmove(subscriptions[i]->lastread, buffer+4+topiclen+packet_id_len, datalen);
buffer + topicstart + topiclen + packet_id_len, datalen);
subscriptions[i]->datalen = datalen; subscriptions[i]->datalen = datalen;
DEBUG_PRINT(F("Data len: ")); DEBUG_PRINT(F("Data len: ")); DEBUG_PRINTLN(datalen);
DEBUG_PRINTLN(datalen); DEBUG_PRINT(F("Data: ")); DEBUG_PRINTLN((char *)subscriptions[i]->lastread);
DEBUG_PRINT(F("Data: "));
DEBUG_PRINTLN((char *)subscriptions[i]->lastread);
if ((MQTT_PROTOCOL_LEVEL > 3) &&(buffer[0] & 0x6) == 0x2) { if ((MQTT_PROTOCOL_LEVEL > 3) &&(buffer[0] & 0x6) == 0x2) {
uint8_t ackpacket[4]; uint8_t ackpacket[4];
@ -628,8 +520,7 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::handleSubscriptionPacket(uint16_t len) {
void Adafruit_MQTT::flushIncoming(uint16_t timeout) { void Adafruit_MQTT::flushIncoming(uint16_t timeout) {
// flush input! // flush input!
DEBUG_PRINTLN(F("Flushing input buffer")); DEBUG_PRINTLN(F("Flushing input buffer"));
while (readPacket(buffer, MAXBUFFERSIZE, timeout)) while (readPacket(buffer, MAXBUFFERSIZE, timeout));
;
} }
bool Adafruit_MQTT::ping(uint8_t num) { bool Adafruit_MQTT::ping(uint8_t num) {
@ -692,6 +583,7 @@ uint8_t Adafruit_MQTT::connectPacket(uint8_t *packet) {
if(will_retain == 1) if(will_retain == 1)
p[0] |= MQTT_CONN_WILLRETAIN; p[0] |= MQTT_CONN_WILLRETAIN;
} }
if (pgm_read_byte(username) != 0) if (pgm_read_byte(username) != 0)
@ -700,9 +592,9 @@ uint8_t Adafruit_MQTT::connectPacket(uint8_t *packet) {
p[0] |= MQTT_CONN_PASSWORDFLAG; p[0] |= MQTT_CONN_PASSWORDFLAG;
p++; p++;
p[0] = keepAliveInterval >> 8; p[0] = MQTT_CONN_KEEPALIVE >> 8;
p++; p++;
p[0] = keepAliveInterval & 0xFF; p[0] = MQTT_CONN_KEEPALIVE & 0xFF;
p++; p++;
if(MQTT_PROTOCOL_LEVEL == 3) { if(MQTT_PROTOCOL_LEVEL == 3) {
@ -739,11 +631,10 @@ uint8_t Adafruit_MQTT::connectPacket(uint8_t *packet) {
return len; return len;
} }
// as per
// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718040 // as per 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, 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) {
uint16_t maxPacketLen, uint8_t retain) {
uint8_t *p = packet; uint8_t *p = packet;
uint16_t len=0; uint16_t len=0;
@ -753,27 +644,10 @@ uint16_t Adafruit_MQTT::publishPacket(uint8_t *packet, const char *topic,
if(qos > 0) { if(qos > 0) {
len += 2; // qos packet id len += 2; // qos packet id
} }
// Calculate additional bytes for length field (if any) len += bLen; // payload length
uint16_t additionalLen = packetAdditionalLen(len + bLen);
// Payload remaining length. When maxPacketLen provided is 0, let's
// assume buffer is big enough. Fingers crossed.
// 2 + additionalLen: header byte + remaining length field (from 1 to 4 bytes)
// len = topic size field + value (string)
// bLen = buffer size
if (!(maxPacketLen == 0 ||
(len + bLen + 2 + additionalLen <= maxPacketLen))) {
// If we make it here, we got a pickle: the payload is not going
// to fit in the packet buffer. Instead of corrupting memory, let's
// do something less damaging by reducing the bLen to what we are
// able to accomodate. Alternatively, consider using a bigger
// maxPacketLen.
bLen = maxPacketLen - (len + 2 + packetAdditionalLen(maxPacketLen));
}
len += bLen; // remaining len excludes header byte & length field
// Now you can start generating the packet! // Now you can start generating the packet!
p[0] = MQTT_CTRL_PUBLISH << 4 | qos << 1 | (retain ? 1 : 0); p[0] = MQTT_CTRL_PUBLISH << 4 | qos << 1;
p++; p++;
// fill in packet[1] last // fill in packet[1] last
@ -838,6 +712,8 @@ uint8_t Adafruit_MQTT::subscribePacket(uint8_t *packet, const char *topic,
return len; return len;
} }
uint8_t Adafruit_MQTT::unsubscribePacket(uint8_t *packet, const char *topic) { uint8_t Adafruit_MQTT::unsubscribePacket(uint8_t *packet, const char *topic) {
uint8_t *p = packet; uint8_t *p = packet;
@ -862,6 +738,7 @@ uint8_t Adafruit_MQTT::unsubscribePacket(uint8_t *packet, const char *topic) {
DEBUG_PRINTLN(F("MQTT unsubscription packet:")); DEBUG_PRINTLN(F("MQTT unsubscription packet:"));
DEBUG_PRINTBUFFER(buffer, len); DEBUG_PRINTBUFFER(buffer, len);
return len; return len;
} }
uint8_t Adafruit_MQTT::pingPacket(uint8_t *packet) { uint8_t Adafruit_MQTT::pingPacket(uint8_t *packet) {
@ -890,56 +767,43 @@ uint8_t Adafruit_MQTT::disconnectPacket(uint8_t *packet) {
return 2; return 2;
} }
uint Adafruit_MQTT::getSubscriptionCount()
{
uint count = 0;
for (int i = 0; i < MAXSUBSCRIPTIONS; i++) {
if (subscriptions[i])
count++;
}
return count;
}
// Adafruit_MQTT_Publish Definition //////////////////////////////////////////// // Adafruit_MQTT_Publish Definition ////////////////////////////////////////////
Adafruit_MQTT_Publish::Adafruit_MQTT_Publish(Adafruit_MQTT *mqttserver, Adafruit_MQTT_Publish::Adafruit_MQTT_Publish(Adafruit_MQTT *mqttserver,
const char *feed, uint8_t q, uint8_t r) { const char *feed, uint8_t q) {
mqtt = mqttserver; mqtt = mqttserver;
topic = feed; topic = feed;
qos = q; qos = q;
retain = r;
} }
bool Adafruit_MQTT_Publish::publish(int32_t i) { bool Adafruit_MQTT_Publish::publish(int32_t i) {
char payload[12]; char payload[12];
ltoa(i, payload, 10); ltoa(i, payload, 10);
return mqtt->publish(topic, payload, qos, retain); return mqtt->publish(topic, payload, qos);
} }
bool Adafruit_MQTT_Publish::publish(uint32_t i) { bool Adafruit_MQTT_Publish::publish(uint32_t i) {
char payload[11]; char payload[11];
ultoa(i, payload, 10); ultoa(i, payload, 10);
return mqtt->publish(topic, payload, qos, retain); return mqtt->publish(topic, payload, qos);
} }
bool Adafruit_MQTT_Publish::publish(double f, uint8_t precision) { bool Adafruit_MQTT_Publish::publish(double f, uint8_t precision) {
char payload[41]; // Need to technically hold float max, 39 digits and minus char payload[41]; // Need to technically hold float max, 39 digits and minus sign.
// sign.
dtostrf(f, 0, precision, payload); dtostrf(f, 0, precision, payload);
return mqtt->publish(topic, payload, qos, retain); return mqtt->publish(topic, payload, qos);
} }
bool Adafruit_MQTT_Publish::publish(const char *payload) { bool Adafruit_MQTT_Publish::publish(const char *payload) {
return mqtt->publish(topic, payload, qos, retain); return mqtt->publish(topic, payload, qos);
} }
//publish buffer of arbitrary length //publish buffer of arbitrary length
bool Adafruit_MQTT_Publish::publish(uint8_t *payload, uint16_t bLen) { bool Adafruit_MQTT_Publish::publish(uint8_t *payload, uint16_t bLen) {
return mqtt->publish(topic, payload, bLen, qos, retain); return mqtt->publish(topic, payload, bLen, qos);
} }
// Adafruit_MQTT_Subscribe Definition ////////////////////////////////////////// // Adafruit_MQTT_Subscribe Definition //////////////////////////////////////////
Adafruit_MQTT_Subscribe::Adafruit_MQTT_Subscribe(Adafruit_MQTT *mqttserver, Adafruit_MQTT_Subscribe::Adafruit_MQTT_Subscribe(Adafruit_MQTT *mqttserver,
@ -953,7 +817,6 @@ Adafruit_MQTT_Subscribe::Adafruit_MQTT_Subscribe(Adafruit_MQTT *mqttserver,
callback_double = 0; callback_double = 0;
callback_io = 0; callback_io = 0;
io_mqtt = 0; io_mqtt = 0;
new_message = false;
} }
void Adafruit_MQTT_Subscribe::setCallback(SubscribeCallbackUInt32Type cb) { void Adafruit_MQTT_Subscribe::setCallback(SubscribeCallbackUInt32Type cb) {
@ -968,8 +831,7 @@ void Adafruit_MQTT_Subscribe::setCallback(SubscribeCallbackBufferType cb) {
callback_buffer = cb; callback_buffer = cb;
} }
void Adafruit_MQTT_Subscribe::setCallback(AdafruitIO_MQTT *io, void Adafruit_MQTT_Subscribe::setCallback(AdafruitIO_MQTT *io, SubscribeCallbackIOType cb) {
SubscribeCallbackIOType cb) {
callback_io = cb; callback_io = cb;
io_mqtt= io; io_mqtt= io;
} }

118
Adafruit_MQTT.h
View File

@ -9,8 +9,8 @@
// copies of the Software, and to permit persons to whom the Software is // copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions: // furnished to do so, subject to the following conditions:
// //
// The above copyright notice and this permission notice shall be included in // The above copyright notice and this permission notice shall be included in all
// all copies or substantial portions of the Software. // copies or substantial portions of the Software.
// //
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@ -44,35 +44,23 @@
// Define actual debug output functions when necessary. // Define actual debug output functions when necessary.
#ifdef MQTT_DEBUG #ifdef MQTT_DEBUG
#define DEBUG_PRINT(...) \ #define DEBUG_PRINT(...) { DEBUG_PRINTER.print(__VA_ARGS__); }
{ DEBUG_PRINTER.print(__VA_ARGS__); } #define DEBUG_PRINTLN(...) { DEBUG_PRINTER.println(__VA_ARGS__); }
#define DEBUG_PRINTLN(...) \ #define DEBUG_PRINTBUFFER(buffer, len) { printBuffer(buffer, len); }
{ DEBUG_PRINTER.println(__VA_ARGS__); }
#define DEBUG_PRINTBUFFER(buffer, len) \
{ printBuffer(buffer, len); }
#else #else
#define DEBUG_PRINT(...) \ #define DEBUG_PRINT(...) {}
{} #define DEBUG_PRINTLN(...) {}
#define DEBUG_PRINTLN(...) \ #define DEBUG_PRINTBUFFER(buffer, len) {}
{}
#define DEBUG_PRINTBUFFER(buffer, len) \
{}
#endif #endif
#ifdef MQTT_ERROR #ifdef MQTT_ERROR
#define ERROR_PRINT(...) \ #define ERROR_PRINT(...) { DEBUG_PRINTER.print(__VA_ARGS__); }
{ DEBUG_PRINTER.print(__VA_ARGS__); } #define ERROR_PRINTLN(...) { DEBUG_PRINTER.println(__VA_ARGS__); }
#define ERROR_PRINTLN(...) \ #define ERROR_PRINTBUFFER(buffer, len) { printBuffer(buffer, len); }
{ DEBUG_PRINTER.println(__VA_ARGS__); }
#define ERROR_PRINTBUFFER(buffer, len) \
{ printBuffer(buffer, len); }
#else #else
#define ERROR_PRINT(...) \ #define ERROR_PRINT(...) {}
{} #define ERROR_PRINTLN(...) {}
#define ERROR_PRINTLN(...) \ #define ERROR_PRINTBUFFER(buffer, len) {}
{}
#define ERROR_PRINTBUFFER(buffer, len) \
{}
#endif #endif
// Use 3 (MQTT 3.0) or 4 (MQTT 3.1.1) // Use 3 (MQTT 3.0) or 4 (MQTT 3.1.1)
@ -117,13 +105,14 @@
#define MQTT_CONN_WILLFLAG 0x04 #define MQTT_CONN_WILLFLAG 0x04
#define MQTT_CONN_CLEANSESSION 0x02 #define MQTT_CONN_CLEANSESSION 0x02
// how much data we save in a subscription object // how many subscriptions we want to be able to track
// and how many subscriptions we want to be able to track.
#if defined(__AVR_ATmega32U4__) || defined(__AVR_ATmega328P__)
#define MAXSUBSCRIPTIONS 5 #define MAXSUBSCRIPTIONS 5
// how much data we save in a subscription object
// eg max-subscription-payload-size
#if defined (__AVR_ATmega32U4__) || defined(__AVR_ATmega328P__)
#define SUBSCRIPTIONDATALEN 20 #define SUBSCRIPTIONDATALEN 20
#else #else
#define MAXSUBSCRIPTIONS 15
#define SUBSCRIPTIONDATALEN 100 #define SUBSCRIPTIONDATALEN 100
#endif #endif
@ -136,8 +125,7 @@ typedef void (*SubscribeCallbackDoubleType)(double);
// returns a chunk of raw data // returns a chunk of raw data
typedef void (*SubscribeCallbackBufferType)(char *str, uint16_t len); typedef void (*SubscribeCallbackBufferType)(char *str, uint16_t len);
// returns an io data wrapper instance // returns an io data wrapper instance
typedef void (AdafruitIO_MQTT::*SubscribeCallbackIOType)(char *str, typedef void (AdafruitIO_MQTT::*SubscribeCallbackIOType)(char *str, uint16_t len);
uint16_t len);
extern void printBuffer(uint8_t *buffer, uint16_t len); extern void printBuffer(uint8_t *buffer, uint16_t len);
@ -145,10 +133,15 @@ class Adafruit_MQTT_Subscribe; // forward decl
class Adafruit_MQTT { class Adafruit_MQTT {
public: public:
Adafruit_MQTT(const char *server, uint16_t port, const char *cid, Adafruit_MQTT(const char *server,
const char *user, const char *pass); uint16_t port,
const char *cid,
const char *user,
const char *pass);
Adafruit_MQTT(const char *server, uint16_t port, const char *user = "", Adafruit_MQTT(const char *server,
uint16_t port,
const char *user = "",
const char *pass = ""); const char *pass = "");
virtual ~Adafruit_MQTT() {} virtual ~Adafruit_MQTT() {}
@ -181,17 +174,12 @@ public:
// Set MQTT last will topic, payload, QOS, and retain. This needs // Set MQTT last will topic, payload, QOS, and retain. This needs
// to be called before connect() because it is sent as part of the // to be called before connect() because it is sent as part of the
// connect control packet. // connect control packet.
bool will(const char *topic, const char *payload, uint8_t qos = 0, bool will(const char *topic, const char *payload, uint8_t qos = 0, uint8_t retain = 0);
uint8_t retain = 0);
// Sets the KeepAlive Interval, in seconds.
bool setKeepAliveInterval(uint16_t keepAlive);
// Publish a message to a topic using the specified QoS level. Returns true // Publish a message to a topic using the specified QoS level. Returns true
// if the message was published, false otherwise. // if the message was published, false otherwise.
bool publish(const char *topic, const char *payload, uint8_t qos = 0, uint8_t retain = 0); bool publish(const char *topic, const char *payload, uint8_t qos = 0);
bool publish(const char *topic, uint8_t *payload, uint16_t bLen, bool publish(const char *topic, uint8_t *payload, uint16_t bLen, uint8_t qos = 0);
uint8_t qos = 0, uint8_t retain = 0);
// Add a subscription to receive messages for a topic. Returns true if the // Add a subscription to receive messages for a topic. Returns true if the
// subscription could be added or was already present, false otherwise. // subscription could be added or was already present, false otherwise.
@ -203,32 +191,23 @@ public:
bool unsubscribe(Adafruit_MQTT_Subscribe *sub); bool unsubscribe(Adafruit_MQTT_Subscribe *sub);
// Check if any subscriptions have new messages. Will return a reference to // Check if any subscriptions have new messages. Will return a reference to
// an Adafruit_MQTT_Subscribe object which has a new message. Should be // an Adafruit_MQTT_Subscribe object which has a new message. Should be called
// called in the sketch's loop function to ensure new messages are recevied. // in the sketch's loop function to ensure new messages are recevied. Note
// Note that subscribe should be called first for each topic that receives // that subscribe should be called first for each topic that receives messages!
// messages!
Adafruit_MQTT_Subscribe *readSubscription(int16_t timeout=0); Adafruit_MQTT_Subscribe *readSubscription(int16_t timeout=0);
// Handle any data coming in for subscriptions and fires them off to the
// appropriate callback
Adafruit_MQTT_Subscribe *handleSubscriptionPacket(uint16_t len);
void processPackets(int16_t timeout); void processPackets(int16_t timeout);
// Ping the server to ensure the connection is still alive. // Ping the server to ensure the connection is still alive.
bool ping(uint8_t n = 1); bool ping(uint8_t n = 1);
// Count the number of registrered Adafruit_MQTT_Subscribe
uint getSubscriptionCount();
protected: protected:
// Interface that subclasses need to implement: // Interface that subclasses need to implement:
// Connect to the server and return true if successful, false otherwise. // Connect to the server and return true if successful, false otherwise.
virtual bool connectServer() = 0; virtual bool connectServer() = 0;
// Disconnect from the MQTT server. Returns true if disconnected, false // Disconnect from the MQTT server. Returns true if disconnected, false otherwise.
// otherwise.
virtual bool disconnectServer() = 0; // Subclasses need to fill this in! virtual bool disconnectServer() = 0; // Subclasses need to fill this in!
// Send data to the server specified by the buffer and length of data. // Send data to the server specified by the buffer and length of data.
@ -237,14 +216,12 @@ protected:
// Read MQTT packet from the server. Will read up to maxlen bytes and store // 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 // the data in the provided buffer. Waits up to the specified timeout (in
// milliseconds) for data to be available. // milliseconds) for data to be available.
virtual uint16_t readPacket(uint8_t *buffer, uint16_t maxlen, virtual uint16_t readPacket(uint8_t *buffer, uint16_t maxlen, int16_t timeout) = 0;
int16_t timeout) = 0;
// Read a full packet, keeping note of the correct length // Read a full packet, keeping note of the correct length
uint16_t readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16_t timeout); uint16_t readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16_t timeout);
// Properly process packets until you get to one you want // Properly process packets until you get to one you want
uint16_t processPacketsUntil(uint8_t *buffer, uint8_t waitforpackettype, uint16_t processPacketsUntil(uint8_t *buffer, uint8_t waitforpackettype, uint16_t timeout);
uint16_t timeout);
// Shared state that subclasses can use: // Shared state that subclasses can use:
const char *servername; const char *servername;
@ -256,7 +233,6 @@ protected:
const char *will_payload; const char *will_payload;
uint8_t will_qos; uint8_t will_qos;
uint8_t will_retain; uint8_t will_retain;
uint16_t keepAliveInterval; // MQTT KeepAlive time interval, in seconds
uint8_t buffer[MAXBUFFERSIZE]; // one buffer, used for all incoming/outgoing uint8_t buffer[MAXBUFFERSIZE]; // one buffer, used for all incoming/outgoing
uint16_t packet_id_counter; uint16_t packet_id_counter;
@ -268,40 +244,35 @@ private:
// Functions to generate MQTT packets. // Functions to generate MQTT packets.
uint8_t connectPacket(uint8_t *packet); uint8_t connectPacket(uint8_t *packet);
uint8_t disconnectPacket(uint8_t *packet); uint8_t disconnectPacket(uint8_t *packet);
uint16_t publishPacket(uint8_t *packet, const char *topic, uint8_t *payload, uint16_t publishPacket(uint8_t *packet, const char *topic, uint8_t *payload, uint16_t bLen, uint8_t qos);
uint16_t bLen, uint8_t qos, uint16_t maxPacketLen = 0, uint8_t retain = 0);
uint8_t subscribePacket(uint8_t *packet, const char *topic, 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 unsubscribePacket(uint8_t *packet, const char *topic);
uint8_t pingPacket(uint8_t *packet); uint8_t pingPacket(uint8_t *packet);
uint8_t pubackPacket(uint8_t *packet, uint16_t packetid); uint8_t pubackPacket(uint8_t *packet, uint16_t packetid);
}; };
class Adafruit_MQTT_Publish { class Adafruit_MQTT_Publish {
public: public:
Adafruit_MQTT_Publish(Adafruit_MQTT *mqttserver, const char *feed, Adafruit_MQTT_Publish(Adafruit_MQTT *mqttserver, const char *feed, uint8_t qos = 0);
uint8_t qos = 0, uint8_t retain = 0);
bool publish(const char *s); bool publish(const char *s);
bool publish( bool publish(double f, uint8_t precision=2); // Precision controls the minimum number of digits after decimal.
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. // This might be ignored and a higher precision value sent.
bool publish(int32_t i); bool publish(int32_t i);
bool publish(uint32_t i); bool publish(uint32_t i);
bool publish(uint8_t *b, uint16_t bLen); bool publish(uint8_t *b, uint16_t bLen);
private: private:
Adafruit_MQTT *mqtt; Adafruit_MQTT *mqtt;
const char *topic; const char *topic;
uint8_t qos; uint8_t qos;
uint8_t retain;
}; };
class Adafruit_MQTT_Subscribe { class Adafruit_MQTT_Subscribe {
public: public:
Adafruit_MQTT_Subscribe(Adafruit_MQTT *mqttserver, const char *feedname, Adafruit_MQTT_Subscribe(Adafruit_MQTT *mqttserver, const char *feedname, uint8_t q=0);
uint8_t q = 0);
void setCallback(SubscribeCallbackUInt32Type callb); void setCallback(SubscribeCallbackUInt32Type callb);
void setCallback(SubscribeCallbackDoubleType callb); void setCallback(SubscribeCallbackDoubleType callb);
@ -324,10 +295,9 @@ public:
AdafruitIO_MQTT *io_mqtt; AdafruitIO_MQTT *io_mqtt;
bool new_message;
private: private:
Adafruit_MQTT *mqtt; Adafruit_MQTT *mqtt;
}; };
#endif #endif

27
Adafruit_MQTT_Client.cpp
View File

@ -9,8 +9,8 @@
// copies of the Software, and to permit persons to whom the Software is // copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions: // furnished to do so, subject to the following conditions:
// //
// The above copyright notice and this permission notice shall be included in // The above copyright notice and this permission notice shall be included in all
// all copies or substantial portions of the Software. // copies or substantial portions of the Software.
// //
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@ -21,16 +21,15 @@
// SOFTWARE. // SOFTWARE.
#include "Adafruit_MQTT_Client.h" #include "Adafruit_MQTT_Client.h"
bool Adafruit_MQTT_Client::connectServer() { bool Adafruit_MQTT_Client::connectServer() {
// Grab server name from flash and copy to buffer for name resolution. // Grab server name from flash and copy to buffer for name resolution.
memset(buffer, 0, sizeof(buffer)); memset(buffer, 0, sizeof(buffer));
strcpy((char *)buffer, servername); strcpy((char *)buffer, servername);
DEBUG_PRINT(F("Connecting to: ")); DEBUG_PRINT(F("Connecting to: ")); DEBUG_PRINTLN((char *)buffer);
DEBUG_PRINTLN((char *)buffer);
// Connect and check for success (0 result). // Connect and check for success (0 result).
int r = client->connect((char *)buffer, portnum); int r = client->connect((char *)buffer, portnum);
DEBUG_PRINT(F("Connect result: ")); DEBUG_PRINT(F("Connect result: ")); DEBUG_PRINTLN(r);
DEBUG_PRINTLN(r);
return r != 0; return r != 0;
} }
@ -50,15 +49,10 @@ bool Adafruit_MQTT_Client::connected() {
uint16_t Adafruit_MQTT_Client::readPacket(uint8_t *buffer, uint16_t maxlen, uint16_t Adafruit_MQTT_Client::readPacket(uint8_t *buffer, uint16_t maxlen,
int16_t timeout) { int16_t timeout) {
/* 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; uint16_t len = 0;
int16_t t = timeout; int16_t t = timeout;
if (maxlen == 0) { // handle zero-length packets
return 0;
}
while (client->connected() && (timeout >= 0)) { while (client->connected() && (timeout >= 0)) {
//DEBUG_PRINT('.'); //DEBUG_PRINT('.');
while (client->available()) { while (client->available()) {
@ -68,7 +62,6 @@ uint16_t Adafruit_MQTT_Client::readPacket(uint8_t *buffer, uint16_t maxlen,
buffer[len] = c; buffer[len] = c;
//DEBUG_PRINTLN((uint8_t)c, HEX); //DEBUG_PRINTLN((uint8_t)c, HEX);
len++; len++;
if (len == maxlen) { // we read all we want, bail if (len == maxlen) { // we read all we want, bail
DEBUG_PRINT(F("Read data:\t")); DEBUG_PRINT(F("Read data:\t"));
DEBUG_PRINTBUFFER(buffer, len); DEBUG_PRINTBUFFER(buffer, len);
@ -83,18 +76,16 @@ uint16_t Adafruit_MQTT_Client::readPacket(uint8_t *buffer, uint16_t maxlen,
bool Adafruit_MQTT_Client::sendPacket(uint8_t *buffer, uint16_t len) { bool Adafruit_MQTT_Client::sendPacket(uint8_t *buffer, uint16_t len) {
uint16_t ret = 0; uint16_t ret = 0;
uint16_t offset = 0;
while (len > 0) { while (len > 0) {
if (client->connected()) { if (client->connected()) {
// send 250 bytes at most at a time, can adjust this later based on Client // send 250 bytes at most at a time, can adjust this later based on Client
uint16_t sendlen = len > 250 ? 250 : len; uint16_t sendlen = len > 250 ? 250 : len;
//Serial.print("Sending: "); Serial.println(sendlen); //Serial.print("Sending: "); Serial.println(sendlen);
ret = client->write(buffer + offset, sendlen); ret = client->write(buffer, sendlen);
DEBUG_PRINT(F("Client sendPacket returned: ")); DEBUG_PRINT(F("Client sendPacket returned: ")); DEBUG_PRINTLN(ret);
DEBUG_PRINTLN(ret);
len -= ret; len -= ret;
offset += ret;
if (ret != sendlen) { if (ret != sendlen) {
DEBUG_PRINTLN("Failed to send packet."); DEBUG_PRINTLN("Failed to send packet.");

34
Adafruit_MQTT_Client.h
View File

@ -9,8 +9,8 @@
// copies of the Software, and to permit persons to whom the Software is // copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions: // furnished to do so, subject to the following conditions:
// //
// The above copyright notice and this permission notice shall be included in // The above copyright notice and this permission notice shall be included in all
// all copies or substantial portions of the Software. // copies or substantial portions of the Software.
// //
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@ -22,36 +22,40 @@
#ifndef _ADAFRUIT_MQTT_CLIENT_H_ #ifndef _ADAFRUIT_MQTT_CLIENT_H_
#define _ADAFRUIT_MQTT_CLIENT_H_ #define _ADAFRUIT_MQTT_CLIENT_H_
#include "Adafruit_MQTT.h"
#include "Client.h" #include "Client.h"
#include "Adafruit_MQTT.h"
// How long to delay waiting for new data to be available in readPacket. // How long to delay waiting for new data to be available in readPacket.
#define MQTT_CLIENT_READINTERVAL_MS 10 #define MQTT_CLIENT_READINTERVAL_MS 10
// MQTT client implementation for a generic Arduino Client interface. Can work // MQTT client implementation for a generic Arduino Client interface. Can work
// with almost all Arduino network hardware like ethernet shield, wifi shield, // with almost all Arduino network hardware like ethernet shield, wifi shield,
// and even other platforms like ESP8266. // and even other platforms like ESP8266.
class Adafruit_MQTT_Client : public Adafruit_MQTT { class Adafruit_MQTT_Client : public Adafruit_MQTT {
public: public:
Adafruit_MQTT_Client(Client *client, const char *server, uint16_t port, 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), client(client) {} Adafruit_MQTT(server, port, cid, user, pass),
client(client)
{}
Adafruit_MQTT_Client(Client *client, const char *server, uint16_t port, 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), client(client) {} Adafruit_MQTT(server, port, user, pass),
client(client)
{}
bool connected() override; bool connectServer();
bool disconnectServer();
protected: bool connected();
bool connectServer() override; uint16_t readPacket(uint8_t *buffer, uint16_t maxlen, int16_t timeout);
bool disconnectServer() override; bool sendPacket(uint8_t *buffer, uint16_t len);
uint16_t readPacket(uint8_t *buffer, uint16_t maxlen,
int16_t timeout) override;
bool sendPacket(uint8_t *buffer, uint16_t len) override;
private: private:
Client* client; Client* client;
}; };
#endif #endif

58
Adafruit_MQTT_FONA.h
View File

@ -9,8 +9,8 @@
// copies of the Software, and to permit persons to whom the Software is // copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions: // furnished to do so, subject to the following conditions:
// //
// The above copyright notice and this permission notice shall be included in // The above copyright notice and this permission notice shall be included in all
// all copies or substantial portions of the Software. // copies or substantial portions of the Software.
// //
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@ -22,12 +22,13 @@
#ifndef _ADAFRUIT_MQTT_FONA_H_ #ifndef _ADAFRUIT_MQTT_FONA_H_
#define _ADAFRUIT_MQTT_FONA_H_ #define _ADAFRUIT_MQTT_FONA_H_
#include "Adafruit_MQTT.h"
#include <Adafruit_FONA.h> #include <Adafruit_FONA.h>
#include "Adafruit_MQTT.h"
#define MQTT_FONA_INTERAVAILDELAY 100 #define MQTT_FONA_INTERAVAILDELAY 100
#define MQTT_FONA_QUERYDELAY 500 #define MQTT_FONA_QUERYDELAY 500
// FONA-specific version of the Adafruit_MQTT class. // FONA-specific version of the Adafruit_MQTT class.
// Note that this is defined as a header-only class to prevent issues with using // 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 // the library on non-FONA platforms (since Arduino will include all .cpp files
@ -35,20 +36,18 @@
class Adafruit_MQTT_FONA : public Adafruit_MQTT { class Adafruit_MQTT_FONA : public Adafruit_MQTT {
public: public:
Adafruit_MQTT_FONA(Adafruit_FONA *f, const char *server, uint16_t port, 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), fona(f) {} Adafruit_MQTT(server, port, cid, user, pass),
fona(f)
{}
Adafruit_MQTT_FONA(Adafruit_FONA *f, const char *server, uint16_t port, 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), fona(f) {} Adafruit_MQTT(server, port, user, pass),
fona(f)
{}
bool connected() { bool connectServer() {
// Return true if connected, false if not connected.
return fona->TCPconnected();
}
protected:
bool connectServer() override {
char server[40]; char server[40];
strncpy(server, servername, 40); strncpy(server, servername, 40);
#ifdef ADAFRUIT_SLEEPYDOG_H #ifdef ADAFRUIT_SLEEPYDOG_H
@ -60,18 +59,23 @@ protected:
return fona->TCPconnect(server, portnum); return fona->TCPconnect(server, portnum);
} }
bool disconnectServer() override { return fona->TCPclose(); } bool disconnectServer() {
return fona->TCPclose();
}
uint16_t readPacket(uint8_t *buffer, uint16_t maxlen, bool connected() {
int16_t timeout) override { // Return true if connected, false if not connected.
return fona->TCPconnected();
}
uint16_t readPacket(uint8_t *buffer, uint16_t maxlen, int16_t timeout) {
uint8_t *buffp = buffer; uint8_t *buffp = buffer;
DEBUG_PRINTLN(F("Reading data..")); DEBUG_PRINTLN(F("Reading data.."));
if (!fona->TCPconnected()) if (!fona->TCPconnected()) return 0;
return 0;
/* 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; uint16_t len = 0;
int16_t t = timeout; int16_t t = timeout;
uint16_t avail; uint16_t avail;
@ -83,13 +87,11 @@ protected:
if (len + avail > maxlen) { if (len + avail > maxlen) {
avail = maxlen - len; avail = maxlen - len;
if (avail == 0) if (avail == 0) return len;
return len;
} }
// try to read the data into the end of the pointer // try to read the data into the end of the pointer
if (!fona->TCPread(buffp, avail)) if (! fona->TCPread(buffp, avail)) return len;
return len;
// read it! advance pointer // read it! advance pointer
buffp += avail; buffp += avail;
@ -108,15 +110,14 @@ protected:
Watchdog.reset(); Watchdog.reset();
#endif #endif
timeout -= MQTT_FONA_INTERAVAILDELAY; timeout -= MQTT_FONA_INTERAVAILDELAY;
timeout -= MQTT_FONA_QUERYDELAY; // this is how long it takes to query the timeout -= MQTT_FONA_QUERYDELAY; // this is how long it takes to query the FONA for avail()
// FONA for avail()
delay(MQTT_FONA_INTERAVAILDELAY); delay(MQTT_FONA_INTERAVAILDELAY);
} }
return len; return len;
} }
bool sendPacket(uint8_t *buffer, uint16_t len) override { bool sendPacket(uint8_t *buffer, uint16_t len) {
DEBUG_PRINTLN(F("Writing packet")); DEBUG_PRINTLN(F("Writing packet"));
if (fona->TCPconnected()) { if (fona->TCPconnected()) {
boolean ret = fona->TCPsend((char *)buffer, len); boolean ret = fona->TCPsend((char *)buffer, len);
@ -137,4 +138,5 @@ private:
Adafruit_FONA *fona; Adafruit_FONA *fona;
}; };
#endif #endif

4
README.md
View File

@ -1,4 +1,4 @@
# 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) # Adafruit MQTT Library [![Build Status](https://travis-ci.org/adafruit/Adafruit_MQTT_Library.svg?branch=master)](https://travis-ci.org/adafruit/Adafruit_MQTT_Library)
Arduino library for MQTT support, including access to Adafruit IO. Works with Arduino library for MQTT support, including access to Adafruit IO. Works with
the Adafruit FONA, Arduino Yun, ESP8266 Arduino platforms, and anything that supports the Adafruit FONA, Arduino Yun, ESP8266 Arduino platforms, and anything that supports
@ -36,7 +36,6 @@ ESP8266 | | | X |
Atmega2560 @ 16MHz | | | X | Atmega2560 @ 16MHz | | | X |
ATSAM3X8E | | | X | ATSAM3X8E | | | X |
ATSAM21D | | | X | ATSAM21D | | | X |
ATSAMD51J20 | | | X |
ATtiny85 @ 16MHz | | | X | ATtiny85 @ 16MHz | | | X |
ATtiny85 @ 8MHz | | | X | ATtiny85 @ 8MHz | | | X |
Intel Curie @ 32MHz | | | X | Intel Curie @ 32MHz | | | X |
@ -50,7 +49,6 @@ STM32F2 | | | X |
* ATmega2560 @ 16MHz : Arduino Mega * ATmega2560 @ 16MHz : Arduino Mega
* ATSAM3X8E : Arduino Due * ATSAM3X8E : Arduino Due
* ATSAM21D : Arduino Zero, M0 Pro * ATSAM21D : Arduino Zero, M0 Pro
* ATSAMD51J20: Adafruit PyPortal
* ATtiny85 @ 16MHz : Adafruit Trinket 5V * ATtiny85 @ 16MHz : Adafruit Trinket 5V
* ATtiny85 @ 8MHz : Adafruit Gemma, Arduino Gemma, Adafruit Trinket 3V * ATtiny85 @ 8MHz : Adafruit Gemma, Arduino Gemma, Adafruit Trinket 3V

1
examples/adafruitio_anon_time_esp8266/.zero.test.skip
View File

@ -1 +0,0 @@

1
examples/adafruitio_errors_esp8266/.zero.test.skip
View File

@ -1 +0,0 @@

1
examples/adafruitio_secure_airlift/.esp8266.test.skip
View File

@ -1 +0,0 @@

1
examples/adafruitio_secure_airlift/.zero.test.skip
View File

@ -1 +0,0 @@

183
examples/adafruitio_secure_airlift/adafruitio_secure_airlift.ino
View File

@ -1,183 +0,0 @@
/****************************************************************
Adafruit MQTT Library, Adafruit IO SSL/TLS Example for AirLift
Must use the latest version of nina-fw from:
https://github.com/adafruit/nina-fw
Works great with Adafruit AirLift ESP32 Co-Processors!
--> https://www.adafruit.com/product/4201
--> https://www.adafruit.com/product/4116
Adafruit invests time and resources providing this open source code,
please support Adafruit and open-source hardware by purchasing
products from Adafruit!
Written by Brent Rubell for Adafruit Industries.
MIT license, all text above must be included in any redistribution
*******************************************************************/
#include <WiFiNINA.h>
#include <SPI.h>
// For AirLift Breakout/Wing/Shield: Configure the following to match the ESP32 Pins!
#if !defined(SPIWIFI_SS)
// Don't change the names of these #define's! they match the variant ones
#define SPIWIFI SPI
#define SPIWIFI_SS 11 // Chip select pin
#define SPIWIFI_ACK 10 // a.k.a BUSY or READY pin
#define ESP32_RESETN 9 // Reset pin
#define ESP32_GPIO0 -1 // Not connected
#define SET_PINS 1 // Pins were set using this IFNDEF
#endif
#include "Adafruit_MQTT.h"
#include "Adafruit_MQTT_Client.h"
/************************* WiFi Access Point *********************************/
#define WLAN_SSID "WLAN_SSID"
#define WLAN_PASS "WIFI_PASSWORD"
int keyIndex = 0; // your network key Index number (needed only for WEP)
int status = WL_IDLE_STATUS;
/************************* Adafruit.io Setup *********************************/
#define AIO_SERVER "io.adafruit.com"
// Using port 8883 for MQTTS
#define AIO_SERVERPORT 8883
// Adafruit IO Account Configuration
// (to obtain these values, visit https://io.adafruit.com and click on Active Key)
#define AIO_USERNAME "YOUR_ADAFRUIT_IO_USERNAME"
#define AIO_KEY "YOUR_ADAFRUIT_IO_KEY"
/************ Global State (you don't need to change this!) ******************/
// WiFiSSLClient for SSL/TLS support
WiFiSSLClient client;
// Setup the MQTT client class by WLAN_PASSing in the WiFi client and MQTT server and login details.
Adafruit_MQTT_Client mqtt(&client, AIO_SERVER, AIO_SERVERPORT, AIO_USERNAME, AIO_KEY);
/****************************** Feeds ***************************************/
// Setup a feed called 'test' for publishing.
// Notice MQTT paths for AIO follow the form: <username>/feeds/<feedname>
Adafruit_MQTT_Publish test = Adafruit_MQTT_Publish(&mqtt, AIO_USERNAME "/feeds/test");
/*************************** Sketch Code ************************************/
void setup()
{
//Initialize serial and wait for port to open:
Serial.begin(115200);
while (!Serial)
{
; // wait for serial port to connect. Needed for native USB port only
}
// if the AirLift's pins were defined above...
#ifdef SET_PINS
WiFi.setPins(SPIWIFI_SS, SPIWIFI_ACK, ESP32_RESETN, ESP32_GPIO0, &SPIWIFI);
#endif
// check for the wifi module
while (WiFi.status() == WL_NO_MODULE)
{
Serial.println("Communication with WiFi module failed!");
delay(1000);
}
String fv = WiFi.firmwareVersion();
if (fv < "1.0.0")
{
Serial.println("Please upgrade the firmware");
}
// attempt to connect to Wifi network:
Serial.print("Attempting to connect to SSID: ");
Serial.println(WLAN_SSID);
// Connect to WPA/WPA2 network. Change this line if using open or WEP network:
do
{
status = WiFi.begin(WLAN_SSID, WLAN_PASS);
delay(100); // wait until connected
} while (status != WL_CONNECTED);
Serial.println("Connected to wifi");
printWiFiStatus();
}
uint32_t x = 0;
void loop()
{
// Ensure the connection to the MQTT server is alive (this will make the first
// connection and automatically reconnect when disconnected). See the MQTT_connect
// function definition further below.
MQTT_connect();
// Now we can publish stuff!
Serial.print(F("\nSending val "));
Serial.print(x);
Serial.print(F(" to test feed..."));
if (!test.publish(x++))
{
Serial.println(F("Failed"));
}
else
{
Serial.println(F("OK!"));
}
// wait a couple seconds to avoid rate limit
delay(2000);
}
// Function to connect and reconnect as necessary to the MQTT server.
// Should be called in the loop function and it will take care if connecting.
void MQTT_connect()
{
int8_t ret;
// Stop if already connected.
if (mqtt.connected())
{
return;
}
Serial.print("Connecting to MQTT... ");
uint8_t retries = 3;
while ((ret = mqtt.connect()) != 0)
{ // connect will return 0 for connected
Serial.println(mqtt.connectErrorString(ret));
Serial.println("Retrying MQTT connection in 5 seconds...");
mqtt.disconnect();
delay(5000); // wait 5 seconds
retries--;
if (retries == 0)
{
// basically die and wait for WDT to reset me
while (1)
;
}
}
Serial.println("MQTT Connected!");
}
void printWiFiStatus()
{
// print the SSID of the network you're attached to:
Serial.print("SSID: ");
Serial.println(WiFi.SSID());
// print your board's IP address:
IPAddress ip = WiFi.localIP();
Serial.print("IP Address: ");
Serial.println(ip);
// print the received signal strength:
long rssi = WiFi.RSSI();
Serial.print("signal strength (RSSI):");
Serial.print(rssi);
Serial.println(" dBm");
}

1
examples/adafruitio_secure_esp32/.esp8266.test.skip
View File

@ -1 +0,0 @@

1
examples/adafruitio_secure_esp32/.zero.test.skip
View File

@ -1 +0,0 @@

160
examples/adafruitio_secure_esp32/adafruitio_secure_esp32.ino
View File

@ -1,160 +0,0 @@
/***********************************************************************
Adafruit MQTT Library ESP32 Adafruit IO SSL/TLS example
Use the latest version of the ESP32 Arduino Core:
https://github.com/espressif/arduino-esp32
Works great with Adafruit Huzzah32 Feather and Breakout Board:
https://www.adafruit.com/product/3405
https://www.adafruit.com/products/4172
Adafruit invests time and resources providing this open source code,
please support Adafruit and open-source hardware by purchasing
products from Adafruit!
Written by Tony DiCola for Adafruit Industries.
Modified by Brent Rubell for Adafruit Industries
MIT license, all text above must be included in any redistribution
**********************************************************************/
#include <WiFi.h>
#include "WiFiClientSecure.h"
#include "Adafruit_MQTT.h"
#include "Adafruit_MQTT_Client.h"
/************************* WiFi Access Point *********************************/
#define WLAN_SSID "WLAN_SSID"
#define WLAN_PASS "WIFI_PASSWORD"
/************************* Adafruit.io Setup *********************************/
#define AIO_SERVER "io.adafruit.com"
// Using port 8883 for MQTTS
#define AIO_SERVERPORT 8883
// Adafruit IO Account Configuration
// (to obtain these values, visit https://io.adafruit.com and click on Active Key)
#define AIO_USERNAME "YOUR_ADAFRUIT_IO_USERNAME"
#define AIO_KEY "YOUR_ADAFRUIT_IO_KEY"
/************ Global State (you don't need to change this!) ******************/
// WiFiFlientSecure for SSL/TLS support
WiFiClientSecure client;
// Setup the MQTT client class by passing in the WiFi client and MQTT server and login details.
Adafruit_MQTT_Client mqtt(&client, AIO_SERVER, AIO_SERVERPORT, AIO_USERNAME, AIO_KEY);
// io.adafruit.com root CA
const char* adafruitio_root_ca = \
"-----BEGIN CERTIFICATE-----\n" \
"MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh\n" \
"MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\n" \
"d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD\n" \
"QTAeFw0wNjExMTAwMDAwMDBaFw0zMTExMTAwMDAwMDBaMGExCzAJBgNVBAYTAlVT\n" \
"MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j\n" \
"b20xIDAeBgNVBAMTF0RpZ2lDZXJ0IEdsb2JhbCBSb290IENBMIIBIjANBgkqhkiG\n" \
"9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4jvhEXLeqKTTo1eqUKKPC3eQyaKl7hLOllsB\n" \
"CSDMAZOnTjC3U/dDxGkAV53ijSLdhwZAAIEJzs4bg7/fzTtxRuLWZscFs3YnFo97\n" \
"nh6Vfe63SKMI2tavegw5BmV/Sl0fvBf4q77uKNd0f3p4mVmFaG5cIzJLv07A6Fpt\n" \
"43C/dxC//AH2hdmoRBBYMql1GNXRor5H4idq9Joz+EkIYIvUX7Q6hL+hqkpMfT7P\n" \
"T19sdl6gSzeRntwi5m3OFBqOasv+zbMUZBfHWymeMr/y7vrTC0LUq7dBMtoM1O/4\n" \
"gdW7jVg/tRvoSSiicNoxBN33shbyTApOB6jtSj1etX+jkMOvJwIDAQABo2MwYTAO\n" \
"BgNVHQ8BAf8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUA95QNVbR\n" \
"TLtm8KPiGxvDl7I90VUwHwYDVR0jBBgwFoAUA95QNVbRTLtm8KPiGxvDl7I90VUw\n" \
"DQYJKoZIhvcNAQEFBQADggEBAMucN6pIExIK+t1EnE9SsPTfrgT1eXkIoyQY/Esr\n" \
"hMAtudXH/vTBH1jLuG2cenTnmCmrEbXjcKChzUyImZOMkXDiqw8cvpOp/2PV5Adg\n" \
"06O/nVsJ8dWO41P0jmP6P6fbtGbfYmbW0W5BjfIttep3Sp+dWOIrWcBAI+0tKIJF\n" \
"PnlUkiaY4IBIqDfv8NZ5YBberOgOzW6sRBc4L0na4UU+Krk2U886UAb3LujEV0ls\n" \
"YSEY1QSteDwsOoBrp+uvFRTp2InBuThs4pFsiv9kuXclVzDAGySj4dzp30d8tbQk\n" \
"CAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4=\n" \
"-----END CERTIFICATE-----\n";
/****************************** Feeds ***************************************/
// Setup a feed called 'test' for publishing.
// Notice MQTT paths for AIO follow the form: <username>/feeds/<feedname>
Adafruit_MQTT_Publish test = Adafruit_MQTT_Publish(&mqtt, AIO_USERNAME "/feeds/test");
/*************************** Sketch Code ************************************/
void setup() {
Serial.begin(115200);
delay(10);
Serial.println(F("Adafruit IO MQTTS (SSL/TLS) Example"));
// Connect to WiFi access point.
Serial.println(); Serial.println();
Serial.print("Connecting to ");
Serial.println(WLAN_SSID);
delay(1000);
WiFi.begin(WLAN_SSID, WLAN_PASS);
delay(2000);
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
Serial.println();
Serial.println("WiFi connected");
Serial.println("IP address: "); Serial.println(WiFi.localIP());
// Set Adafruit IO's root CA
client.setCACert(adafruitio_root_ca);
}
uint32_t x=0;
void loop() {
// Ensure the connection to the MQTT server is alive (this will make the first
// connection and automatically reconnect when disconnected). See the MQTT_connect
// function definition further below.
MQTT_connect();
// Now we can publish stuff!
Serial.print(F("\nSending val "));
Serial.print(x);
Serial.print(F(" to test feed..."));
if (! test.publish(x++)) {
Serial.println(F("Failed"));
} else {
Serial.println(F("OK!"));
}
// wait a couple seconds to avoid rate limit
delay(2000);
}
// Function to connect and reconnect as necessary to the MQTT server.
// Should be called in the loop function and it will take care if connecting.
void MQTT_connect() {
int8_t ret;
// Stop if already connected.
if (mqtt.connected()) {
return;
}
Serial.print("Connecting to MQTT... ");
uint8_t retries = 3;
while ((ret = mqtt.connect()) != 0) { // connect will return 0 for connected
Serial.println(mqtt.connectErrorString(ret));
Serial.println("Retrying MQTT connection in 5 seconds...");
mqtt.disconnect();
delay(5000); // wait 5 seconds
retries--;
if (retries == 0) {
// basically die and wait for WDT to reset me
while (1);
}
}
Serial.println("MQTT Connected!");
}

1
examples/adafruitio_secure_esp8266/.zero.test.skip
View File

@ -1 +0,0 @@

53
examples/adafruitio_secure_esp8266/adafruitio_secure_esp8266.ino
View File

@ -22,18 +22,15 @@
/************************* WiFi Access Point *********************************/ /************************* WiFi Access Point *********************************/
#define WLAN_SSID "WLAN_SSID" #define WLAN_SSID "...your SSID..."
#define WLAN_PASS "WIFI_PASSWORD" #define WLAN_PASS "...your password..."
/************************* Adafruit.io Setup *********************************/ /************************* Adafruit.io Setup *********************************/
#define AIO_SERVER "io.adafruit.com" #define AIO_SERVER "io.adafruit.com"
// Using port 8883 for MQTTS #define AIO_SERVERPORT 8883 // 8883 for MQTTS
#define AIO_SERVERPORT 8883 #define AIO_USERNAME "...your AIO username (see https://accounts.adafruit.com)..."
// Adafruit IO Account Configuration #define AIO_KEY "...your AIO key..."
// (to obtain these values, visit https://io.adafruit.com and click on Active Key)
#define AIO_USERNAME "YOUR_ADAFRUIT_IO_USERNAME"
#define AIO_KEY "YOUR_ADAFRUIT_IO_KEY"
/************ Global State (you don't need to change this!) ******************/ /************ Global State (you don't need to change this!) ******************/
@ -43,13 +40,9 @@ WiFiClientSecure client;
// Setup the MQTT client class by passing in the WiFi client and MQTT server and login details. // Setup the MQTT client class by passing in the WiFi client and MQTT server and login details.
Adafruit_MQTT_Client mqtt(&client, AIO_SERVER, AIO_SERVERPORT, AIO_USERNAME, AIO_KEY); Adafruit_MQTT_Client mqtt(&client, AIO_SERVER, AIO_SERVERPORT, AIO_USERNAME, AIO_KEY);
// io.adafruit.com SHA1 fingerprint // io.adafruit.com SHA1 fingerprint. Current fingerprint can be verified via:
/* WARNING - This value was last updated on 08/15/22 and may not be up-to-date! // echo | openssl s_client -connect io.adafruit.com:443 |& openssl x509 -fingerprint -noout
* If security is a concern for your project, we strongly recommend users impacted by this moving #define AIO_SSL_FINGERPRINT "77 00 54 2D DA E7 D8 03 27 31 23 99 EB 27 DB CB A5 4C 57 18"
* to ESP32 which has certificate verification by storing root certs and having a
* chain-of-trust rather than doing individual certificate fingerprints.
*/
static const char *fingerprint PROGMEM = "18 C0 C2 3D BE DD 81 37 73 40 E7 E4 36 61 CB 0A DF 96 AD 25";
/****************************** Feeds ***************************************/ /****************************** Feeds ***************************************/
@ -59,6 +52,11 @@ Adafruit_MQTT_Publish test = Adafruit_MQTT_Publish(&mqtt, AIO_USERNAME "/feeds/t
/*************************** Sketch Code ************************************/ /*************************** Sketch Code ************************************/
// Bug workaround for Arduino 1.6.6, it seems to need a function declaration
// for some reason (only affects ESP8266, likely an arduino-builder bug).
void MQTT_connect();
void verifyFingerprint();
void setup() { void setup() {
Serial.begin(115200); Serial.begin(115200);
delay(10); delay(10);
@ -85,7 +83,8 @@ void setup() {
Serial.println("IP address: "); Serial.println(WiFi.localIP()); Serial.println("IP address: "); Serial.println(WiFi.localIP());
// check the fingerprint of io.adafruit.com's SSL cert // check the fingerprint of io.adafruit.com's SSL cert
client.setFingerprint(fingerprint); verifyFingerprint();
} }
uint32_t x=0; uint32_t x=0;
@ -111,6 +110,28 @@ void loop() {
} }
void verifyFingerprint() {
const char* host = AIO_SERVER;
Serial.print("Connecting to ");
Serial.println(host);
if (! client.connect(host, AIO_SERVERPORT)) {
Serial.println("Connection failed. Halting execution.");
while(1);
}
if (client.verify(fingerprint, host)) {
Serial.println("Connection secure.");
} else {
Serial.println("Connection insecure! Halting execution.");
while(1);
}
}
// Function to connect and reconnect as necessary to the MQTT server. // Function to connect and reconnect as necessary to the MQTT server.
// Should be called in the loop function and it will take care if connecting. // Should be called in the loop function and it will take care if connecting.
void MQTT_connect() { void MQTT_connect() {

1
examples/adafruitio_time_esp8266/.zero.test.skip
View File

@ -1 +0,0 @@

1
examples/mqtt_2subs_esp8266/.zero.test.skip
View File

@ -1 +0,0 @@

1
examples/mqtt_esp8266/.zero.test.skip
View File

@ -1 +0,0 @@

2
examples/mqtt_esp8266/mqtt_esp8266.ino
View File

@ -35,7 +35,7 @@
// Create an ESP8266 WiFiClient class to connect to the MQTT server. // Create an ESP8266 WiFiClient class to connect to the MQTT server.
WiFiClient client; WiFiClient client;
// or... use WiFiClientSecure for SSL // or... use WiFiFlientSecure for SSL
//WiFiClientSecure client; //WiFiClientSecure client;
// Setup the MQTT client class by passing in the WiFi client and MQTT server and login details. // Setup the MQTT client class by passing in the WiFi client and MQTT server and login details.

1
examples/mqtt_esp8266_callback/.esp8266.test.skip
View File

@ -1 +0,0 @@

1
examples/mqtt_esp8266_callback/.zero.test.skip
View File

@ -1 +0,0 @@

1
examples/mqtt_ethernet/.zero.test.skip
View File

@ -1 +0,0 @@

1
examples/mqtt_fona/.zero.test.skip
View File

@ -1 +0,0 @@

13
examples/mqtt_fona/fonahelper.cpp
View File

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

1
examples/mqtt_winc1500/.esp8266.test.skip
View File

@ -1 +0,0 @@

1
examples/mqtt_yun/.esp8266.test.skip
View File

@ -1 +0,0 @@

1
examples/mqtt_yun/.zero.test.skip
View File

@ -1 +0,0 @@

1
keywords.txt
View File

@ -1,4 +1,5 @@
Adafruit_MQTT KEYWORD1 Adafruit_MQTT KEYWORD1
Adafruit_MQTT_CC3000 KEYWORD1
Adafruit_MQTT_FONA KEYWORD1 Adafruit_MQTT_FONA KEYWORD1
Adafruit_MQTT_Client KEYWORD1 Adafruit_MQTT_Client KEYWORD1
Adafruit_MQTT_Publish KEYWORD1 Adafruit_MQTT_Publish KEYWORD1

5
library.properties
View File

@ -1,10 +1,9 @@
name=Adafruit MQTT Library name=Adafruit MQTT Library
version=2.4.3 version=0.20.1
author=Adafruit author=Adafruit
maintainer=Adafruit <info@adafruit.com> maintainer=Adafruit <info@adafruit.com>
sentence=MQTT library that supports the FONA, ESP8266, ESP32, Yun, and generic Arduino Client hardware. sentence=MQTT library that supports the FONA, ESP8266, Yun, and generic Arduino Client hardware.
paragraph=Simple MQTT library that supports the bare minimum to publish and subscribe to topics. paragraph=Simple MQTT library that supports the bare minimum to publish and subscribe to topics.
category=Communication category=Communication
url=https://github.com/adafruit/Adafruit_MQTT_Library url=https://github.com/adafruit/Adafruit_MQTT_Library
architectures=* architectures=*
depends=Adafruit SleepyDog Library, Adafruit FONA Library, WiFi101