Example of AWS IoT connection and Web Dashboard thru STM32 Nucleo evaluation board and mbed OS.
Dependencies: X_NUCLEO_IKS01A1 mbed FP MQTTPacket DnsQuery ATParser
Introduction
The demo is aimed to STM32 Nucleo board with WiFi and sensors expansions. The board is a "thing" for the AWS IoT service. It updates IoT service shadow with sensors data every second and checks subscription messages.
Hardware Configuration
- NUCLEO-F401RE - Nucleo Development Board
- X-NUCLEO-IDW01M1 - Wi-Fi expansion board for STM32 Nucleo
- X-NUCLEO-IKS01A1 - Motion MEMS and environmental sensor expansion board for STM32 Nucleo
Software Configuration
- Import this Project to mbed online compiler
- Find the next part of code in main.cpp file ...
WiFi network credential
#include "mbed.h" // WiFi network credential #define SSID "" // Network must be visible otherwise it can't connect #define PASSW "" #error "Wifi SSID & password empty"
- ... And set it to your Network Name and Password. Do not forget to remove "#error" pragma line.
Information
Nucleo WiFi module is not the same as your smartphone or laptope - it is based on demo board. To avoid connection problems:
- Place Nucleo as close to WiFi hot spot as possible. Or...
- Turn on mobile hot spot in your laptop as close to the device as possible.
- Make sure that hot spot permits 2.4 GHz band communications
- Setup BackEnd and store certificates using this backend setup instruction
- Find AWS_IOT_MQTT_HOST define and change it to HTTPS point mentioned in your AWS IoT thing properties named "interact"
#define AWS_IOT_MQTT_HOST "xxxxxxxxxx.iot.us-east-1.amazonaws.com" //Use your own host.
- Find the certificate defines clientCRT and clientKey in main.cpp file and change it to ones provided by Amazon.
/********************************************************************************************** *********************************************************************************************** Device Identity Certificates: Modify for your AWS IoT Thing *********************************************************************************************** ***********************************************************************************************/ /**************************************** (somecode)-certificate.pem.crt - Amazon signed PEM sertificate. *****************************************/ //This Client cert is example. Use own instead. const uint8_t clientCRT[] = "\ -----BEGIN CERTIFICATE-----\n\ MIIDBjCCAe6gAwIBAgIUVph856omeIxW3UPioq+UrX1DbwowDQYJKoZIhvcNAQEL\ BQAwTTFLMEkGA1UECwxCQW1hem9uIFdlYiBTZXJ2aWNlcyBPPUFtYXpvbi5jb20g\ SW5jLiBMPVNlYXR0bGUgU1Q9V2FzaGluZ3RvbiBDPVVTMB4XDTE3MDUyNTExNTEy\ OVoXDTQ5MTIzMTIzNTk1OVowgZUxCzAJBgNVBAYTAkJZMQ4wDAYDVQQIDAVNaW5z\ azEOMAwGA1UEBwwFTWluc2sxFzAVBgNVBAoMDktsaWthLVRlY2ggTExDMRcwFQYD\ VQQLDA5LbGlrYS1UZWNoIExMQzEMMAoGA1UEAwwDUm5EMSYwJAYJKoZIhvcNAQkB\ FhdtdmF0YWxldUBrbGlrYS10ZWNoLmNvbTBZMBMGByqGSM49AgEGCCqGSM49AwEH\ A0IABCJgOQJmoTBJVPfli9Hm/JVixaxkY5rtlgrYO3hSl633A2hg0P/ue0wXDbF3\ aQ0X57IRFE4k4FEbr3UXjT/IczKjYDBeMB8GA1UdIwQYMBaAFK3YzTUPlYB2Li75\ i/z8rEogr1d6MB0GA1UdDgQWBBT18HXBaXFJuAR/0SwegnxJ+pyJ6TAMBgNVHRMB\ Af8EAjAAMA4GA1UdDwEB/wQEAwIHgDANBgkqhkiG9w0BAQsFAAOCAQEAb0Ux1aH5\ RLxjrfGqXN6rPVqh8QQRS+AyBfzmaQN8HaPZMkX5WxXLvcn0A3uWlwQxPPkcZ4zf\ 51GHtFFQWB4YZ8dx8mUQ0v/j7onHjCJgZ8iDgwOyKMGtnsDZWCakQw+a6cj+NrMZ\ tzhjwCzEEP6ePcbXwErI5OOzLuWns2L/JEr2wWNkokgRuS8ewr/SQ9OLWIWa2rFM\ ahPNTb3y/qBeWdjeJmhI+TOxdqIpsF8roWP25zwo/zkzCHCjXFBrL+0CA4MpxIl9\ x02i7aAhlJ6ys80lDxdeWeeQJXRKkGknP8mcmKn3iEqqJ5s1dQePj2b5d3ldatya\ wsxQBqqZXzIWEw==\ \n\ -----END CERTIFICATE-----\n"; /********************************************************************************************** *********************************************************************************************** Private Key: Modify for your AWS IoT Thing *********************************************************************************************** ***********************************************************************************************/ /********************************************************************8**************************************** nucleo.key.pem - client key generated according to readme. **************************************************************************************************************/ //This Client Key is example. Use own instead. const uint8_t clientKey[] ="\ -----BEGIN EC PARAMETERS-----\n\ BggqhkjOPQMBBw==\ -----END EC PARAMETERS-----\n\ -----BEGIN EC PRIVATE KEY-----\n\ MHcCAQEEIHPRfWSC8/k/BsqDWKuP15dXsI9fGwpkTIsLZe6mIrAAoAoGCCqGSM49\ AwEHoUQDQgAEImA5AmahMElU9+WL0eb8lWLFrGRjmu2WCtg7eFKXrfcDaGDQ/+57\ TBcNsXdpDRfnshEUTiTgURuvdReNP8hzMg==\ -----END EC PRIVATE KEY-----\n";
Build and Check
- Plugin your board to USB of your PC. USB Disk Drive and USB COM Port should appear in your system.
- Open any Serial Console, connect it to your USB Serial Port and setup speed equal to 115200.
- Compile this Project and save .bin file to USB Disk Drive
- After board reset you should see next log in serial console:
X-NUCLEO-IDW01M1 mbed Application connecting to AP LOG: int main() L#361 Connected to WiFI. LOG: int connect(MQTT::Client<MQTTWiFi, Countdown, 350, 5> *, MQTTWiFi *) L#186 ===================================== LOG: int connect(MQTT::Client<MQTTWiFi, Countdown, 350, 5> *, MQTTWiFi *) L#187 Connecting WiFi. LOG: int connect(MQTT::Client<MQTTWiFi, Countdown, 350, 5> *, MQTTWiFi *) L#188 Nucleo IP ADDRESS: X.X.X.X LOG: int connect(MQTT::Client<MQTTWiFi, Countdown, 350, 5> *, MQTTWiFi *) L#189 Nucleo MAC ADDRESS: 00:11:22:33:44:55 LOG: int connect(MQTT::Client<MQTTWiFi, Countdown, 350, 5> *, MQTTWiFi *) L#190 Server Hostname: xxxxxxxx.iot.us-east-1.amazonaws.com port: 8883 LOG: int connect(MQTT::Client<MQTTWiFi, Countdown, 350, 5> *, MQTTWiFi *) L#191 Client ID: Nucleo LOG: int connect(MQTT::Client<MQTTWiFi, Countdown, 350, 5> *, MQTTWiFi *) L#194 ===================================== LOG: int MQTTSocket::getNTPtime(int) L#58 Success receiving time from ntp server. Tick from 1 Jan 1970 is equal to 1505399292. --->TCP Connected --->MQTT Connected --->>>MQTT subscribed to: Nucleo/test Length - 245, Publishing {"state": {"reported": {"temperature": 23.690001, "humidity": 98.190002, "pressure": 982.869141, "accelerometer": [-0.009000, 0.030000, 0.971000], "gyroscope": [0.420000, -2.660000, 1.750000], "magnetometer": [-3.600000, -7.100000, 53.300000]}}} Length - 245, Publishing {"state": {"reported": {"temperature": 23.660000, "humidity": 98.010002, "pressure": 982.770264, "accelerometer": [-0.009000, 0.030000, 0.971000], "gyroscope": [0.770000, -2.310000, 1.470000], "magnetometer": [-3.100000, -8.300000, 54.200000]}}} Length - 245, Publishing {"state": {"reported": {"temperature": 23.670000, "humidity": 98.129997, "pressure": 982.724121, "accelerometer": [-0.008000, 0.029000, 0.971000], "gyroscope": [0.630000, -2.380000, 1.400000], "magnetometer": [-3.100000, -7.900000, 53.400000]}}} Length - 245, Publishing {"state": {"reported": {"temperature": 23.690001, "humidity": 98.019997, "pressure": 982.840088, "accelerometer": [-0.009000, 0.030000, 0.972000], "gyroscope": [0.700000, -2.450000, 1.540000], "magnetometer": [-3.700000, -7.900000, 53.400000]}}} Length - 245, Publishing {"state": {"reported": {"temperature": 23.709999, "humidity": 98.040001, "pressure": 982.828613, "accelerometer": [-0.009000, 0.030000, 0.971000], "gyroscope": [0.630000, -2.520000, 1.470000], "magnetometer": [-2.900000, -7.400000, 52.400000]}}} Length - 245, Publishing {"state": {"reported": {"temperature": 23.719999, "humidity": 97.860001, "pressure": 982.917236, "accelerometer": [-0.026000, 0.103000, 0.891000], "gyroscope": [1.050000, -2.310000, 1.260000], "magnetometer": [-3.300000, -7.100000, 53.500000]}}}
Information
Device connection state might be checked by Green Led on the board. Green light means that device is connected and transferring data to cloud.
- Configure and start your dashboard using instruction and corresponding sources from github
- Use Blue button to set up markers to charts.
- Use AWS IoT console MQTT Client to test device subscription to "Nucleo/test". Just publish any message to this topic and serial port output.
- PROFIT!
MQTT/MQTTClient.h
- Committer:
- PavelSavyhin
- Date:
- 2017-10-19
- Revision:
- 1:042ca9148926
- Parent:
- 0:4cdaf9b1e7d0
File content as of revision 1:042ca9148926:
/******************************************************************************* * Copyright (c) 2014, 2015 IBM Corp. * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * and Eclipse Distribution License v1.0 which accompany this distribution. * * The Eclipse Public License is available at * http://www.eclipse.org/legal/epl-v10.html * and the Eclipse Distribution License is available at * http://www.eclipse.org/org/documents/edl-v10.php. * * Contributors: * * Ian Craggs - initial API and implementation and/or initial documentation * Ian Craggs - fix for bug 458512 - QoS 2 messages * Ian Craggs - fix for bug 460389 - send loop uses wrong length * Ian Craggs - fix for bug 464169 - clearing subscriptions * Ian Craggs - fix for bug 464551 - enums and ints can be different size *******************************************************************************/ #if !defined(MQTTCLIENT_H) #define MQTTCLIENT_H #include "FP.h" #include "MQTTPacket.h" #include "stdio.h" #include "MQTTLogging.h" #if !defined(MQTTCLIENT_QOS1) #define MQTTCLIENT_QOS1 1 #endif #if !defined(MQTTCLIENT_QOS2) #define MQTTCLIENT_QOS2 0 #endif namespace MQTT { enum QoS { QOS0, QOS1, QOS2 }; // all failure return codes must be negative enum returnCode { BUFFER_OVERFLOW = -2, FAILURE = -1, SUCCESS = 0 }; struct Message { enum QoS qos; bool retained; bool dup; unsigned short id; void *payload; size_t payloadlen; }; struct MessageData { MessageData(MQTTString &aTopicName, struct Message &aMessage) : message(aMessage), topicName(aTopicName) { } struct Message &message; MQTTString &topicName; }; class PacketId { public: PacketId() { next = 0; } int getNext() { return next = (next == MAX_PACKET_ID) ? 1 : ++next; } private: static const int MAX_PACKET_ID = 65535; int next; }; /** * @class Client * @brief blocking, non-threaded MQTT client API * * This version of the API blocks on all method calls, until they are complete. This means that only one * MQTT request can be in process at any one time. * @param Network a network class which supports send, receive * @param Timer a timer class with the methods: */ template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE = 100, int MAX_MESSAGE_HANDLERS = 5> class Client { public: typedef void (*messageHandler)(MessageData&); /** Construct the client * @param network - pointer to an instance of the Network class - must be connected to the endpoint * before calling MQTT connect * @param limits an instance of the Limit class - to alter limits as required */ Client(Network& network, unsigned int command_timeout_ms = 30000); /** Set the default message handling callback - used for any message which does not match a subscription message handler * @param mh - pointer to the callback function */ void setDefaultMessageHandler(messageHandler mh) { defaultMessageHandler.attach(mh); } /** MQTT Connect - send an MQTT connect packet down the network and wait for a Connack * The nework object must be connected to the network endpoint before calling this * Default connect options are used * @return success code - */ int connect(); /** MQTT Connect - send an MQTT connect packet down the network and wait for a Connack * The nework object must be connected to the network endpoint before calling this * @param options - connect options * @return success code - */ int connect(MQTTPacket_connectData& options); /** MQTT Publish - send an MQTT publish packet and wait for all acks to complete for all QoSs * @param topic - the topic to publish to * @param message - the message to send * @return success code - */ int publish(const char* topicName, Message& message); /** MQTT Publish - send an MQTT publish packet and wait for all acks to complete for all QoSs * @param topic - the topic to publish to * @param payload - the data to send * @param payloadlen - the length of the data * @param qos - the QoS to send the publish at * @param retained - whether the message should be retained * @return success code - */ int publish(const char* topicName, void* payload, size_t payloadlen, enum QoS qos = QOS0, bool retained = false); /** MQTT Publish - send an MQTT publish packet and wait for all acks to complete for all QoSs * @param topic - the topic to publish to * @param payload - the data to send * @param payloadlen - the length of the data * @param id - the packet id used - returned * @param qos - the QoS to send the publish at * @param retained - whether the message should be retained * @return success code - */ int publish(const char* topicName, void* payload, size_t payloadlen, unsigned short& id, enum QoS qos = QOS1, bool retained = false); /** MQTT Subscribe - send an MQTT subscribe packet and wait for the suback * @param topicFilter - a topic pattern which can include wildcards * @param qos - the MQTT QoS to subscribe at * @param mh - the callback function to be invoked when a message is received for this subscription * @return success code - */ int subscribe(const char* topicFilter, enum QoS qos, messageHandler mh); /** MQTT Unsubscribe - send an MQTT unsubscribe packet and wait for the unsuback * @param topicFilter - a topic pattern which can include wildcards * @return success code - */ int unsubscribe(const char* topicFilter); /** MQTT Disconnect - send an MQTT disconnect packet, and clean up any state * @return success code - */ int disconnect(); /** A call to this API must be made within the keepAlive interval to keep the MQTT connection alive * yield can be called if no other MQTT operation is needed. This will also allow messages to be * received. * @param timeout_ms the time to wait, in milliseconds * @return success code - on failure, this means the client has disconnected */ int yield(unsigned long timeout_ms = 1000L); /** Is the client connected? * @return flag - is the client connected or not? */ bool isConnected() { return isconnected; } private: void cleanSession(); int cycle(Timer& timer); int waitfor(int packet_type, Timer& timer); int keepalive(); int publish(int len, Timer& timer, enum QoS qos); int decodePacket(int* value, int timeout); int readPacket(Timer& timer); int sendPacket(int length, Timer& timer); int deliverMessage(MQTTString& topicName, Message& message); bool isTopicMatched(char* topicFilter, MQTTString& topicName); Network& ipstack; unsigned long command_timeout_ms; unsigned char sendbuf[MAX_MQTT_PACKET_SIZE]; unsigned char readbuf[MAX_MQTT_PACKET_SIZE]; Timer last_sent, last_received; unsigned int keepAliveInterval; bool ping_outstanding; bool cleansession; PacketId packetid; struct MessageHandlers { const char* topicFilter; FP<void, MessageData&> fp; } messageHandlers[MAX_MESSAGE_HANDLERS]; // Message handlers are indexed by subscription topic FP<void, MessageData&> defaultMessageHandler; bool isconnected; #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2 unsigned char pubbuf[MAX_MQTT_PACKET_SIZE]; // store the last publish for sending on reconnect int inflightLen; unsigned short inflightMsgid; enum QoS inflightQoS; #endif #if MQTTCLIENT_QOS2 bool pubrel; #if !defined(MAX_INCOMING_QOS2_MESSAGES) #define MAX_INCOMING_QOS2_MESSAGES 10 #endif unsigned short incomingQoS2messages[MAX_INCOMING_QOS2_MESSAGES]; bool isQoS2msgidFree(unsigned short id); bool useQoS2msgid(unsigned short id); void freeQoS2msgid(unsigned short id); #endif }; } template<class Network, class Timer, int a, int MAX_MESSAGE_HANDLERS> void MQTT::Client<Network, Timer, a, MAX_MESSAGE_HANDLERS>::cleanSession() { ping_outstanding = false; for (int i = 0; i < MAX_MESSAGE_HANDLERS; ++i) messageHandlers[i].topicFilter = 0; isconnected = false; #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2 inflightMsgid = 0; inflightQoS = QOS0; #endif #if MQTTCLIENT_QOS2 pubrel = false; for (int i = 0; i < MAX_INCOMING_QOS2_MESSAGES; ++i) incomingQoS2messages[i] = 0; #endif } template<class Network, class Timer, int a, int MAX_MESSAGE_HANDLERS> MQTT::Client<Network, Timer, a, MAX_MESSAGE_HANDLERS>::Client(Network& network, unsigned int command_timeout_ms) : ipstack(network), packetid() { last_sent = Timer(); last_received = Timer(); this->command_timeout_ms = command_timeout_ms; cleanSession(); } #if MQTTCLIENT_QOS2 template<class Network, class Timer, int a, int b> bool MQTT::Client<Network, Timer, a, b>::isQoS2msgidFree(unsigned short id) { for (int i = 0; i < MAX_INCOMING_QOS2_MESSAGES; ++i) { if (incomingQoS2messages[i] == id) return false; } return true; } template<class Network, class Timer, int a, int b> bool MQTT::Client<Network, Timer, a, b>::useQoS2msgid(unsigned short id) { for (int i = 0; i < MAX_INCOMING_QOS2_MESSAGES; ++i) { if (incomingQoS2messages[i] == 0) { incomingQoS2messages[i] = id; return true; } } return false; } template<class Network, class Timer, int a, int b> void MQTT::Client<Network, Timer, a, b>::freeQoS2msgid(unsigned short id) { for (int i = 0; i < MAX_INCOMING_QOS2_MESSAGES; ++i) { if (incomingQoS2messages[i] == id) { incomingQoS2messages[i] = 0; return; } } } #endif template<class Network, class Timer, int a, int b> int MQTT::Client<Network, Timer, a, b>::sendPacket(int length, Timer& timer) { int rc = FAILURE, sent = 0; while (sent < length && !timer.expired()) { rc = ipstack.write(&sendbuf[sent], length - sent, timer.left_ms()); if (rc < 0) // there was an error writing the data break; sent += rc; } if (sent == length) { if (this->keepAliveInterval > 0) last_sent.countdown(this->keepAliveInterval); // record the fact that we have successfully sent the packet rc = SUCCESS; } else rc = FAILURE; #if defined(MQTT_DEBUG) char printbuf[150]; DEBUG("Rc %d from sending packet %s\n", rc, MQTTFormat_toServerString(printbuf, sizeof(printbuf), sendbuf, length)); #endif return rc; } template<class Network, class Timer, int a, int b> int MQTT::Client<Network, Timer, a, b>::decodePacket(int* value, int timeout) { unsigned char c; int multiplier = 1; int len = 0; const int MAX_NO_OF_REMAINING_LENGTH_BYTES = 4; *value = 0; do { int rc = MQTTPACKET_READ_ERROR; if (++len > MAX_NO_OF_REMAINING_LENGTH_BYTES) { rc = MQTTPACKET_READ_ERROR; /* bad data */ goto exit; } rc = ipstack.read(&c, 1, timeout); if (rc != 1) goto exit; *value += (c & 127) * multiplier; multiplier *= 128; } while ((c & 128) != 0); exit: return len; } /** * If any read fails in this method, then we should disconnect from the network, as on reconnect * the packets can be retried. * @param timeout the max time to wait for the packet read to complete, in milliseconds * @return the MQTT packet type, or -1 if none */ template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::readPacket(Timer& timer) { int rc = FAILURE; MQTTHeader header = {0}; int len = 0; int rem_len = 0; /* 1. read the header byte. This has the packet type in it */ if (ipstack.read(readbuf, 1, timer.left_ms()) != 1) goto exit; len = 1; /* 2. read the remaining length. This is variable in itself */ decodePacket(&rem_len, timer.left_ms()); len += MQTTPacket_encode(readbuf + 1, rem_len); /* put the original remaining length into the buffer */ if (rem_len > (MAX_MQTT_PACKET_SIZE - len)) { rc = BUFFER_OVERFLOW; goto exit; } /* 3. read the rest of the buffer using a callback to supply the rest of the data */ if (rem_len > 0 && (ipstack.read(readbuf + len, rem_len, timer.left_ms()) != rem_len)) goto exit; header.byte = readbuf[0]; rc = header.bits.type; if (this->keepAliveInterval > 0) last_received.countdown(this->keepAliveInterval); // record the fact that we have successfully received a packet exit: #if defined(MQTT_DEBUG) if (rc >= 0) { char printbuf[50]; DEBUG("Rc %d from receiving packet %s\n", rc, MQTTFormat_toClientString(printbuf, sizeof(printbuf), readbuf, len)); } #endif return rc; } // assume topic filter and name is in correct format // # can only be at end // + and # can only be next to separator template<class Network, class Timer, int a, int b> bool MQTT::Client<Network, Timer, a, b>::isTopicMatched(char* topicFilter, MQTTString& topicName) { char* curf = topicFilter; char* curn = topicName.lenstring.data; char* curn_end = curn + topicName.lenstring.len; while (*curf && curn < curn_end) { if (*curn == '/' && *curf != '/') break; if (*curf != '+' && *curf != '#' && *curf != *curn) break; if (*curf == '+') { // skip until we meet the next separator, or end of string char* nextpos = curn + 1; while (nextpos < curn_end && *nextpos != '/') nextpos = ++curn + 1; } else if (*curf == '#') curn = curn_end - 1; // skip until end of string curf++; curn++; }; return (curn == curn_end) && (*curf == '\0'); } template<class Network, class Timer, int a, int MAX_MESSAGE_HANDLERS> int MQTT::Client<Network, Timer, a, MAX_MESSAGE_HANDLERS>::deliverMessage(MQTTString& topicName, Message& message) { int rc = FAILURE; // we have to find the right message handler - indexed by topic for (int i = 0; i < MAX_MESSAGE_HANDLERS; ++i) { if (messageHandlers[i].topicFilter != 0 && (MQTTPacket_equals(&topicName, (char*)messageHandlers[i].topicFilter) || isTopicMatched((char*)messageHandlers[i].topicFilter, topicName))) { if (messageHandlers[i].fp.attached()) { MessageData md(topicName, message); messageHandlers[i].fp(md); rc = SUCCESS; } } } if (rc == FAILURE && defaultMessageHandler.attached()) { MessageData md(topicName, message); defaultMessageHandler(md); rc = SUCCESS; } return rc; } template<class Network, class Timer, int a, int b> int MQTT::Client<Network, Timer, a, b>::yield(unsigned long timeout_ms) { int rc = SUCCESS; Timer timer = Timer(); timer.countdown_ms(timeout_ms); while (!timer.expired()) { if (cycle(timer) < 0) { rc = FAILURE; break; } } return rc; } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::cycle(Timer& timer) { /* get one piece of work off the wire and one pass through */ // read the socket, see what work is due int packet_type = readPacket(timer); int len = 0, rc = SUCCESS; switch (packet_type) { case FAILURE: case BUFFER_OVERFLOW: rc = packet_type; break; case CONNACK: case PUBACK: case SUBACK: break; case PUBLISH: { MQTTString topicName = MQTTString_initializer; Message msg; int intQoS; if (MQTTDeserialize_publish((unsigned char*)&msg.dup, &intQoS, (unsigned char*)&msg.retained, (unsigned short*)&msg.id, &topicName, (unsigned char**)&msg.payload, (int*)&msg.payloadlen, readbuf, MAX_MQTT_PACKET_SIZE) != 1) goto exit; msg.qos = (enum QoS)intQoS; #if MQTTCLIENT_QOS2 if (msg.qos != QOS2) #endif deliverMessage(topicName, msg); #if MQTTCLIENT_QOS2 else if (isQoS2msgidFree(msg.id)) { if (useQoS2msgid(msg.id)) deliverMessage(topicName, msg); else WARN("Maximum number of incoming QoS2 messages exceeded"); } #endif #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2 if (msg.qos != QOS0) { if (msg.qos == QOS1) len = MQTTSerialize_ack(sendbuf, MAX_MQTT_PACKET_SIZE, PUBACK, 0, msg.id); else if (msg.qos == QOS2) len = MQTTSerialize_ack(sendbuf, MAX_MQTT_PACKET_SIZE, PUBREC, 0, msg.id); if (len <= 0) rc = FAILURE; else rc = sendPacket(len, timer); if (rc == FAILURE) goto exit; // there was a problem } break; #endif } #if MQTTCLIENT_QOS2 case PUBREC: case PUBREL: unsigned short mypacketid; unsigned char dup, type; if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, MAX_MQTT_PACKET_SIZE) != 1) rc = FAILURE; else if ((len = MQTTSerialize_ack(sendbuf, MAX_MQTT_PACKET_SIZE, (packet_type == PUBREC) ? PUBREL : PUBCOMP, 0, mypacketid)) <= 0) rc = FAILURE; else if ((rc = sendPacket(len, timer)) != SUCCESS) // send the PUBREL packet rc = FAILURE; // there was a problem if (rc == FAILURE) goto exit; // there was a problem if (packet_type == PUBREL) freeQoS2msgid(mypacketid); break; case PUBCOMP: break; #endif case PINGRESP: ping_outstanding = false; break; } keepalive(); exit: if (rc == SUCCESS) rc = packet_type; return rc; } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::keepalive() { int rc = FAILURE; if (keepAliveInterval == 0) { rc = SUCCESS; goto exit; } if (last_sent.expired() || last_received.expired()) { if (!ping_outstanding) { Timer timer(1000); int len = MQTTSerialize_pingreq(sendbuf, MAX_MQTT_PACKET_SIZE); if (len > 0 && (rc = sendPacket(len, timer)) == SUCCESS) // send the ping packet ping_outstanding = true; } } exit: return rc; } // only used in single-threaded mode where one command at a time is in process template<class Network, class Timer, int a, int b> int MQTT::Client<Network, Timer, a, b>::waitfor(int packet_type, Timer& timer) { int rc = FAILURE; do { if (timer.expired()) break; // we timed out } while ((rc = cycle(timer)) != packet_type); return rc; } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::connect(MQTTPacket_connectData& options) { Timer connect_timer(command_timeout_ms); int rc = FAILURE; int len = 0; if (isconnected) // don't send connect packet again if we are already connected goto exit; this->keepAliveInterval = options.keepAliveInterval; this->cleansession = options.cleansession; if ((len = MQTTSerialize_connect(sendbuf, MAX_MQTT_PACKET_SIZE, &options)) <= 0) goto exit; if ((rc = sendPacket(len, connect_timer)) != SUCCESS) // send the connect packet goto exit; // there was a problem if (this->keepAliveInterval > 0) last_received.countdown(this->keepAliveInterval); // this will be a blocking call, wait for the connack if (waitfor(CONNACK, connect_timer) == CONNACK) { unsigned char connack_rc = 255; bool sessionPresent = false; if (MQTTDeserialize_connack((unsigned char*)&sessionPresent, &connack_rc, readbuf, MAX_MQTT_PACKET_SIZE) == 1) rc = connack_rc; else rc = FAILURE; } else rc = FAILURE; #if MQTTCLIENT_QOS2 // resend any inflight publish if (inflightMsgid > 0 && inflightQoS == QOS2 && pubrel) { if ((len = MQTTSerialize_ack(sendbuf, MAX_MQTT_PACKET_SIZE, PUBREL, 0, inflightMsgid)) <= 0) rc = FAILURE; else rc = publish(len, connect_timer, inflightQoS); } else #endif #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2 if (inflightMsgid > 0) { memcpy(sendbuf, pubbuf, MAX_MQTT_PACKET_SIZE); rc = publish(inflightLen, connect_timer, inflightQoS); } #endif exit: if (rc == SUCCESS) isconnected = true; return rc; } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::connect() { MQTTPacket_connectData default_options = MQTTPacket_connectData_initializer; return connect(default_options); } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int MAX_MESSAGE_HANDLERS> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, MAX_MESSAGE_HANDLERS>::subscribe(const char* topicFilter, enum QoS qos, messageHandler messageHandler) { int rc = FAILURE; Timer timer(command_timeout_ms); int len = 0; MQTTString topic = {(char*)topicFilter, {0, 0}}; if (!isconnected) goto exit; len = MQTTSerialize_subscribe(sendbuf, MAX_MQTT_PACKET_SIZE, 0, packetid.getNext(), 1, &topic, (int*)&qos); if (len <= 0) goto exit; if ((rc = sendPacket(len, timer)) != SUCCESS) // send the subscribe packet goto exit; // there was a problem if (waitfor(SUBACK, timer) == SUBACK) // wait for suback { int count = 0, grantedQoS = -1; unsigned short mypacketid; if (MQTTDeserialize_suback(&mypacketid, 1, &count, &grantedQoS, readbuf, MAX_MQTT_PACKET_SIZE) == 1) rc = grantedQoS; // 0, 1, 2 or 0x80 if (rc != 0x80) { for (int i = 0; i < MAX_MESSAGE_HANDLERS; ++i) { if (messageHandlers[i].topicFilter == 0) { messageHandlers[i].topicFilter = topicFilter; messageHandlers[i].fp.attach(messageHandler); rc = 0; break; } } } } else rc = FAILURE; exit: if (rc != SUCCESS) cleanSession(); return rc; } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int MAX_MESSAGE_HANDLERS> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, MAX_MESSAGE_HANDLERS>::unsubscribe(const char* topicFilter) { int rc = FAILURE; Timer timer(command_timeout_ms); MQTTString topic = {(char*)topicFilter, {0, 0}}; int len = 0; if (!isconnected) goto exit; if ((len = MQTTSerialize_unsubscribe(sendbuf, MAX_MQTT_PACKET_SIZE, 0, packetid.getNext(), 1, &topic)) <= 0) goto exit; if ((rc = sendPacket(len, timer)) != SUCCESS) // send the unsubscribe packet goto exit; // there was a problem if (waitfor(UNSUBACK, timer) == UNSUBACK) { unsigned short mypacketid; // should be the same as the packetid above if (MQTTDeserialize_unsuback(&mypacketid, readbuf, MAX_MQTT_PACKET_SIZE) == 1) { rc = 0; // remove the subscription message handler associated with this topic, if there is one for (int i = 0; i < MAX_MESSAGE_HANDLERS; ++i) { if (messageHandlers[i].topicFilter && strcmp(messageHandlers[i].topicFilter, topicFilter) == 0) { messageHandlers[i].topicFilter = 0; break; } } } } else rc = FAILURE; exit: if (rc != SUCCESS) cleanSession(); return rc; } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::publish(int len, Timer& timer, enum QoS qos) { int rc; if ((rc = sendPacket(len, timer)) != SUCCESS) // send the publish packet goto exit; // there was a problem #if MQTTCLIENT_QOS1 if (qos == QOS1) { if (waitfor(PUBACK, timer) == PUBACK) { unsigned short mypacketid; unsigned char dup, type; if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, MAX_MQTT_PACKET_SIZE) != 1) rc = FAILURE; else if (inflightMsgid == mypacketid) inflightMsgid = 0; } else rc = FAILURE; } #elif MQTTCLIENT_QOS2 else if (qos == QOS2) { if (waitfor(PUBCOMP, timer) == PUBCOMP) { unsigned short mypacketid; unsigned char dup, type; if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, MAX_MQTT_PACKET_SIZE) != 1) rc = FAILURE; else if (inflightMsgid == mypacketid) inflightMsgid = 0; } else rc = FAILURE; } #endif exit: if (rc != SUCCESS) cleanSession(); return rc; } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::publish(const char* topicName, void* payload, size_t payloadlen, unsigned short& id, enum QoS qos, bool retained) { int rc = FAILURE; Timer timer(command_timeout_ms); MQTTString topicString = MQTTString_initializer; int len = 0; if (!isconnected) goto exit; topicString.cstring = (char*)topicName; #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2 if (qos == QOS1 || qos == QOS2) id = packetid.getNext(); #endif len = MQTTSerialize_publish(sendbuf, MAX_MQTT_PACKET_SIZE, 0, qos, retained, id, topicString, (unsigned char*)payload, payloadlen); if (len <= 0) goto exit; #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2 if (!cleansession) { memcpy(pubbuf, sendbuf, len); inflightMsgid = id; inflightLen = len; inflightQoS = qos; #if MQTTCLIENT_QOS2 pubrel = false; #endif } #endif rc = publish(len, timer, qos); exit: return rc; } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::publish(const char* topicName, void* payload, size_t payloadlen, enum QoS qos, bool retained) { unsigned short id = 0; // dummy - not used for anything return publish(topicName, payload, payloadlen, id, qos, retained); } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::publish(const char* topicName, Message& message) { return publish(topicName, message.payload, message.payloadlen, message.qos, message.retained); } template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b> int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::disconnect() { int rc = FAILURE; Timer timer(command_timeout_ms); // we might wait for incomplete incoming publishes to complete int len = MQTTSerialize_disconnect(sendbuf, MAX_MQTT_PACKET_SIZE); if (len > 0) rc = sendPacket(len, timer); // send the disconnect packet if (cleansession) cleanSession(); else isconnected = false; return rc; } #endif