]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
mqtt: fix mqtt.md wording and add clearer explanation
authorMarwan Yassini <yassinimarwan6@gmail.com>
Tue, 29 Oct 2024 17:22:03 +0000 (17:22 +0000)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 30 Oct 2024 07:44:05 +0000 (08:44 +0100)
Some of the wording in the mqtt.md confused me as to how the commands
were used and what they did, so I cleared up some of the wording to
better explain what each command does.

Closes #15451

docs/internals/MQTT.md

index a1bc4b349ef3bc91fa7bbc29ec438276f56036c3..58a3585662215905fc24e4c3556da8b9e0528b7a 100644 (file)
@@ -9,19 +9,35 @@ SPDX-License-Identifier: curl
 ## Usage
 
 A plain "GET" subscribes to the topic and prints all published messages.
+
 Doing a "POST" publishes the post data to the topic and exits.
 
+
+### Subscribing
+Command usage:
+    
+    curl mqtt://host/topic
+
 Example subscribe:
 
     curl mqtt://host.home/bedroom/temp
 
+This will send an MQTT SUBSCRIBE packet for the topic `bedroom/temp` and listen in for incoming PUBLISH packets.
+
+### Publishing
+Command usage:
+
+    curl -d payload mqtt://host/topic
+
 Example publish:
 
     curl -d 75 mqtt://host.home/bedroom/dimmer
 
+This will send an MQTT PUBLISH packet to the topic `bedroom/dimmer` with the payload `75`.
+
 ## What does curl deliver as a response to a subscribe
 
-It outputs two bytes topic length (MSB | LSB), the topic followed by the
+Whenever a PUBLISH packet is received, curl outputs two bytes topic length (MSB | LSB), the topic followed by the
 payload.
 
 ## Caveats