Skip to content

Commit

Permalink
Correction of the documentation according to the suggestions
Browse files Browse the repository at this point in the history
Update pkg/paho-mqtt/doc.txt

Also thanks for the correction

Update pkg/paho-mqtt/doc.txt

Thanks for correcting. Next time I will pay attention to correct pronunciation

Update doc.txt

Add some Information about the paho stack

Co-Authored-By: Oleg Hahm <[email protected]>
  • Loading branch information
DeJusten and OlegHahm committed Feb 12, 2025
1 parent e09a800 commit 7f0cdc3
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions pkg/paho-mqtt/doc.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
/**
* @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 versions

The supported protocol versions of the used paho.mqtt.embedded-c stack are
- 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 runs in a dedicated thread (`paho_mqtt_riot`) in the function `mqtt_riot_run()` with a default cycle of 30ms (MQTT_YIELD_POLLING_MS)
and a default duration of 10ms (PAHO_MQTT_YIELD_MS)
- When publishing a topic with `MQTTPublish()` and QoS>0, the function blocks until an acknowledgement (QoS=1) or two confirmations (QoS=2) were received

*/

0 comments on commit 7f0cdc3

Please sign in to comment.