Skip to content

Commit

Permalink
Update doc.txt
Browse files Browse the repository at this point in the history
Add some Information about the paho stack
  • Loading branch information
DeJusten authored Jan 14, 2025
1 parent e09a800 commit f111627
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions pkg/paho-mqtt/doc.txt
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

Check failure on line 6 in pkg/paho-mqtt/doc.txt

View workflow job for this annotation

GitHub Actions / static-tests

trailing whitespace.
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)

Check failure on line 15 in pkg/paho-mqtt/doc.txt

View workflow job for this annotation

GitHub Actions / static-tests

trailing whitespace.
# Implementation specific information

- The Main-Loop is running in the Task mqtt_riot_run() with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS)

Check failure on line 18 in pkg/paho-mqtt/doc.txt

View workflow job for this annotation

GitHub Actions / static-tests

trailing whitespace.
and an default duration of 10ms (PAHO_MQTT_YIELD_MS)
- During publish a topic with MQTTPublish() and QoS>0, the functions blocks until

Check failure on line 20 in pkg/paho-mqtt/doc.txt

View workflow job for this annotation

GitHub Actions / static-tests

trailing whitespace.
it receive des One Acknowledge (QoS=1) or two Acknowledges (Qos=2).

*/

0 comments on commit f111627

Please sign in to comment.