-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some Information about the paho stack
- Loading branch information
Showing
1 changed file
with
21 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,23 @@ | ||
/** | ||
* @defgroup pkg_paho_mqtt PAHO MQTT framework | ||
* @ingroup pkg | ||
* @brief The Eclipse Paho project provides open-source client implementations of MQTT for embedded systems | ||
* @see https://github.com/eclipse/paho.mqtt.embedded-c | ||
* | ||
* The Eclipse Paho project provides open-source client | ||
* implementations of MQTT. | ||
@defgroup pkg_paho_mqtt PAHO MQTT framework | ||
@ingroup pkg | ||
@brief The Eclipse Paho project provides open-source client implementations of MQTT for embedded systems | ||
@see https://github.com/eclipse/paho.mqtt.embedded-c | ||
|
||
The Eclipse Paho project provides open-source client | ||
implementations of MQTT. | ||
|
||
# Supported MQTT Protocol Version | ||
|
||
The supported protocol version of the used paho.mqtt.embedded-c stack is | ||
- MQTT-Version = 3.1 (MQTTVersion struct member of MQTTPacket_connectData = 3) | ||
- MQTT-Version = 3.1.1 (MQTTVersion struct member of MQTTPacket_connectData = 4) | ||
|
||
# Implementation specific information | ||
|
||
- The Main-Loop is running in the Task mqtt_riot_run() with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) | ||
and an default duration of 10ms (PAHO_MQTT_YIELD_MS) | ||
- During publish a topic with MQTTPublish() and QoS>0, the functions blocks until | ||
it receive des One Acknowledge (QoS=1) or two Acknowledges (Qos=2). | ||
|
||
*/ |