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

[Documentation] Markdown improvements for bindings a to e (#13859)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-07 21:09:32 +01:00
committed by GitHub
parent 72efc1cfed
commit caf71f72e6
86 changed files with 1740 additions and 1822 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
bundles/org.openhab.binding.enigma2/README.md
View File

@@ -24,7 +24,7 @@ Enigma2 has the following configuration parameters:
| Name | Description | Mandatory |
|-----------------|----------------------------------------------------|-----------|
| host | Hostname or IP address of the Enigma2 device | yes |
| host | Hostname or IP address of the Enigma2 device | yes |
| refreshInterval | The refresh interval in seconds | yes |
| timeout | The timeout for reading from the device in seconds | yes |
| user | Optional: The Username of the Enigma2 Web API | no |
@@ -34,7 +34,7 @@ Enigma2 has the following configuration parameters:
Set the parameters as in the following example:
```
```java
Thing enigma2:device:192_168_0_3 [host="192.168.1.3", refreshInterval="5", timeout="5", user="usename" , password="***"]
```
@@ -56,13 +56,13 @@ Thing enigma2:device:192_168_0_3 [host="192.168.1.3", refreshInterval="5", timeo
demo.things:
```
```java
Thing enigma2:device:192_168_0_3 [host="192.168.1.3", refreshInterval="5"]
```
demo.items:
```
```java
Switch Enigma2_Power "Power: [%s]" <switch> { channel="enigma2:device:192_168_0_3:power" }
Dimmer Enigma2_Volume "Volume: [%d %%]" <soundvolume> { channel="enigma2:device:192_168_0_3:volume" }
Switch Enigma2_Mute "Mute: [%s]" <soundvolume_mute> { channel="enigma2:device:192_168_0_3:mute" }
@@ -80,7 +80,7 @@ String Enigma2_SendInfo "Info" <text> { a
demo.sitemap:
```
```perl
sitemap demo label="Enigma2 Demo"
{
Frame label="Enigma2" {
@@ -122,10 +122,9 @@ sitemap demo label="Enigma2 Demo"
}
```
demo.rules:
```
```java
rule "Enigma2_KeyS"
when Item Enigma2_RemoteKeys received command
then
@@ -199,7 +198,7 @@ Multiple actions are supported by this binding. In classic rules these are acces
Example
```
```java
val actions = getActions("enigma2","enigma2:device:192_168_0_3")
if(null === actions) {
logInfo("actions", "Actions not found, check thing ID")
@@ -219,7 +218,7 @@ Parameters:
Example:
```
```java
actions.sendInfo("Hello World")
```
@@ -236,7 +235,7 @@ Parameters:
Example:
```
```java
actions.sendInfo("Hello World", 10)
```
@@ -252,7 +251,7 @@ Parameters:
Example:
```
```java
actions.sendWarning("Hello World")
```
@@ -269,7 +268,7 @@ Parameters:
Example:
```
```java
actions.sendWarning("Hello World", 10)
```
@@ -285,7 +284,7 @@ Parameters:
Example:
```
```java
actions.sendError("Hello World")
```
@@ -302,7 +301,7 @@ Parameters:
Example:
```
```java
actions.sendError("Hello World", 10)
```
@@ -319,7 +318,7 @@ Parameters:
Example:
```
```java
actions.sendQuestion("Say hello?")
```
@@ -337,7 +336,7 @@ Parameters:
Example:
```
```java
actions.sendQuestion("Say hello?", 10)
```
@@ -351,7 +350,6 @@ Parameters:
|---------|------------------------------------------------------------------------|
| button | see the supported buttons in chapter 'Remote Control Buttons' |
The button parameter has only been tested on a Vu+Solo2 and this is a list of button codes that are known to work with this device.
| Code String |
@@ -403,7 +401,6 @@ The button parameter has only been tested on a Vu+Solo2 and this is a list of bu
Example:
```
```java
actions.sendRcCommand("KEY_1")
```