From da0e0e837e57a1aa703b42ecad5540451e55443f Mon Sep 17 00:00:00 2001 From: "Pavel V. Gololobov" Date: Mon, 17 Jun 2019 15:05:10 +0300 Subject: [PATCH] [xmppclient] Improved readme file (#5722) * Improved readme Signed-off-by: Pavel Gololobov Signed-off-by: Maximilian Hess --- .../org.openhab.binding.xmppclient/README.md | 38 +++++++++++++------ 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/bundles/org.openhab.binding.xmppclient/README.md b/bundles/org.openhab.binding.xmppclient/README.md index 412f8613ef54d..db7d9c04a2fd6 100644 --- a/bundles/org.openhab.binding.xmppclient/README.md +++ b/bundles/org.openhab.binding.xmppclient/README.md @@ -8,24 +8,40 @@ xmppBridge - Basic XMPP (Jabber) client thing, that can send and receive message ## Thing Configuration -**xmppBridge** parameters: +Sample configurations: + +``` +Bridge xmppclient:xmppBridge:xmpp "XMPP Client" [ username="openhab", domain="example.com", password="********" ] { + Channels: + Trigger String : xmpp_command [ separator="##" ] +} +``` -| Name | Label | Description | Required | -|----------|-------------|------|------| -| host | Server Hostname/IP | The IP/Hostname of the XMPP server | true | -| port | XMPP server Port | The typical port is 5222 | true | -| username | Username | The XMPP username | true | -| password | Password | The XMPP password | true | +``` +Bridge xmppclient:xmppBridge:xmpp "XMPP Client" [ host="xmpp.example.com", port=7222, username="openhab", domain="example.com", password="********" ] { + Channels: + Trigger String : xmpp_command [ separator="##" ] +} +``` + +**xmppBridge** parameters: +| Name | Label | Description | Required | Default value | +|----------|--------------------|-------------------------------------------|-----------|-----------------------| +| username | Username | The XMPP username (left part of JID) | true | - | +| domain | Domain | The XMPP domain name (right part of JID) | true | - | +| password | Password | The XMPP user password | true | - | +| host | Server Hostname/IP | The IP/Hostname of the XMPP server | false | as "domain" parameter | +| port | XMPP server Port | The typical port is 5222 | false | 5222 | ## Channels **publishTrigger** parameters: -| Name | Label | Description | Required | -|----------|-------------|------|------| -| payload | Payload condition | An optional condition on the value | false | -| separator | Separator character | The trigger channel payload usually only contains the received text. If you define a separator character, for example '#', the sender UID and received text will be in the trigger channel payload. For example: pavel@example.com#My Message Text | false | +| Name | Label | Description | Required | +|-----------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| payload | Payload condition | An optional condition on the value | false | +| separator | Separator character | The trigger channel payload usually only contains the received text. If you define a separator character, for example '#', the sender UID and received text will be in the trigger channel payload. For example: pavel@example.com#My Message Text | false | ## Example Rules