Markdown Documentation fixes (openhab#17526)

Signed-off-by: Leo Siepel <[email protected]>
psmedley · Oct 10, 2024 · 20b889c · 20b889c
1 parent 7a5ba4e
commit 20b889c
Show file tree

Hide file tree

Showing 105 changed files with 466 additions and 555 deletions.
diff --git a/bundles/org.openhab.binding.adorne/README.md b/bundles/org.openhab.binding.adorne/README.md
@@ -73,7 +73,7 @@ Remember that the host and port parameter are not needed in most cases.
 As discussed above care is taken that the brightness channel only allows values from 1 to 100 by specifying a min and max value in the sitemap for the dimmers.
 For this example to run on an openHAB version older than 2.5 Bedroom 1's Slider must be removed in the sitemap since older versions don't support the min/max setting.
 
-## demo.things
+## `demo.things` Example
 
 ```java
 Bridge adorne:hub:home "Adorne Hub" [host="192.160.1.111", port=2113] {
@@ -83,7 +83,7 @@ Bridge adorne:hub:home "Adorne Hub" [host="192.160.1.111", port=2113] {
 }
 ```
 
-## demo.items
+## `demo.items` Example
 
 ```java
 Switch LightBathroom {channel="adorne:switch:home:bathroom:power"}
@@ -93,7 +93,7 @@ Switch LightBedroomSwitch2 {channel="adorne:dimmer:home:bedroom2:power"}
 Dimmer LightBedroomDimmer2 {channel="adorne:dimmer:home:bedroom2:brightness"}
 ```
 
-## demo.sitemap
+## `demo.sitemap` Example
 
 ```perl
 sitemap demo label="Adorne Binding Demo"

diff --git a/bundles/org.openhab.binding.ahawastecollection/README.md b/bundles/org.openhab.binding.ahawastecollection/README.md
@@ -99,7 +99,6 @@ actions:
         var papierDate = items['collectionDay_paper'].getZonedDateTime();
         var restmuellDate = items['collectionDay_generalWaste'].getZonedDateTime();
 
-
         // Check which waste types are collected on the next day
         var biomuellCollection = biomuellDate.equals(tomorrow);
         var leichtverpackungCollection = leichtverpackungDate.equals(tomorrow);
@@ -125,7 +124,6 @@ actions:
           toBeCollected.push('general waste');
         }
 
-
         // Send message (or something else) if at least one waste type is collected
         if (toBeCollected.length > 0) {
             var message = "Tomorrow the following waste will be collected:\n" + toBeCollected.join(', ');

diff --git a/bundles/org.openhab.binding.airgradient/README.md b/bundles/org.openhab.binding.airgradient/README.md
@@ -101,7 +101,6 @@ These configuration settings needs AirGradient firmware on the sensor of version
 | model                 | String               | Read/Write | The model of the device (can be changed e.g. if you change sensors)              |
 | led-bar-test          | String               | Write      | Trigger test of LED bar                                                          |
 
-
 ## Full Example
 
 ### Thing Configuration
@@ -118,5 +117,3 @@ Bridge airgradient:airgradient-api:home "My Home" [ token="abc123...." ] {
 Number:Density      AirGradient_Location_PM2        "%.0f kg/m³"                         <density>       {channel="airgradient:location:654321:pm2"}"
 Number:Temperature  AirGradient_Location_PM2        "Temperature [%.1f °C]"              <temperature>   {channel="airgradient:location:654321:atmp"}"
 ```
-
-
diff --git a/bundles/org.openhab.binding.amberelectric/README.md b/bundles/org.openhab.binding.amberelectric/README.md
@@ -20,27 +20,27 @@ As a minimum, the IP address is needed:
 
 ## Channels
 
-| channel id             | type                 | description                                                                     |
-|------------------------|----------------------|---------------------------------------------------------------------------------|
-| electricity-price      | Number:EnergyPrice   | Current price to import power from the grid
-| controlled-load-price  | Number:EnergyPrice   | Current price to import power for Controlled Load
-| feed-in-price          | Number:EnergyPrice   | Current price to export power to the grid
-| electricity-status     | String               | Current price status of grid import
-| controlled-load-status | String               | Current price status of controlled load import
-| feed-in-status         | String               | Current price status of Feed-In
-| nem-time               | String               | NEM time of last pricing update
-| renewables             | Number:Dimensionless | Current level of renewables in the grid
-| spike                  | Switch               | Report if the grid has a current price spike
+| channel id             | type                 | description                                       |
+|------------------------|----------------------|---------------------------------------------------|
+| electricity-price      | Number:EnergyPrice   | Current price to import power from the grid       |
+| controlled-load-price  | Number:EnergyPrice   | Current price to import power for Controlled Load |
+| feed-in-price          | Number:EnergyPrice   | Current price to export power to the grid         |
+| electricity-status     | String               | Current price status of grid import               |
+| controlled-load-status | String               | Current price status of controlled load import    |
+| feed-in-status         | String               | Current price status of Feed-In                   |
+| nem-time               | String               | NEM time of last pricing update                   |
+| renewables             | Number:Dimensionless | Current level of renewables in the grid           |
+| spike                  | Switch               | Report if the grid has a current price spike      |
 
 ## Full Example
 
-### `amberelectric.things`:
+### `amberelectric.things`
 
 ```java
 amberelectric:service:AmberElectric [ apiKey="psk_xxxxxxxxxxxxxxxxxxxx" ]
 ```
 
-### `amberelectric.items`:
+### `amberelectric.items`
 
 ```java
 Number:EnergyPrice AmberElectric_ElectricityPrice { channel="amberelectric:service:AmberElectric:electricity-price" }
@@ -54,7 +54,7 @@ Number AmberElectric_Renewables { channel="amberelectric:service:AmberElectric:r
 Switch AmberElectric_Spike { channel="amberelectric:service:AmberElectric:spike" }
 ```
 
-### `amberelectric.sitemap`:
+### `amberelectric.sitemap`
 
 ```perl
 Text item=AmberElectric_ElectricityPrice label="Electricity Price"

diff --git a/bundles/org.openhab.binding.ambientweather/README.md b/bundles/org.openhab.binding.ambientweather/README.md
@@ -149,7 +149,6 @@ Number:Temperature WS1400IP_IndoorTemperature "Indoor Temperature [%.1f %unit%]"
 Number:Dimensionless WS1400IP_IndoorHumidity "Indoor Humidity [%.1f %%]" { channel="ambientweather:ws1400ip:account:1400:indoorSensor#relativeHumidity" }
 String WS1400IP_IndoorBattery "Indoor Battery [MAP(ambient-battery.map):%s]" { channel="ambientweather:ws1400ip:account:1400:indoorSensor#batteryIndicator" }
 
-
 // WS-8482 Weather Station
 String WS8482_StationName "Station Name [%s]" { channel="ambientweather:ws8482:ws8482:station#name" }
 String WS8482_StationLocation "Station Location [%s]" { channel="ambientweather:ws8482:ws8482:station#location" }

diff --git a/bundles/org.openhab.binding.androiddebugbridge/README.md b/bundles/org.openhab.binding.androiddebugbridge/README.md
@@ -152,7 +152,7 @@ This is a sample:
 
 Not all the [arguments](https://developer.android.com/studio/command-line/adb#IntentSpec) are supported. Please open an issue or pull request if you need more.
 
-### Available key-event values:
+### Available key-event values
 
 - KEYCODE_0
 - KEYCODE_1

diff --git a/bundles/org.openhab.binding.androidtv/README.md b/bundles/org.openhab.binding.androidtv/README.md
@@ -85,7 +85,6 @@ Thing androidtv:philipstv:bedroom [ ipAddress="192.168.1.4" ]
 | ambilightTopColor    | Color  | Color for top Ambilight Side         |    N/A   |    N/A   |     RW    |
 | ambilightBottomColor | Color  | Color for bottom Ambilight Side      |    N/A   |    N/A   |     RW    |
 
-
 ```java
 String ShieldTV_KEYBOARD "KEYBOARD [%s]" { channel = "androidtv:shieldtv:livingroom:keyboard" }
 String ShieldTV_KEYPRESS "KEYPRESS [%s]" { channel = "androidtv:shieldtv:livingroom:keypress" }

diff --git a/bundles/org.openhab.binding.anthem/README.md b/bundles/org.openhab.binding.anthem/README.md
@@ -12,7 +12,6 @@ The following thing type is supported:
 
 Tested models include the AVM-60 11.2-channel preamp/processor.
 
-
 ## Thing Configuration
 
 The following configuration parameters are available on the Anthem thing:
@@ -49,18 +48,17 @@ The Anthem AV processor supports the following channels (some zones/channels are
 | 2#activeInputShortName  | String  | Short friendly name of the active input  |
 | 2#activeInputLongName   | String  | Long friendly name of the active input   |
 
-
 ## Full Example
 
 ### Things
 
-```
+```java
 Thing anthem:anthem:mediaroom "Anthem AVM 60" [ host="192.168.1.100" ]
 ```
 
 ### Items
 
-```
+```java
 String  Anthem_Command                    "Command [%s]"                           { channel="anthem:anthem:mediaroom:general#command" }
 
 Switch  Anthem_Z1_Power                   "Zone 1 Power [%s]"                      { channel="anthem:anthem:mediaroom:1#power" }

diff --git a/bundles/org.openhab.binding.argoclima/README.md b/bundles/org.openhab.binding.argoclima/README.md
@@ -115,7 +115,6 @@ Thing argoclima:remote:argoHvacRemote "Argo HVAC (via Argo remote API)" @ "Livin
     password="<yourArgoPassword>"
 ]
 
-
 Thing argoclima:local:argoHvacLocalDirect "Argo HVAC (connected locally)" @ "Living Room" [
     hostname="192.168.0.3"
 ]
@@ -149,7 +148,6 @@ Thing argoclima:local:argoHvacLocalWithPassthroughIndirect "Argo HVAC (accessibl
     useLocalConnection=false
 ]
 
-
 Thing argoclima:local:argoHvacLocalWithPassthroughPlusDirectEx "Argo HVAC (accessible both indirectly and directly, via pass-through mode, with explicit options)" [
     hostname="192.168.0.3",             // Direct address of the device (reachable from openHAB)
     connectionMode="REMOTE_API_PROXY",
@@ -171,7 +169,6 @@ Thing argoclima:local:argoHvacLocalWithPassthroughPlusDirectEx "Argo HVAC (acces
     oemServerPort=80
 ]
 
-
 Thing argoclima:local:argoHvacLocalWithStub "Argo HVAC (accessible both indirectly and directly with a stub) - **RECOMMENDED MODE**" [
     hostname="192.168.0.3",           // Has to be reachable, since useLocalConnection is true (default)
     connectionMode="REMOTE_API_STUB",

diff --git a/bundles/org.openhab.binding.astro/README.md b/bundles/org.openhab.binding.astro/README.md
@@ -137,7 +137,6 @@ e.g `sun#astroDawn earliest=6:00, latest=20:00 forceEvent=true`
 
 astronomic dawn start is null but `earliest` is set to 06:00 so the event/datetime value is set to 06:00.
 
-
 ## Full Example
 
 Things:

diff --git a/bundles/org.openhab.binding.asuswrt/README.md b/bundles/org.openhab.binding.asuswrt/README.md
@@ -43,7 +43,6 @@ Firmware 5.x.x (some DSL models) is NOT supported (not Asuswrt).
 | macAddress      | text    | Unique MAC address of the device      | N/A                 | yes      | no       |
 | clientNick      | text    | Nickname used by OH                   | N/A                 | no       | no       |
 
-
 ## Properties
 
 All devices support some of the following properties:
@@ -53,7 +52,6 @@ All devices support some of the following properties:
 | vendor           | Vendor of device             | router, client                        |
 | dnsName          | DNS name of device           | router, client                        |
 
-
 ## Channels
 
 All devices support some of the following channels:
@@ -84,7 +82,6 @@ All devices support some of the following channels:
 |                  | total-rx             | Number:DataAmount      | Data received since reboot in MB           | interface, client                 |
 |                  | total-tx             | Number:DataAmount      | Data sent since reboot in MB               | interface, client                 |
 
-
 ## Events
 
 All devices support some of the following Events:

diff --git a/bundles/org.openhab.binding.automower/README.md b/bundles/org.openhab.binding.automower/README.md
@@ -13,7 +13,7 @@ All Husqvarna Automower models with "Automower Connect" should be supported. It
 
 ## Discovery
 
-Once the bridge is created and configured, OpenHab will automatically discover all Automowers registered on your account.
+Once the bridge is created and configured, openHAB will automatically discover all Automowers registered on your account.
 
 ## Thing Configuration
 

diff --git a/bundles/org.openhab.binding.bluetooth.daikinmadoka/README.md b/bundles/org.openhab.binding.bluetooth.daikinmadoka/README.md
@@ -56,7 +56,7 @@ _Note that it is planned to generate some part of this based on the XML files wi
 
 ## Full Example
 
-### daikinmadoka.things:
+### `daikinmadoka.things` Example
 
 ```java
 Bridge bluetooth:dbusbluez:hci0 [ address="00:1A:7D:DA:71:13" ]
@@ -65,7 +65,7 @@ Thing bluetooth:brc1h:hci0:salon (bluetooth:dbusbluez:hci0)     [ address="00:CC
 
 ```
 
-### daikinmadoka.items:
+### `daikinmadoka.items` Example
 
 ```java
 Group g_climSalon "Salon" [ "Thermostat" ]

diff --git a/bundles/org.openhab.binding.bluetooth.radoneye/README.md b/bundles/org.openhab.binding.bluetooth.radoneye/README.md
@@ -32,17 +32,16 @@ Following channels are supported for `RadonEye` thing:
 | ------------------ | ------------------------ | ------------------------------------------- |
 | radon              | Number:Density           | The measured radon level                    |
 
-
 ## Example
 
 radoneye.things (assuming you have a Bluetooth bridge with the ID `bluetooth:bluegiga:adapter1`:
 
-```
+```java
 bluetooth:radoneye_rd200:adapter1:sensor1  "radoneye Wave Plus Sensor 1" (bluetooth:bluegiga:adapter1) [ address="12:34:56:78:9A:BC", refreshInterval=300 ]
 ```
 
 radoneye.items:
 
-```
+```java
 Number:Density          radon    "Radon level [%d %unit%]"   { channel="bluetooth:radoneye_rd200:adapter1:sensor1:radon" }
 ```
diff --git a/bundles/org.openhab.binding.boschshc/README.md b/bundles/org.openhab.binding.boschshc/README.md
@@ -313,15 +313,13 @@ The smoke detector warns you in case of fire.
 | low-battery       | Switch      | &#9744;  | Indicates whether the battery is low (`ON`) or OK (`OFF`).                                                                                                                                                                  |
 | signal-strength   | Number      | &#9744;  | Communication quality between the device and the Smart Home Controller. Possible values range between 0 (unknown) and 4 (best signal strength).                                                                             |
 
-
 ### User-defined States
 
 User-defined states enable automations to be better adapted to specific needs and everyday situations.
 Individual states can be activated/deactivated and can be used as triggers, conditions and actions in automations.
 
 **Thing Type ID**: `user-defined-state`
 
-
 | Channel Type ID | Item Type | Writable | Description                                |
 |-----------------|-----------| :------: |--------------------------------------------|
 | user-state      | Switch    | &#9745;  | Switches the User-defined state on or off. |
@@ -402,7 +400,7 @@ The log can also be called using the following command.
 tail -f /var/log/openhab/openhab.log /var/log/openhab/events.log
 ```
 
-Alternatively, the log can be viewed using the OpenHab Log Viewer (frontail) via <http://openhab:9001>.
+Alternatively, the log can be viewed using the openHAB Log Viewer (frontail) via <http://openhab:9001>.
 
 Example:
 

diff --git a/bundles/org.openhab.binding.chatgpt/README.md b/bundles/org.openhab.binding.chatgpt/README.md
@@ -40,7 +40,6 @@ Each channel of type `chat` takes the following configuration parameters:
 | systemMessage   | text    | The system message helps set the behavior of the assistant.                                                                                                | N/A           | no       | no       |
 | maxTokens       | decimal | The maximum number of tokens to generate in the completion.                                                                                                | 500           | no       | yes      |
 
-
 ## Full Example
 
 ### Thing Configuration

diff --git a/bundles/org.openhab.binding.deutschebahn/README.md b/bundles/org.openhab.binding.deutschebahn/README.md
@@ -162,7 +162,6 @@ String Zug1_Trip_FilterFlags "Filter" (zug1Fahrt) {channel="deutschebahn:train:t
 String Zug1_Trip_TripType "Fahrttyp" (zug1Fahrt) {channel="deutschebahn:train:timetableLehrte:lehrteZug1:trip#trip-type"}
 String Zug1_Trip_Owner "Unternehmen" (zug1Fahrt) {channel="deutschebahn:train:timetableLehrte:lehrteZug1:trip#owner"}
 
-
 // Arrival Information
 DateTime Zug1_Arrival_Plannedtime "Geplante Zeit" (zug1Ankunft) {channel="deutschebahn:train:timetableLehrte:lehrteZug1:arrival#planned-time"}
 DateTime Zug1_Arrival_Changedtime "Geänderte Zeit" (zug1Ankunft) {channel="deutschebahn:train:timetableLehrte:lehrteZug1:arrival#changed-time"}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -137,7 +137,6 @@ e.g `sun#astroDawn earliest=6:00, latest=20:00 forceEvent=true`

		astronomic dawn start is null but `earliest` is set to 06:00 so the event/datetime value is set to 06:00.


		## Full Example

		Things:
Expand Down