public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[remoteopenhab] Connection to the remote server through openHAB Cloud (#10138)

Browse Source 
Fix #10055

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
This commit is contained in:
lolodomo
2021-02-14 20:00:14 +01:00
committed by GitHub
parent b9c5a0d158
commit 944682d1f1
6 changed files with 112 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
bundles/org.openhab.binding.remoteopenhab/README.md
View File

@@ -42,12 +42,18 @@ The `server` thing has the following configuration parameters:
| useHttps | no | Set to true if you want to use HTTPS to communicate with the remote openHAB server. Default is false. |
| port | yes | The HTTP port to use to communicate with the remote openHAB server. Default is 8080. |
| trustedCertificate | no | Set to true if you want to use HTTPS even without a valid SSL certificate provided by your remote server. |
| restPath | yes | The subpath of the REST API on the remote openHAB server. Default is /rest |
| restPath | yes | The subpath of the REST API on the remote openHAB server. Default is "/rest/" |
| token | no | The token to use when the remote openHAB server is setup to require authorization to run its REST API. |
| username | no | The username to use when the remote openHAB server is setup to require basic authorization to run its REST API. |
| password | no | The password to use when the remote openHAB server is setup to require basic authorization to run its REST API. |
| authenticateAnyway | no | Set it to true in case you want to pass authentication information even when the communicate with the remote openHAB server is not secured (only HTTP). This is of course not recommended especially if your connection is over the Internet. Default is false. |
| accessibilityInterval | no | Minutes between checking the remote server accessibility. 0 to disable the check. Default is 3. |
| aliveInterval | no | Number of last minutes to consider when monitoring the receipt of events from the remote server. If an event is received during this interval, the remote server is considered alive and its accessibility will not be verified. Use 0 to disable this feature. Default is 5. |
| restartIfNoActivity | no | Set it to true if you want to restart the connection (SSE) to the remote server when no events are received in the monitored interval. It is not necessary if the goal is to properly handle a short network outage (few seconds). This can be useful if you want to deal with a long network outage. Do not enable it if you remote server does not send events during the monitored interval under normal conditions, it will cause frequent restart of the connection and potential loss of events. Default is false. |
Please note that even though the default configuration is based on insecure communication over HTTP, it is recommended to adjust the configuration to be based on secure communication over HTTPS.
This is of course essential if your connection to the remote openHAB server is over the Internet.
The `thing` thing has the following configuration parameters:
| Parameter | Required | Description |
@@ -55,7 +61,8 @@ The `thing` thing has the following configuration parameters:
| thingUID | yes | The thing UID in the remote openHAB server. |
| buildTriggerChannels | no | If set to true, a trigger channel will be automatically created and linked to each trigger channel from the remote thing. Default is true. |
Please note that if your remote server is an openHAB v3 server, you will need to define a valid token on your bridge thing to have your things correctly initialized.
Please note that if your remote server is an openHAB v3 server, in order for all of your things to be properly initialized, you will need to define on your bridge thing a valid API token in the parameter `token` and also define the parameter `authenticateAnyway` to true in case you are using an unsecured connection (HTTP).
This API token can be created on your remote server using Main UI.
Setting the `buildTriggerChannels` parameter to false is for the main following advanced usages: