myDevicesIoT
The Cayenne MQTT mbed Library provides functions to easily connect to the Cayenne IoT project builder.
Dependents: Cayenne-ESP8266Interface Cayenne-WIZnet_Library Cayenne-WIZnetInterface Cayenne-X-NUCLEO-IDW01M1 ... more
Diff: src/CayenneMQTTClient/CayenneMQTTClient.h
- Revision:
- 1:90dccf306268
- Parent:
- 0:09ef59d2d0f7
- Child:
- 2:c0419dbecfbd
--- a/src/CayenneMQTTClient/CayenneMQTTClient.h Fri Oct 07 17:21:45 2016 +0000
+++ b/src/CayenneMQTTClient/CayenneMQTTClient.h Fri Oct 07 22:24:51 2016 +0000
@@ -36,7 +36,15 @@
CayenneValuePair values[CAYENNE_MAX_MESSAGE_VALUES];
size_t valueCount;
} MessageData;
-
+
+ /**
+ * Client class for connecting to Cayenne via MQTT.
+ * @class MQTTClient
+ * @param Network A network class with the methods: read, write. See NetworkInterface.h for function definitions.
+ * @param Timer A timer class with the methods: countdown_ms, countdown, left_ms, expired. See TimerInterface.h for function definitions.
+ * @param MAX_MQTT_PACKET_SIZE Maximum size of an MQTT message, in bytes.
+ * @param MAX_MESSAGE_HANDLERS Maximum number of message handlers.
+ */
template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE = 128, int MAX_MESSAGE_HANDLERS = 5>
class MQTTClient : private MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, 0>
{