Skip to content

Commit

Permalink
[xmppclient] Improved readme file (openhab#5722)
Browse files Browse the repository at this point in the history
* Improved readme

Signed-off-by: Pavel Gololobov <pavel@ochat.org>
Signed-off-by: Maximilian Hess <mail@ne0h.de>
  • Loading branch information
pavel-gololobov authored and ne0h committed Sep 15, 2019
1 parent 222e82c commit da0e0e8
Showing 1 changed file with 27 additions and 11 deletions.
38 changes: 27 additions & 11 deletions bundles/org.openhab.binding.xmppclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit da0e0e8

Please sign in to comment.