Skip to content

Commit 20b889c

Browse files
lsiepellsiepel
authored
Markdown Documentation fixes (openhab#17526)
Signed-off-by: Leo Siepel <[email protected]>
1 parent 7a5ba4e commit 20b889c

File tree

105 files changed

+466
-555
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+466
-555
lines changed

‎bundles/org.openhab.binding.adorne/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Remember that the host and port parameter are not needed in most cases.
7373
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.
7474
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.
7575

76-
## demo.things
76+
## `demo.things` Example
7777

7878
```java
7979
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] {
8383
}
8484
```
8585

86-
## demo.items
86+
## `demo.items` Example
8787

8888
```java
8989
Switch LightBathroom {channel="adorne:switch:home:bathroom:power"}
@@ -93,7 +93,7 @@ Switch LightBedroomSwitch2 {channel="adorne:dimmer:home:bedroom2:power"}
9393
Dimmer LightBedroomDimmer2 {channel="adorne:dimmer:home:bedroom2:brightness"}
9494
```
9595

96-
## demo.sitemap
96+
## `demo.sitemap` Example
9797

9898
```perl
9999
sitemap demo label="Adorne Binding Demo"

‎bundles/org.openhab.binding.ahawastecollection/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,6 @@ actions:
9999
var papierDate = items['collectionDay_paper'].getZonedDateTime();
100100
var restmuellDate = items['collectionDay_generalWaste'].getZonedDateTime();
101101
102-
103102
// Check which waste types are collected on the next day
104103
var biomuellCollection = biomuellDate.equals(tomorrow);
105104
var leichtverpackungCollection = leichtverpackungDate.equals(tomorrow);
@@ -125,7 +124,6 @@ actions:
125124
toBeCollected.push('general waste');
126125
}
127126
128-
129127
// Send message (or something else) if at least one waste type is collected
130128
if (toBeCollected.length > 0) {
131129
var message = "Tomorrow the following waste will be collected:\n" + toBeCollected.join(', ');

‎bundles/org.openhab.binding.airgradient/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ These configuration settings needs AirGradient firmware on the sensor of version
101101
| model | String | Read/Write | The model of the device (can be changed e.g. if you change sensors) |
102102
| led-bar-test | String | Write | Trigger test of LED bar |
103103

104-
105104
## Full Example
106105

107106
### Thing Configuration
@@ -118,5 +117,3 @@ Bridge airgradient:airgradient-api:home "My Home" [ token="abc123...." ] {
118117
Number:Density AirGradient_Location_PM2 "%.0f kg/m³" <density> {channel="airgradient:location:654321:pm2"}"
119118
Number:Temperature AirGradient_Location_PM2 "Temperature [%.1f °C]" <temperature> {channel="airgradient:location:654321:atmp"}"
120119
```
121-
122-

‎bundles/org.openhab.binding.amberelectric/README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,27 @@ As a minimum, the IP address is needed:
2020

2121
## Channels
2222

23-
| channel id | type | description |
24-
|------------------------|----------------------|---------------------------------------------------------------------------------|
25-
| electricity-price | Number:EnergyPrice | Current price to import power from the grid
26-
| controlled-load-price | Number:EnergyPrice | Current price to import power for Controlled Load
27-
| feed-in-price | Number:EnergyPrice | Current price to export power to the grid
28-
| electricity-status | String | Current price status of grid import
29-
| controlled-load-status | String | Current price status of controlled load import
30-
| feed-in-status | String | Current price status of Feed-In
31-
| nem-time | String | NEM time of last pricing update
32-
| renewables | Number:Dimensionless | Current level of renewables in the grid
33-
| spike | Switch | Report if the grid has a current price spike
23+
| channel id | type | description |
24+
|------------------------|----------------------|---------------------------------------------------|
25+
| electricity-price | Number:EnergyPrice | Current price to import power from the grid |
26+
| controlled-load-price | Number:EnergyPrice | Current price to import power for Controlled Load |
27+
| feed-in-price | Number:EnergyPrice | Current price to export power to the grid |
28+
| electricity-status | String | Current price status of grid import |
29+
| controlled-load-status | String | Current price status of controlled load import |
30+
| feed-in-status | String | Current price status of Feed-In |
31+
| nem-time | String | NEM time of last pricing update |
32+
| renewables | Number:Dimensionless | Current level of renewables in the grid |
33+
| spike | Switch | Report if the grid has a current price spike |
3434

3535
## Full Example
3636

37-
### `amberelectric.things`:
37+
### `amberelectric.things`
3838

3939
```java
4040
amberelectric:service:AmberElectric [ apiKey="psk_xxxxxxxxxxxxxxxxxxxx" ]
4141
```
4242

43-
### `amberelectric.items`:
43+
### `amberelectric.items`
4444

4545
```java
4646
Number:EnergyPrice AmberElectric_ElectricityPrice { channel="amberelectric:service:AmberElectric:electricity-price" }
@@ -54,7 +54,7 @@ Number AmberElectric_Renewables { channel="amberelectric:service:AmberElectric:r
5454
Switch AmberElectric_Spike { channel="amberelectric:service:AmberElectric:spike" }
5555
```
5656

57-
### `amberelectric.sitemap`:
57+
### `amberelectric.sitemap`
5858

5959
```perl
6060
Text item=AmberElectric_ElectricityPrice label="Electricity Price"

‎bundles/org.openhab.binding.ambientweather/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,6 @@ Number:Temperature WS1400IP_IndoorTemperature "Indoor Temperature [%.1f %unit%]"
149149
Number:Dimensionless WS1400IP_IndoorHumidity "Indoor Humidity [%.1f %%]" { channel="ambientweather:ws1400ip:account:1400:indoorSensor#relativeHumidity" }
150150
String WS1400IP_IndoorBattery "Indoor Battery [MAP(ambient-battery.map):%s]" { channel="ambientweather:ws1400ip:account:1400:indoorSensor#batteryIndicator" }
151151

152-
153152
// WS-8482 Weather Station
154153
String WS8482_StationName "Station Name [%s]" { channel="ambientweather:ws8482:ws8482:station#name" }
155154
String WS8482_StationLocation "Station Location [%s]" { channel="ambientweather:ws8482:ws8482:station#location" }

‎bundles/org.openhab.binding.androiddebugbridge/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ This is a sample:
152152

153153
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.
154154

155-
### Available key-event values:
155+
### Available key-event values
156156

157157
- KEYCODE_0
158158
- KEYCODE_1

‎bundles/org.openhab.binding.androidtv/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ Thing androidtv:philipstv:bedroom [ ipAddress="192.168.1.4" ]
8585
| ambilightTopColor | Color | Color for top Ambilight Side | N/A | N/A | RW |
8686
| ambilightBottomColor | Color | Color for bottom Ambilight Side | N/A | N/A | RW |
8787

88-
8988
```java
9089
String ShieldTV_KEYBOARD "KEYBOARD [%s]" { channel = "androidtv:shieldtv:livingroom:keyboard" }
9190
String ShieldTV_KEYPRESS "KEYPRESS [%s]" { channel = "androidtv:shieldtv:livingroom:keypress" }

‎bundles/org.openhab.binding.anthem/README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ The following thing type is supported:
1212

1313
Tested models include the AVM-60 11.2-channel preamp/processor.
1414

15-
1615
## Thing Configuration
1716

1817
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
4948
| 2#activeInputShortName | String | Short friendly name of the active input |
5049
| 2#activeInputLongName | String | Long friendly name of the active input |
5150

52-
5351
## Full Example
5452

5553
### Things
5654

57-
```
55+
```java
5856
Thing anthem:anthem:mediaroom "Anthem AVM 60" [ host="192.168.1.100" ]
5957
```
6058

6159
### Items
6260

63-
```
61+
```java
6462
String Anthem_Command "Command [%s]" { channel="anthem:anthem:mediaroom:general#command" }
6563

6664
Switch Anthem_Z1_Power "Zone 1 Power [%s]" { channel="anthem:anthem:mediaroom:1#power" }

‎bundles/org.openhab.binding.argoclima/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,6 @@ Thing argoclima:remote:argoHvacRemote "Argo HVAC (via Argo remote API)" @ "Livin
115115
password="<yourArgoPassword>"
116116
]
117117

118-
119118
Thing argoclima:local:argoHvacLocalDirect "Argo HVAC (connected locally)" @ "Living Room" [
120119
hostname="192.168.0.3"
121120
]
@@ -149,7 +148,6 @@ Thing argoclima:local:argoHvacLocalWithPassthroughIndirect "Argo HVAC (accessibl
149148
useLocalConnection=false
150149
]
151150

152-
153151
Thing argoclima:local:argoHvacLocalWithPassthroughPlusDirectEx "Argo HVAC (accessible both indirectly and directly, via pass-through mode, with explicit options)" [
154152
hostname="192.168.0.3", // Direct address of the device (reachable from openHAB)
155153
connectionMode="REMOTE_API_PROXY",
@@ -171,7 +169,6 @@ Thing argoclima:local:argoHvacLocalWithPassthroughPlusDirectEx "Argo HVAC (acces
171169
oemServerPort=80
172170
]
173171

174-
175172
Thing argoclima:local:argoHvacLocalWithStub "Argo HVAC (accessible both indirectly and directly with a stub) - **RECOMMENDED MODE**" [
176173
hostname="192.168.0.3", // Has to be reachable, since useLocalConnection is true (default)
177174
connectionMode="REMOTE_API_STUB",

‎bundles/org.openhab.binding.astro/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ e.g `sun#astroDawn earliest=6:00, latest=20:00 forceEvent=true`
137137

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

140-
141140
## Full Example
142141

143142
Things:

‎bundles/org.openhab.binding.asuswrt/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ Firmware 5.x.x (some DSL models) is NOT supported (not Asuswrt).
4343
| macAddress | text | Unique MAC address of the device | N/A | yes | no |
4444
| clientNick | text | Nickname used by OH | N/A | no | no |
4545

46-
4746
## Properties
4847

4948
All devices support some of the following properties:
@@ -53,7 +52,6 @@ All devices support some of the following properties:
5352
| vendor | Vendor of device | router, client |
5453
| dnsName | DNS name of device | router, client |
5554

56-
5755
## Channels
5856

5957
All devices support some of the following channels:
@@ -84,7 +82,6 @@ All devices support some of the following channels:
8482
| | total-rx | Number:DataAmount | Data received since reboot in MB | interface, client |
8583
| | total-tx | Number:DataAmount | Data sent since reboot in MB | interface, client |
8684

87-
8885
## Events
8986

9087
All devices support some of the following Events:

‎bundles/org.openhab.binding.automower/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ All Husqvarna Automower models with "Automower Connect" should be supported. It
1313

1414
## Discovery
1515

16-
Once the bridge is created and configured, OpenHab will automatically discover all Automowers registered on your account.
16+
Once the bridge is created and configured, openHAB will automatically discover all Automowers registered on your account.
1717

1818
## Thing Configuration
1919

‎bundles/org.openhab.binding.bluetooth.daikinmadoka/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ _Note that it is planned to generate some part of this based on the XML files wi
5656

5757
## Full Example
5858

59-
### daikinmadoka.things:
59+
### `daikinmadoka.things` Example
6060

6161
```java
6262
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
6565

6666
```
6767

68-
### daikinmadoka.items:
68+
### `daikinmadoka.items` Example
6969

7070
```java
7171
Group g_climSalon "Salon" [ "Thermostat" ]

‎bundles/org.openhab.binding.bluetooth.radoneye/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,16 @@ Following channels are supported for `RadonEye` thing:
3232
| ------------------ | ------------------------ | ------------------------------------------- |
3333
| radon | Number:Density | The measured radon level |
3434

35-
3635
## Example
3736

3837
radoneye.things (assuming you have a Bluetooth bridge with the ID `bluetooth:bluegiga:adapter1`:
3938

40-
```
39+
```java
4140
bluetooth:radoneye_rd200:adapter1:sensor1 "radoneye Wave Plus Sensor 1" (bluetooth:bluegiga:adapter1) [ address="12:34:56:78:9A:BC", refreshInterval=300 ]
4241
```
4342

4443
radoneye.items:
4544

46-
```
45+
```java
4746
Number:Density radon "Radon level [%d %unit%]" { channel="bluetooth:radoneye_rd200:adapter1:sensor1:radon" }
4847
```

‎bundles/org.openhab.binding.boschshc/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -313,15 +313,13 @@ The smoke detector warns you in case of fire.
313313
| low-battery | Switch | &#9744; | Indicates whether the battery is low (`ON`) or OK (`OFF`). |
314314
| 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). |
315315

316-
317316
### User-defined States
318317

319318
User-defined states enable automations to be better adapted to specific needs and everyday situations.
320319
Individual states can be activated/deactivated and can be used as triggers, conditions and actions in automations.
321320

322321
**Thing Type ID**: `user-defined-state`
323322

324-
325323
| Channel Type ID | Item Type | Writable | Description |
326324
|-----------------|-----------| :------: |--------------------------------------------|
327325
| 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.
402400
tail -f /var/log/openhab/openhab.log /var/log/openhab/events.log
403401
```
404402

405-
Alternatively, the log can be viewed using the OpenHab Log Viewer (frontail) via <http://openhab:9001>.
403+
Alternatively, the log can be viewed using the openHAB Log Viewer (frontail) via <http://openhab:9001>.
406404

407405
Example:
408406

‎bundles/org.openhab.binding.chatgpt/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ Each channel of type `chat` takes the following configuration parameters:
4040
| systemMessage | text | The system message helps set the behavior of the assistant. | N/A | no | no |
4141
| maxTokens | decimal | The maximum number of tokens to generate in the completion. | 500 | no | yes |
4242

43-
4443
## Full Example
4544

4645
### Thing Configuration

‎bundles/org.openhab.binding.deutschebahn/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,6 @@ String Zug1_Trip_FilterFlags "Filter" (zug1Fahrt) {channel="deutschebahn:train:t
162162
String Zug1_Trip_TripType "Fahrttyp" (zug1Fahrt) {channel="deutschebahn:train:timetableLehrte:lehrteZug1:trip#trip-type"}
163163
String Zug1_Trip_Owner "Unternehmen" (zug1Fahrt) {channel="deutschebahn:train:timetableLehrte:lehrteZug1:trip#owner"}
164164

165-
166165
// Arrival Information
167166
DateTime Zug1_Arrival_Plannedtime "Geplante Zeit" (zug1Ankunft) {channel="deutschebahn:train:timetableLehrte:lehrteZug1:arrival#planned-time"}
168167
DateTime Zug1_Arrival_Changedtime "Geänderte Zeit" (zug1Ankunft) {channel="deutschebahn:train:timetableLehrte:lehrteZug1:arrival#changed-time"}

0 commit comments

Comments
 (0)