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

[Documentation] Markdown improvements t to z (#14371)

Browse Source 
* Apply markdown fixes for bindings with letter _t_
* Apply markdown fixes for bindings with letter _u_
* Apply markdown fixes for bindings with letter _v_
* Apply markdown fixes for bindings with letter _w_
* Apply markdown fixes for bindings with letter _x_
* Apply markdown fixes for bindings with letter _y_
* Apply markdown fixes for bindings with letter _z_

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2023-04-11 12:54:54 +02:00
committed by GitHub
parent 69a09ed825
commit ce3f673380
54 changed files with 1655 additions and 1778 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
bundles/org.openhab.binding.yioremote/README.md
View File

@@ -1,6 +1,6 @@
# YIOremote Binding
This binding will control a YIO Dock/Remote combination. YIO Remote/Dock is a smart home solution that includes an IP based remote. More information can be found at [yio-remote](https://www.yio-remote.com/) or in the forums at [yio-remote](https://community.yio-remote.com/).
This binding will control a YIO Dock/Remote combination. YIO Remote/Dock is a smart home solution that includes an IP based remote. More information can be found at [yio-remote](https://www.yio-remote.com/) or in the forums at [yio-remote](https://community.yio-remote.com/).
This binding has been designed to compliment the YIO websocket Transport Protocol.
@@ -8,27 +8,27 @@ Since this binding allows actual you to trigger IR send/receive actions on YIO D
## Supported Things
* Thing Type ID: `yioRemoteDock`
- Thing Type ID: `yioRemoteDock`
The following are the configurations available to each of the bridges/things:
### YIO Dock
| Name | Type | Required | Default | Description |
|-----------------------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------|
| host | string | Yes | (None) | Host/IP Address or host name of the YIO Dock |
| accesstoken | string | Yes | 0 | The authentication token for the access currently 0 |
| Name | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | --------------------------------------------------- |
| host | string | Yes | (None) | Host/IP Address or host name of the YIO Dock |
| accesstoken | string | Yes | 0 | The authentication token for the access currently 0 |
## Channels
### YIO Dock
The YIO Dock has the following channels:
| Channel | Input/Output | Item Type | Description |
|---------------------------|---------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| receiverswitch | Input | Switch | The switch to enable disable the IR receiving diode/function |
| status | Output | String | The status of the YIO Dock. If the reciever is on than the recognized IR code will be displayed otherwise the IR send status is displayed of the last IR code send. |
| Channel | Input/Output | Item Type | Description |
| -------------- | ------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| receiverswitch | Input | Switch | The switch to enable disable the IR receiving diode/function |
| status | Output | String | The status of the YIO Dock. If the reciever is on than the recognized IR code will be displayed otherwise the IR send status is displayed of the last IR code send. |
# Actions
@@ -36,20 +36,20 @@ With the YIO remote action, you can send IR Codes via the YIO Remote Dock.
## Example
```
```java
rule "yioremote Action Example"
when
...
then
val actions = getActions("yioremote", "yioremote:yioRemoteDock:livingroom")
if (actions === null)
{
......
}
else
{
actions.sendIRCode("3;0x20DF40BF;32;0")
}
val actions = getActions("yioremote", "yioremote:yioRemoteDock:livingroom")
if (actions === null)
{
......
}
else
{
actions.sendIRCode("3;0x20DF40BF;32;0")
}
end
```
@@ -57,22 +57,22 @@ end
.things
```
yioremote:yioRemoteDock:livingroom [ host="xxx.xxx.xxx.xxx", accesstoken="0" ]
```java
yioremote:yioRemoteDock:livingroom [ host="xxx.xxx.xxx.xxx", accesstoken="0" ]
```
.items
```
Switch receiverswitch "IR recieving switch" {channel="yioremote:yioRemoteDock:livingroom:input# receiverswitch"}
String status "YIO Dock status[%s]" {channel="yioremote:yioRemoteDock:livingroom:output# status"}
```java
Switch receiverswitch "IR recieving switch" {channel="yioremote:yioRemoteDock:livingroom:input# receiverswitch"}
String status "YIO Dock status[%s]" {channel="yioremote:yioRemoteDock:livingroom:output# status"}
```
.sitemap
```
```perl
sitemap Basic label="YIO Dock" {
Switch item= receiverswitch
Text item= status
Switch item=receiverswitch
Text item=status
}
```