Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[xmppclient] Improved readme file #5722

Merged
merged 2 commits into from
Jun 17, 2019
Merged

[xmppclient] Improved readme file #5722

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1deadb
Improved readme
pavel-gololobov Jun 13, 2019
fc0fd32
fix tables
pavel-gololobov Jun 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions bundles/org.openhab.binding.xmppclient/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,31 @@ xmppBridge - Basic XMPP (Jabber) client thing, that can send and receive message

## Thing Configuration

**xmppBridge** parameters:
Sample configurations:

| 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" [ username="openhab", domain="example.com", password="********" ] {
Channels:
Trigger String : xmpp_command [ separator="##" ]
}
```

```
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 |
J-N-K marked this conversation as resolved.
Show resolved Hide resolved
|----------|-------------|------|------|------|
| 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

Expand Down