diff options
| author | Alfred E. Heggestad <alfred.heggestad@gmail.com> | 2018-02-11 11:34:38 +0100 |
|---|---|---|
| committer | Alfred E. Heggestad <alfred.heggestad@gmail.com> | 2018-02-11 11:34:38 +0100 |
| commit | 7bcdfd0943bfeeb5400fcc3f88d3436faeca599d (patch) | |
| tree | d87d2ea92be7369b1ba118a7b50e86a40c089bba /modules | |
| parent | ac4736ec5be5ca60157ac075e02478a32ef56864 (diff) | |
mqtt: update README with correct JSON syntax (ref #356)
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/mqtt/README.md | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/modules/mqtt/README.md b/modules/mqtt/README.md index 6a86b84..ace3c36 100644 --- a/modules/mqtt/README.md +++ b/modules/mqtt/README.md @@ -6,7 +6,7 @@ This module implements an MQTT (Message Queue Telemetry Transport) client for publishing and subscribing to topics. -The module is using libmosquitto +The module is using libmosquitto. All messages are encoded in JSON format. Starting the MQTT broker: @@ -19,7 +19,7 @@ $ /usr/local/sbin/mosquitto -v Subscribing to all topics: ``` -$ mosquitto_sub -t /baresip/+ +$ mosquitto_sub -v -t /baresip/# ``` @@ -43,17 +43,16 @@ $ mosquitto_pub -t /baresip/xxx -m foo=42 ## Examples ``` -/baresip/event sip:aeh@iptel.org,REGISTERING -/baresip/event sip:aeh@iptel.org,REGISTER_OK -/baresip/event sip:aeh@iptel.org,SHUTDOWN +/baresip/event {"type":"REGISTERING","class":"register","accountaor":"sip:aeh@iptel.org"} +/baresip/event {"type":"REGISTER_OK","class":"register","accountaor":"sip:aeh@iptel.org","param":"200 OK"} +/baresip/event {"type":"SHUTDOWN","class":"application","accountaor":"sip:aeh@iptel.org"} ``` ``` mosquitto_pub -t /baresip/command -m "/dial music" -/baresip/command /dial music -/baresip/command_resp (null) -/baresip/event sip:aeh@iptel.org,CALL_ESTABLISHED -/baresip/event sip:aeh@iptel.org,CALL_CLOSED +/baresip/command {"command":"dial","params":"music","token":"123"} +/baresip/command_resp/123 (null) +/baresip/event {"type":"CALL_ESTABLISHED","class":"call","accountaor":"sip:aeh@iptel.org","direction":"outgoing","peeruri":"sip:music@iptel.org","id":"4d758140c42c5d55","param":"sip:music@iptel.org"} +/baresip/event {"type":"CALL_CLOSED","class":"call","accountaor":"sip:aeh@iptel.org","direction":"outgoing","peeruri":"sip:music@iptel.org","id":"4d758140c42c5d55","param":"Connection reset by user"} ``` - |