pkg/paho-mqtt: Update doc.txt #21136
Conversation
Add some Information about the paho stack
github-actions
bot
added
Area: network
| @see https://github.com/eclipse/paho.mqtt.embedded-c | ||
|
|
||
| The Eclipse Paho project provides open-source client | ||
| implementations of MQTT. |
There was a problem hiding this comment.
Isn't that redundant to the @brief text?
There was a problem hiding this comment.
It is duplicated. However, I only removed the asterisk here. The rest is original
There was a problem hiding this comment.
I'd still remove the duplicated sentence here.
|
Thanks for the contribution and improvement - and welcome to RIOT! And sorry for my somewhat pedantic review: actually I thought to review a PR my a fellow RIOT maintainer. 😅 |
|
ping @DeJusten I think some simple fixes are needed to get in. |
Thanks for correcting. Next time I will pay attention to correct pronunciation Co-authored-by: Oleg Hahm <[email protected]>
Also thanks for the correction Co-authored-by: Oleg Hahm <[email protected]>
pkg/paho-mqtt/doc.txt
Outdated
| - MQTT-Version = 3.1 (MQTTVersion struct member of MQTTPacket_connectData = 3) | ||
| - MQTT-Version = 3.1.1 (MQTTVersion struct member of MQTTPacket_connectData = 4) |
There was a problem hiding this comment.
So two different MQTT versions are supported? Then I would prefer plural in the sentence above.
There was a problem hiding this comment.
That's correct. But I don't know how to change this in this stage.
There was a problem hiding this comment.
please see #21176 (comment)
| - 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 |
There was a problem hiding this comment.
| # Implementation specific information | |
| # Implementation-specific information |
pkg/paho-mqtt/doc.txt
Outdated
|
|
||
| # Implementation specific information | ||
|
|
||
| - The main loop is running in a dedicated thread (` paho_mqtt_riot`) in the function `mqtt_riot_run()` with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) |
There was a problem hiding this comment.
| - The main loop is running in a dedicated thread (` paho_mqtt_riot`) in the function `mqtt_riot_run()` with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) | |
| - The main loop is running in a dedicated thread (`paho_mqtt_riot`) in the function `mqtt_riot_run()` with a default cycle of 30ms (MQTT_YIELD_POLLING_MS) |
can these defaults be changed? If so, could you briefly state how?
pkg/paho-mqtt/doc.txt
Outdated
| # Implementation specific information | ||
|
|
||
| - The main loop is running in a dedicated thread (` paho_mqtt_riot`) in the function `mqtt_riot_run()` with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) | ||
| and an default duration of 10ms (PAHO_MQTT_YIELD_MS) |
There was a problem hiding this comment.
| and an default duration of 10ms (PAHO_MQTT_YIELD_MS) | |
| and a default duration of 10ms (PAHO_MQTT_YIELD_MS) |
Also I'm not sure I understand what you mean by cycle and duration here. Are those special MQTT terms?
pkg/paho-mqtt/doc.txt
Outdated
| - The main loop is running in a dedicated thread (` paho_mqtt_riot`) in the function `mqtt_riot_run()` with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) | ||
| and an default duration of 10ms (PAHO_MQTT_YIELD_MS) | ||
| - When publishing a topic with `MQTTPublish()` and QoS>0, the functions blocks until | ||
| it one acknowledgement (QoS=1) or two acknowledgements (QoS=2) are received.. |
There was a problem hiding this comment.
| it one acknowledgement (QoS=1) or two acknowledgements (QoS=2) are received.. | |
| one (QoS=1) or two acknowledgements (QoS=2) are received. |
| * @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 |
There was a problem hiding this comment.
I'm not sure whether the stars are needed. Let's see what CI makes out of it.
There was a problem hiding this comment.
Looks good, so no need to change: https://ci.riot-os.org/results/715889b6444d498aa4654678cab2fb99/doc-preview/group__pkg__paho__mqtt.html
mguetschow
added
the
CI: ready for build
Add some Information about the paho stack in the doc.txt file
Contribution description
Testing procedure
Issues/PRs references