├── README.md ├── examples ├── mqttSwitchBroker │ └── mqttSwitchBroker.ino ├── mqttqostest │ └── mqttqostest.ino ├── mqtttest │ └── mqtttest.ino └── threadtest │ └── testapps.ino ├── library.properties ├── license.txt └── src ├── MQTT.cpp ├── MQTT.h └── MQTT └── MQTT.h /README.md: -------------------------------------------------------------------------------- 1 | # MQTT for Photon, Spark Core 2 | MQTT publish/subscribe library for Photon, Argon, Tracker One...etc version 0.4.32. 3 | 4 | ## Source Code 5 | This lightweight library source code is only 2 files. firmware -> MQTT.cpp, MQTT.h. 6 | 7 | The application can use QoS 0, 1, 2 and the retain flag when publishing a message. 8 | 9 | ## Example 10 | Some sample sketches for Spark Core and Photon included (firmware/examples/). 11 | - mqtttest.ino : simple pub/sub sample. 12 | - mqttqostest.ino : QoS1, QoS2 publish and callback sample. 13 | - mqttSwitchBroker.ino : Example of how to switch to different brokers. 14 | - threadtest.ino : Example of SYSTEM_THREAD(ENABLED). 15 | 16 | ## developer examples 17 | some applications use MQTT with Photon. here are developer's reference examples. 18 | - Spark Core / Photon and CloudMQTT 19 | - MQTT Publish-Subscribe Using Rpi, ESP and Photon 20 | - Particle Photon on Watson IoT 21 | - Connecting IoT devices to the Watson Conversation Car-Dashboard app 22 | - ThingSpeak MQTT API 23 | - How to Connect a Particle Photon to the Losant IoT Platform 24 | - How I Hacked my Humidor with Losant and a Particle Photon 25 | - How to Build a Photon MQTT Logger 26 | - Particle and Ubidots using MQTT 27 | - Using Twilio Sync with MQTT on a Particle Photon 28 | 29 | ## sample source 30 | ``` 31 | #include "application.h" 32 | #include "MQTT.h" 33 | 34 | void callback(char* topic, byte* payload, unsigned int length); 35 | MQTT client("iot.eclipse.org", 1883, callback); 36 | 37 | // recieve message 38 | void callback(char* topic, byte* payload, unsigned int length) { 39 | char p[length + 1]; 40 | memcpy(p, payload, length); 41 | p[length] = NULL; 42 | 43 | if (!strcmp(p, "RED")) 44 | RGB.color(255, 0, 0); 45 | else if (!strcmp(p, "GREEN")) 46 | RGB.color(0, 255, 0); 47 | else if (!strcmp(p, "BLUE")) 48 | RGB.color(0, 0, 255); 49 | else 50 | RGB.color(255, 255, 255); 51 | delay(1000); 52 | } 53 | 54 | 55 | void setup() { 56 | RGB.control(true); 57 | 58 | // connect to the server(unique id by Time.now()) 59 | client.connect("sparkclient_" + String(Time.now())); 60 | 61 | // publish/subscribe 62 | if (client.isConnected()) { 63 | client.publish("outTopic/message","hello world"); 64 | client.subscribe("inTopic/message"); 65 | } 66 | } 67 | 68 | void loop() { 69 | if (client.isConnected()) 70 | client.loop(); 71 | } 72 | ``` 73 | ## FAQ 74 | ### Can't connect/publish/subscribe to the MQTT server? 75 | - Test your MQTT server and port (default 1883) with the mosquitto_pub/sub command. 76 | - Check your network environments. Make sure your MQTT server can reach the Internet through your firewall. 77 | - Verify your subscribe/publish topic name is correct. 78 | - Perhaps device firmware network stack is failed. check your firmware version and bugs. 79 | - If you are using MQTT-TLS, make sure your RooT CA pem file, client key, certifications is valid. 80 | - Several MQTT servers will disconnect the first connection when you use the same user_id. When the application calls the connect method, use a different user_id on every device as connect method's second argument. Using the MAC address as a user_id is suggested. 81 |

 82 |    // device.1
 83 |    client.connect("spark-client", "user_1", "password1");
 84 |    // other devices...
 85 |    client.connect("spark-client", "user_others", "password1");
 86 |

87 | 88 | ### I want to change MQTT keepalive timeout. 89 | MQTT keepalive timeout is defined "MQTT_DEFAULT_KEEPALIVE 15"(15 sec) in header file. You can change the keepalive timeout in constructor. 90 |

 91 |     MQTT client("server_name", 1883, callback); // default: send keepalive packet to MQTT server every 15sec.
 92 |     MQTT client("server_name", 1883, 256, 30, callback); // keepalive timeout is 30 seconds, default message size also added to be able to access correct constructor 
 93 |

94 | 95 | ### Want to use over the 255 byte message size. 96 | In this library, the maximum MQTT message size is defined as "MQTT_MAX_PACKET_SIZE 255" in the header file. If you want to use over 255 bytes, use the constructor's last argument. 97 |

 98 |     MQTT client("server_name", 1883, callback);      // default 255 bytes
 99 |     MQTT client("server_name", 1883, 512, callback); // max 512 bytes
100 |