Skip to content

documentation: Document MQTT-C with Mbed TLS usage.#18729

Merged
xiaoxiang781216 merged 1 commit intoapache:masterfrom
arjav1528:dev-issue-18708
Apr 14, 2026
Merged

documentation: Document MQTT-C with Mbed TLS usage.#18729
xiaoxiang781216 merged 1 commit intoapache:masterfrom
arjav1528:dev-issue-18708

Conversation

@arjav1528
Copy link
Copy Markdown
Contributor

Fixes #18708

Summary

Adds Kconfig guidance (CONFIG_CRYPTO_MBEDTLS, CONFIG_NETUTILS_MQTTC, CONFIG_NETUTILS_MQTTC_WITH_MBEDTLS, related example options), describes mqttc_pub TLS behavior (including default port 8883 and -c for a CA PEM file), documents the mqttc_mbedtls_pub upstream example, and cross-links the mqttc example page and the mbedtls overview page.

Impact

  • Users: Can follow the docs to enable and run MQTT-C over TLS with mbedTLS.
  • Build / hardware: None.
  • Documentation: New and expanded RST under Documentation/applications/netutils/mqttc/, Documentation/applications/examples/mqttc/, and Documentation/applications/crypto/mbedtls/.
  • Security / compatibility: None (docs only; notes embedded test CA caveat where relevant).

Testing

  • ./tools/checkpatch.sh -f on the modified RST files (passes).
  • Documentation: make html under Documentation/ and spot-check rendered pages in a browser (recommended).

Note: Please adhere to Contributing Guidelines.

Add Kconfig guidance, mqttc_pub TLS options and default port, the
mqttc_mbedtls_pub example, and cross-links between the mqttc example and mbedtls overview pages

Signed-off-by: Arjav Patel <arjav1528@gmail.com>
@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium labels Apr 14, 2026
@xiaoxiang781216 xiaoxiang781216 merged commit ea161e4 into apache:master Apr 14, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCUMENTATION] Add Documentation about how to use MQTTC with mbedTLS

3 participants