]> git.basschouten.com Git - openhab-addons.git/commitdiff
Fix alignment/indentation (#13994)
authorJacob Laursen <jacob-github@vindvejr.dk>
Sun, 18 Dec 2022 09:22:07 +0000 (10:22 +0100)
committerGitHub <noreply@github.com>
Sun, 18 Dec 2022 09:22:07 +0000 (10:22 +0100)
Fixes #13882

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
bundles/org.openhab.binding.flicbutton/README.md
bundles/org.openhab.binding.foobot/README.md
bundles/org.openhab.binding.fsinternetradio/README.md
bundles/org.openhab.binding.haywardomnilogic/README.md
bundles/org.openhab.binding.hdpowerview/README.md
bundles/org.openhab.binding.heos/README.md
bundles/org.openhab.binding.http/README.md
bundles/org.openhab.binding.jellyfin/README.md

index 36416cbef591f90c28ec0272b51c945224dd59ad..8ead359c455e9a073818d9fe87e0868ad69a0e06 100644 (file)
@@ -95,8 +95,8 @@ demo.things:
 
 ```java
 Bridge flicbutton:flicd-bridge:local-flicd {
- Thing button flic_livingroom "Yellow Button Living Room" [address = "60:13:B3:02:18:BD"]
- Thing button flic_kitchen "Black Button Kitchen" [address = "B5:7E:59:78:86:9F"]
   Thing button flic_livingroom "Yellow Button Living Room" [address = "60:13:B3:02:18:BD"]
   Thing button flic_kitchen "Black Button Kitchen" [address = "B5:7E:59:78:86:9F"]
 }
 ```
 
index 7390e8e71795831d189532c405177d8f915b08a6..24a78586314964397b8f376f17e1e5b56341a545 100644 (file)
@@ -23,11 +23,11 @@ The discovery process is able to automatically discover all devices associated w
 
 Bridge has the following configuration parameters:
 
-| Parameter        | Description                                           | Required
-|------------------|-------------------------------------------------------|----------
-| apikey           | API Key from <https://api.foobot.io/apidoc/index.html>  | Mandatory
-| username         | The e-mail address used to log into the Foobot App    | Mandatory
-| refreshInterval  | Refresh interval in minutes, minimal 5 minutes        | Optional, the default value is 8 minutes.
+| Parameter        | Description                                            | Required
+|------------------|--------------------------------------------------------|----------
+| apikey           | API Key from <https://api.foobot.io/apidoc/index.html> | Mandatory
+| username         | The e-mail address used to log into the Foobot App     | Mandatory
+| refreshInterval  | Refresh interval in minutes, minimal 5 minutes         | Optional, the default value is 8 minutes.
 
 The minimal refresh rate is 5 minutes because the device only sends data every 5 minutes.
 The default is 8 minutes. This will get you through the day with the default rate limit of 200 calls per day.
index 050d35a25514f3d0ac341f8c129a961f47442daa..faff89dc76f43b5b8fad3cccb741837966e3b6dd 100644 (file)
@@ -110,14 +110,14 @@ demo.sitemap:
 ```perl
 sitemap demo label="Main Menu"
 {
- Frame {
-  Switch item=RadioPower
-  Slider visibility=[RadioPower==ON] item=RadioVolume
-  Switch visibility=[RadioPower==ON] item=RadioMute
-  Selection visibility=[RadioPower==ON] item=RadioPreset mappings=[0="Favourit 1", 1="Favourit 2", 2="Favourit 3", 3="Favourit 4"]
-  Selection visibility=[RadioPower==ON] item=RadioMode mappings=[0="Internet Radio", 1="Musik Player", 2="DAB", 3="FM", 4="AUX"]
-  Text visibility=[RadioPower==ON] item=RadioInfo1
-  Text visibility=[RadioPower==ON] item=RadioInfo2
- }
   Frame {
+        Switch item=RadioPower
+        Slider visibility=[RadioPower==ON] item=RadioVolume
+        Switch visibility=[RadioPower==ON] item=RadioMute
+        Selection visibility=[RadioPower==ON] item=RadioPreset mappings=[0="Favourit 1", 1="Favourit 2", 2="Favourit 3", 3="Favourit 4"]
+        Selection visibility=[RadioPower==ON] item=RadioMode mappings=[0="Internet Radio", 1="Musik Player", 2="DAB", 3="FM", 4="AUX"]
+        Text visibility=[RadioPower==ON] item=RadioInfo1
+        Text visibility=[RadioPower==ON] item=RadioInfo2
   }
 }
 ```
index 6e51c98e043cf8457a39080c2ec055415f87f687..4f7939528408961e41ed3ddbbcfb62e7b255ffee 100644 (file)
@@ -29,13 +29,13 @@ The binding will automatically discover the Omnilogic pool things from the cloud
 
 Hayward OmniLogic Connection Parameters:
 
-| Property             | Default                                                        | Required | Description                                  |
-|----------------------|----------------------------------------------------------------|----------|----------------------------------------------|
+| Property             | Default                                                          | Required | Description                                  |
+|----------------------|------------------------------------------------------------------|----------|----------------------------------------------|
 | Host Name            | <https://app1.haywardomnilogic.com/HAAPI/HomeAutomation/API.ash> | Yes      | Host name of the Hayward API server          |
-| User Name            | None                                                           | Yes      | Your Hayward User Name (not email address)   |
-| Password             | None                                                           | Yes      | Your Hayward User Password                   |
-| Telemetry Poll Delay | 12                                                             | Yes      | Telemetry Poll Delay (10-60 seconds)         |
-| Alarm Poll Delay     | 60                                                             | Yes      | Alarm Poll Delay (0-120 seconds, 0 disabled) |
+| User Name            | None                                                             | Yes      | Your Hayward User Name (not email address)   |
+| Password             | None                                                             | Yes      | Your Hayward User Password                   |
+| Telemetry Poll Delay | 12                                                               | Yes      | Telemetry Poll Delay (10-60 seconds)         |
+| Alarm Poll Delay     | 60                                                               | Yes      | Alarm Poll Delay (0-120 seconds, 0 disabled) |
 
 ## Channels
 
index ab6881c1cc4e565d16a919d20231ca25add7c34a..a11c9dd108322317f99e3ca4dfc0fac410112527 100644 (file)
@@ -130,16 +130,16 @@ Depending on whether the shade is a top-down, bottom-up, left-right, right-left,
 |-----------------------------|-------------------|-----------------------|------------------|----------------|-------------------|----------------------|
 | Single action<br>bottom-up  | `position`        | ▲                     | Up               | `OPEN`         | 0%                | ▲                    |
 |                             |                   | ▼                     | Down             | `CLOSED`       | 100%              | ▼                    |
-| Single action<br>top-down   | `position`        | ▲                     | Up               | **`CLOSED`** | 0%                | ▲                    |
-|                             |                   | ▼                     | Down             | **`OPEN`**   | 100%              | ▼                    |
+| Single action<br>top-down   | `position`        | ▲                     | Up               | **`CLOSED`**   | 0%                | ▲                    |
+|                             |                   | ▼                     | Down             | **`OPEN`**     | 100%              | ▼                    |
 | Single action<br>right-left | `position`        | ▲                     | _**Left**_       | `OPEN`         | 0%                | ▲                    |
 |                             |                   | ▼                     | _**Right**_      | `CLOSED`       | 100%              | ▼                    |
 | Single action<br>left-right | `position`        | ▲                     | _**Right**_      | `OPEN`         | 0%                | ▲                    |
 |                             |                   | ▼                     | _**Left**_       | `CLOSED`       | 100%              | ▼                    |
 | Dual action<br>(lower rail) | `position`        | ▲                     | Up               | `OPEN`         | 0%                | ▲                    |
 |                             |                   | ▼                     | Down             | `CLOSED`       | 100%              | ▼                    |
-| Dual action<br>(upper rail) | _**`secondary`**_ | ▲                     | Up               | **`CLOSED`** | 0%<sup>1)</sup>   | ![dual_action arrow_right](doc/right.png)   |
-|                             |                   | ▼                     | Down             | **`OPEN`**   | 100%<sup>1)</sup> | ![dual_action arrow_left](doc/left.png)    |
+| Dual action<br>(upper rail) | _**`secondary`**_ | ▲                     | Up               | **`CLOSED`**   | 0%<sup>1)</sup>   | ![dual_action arrow_right](doc/right.png) |
+|                             |                   | ▼                     | Down             | **`OPEN`**     | 100%<sup>1)</sup> | ![dual_action arrow_left](doc/left.png)   |
 | Blackout panel ('DuoLite')  | _**`secondary`**_ | ▲                     | Up               | `OPEN`         | 0%                | ▲                    |
 |                             |                   | ▼                     | Down             | `CLOSED`       | 100%              | ▼                    |
 
index 62663e3ebf5b4ee71decd0df892865c97b3c9a22..bedbc959409287614a4ec04db7c67b9a37084d10 100644 (file)
@@ -103,9 +103,9 @@ To ensure that the players and groups are attached to the bridge the definition
 
 ```java
 Bridge heos:bridge:main "Bridge" [ipAddress="192.168.0.1", username="userName", password="123456"] {
- player Kitchen "Kitchen"[pid="434523813"]
- player LivingRoom "Living Room"[pid="918797451"]
- group 813793755 "Ground Level"[members="434523813;918797451"]
   player Kitchen "Kitchen"[pid="434523813"]
   player LivingRoom "Living Room"[pid="918797451"]
   group 813793755 "Ground Level"[members="434523813;918797451"]
 }
 ```
 
@@ -269,16 +269,16 @@ String LivingRoom_Playlists {channel="heos:player:main:LivingRoom:Playlists"}
 ### demo.sitemap
 
 ```perl
-   Frame label="LivingRoom" {
-     Default item=LivingRoom_Control
-     Default item=LivingRoom_Mute
-     Default item=LivingRoom_Volume
-     Default item=LivingRoom_Title
-     Default item=LivingRoom_Interpret
-     Default item=LivingRoom_Album
-        Selection item=LivingRoom_Favorites     label="Favorite" icon="music"
-        Selection item=LivingRoom_Playlists     label="Playlist" icon="music"
-    }
+Frame label="LivingRoom" {
+    Default item=LivingRoom_Control
+    Default item=LivingRoom_Mute
+    Default item=LivingRoom_Volume
+    Default item=LivingRoom_Title
+    Default item=LivingRoom_Interpret
+    Default item=LivingRoom_Album
+    Selection item=LivingRoom_Favorites label="Favorite" icon="music"
+    Selection item=LivingRoom_Playlists label="Playlist" icon="music"
+}
 ```
 
 ## Detailed Explanation
@@ -318,17 +318,18 @@ Rule for kitchen:
 
 ```java
 rule "Play AuxIn from Living Room"
- when
-  Item HeosKitchen_InputSelect received command
- then
-  if (receivedCommand.toString == "aux_in_1") {
-   sendCommand(HeosKitchen_Input, "aux_in_1")
-
-  } if (receivedCommand.toString == "LivingRoom") {
-   sendCommand(HeosBridge_Play_Living, ON)
-   sendCommand(HeosKitchen_Input, "aux_in_1")
-   sendCommand(HeosBridge_Play_Living, OFF) //Switch player channel off again to be sure that it is OFF
-  }
+when
+    Item HeosKitchen_InputSelect received command
+then
+    if (receivedCommand.toString == "aux_in_1") {
+        sendCommand(HeosKitchen_Input, "aux_in_1")
+    }
+    if (receivedCommand.toString == "LivingRoom") {
+        sendCommand(HeosBridge_Play_Living, ON)
+        sendCommand(HeosKitchen_Input, "aux_in_1")
+        sendCommand(HeosBridge_Play_Living, OFF) //Switch player channel off again to be sure that it is OFF
+    }
+end
 ```
 
 Sitemap:
@@ -373,18 +374,18 @@ Sitemap:
 ```perl
 Frame label="Heos Group" visibility=[HeosGroup_Status==ONLINE] {
 
- Default item=HeosGroup1_Player
- Default item=HeosGroup1_Volume
- Default item=HeosGroup1_Mute
- Default item=HeosGroup1_Favorites
- Default item=HeosGroup1_Playlist
-
- Text item=HeosGroup1_Song {
-  Default item=HeosGroup1_Song
-  Default item=HeosGroup1_Artist
-  Default item=HeosGroup1_Album
-  Image item=HeosGroup1_Cover url=""
- }
   Default item=HeosGroup1_Player
   Default item=HeosGroup1_Volume
   Default item=HeosGroup1_Mute
   Default item=HeosGroup1_Favorites
   Default item=HeosGroup1_Playlist
+
   Text item=HeosGroup1_Song {
+        Default item=HeosGroup1_Song
+        Default item=HeosGroup1_Artist
+        Default item=HeosGroup1_Album
+        Image item=HeosGroup1_Cover url=""
   }
 
 }
 ```
index b0e4e79ea7ff745b7e4a8c5b74290baac7af75b8..b2388246fec31efb209ace5413d340636694bbbd 100644 (file)
@@ -179,10 +179,10 @@ http://www.domain.org/home/lights/23871/?status=OFF&date=2020-07-06
 
 ```java
 Thing http:url:foo "Foo" [
- baseURL="https://example.com/api/v1/metadata-api/web/metadata",
- headers="key1=value1", "key2=value2", "key3=value3",
- refresh=15] {
-  Channels:
-   Type string : text "Text" [ stateTransformation="JSONPATH:$.metadata.data" ]
   baseURL="https://example.com/api/v1/metadata-api/web/metadata",
   headers="key1=value1", "key2=value2", "key3=value3",
   refresh=15] {
+        Channels:
+         Type string : text "Text" [ stateTransformation="JSONPATH:$.metadata.data" ]
 }
 ```
index a43661f91abb5db6abcf1b3b5b5242283bead8ee..e485f26dd9ee6d7a1e27206b0a8776d733a8fe2e 100644 (file)
@@ -87,11 +87,11 @@ Also, you can target a specific series episode by season and episode numbers pre
 
 ```java
 Bridge jellyfin:server:exampleServerId "Jellyfin Server" [
- clientActiveWithInSeconds=0,
- hostname="192.168.1.177",
- port=8096,
- refreshSeconds=30,
- ssl="false"
   clientActiveWithInSeconds=0,
   hostname="192.168.1.177",
   port=8096,
   refreshSeconds=30,
   ssl="false"
     token=XXXXX # Optional, read bellow
     userId=XXXXX # Optional, read bellow
 ]