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

Handle publish packets when they're not the expected packet type

Browse Source
This commit is contained in:
Lucas Jandrew 2020-02-23 22:42:43 -05:00
parent 259cba0837
commit 5ea3e3ba72
2 changed files with 609 additions and 561 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

169
Adafruit_MQTT.cpp
View File

@ -48,13 +48,15 @@ int strncasecmp(const char * str1, const char * str2, int len) {
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++) {
if (isprint(buffer[i])) if (isprint(buffer[i])) {
DEBUG_PRINTER.write(buffer[i]); DEBUG_PRINTER.write(buffer[i]);
else } else {
DEBUG_PRINTER.print(" "); DEBUG_PRINTER.print(" ");
}
DEBUG_PRINTER.print(F(" [0x")); DEBUG_PRINTER.print(F(" [0x"));
if (buffer[i] < 0x10) if (buffer[i] < 0x10) {
DEBUG_PRINTER.print("0"); DEBUG_PRINTER.print("0");
}
DEBUG_PRINTER.print(buffer[i], HEX); DEBUG_PRINTER.print(buffer[i], HEX);
DEBUG_PRINTER.print("], "); DEBUG_PRINTER.print("], ");
if (i % 8 == 7) { if (i % 8 == 7) {
@ -87,8 +89,10 @@ 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++; p[0] = len >> 8;
p[0] = len & 0xFF; p++; p++;
p[0] = len & 0xFF;
p++;
strncpy((char *) p, s, len); strncpy((char *) p, s, len);
return p + len; return p + len;
} }
@ -148,37 +152,46 @@ Adafruit_MQTT::Adafruit_MQTT(const char *server,
int8_t Adafruit_MQTT::connect() { int8_t Adafruit_MQTT::connect() {
// Connect to the server. // Connect to the server.
if (!connectServer()) if (!connectServer()) {
return -1; return -1;
}
// Construct and send connect packet. // Construct and send connect packet.
uint8_t len = connectPacket(buffer); uint8_t len = connectPacket(buffer);
if (!sendPacket(buffer, len)) if (!sendPacket(buffer, len)) {
return -1; return -1;
}
// 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) continue; if (subscriptions[i] == 0) {
continue;
}
boolean success = false; 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. // 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)) if (!sendPacket(buffer, len)) {
return -1; return -1;
}
if(MQTT_PROTOCOL_LEVEL < 3) // older versions didn't suback if (MQTT_PROTOCOL_LEVEL < 3) { // older versions didn't suback
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 the // TODO: The Server is permitted to start sending PUBLISH packets matching the
@ -196,8 +209,7 @@ int8_t Adafruit_MQTT::connect() {
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();
@ -213,13 +225,15 @@ uint16_t Adafruit_MQTT::processPacketsUntil(uint8_t *buffer, uint8_t waitforpack
break; break;
} }
if ((buffer[0] >> 4) == waitforpackettype) uint8_t packetType = (buffer[0] >> 4);
{ if (packetType == waitforpackettype) {
return len; return len;
} } else {
else // if (packetType == MQTT_CTRL_PUBLISH) {
{ // handleSubscriptionPacket(len);
// } else {
ERROR_PRINTLN(F("Dropped a packet")); ERROR_PRINTLN(F("Dropped a packet"));
// }
} }
} }
return 0; return 0;
@ -235,7 +249,8 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16
rlen = readPacket(pbuff, 1, timeout); 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++; pbuff++;
uint32_t value = 0; uint32_t value = 0;
@ -257,7 +272,8 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16
} }
} while (encodedByte & 0x80); } 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)) { if (value > (maxsize - (pbuff - buffer) - 1)) {
DEBUG_PRINTLN(F("Packet too big for buffer")); DEBUG_PRINTLN(F("Packet too big for buffer"));
@ -272,16 +288,27 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t maxsize, uint16
const __FlashStringHelper *Adafruit_MQTT::connectErrorString(int8_t code) { const __FlashStringHelper *Adafruit_MQTT::connectErrorString(int8_t code) {
switch (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("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("The Client identifier is correct UTF-8 but not allowed by the Server");
case 5: return F("Not authorized to connect"); case 3:
case 6: return F("Exceeded reconnect rate limit. Please try again later."); return F("The MQTT service is unavailable");
case 7: return F("You have been banned from connecting. Please contact the MQTT server administrator for more details."); case 4:
case -1: return F("Connection failed"); return F("The data in the user name or password is malformed");
case -2: return F("Failed to subscribe"); case 5:
default: return F("Unknown error"); 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");
} }
} }
@ -289,8 +316,9 @@ bool Adafruit_MQTT::disconnect() {
// Construct and send disconnect packet. // Construct and send disconnect packet.
uint8_t len = disconnectPacket(buffer); uint8_t len = disconnectPacket(buffer);
if (! sendPacket(buffer, len)) if (!sendPacket(buffer, len)) {
DEBUG_PRINTLN(F("Unable to send disconnect packet")); DEBUG_PRINTLN(F("Unable to send disconnect packet"));
}
return disconnectServer(); return disconnectServer();
@ -357,7 +385,8 @@ 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_PRINTLN(i); DEBUG_PRINT(F("Added sub "));
DEBUG_PRINTLN(i);
subscriptions[i] = sub; subscriptions[i] = sub;
return true; return true;
} }
@ -424,20 +453,17 @@ void Adafruit_MQTT::processPackets(int16_t timeout) {
data = atoi((char *) sub->lastread); 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); 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); //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); //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
//Serial.print("*** calling io instance callback with : "); Serial.println((char *)sub->lastread); //Serial.print("*** calling io instance callback with : "); Serial.println((char *)sub->lastread);
((sub->io_mqtt)->*(sub->callback_io))((char *) sub->lastread, sub->datalen); ((sub->io_mqtt)->*(sub->callback_io))((char *) sub->lastread, sub->datalen);
@ -454,21 +480,32 @@ void Adafruit_MQTT::processPackets(int16_t timeout) {
} }
Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) { Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
uint16_t i, topiclen, datalen;
// Check if data is available to read. // 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 handleSubscriptionPacket(len);
}
Adafruit_MQTT_Subscribe *Adafruit_MQTT::handleSubscriptionPacket(uint16_t len) {
uint16_t i, topiclen, datalen;
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 (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. // Parse out length of packet.
topiclen = buffer[3]; 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. // Find subscription associated with this packet.
for (i = 0; i < MAXSUBSCRIPTIONS; i++) { for (i = 0; i < MAXSUBSCRIPTIONS; i++) {
@ -480,12 +517,15 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
// 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 + 4, subscriptions[i]->topic, topiclen) == 0) { if (strncasecmp((char *) buffer + 4, subscriptions[i]->topic, topiclen) == 0) {
DEBUG_PRINT(F("Found sub #")); DEBUG_PRINTLN(i); DEBUG_PRINT(F("Found sub #"));
DEBUG_PRINTLN(i);
break; 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; uint8_t packet_id_len = 0;
uint16_t packetid = 0; uint16_t packetid = 0;
@ -507,16 +547,17 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
// extract out just the data, into the subscription object itself // 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; 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) { if ((MQTT_PROTOCOL_LEVEL > 3) && (buffer[0] & 0x6) == 0x2) {
uint8_t ackpacket[4]; uint8_t ackpacket[4];
// Construct and send puback packet. // Construct and send puback packet.
uint8_t len = pubackPacket(ackpacket, packetid); uint8_t len = pubackPacket(ackpacket, packetid);
if (!sendPacket(ackpacket, len)) if (!sendPacket(ackpacket, len)) DEBUG_PRINT(F("Failed"));
DEBUG_PRINT(F("Failed"));
} }
// return the valid matching subscription // return the valid matching subscription
@ -535,14 +576,16 @@ bool Adafruit_MQTT::ping(uint8_t num) {
while (num--) { while (num--) {
// Construct and send ping packet. // Construct and send ping packet.
uint8_t len = pingPacket(buffer); uint8_t len = pingPacket(buffer);
if (!sendPacket(buffer, len)) if (!sendPacket(buffer, len)) {
continue; continue;
}
// Process ping reply. // Process ping reply.
len = processPacketsUntil(buffer, MQTT_CTRL_PINGRESP, PING_TIMEOUT_MS); processPacketsUntil(buffer, MQTT_CTRL_PINGRESP, PING_TIMEOUT_MS);
if (buffer[0] == (MQTT_CTRL_PINGRESP << 4)) if (buffer[0] == (MQTT_CTRL_PINGRESP << 4)) {
return true; return true;
} }
}
return false; return false;
} }
@ -689,8 +732,7 @@ uint16_t Adafruit_MQTT::publishPacket(uint8_t *packet, const char *topic,
return len; return len;
} }
uint8_t Adafruit_MQTT::subscribePacket(uint8_t *packet, const char *topic, uint8_t Adafruit_MQTT::subscribePacket(uint8_t *packet, const char *topic, uint8_t qos) {
uint8_t qos) {
uint8_t *p = packet; uint8_t *p = packet;
uint16_t len; uint16_t len;
@ -719,7 +761,6 @@ uint8_t Adafruit_MQTT::subscribePacket(uint8_t *packet, const char *topic,
} }
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;
@ -776,11 +817,13 @@ uint8_t Adafruit_MQTT::disconnectPacket(uint8_t *packet) {
// 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) { const char *feed, uint8_t
q) {
mqtt = mqttserver; mqtt = mqttserver;
topic = feed; topic = feed;
qos = q; qos = q;
} }
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);
@ -804,7 +847,8 @@ bool Adafruit_MQTT_Publish::publish(const char *payload) {
} }
//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); return mqtt->publish(topic, payload, bLen, qos);
} }
@ -813,7 +857,8 @@ bool Adafruit_MQTT_Publish::publish(uint8_t *payload, uint16_t bLen) {
// 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,
const char *feed, uint8_t q) { const char *feed, uint8_t
q) {
mqtt = mqttserver; mqtt = mqttserver;
topic = feed; topic = feed;
qos = q; qos = q;

3
Adafruit_MQTT.h
View File

@ -195,6 +195,9 @@ class Adafruit_MQTT {
// that subscribe should be called first for each topic that receives messages! // that subscribe should be called first for each topic that receives 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.