Skip to content

Commit dfea7a1

Browse files
authored
Add chapter headings for examples (openhab#18195)
Signed-off-by: Michael Lobstein <[email protected]>
1 parent 05e45e0 commit dfea7a1

File tree

12 files changed

+59
-60
lines changed

12 files changed

+59
-60
lines changed

bundles/org.openhab.binding.benqprojector/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This binding supports two thing types based on the connection used: `projector-s
1111

1212
## Discovery
1313

14-
If the projector has a built-in Ethernet port connected to the same network as the openHAB server and either the 'AMX Device Discovery' or 'Control4' options are present and enabled in the projector's network menu, the thing will be discovered automatically.
14+
If the projector has a built-in Ethernet port connected to the same network as the openHAB server and either the 'AMX Device Discovery' or 'Control4' options are present and enabled in the projector's network menu, the Thing will be discovered automatically.
1515
Serial port or serial over IP connections must be configured manually.
1616

1717
## Binding Configuration
@@ -68,7 +68,7 @@ Some notes:
6868

6969
## Full Example
7070

71-
things/benq.things:
71+
### `benq.things` Example
7272

7373
```java
7474
// serial port connection
@@ -79,7 +79,7 @@ benqprojector:projector-tcp:hometheater "Projector" [ host="192.168.0.10", port=
7979

8080
```
8181

82-
items/benq.items
82+
### `benq.items` Example
8383

8484
```java
8585
Switch benqPower { channel="benqprojector:projector-serial:hometheater:power" }
@@ -92,7 +92,7 @@ String benqDirect { channel="benqprojector:p
9292
Number benqLampTime "Lamp Time [%d h]" <light> { channel="benqprojector:projector-serial:hometheater:lamptime" }
9393
```
9494

95-
sitemaps/benq.sitemap
95+
### `benq.sitemap` Example
9696

9797
```perl
9898
sitemap benq label="BenQ Projector" {

bundles/org.openhab.binding.epsonprojector/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This binding supports two thing types based on the connection used: `projector-s
99

1010
## Discovery
1111

12-
If the projector has a built-in Ethernet port connected to the same network as the openHAB server and either the 'AMX Device Discovery' or 'Control4 SDDP' options are present and enabled in the projector's network menu, the thing will be discovered automatically.
12+
If the projector has a built-in Ethernet port connected to the same network as the openHAB server and either the 'AMX Device Discovery' or 'Control4 SDDP' options are present and enabled in the projector's network menu, the Thing will be discovered automatically.
1313
Serial port or serial over IP connections must be configured manually.
1414

1515
## Binding Configuration
@@ -109,7 +109,7 @@ connection: &conEpson
109109
110110
## Full Example
111111
112-
things/epson.things:
112+
### `epson.things` Example
113113

114114
```java
115115
// serial port connection
@@ -120,7 +120,7 @@ epsonprojector:projector-tcp:hometheater "Projector" [ host="192.168.0.10", port
120120
121121
```
122122

123-
items/epson.items
123+
### `epson.items` Example
124124

125125
```java
126126
Switch epsonPower { channel="epsonprojector:projector-serial:hometheater:power" }
@@ -156,7 +156,7 @@ Number epsonErrCode "Error Code [%d]" <error> { channel="epsonprojector
156156
String epsonErrMessage "Error Message [%s]" <error> { channel="epsonprojector:projector-serial:hometheater:errmessage" }
157157
```
158158

159-
sitemaps/epson.sitemap
159+
### `epson.sitemap` Example
160160

161161
```perl
162162
sitemap epson label="Epson Projector"

bundles/org.openhab.binding.kaleidescape/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -140,15 +140,15 @@ The following channels are available:
140140

141141
## Full Example
142142

143-
kaleidescape.things:
143+
### `kaleidescape.things` Example
144144

145145
```java
146146
kaleidescape:strato:myzone1 "Strato Theater Rm" [ host="192.168.1.10", updatePeriod=0, loadHighlightedDetails=true ]
147147
kaleidescape:player:myzone2 "M500 Living Rm" [ host="192.168.1.11", updatePeriod=0, loadHighlightedDetails=true, loadAlbumDetails=true ]
148148
kaleidescape:cinemaone:myzone3 "My Cinema One" [ host="192.168.1.12", updatePeriod=0, loadHighlightedDetails=true, loadAlbumDetails=true ]
149149
```
150150

151-
kaleidescape.items:
151+
### `kaleidescape.items` Example
152152

153153
```java
154154
// Virtual switch to send a command, see sitemap and rules below
@@ -236,7 +236,7 @@ String z1_Detail_DiscLocation "Disc Location: [%s]" { channel="kaleidescape:play
236236
String z1_MovieSearch "Movie Search"
237237
```
238238

239-
ksecondsformat.js:
239+
### `ksecondsformat.js` Example
240240

241241
```javascript
242242
(function(timestamp) {
@@ -260,7 +260,7 @@ ksecondsformat.js:
260260
})(input)
261261
```
262262

263-
kaleidescape.sitemap:
263+
### `kaleidescape.sitemap` Example
264264

265265
```perl
266266
sitemap kaleidescape label="Kaleidescape" {
@@ -350,7 +350,7 @@ sitemap kaleidescape label="Kaleidescape" {
350350
}
351351
```
352352

353-
kaleidescape.rules:
353+
### `kaleidescape.rules` Example
354354

355355
```java
356356
var int lightPercent
@@ -379,7 +379,7 @@ when
379379
then
380380
var volEvt = newState.toString()
381381

382-
// When `volumeBasicEnabled` is true for the thing, VOLUME_UP, VOLUME_DOWN and TOGGLE_MUTE are received from the iPad and phone apps
382+
// When `volumeBasicEnabled` is true for the Thing, VOLUME_UP, VOLUME_DOWN and TOGGLE_MUTE are received from the iPad and phone apps
383383
// VOLUME_UP_PRESS/RELEASE, VOLUME_DOWN_PRESS/RELEASE, TOGGLE_MUTE events will always be received from the IR remote
384384
// *RELEASE events are not used in this example
385385

@@ -459,7 +459,7 @@ then
459459
}
460460
end
461461

462-
// The following are no longer required since the thing configuration will enable automatic loading of metatdata.
462+
// The following are no longer required since the Thing configuration will enable automatic loading of metatdata.
463463
// However the examples are still valid for advanced use cases where retrieving metadata from an arbitrary content handle is desired.
464464

465465
rule "Load selected item Metadata"

bundles/org.openhab.binding.monopriceaudio/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Note that `dnd`, `page` and `keypad` are not available on all thing types.
115115

116116
## Full Example
117117

118-
monoprice.things:
118+
### `monoprice.things` Example
119119

120120
```java
121121
// Monoprice 10761, 39261 / DAX66 (serial port connection)
@@ -139,7 +139,7 @@ monopriceaudio:xantech:myamp "Xantech WHA" [ serialPort="COM5", pollingInterval=
139139
// Note that host and port can be used with any of the thing types to connect as serial over IP
140140
```
141141

142-
monoprice.items:
142+
### `monoprice.items` Example
143143

144144
```java
145145
// substitute 'amplifier' for the appropriate thing id if using 44519, 31028, DAX88 or Xantech amplifier
@@ -163,7 +163,7 @@ Switch z1_keypad "Keypad Connected: [%s]" { channel="monopriceaudio:amplifier:my
163163
// repeat for total number of zones used (substitute z1 and zone1)
164164
```
165165

166-
monoprice.sitemap:
166+
### `monoprice.sitemap` Example
167167

168168
```perl
169169
sitemap monoprice label="Audio Control" {

bundles/org.openhab.binding.nuvo/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ The following channels are available:
124124

125125
## Full Example
126126

127-
nuvo.things:
127+
### `nuvo.things` Example
128128

129129
```java
130130
// serial port connection
@@ -138,7 +138,7 @@ nuvo:amplifier:myamp "Nuvo WHA" [ host="192.168.0.10", port=5006, numZones=6, cl
138138
139139
```
140140

141-
nuvo.items:
141+
### `nuvo.items` Example
142142

143143
```java
144144
// system
@@ -240,7 +240,7 @@ String nuvo_s6_button_press "Button: [%s]" { channel="nuvo:amplifier:myamp:sourc
240240
241241
```
242242

243-
nuvo.sitemap:
243+
### `nuvo.sitemap` Example
244244

245245
```perl
246246
sitemap nuvo label="Audio Control" {
@@ -345,7 +345,7 @@ sitemap nuvo label="Audio Control" {
345345
346346
```
347347

348-
nuvo.rules:
348+
### `nuvo.rules` Example
349349

350350
```java
351351
import java.text.Normalizer
@@ -504,7 +504,7 @@ Also if a menu item from a custom menu was selected, ie: `Top menu 1` on Zone 5,
504504

505505
The functionality can be used to create very powerful rules as demontrated below. The following rule triggered from a menu item turns off all zones except for the zone that triggered the rule.
506506

507-
nuvo-turn-off-all-but-caller.rules:
507+
#### `nuvo-turn-off-all-but-caller.rules` Example
508508

509509
```java
510510
rule "Turn off all zones except caller zone"
@@ -545,7 +545,7 @@ By using these rules, it is possible to have artist, album and track names displ
545545
Global Favorites selection and Menu selections from the custom menus described above are also processed by these rules.
546546
The list of favorite names should be playable via another thing connected to openHAB and this thing should have a means to accept a text string that tells it to play a particular favorite/playlist.
547547

548-
nuvo-advanced.rules:
548+
#### `nuvo-advanced.rules.rules` Example
549549

550550
```java
551551
import java.text.Normalizer

bundles/org.openhab.binding.oppo/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ The following channels are available:
118118
119119
## Full Example
120120
121-
oppo.things:
121+
### `oppo.things` Example
122122

123123
```java
124124
// direct IP connection
@@ -132,7 +132,7 @@ oppo:player:myoppo "Oppo Blu-ray" [ host="192.168.0.9", port=4444, model=103, ve
132132
133133
```
134134

135-
oppo.items:
135+
### `oppo.items` Example
136136

137137
```java
138138
Switch oppo_power "Power" { channel="oppo:player:myoppo:power" }
@@ -163,7 +163,7 @@ String oppo_hdr_mode "HDR Mode [%s]" { channel="oppo:player:myoppo:hdr_mode" }
163163
String oppo_remote_button "Remote Button [%s]" { channel="oppo:player:myoppo:remote_button" }
164164
```
165165

166-
secondsformat.js:
166+
### `secondsformat.js` Example
167167

168168
```javascript
169169
(function(timestamp) {
@@ -190,7 +190,7 @@ secondsformat.js:
190190
})(input)
191191
```
192192

193-
oppo.sitemap:
193+
### `oppo.sitemap` Example
194194

195195
```perl
196196
sitemap oppo label="Oppo Blu-ray" {

bundles/org.openhab.binding.panasonicbdp/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Multiple Things can be added if more than one player is to be controlled.
4343
## Discovery
4444

4545
Auto-discovery is supported if the player can be located on the local network using UPnP.
46-
Otherwise the thing must be manually added.
46+
Otherwise the Thing must be manually added.
4747

4848
## Binding Configuration
4949

@@ -84,14 +84,14 @@ The following channels are available:
8484

8585
## Full Example
8686

87-
panasonicbdp.things:
87+
### `panasonicbdp.things` Example
8888

8989
```java
9090
panasonicbdp:bd-player:mybdplayer "My Blu-ray player" [ hostName="192.168.10.1", refresh=5 ]
9191
panasonicbdp:uhd-player:myuhdplayer "My UHD Blu-ray player" [ hostName="192.168.10.1", refresh=5, playerKey="ABCDEF1234567890abcdef0123456789" ]
9292
```
9393

94-
panasonicbdp.items:
94+
### `panasonicbdp.items` Example
9595

9696
```java
9797
// BD Player
@@ -112,7 +112,7 @@ String Player_PlayerStatus "Status: [%s]" { channel="panasonicb
112112
Number:Time Player_TimeElapsed "Elapsed Time: [%d %unit%]" { channel="panasonicbdp:uhd-player:myuhdplayer:time-elapsed" }
113113
```
114114

115-
panasonicbdp.sitemap:
115+
### `panasonicbdp.sitemap` Example
116116

117117
```perl
118118
sitemap panasonicbdp label="Panasonic Blu-ray" {

bundles/org.openhab.binding.radiothermostat/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Multiple Things can be added if more than one thermostat is to be controlled.
1717
## Discovery
1818

1919
Auto-discovery is supported if the thermostat can be located on the local network using SSDP.
20-
Otherwise the thing must be manually added.
20+
Otherwise the Thing must be manually added.
2121

2222
## Thing Configuration
2323

@@ -101,7 +101,7 @@ The thermostat information that is retrieved is available as these channels:
101101

102102
## Full Example
103103

104-
radiotherm.map:
104+
### `radiotherm.map` Example
105105

106106
```text
107107
UNDEF_stus=-
@@ -144,14 +144,14 @@ NULL_over=-
144144
145145
```
146146

147-
radiotherm.things:
147+
### `radiotherm.things` Example
148148

149149
```java
150150
radiothermostat:rtherm:mytherm1 "My 1st floor thermostat" [ hostName="192.168.10.1", refresh=2, logRefresh=10, isCT80=false, disableLogs=false, setpointMode="temporary" ]
151151
radiothermostat:rtherm:mytherm2 "My 2nd floor thermostat" [ hostName="mythermhost2", refresh=1, logRefresh=20, isCT80=true, disableLogs=false, setpointMode="absolute" ]
152152
```
153153

154-
radiotherm.items:
154+
### `radiotherm.items` Example
155155

156156
```java
157157
Number:Temperature Therm_Temp "Current Temperature [%.1f °F]" <temperature> { channel="radiothermostat:rtherm:mytherm1:temperature" }
@@ -188,7 +188,7 @@ Number:Temperature Therm_Rtemp "Remote Temperature [%d]" <temperature>
188188
Switch Therm_mysetting "Send my preferred setting"
189189
```
190190

191-
radiotherm.sitemap:
191+
### `radiotherm.sitemap` Example
192192

193193
```perl
194194
sitemap radiotherm label="My Thermostat" {
@@ -228,7 +228,7 @@ sitemap radiotherm label="My Thermostat" {
228228
}
229229
```
230230
231-
radiotherm.rules:
231+
### `radiotherm.rules` Example
232232
233233
```java
234234
rule "Send my thermostat command"

bundles/org.openhab.binding.roku/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Multiple Things can be added if more than one Roku is to be controlled.
1717
## Discovery
1818

1919
Auto-discovery is supported if the Roku can be located on the local network using SSDP.
20-
Otherwise the thing must be manually added.
20+
Otherwise the Thing must be manually added.
2121

2222
## Binding Configuration
2323

bundles/org.openhab.binding.tasmotaplug/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ If the number of channels must be increased, delete the Thing and re-create it w
5454

5555
## Full Example
5656

57-
tasmotaplug.things:
57+
### `tasmotaplug.things` Example
5858

5959
```java
6060
tasmotaplug:plug:plug1 "Plug 1" [ hostName="192.168.10.1", refresh=30 ]
6161
tasmotaplug:plug:plug2 "Plug 2" [ hostName="myplug2", refresh=30 ]
6262
```
6363

64-
tasmotaplug.items:
64+
### `tasmotaplug.items` Example
6565

6666
```java
6767
Switch Plug1 "Plug 1 Power" { channel="tasmotaplug:plug:plug1:power" }
@@ -82,7 +82,7 @@ Switch Plug2c "4ch Power 3" { channel="tasmotaplug:plug:plug2:power3" }
8282
Switch Plug2d "4ch Power 4" { channel="tasmotaplug:plug:plug2:power4" }
8383
```
8484

85-
tasmotaplug.sitemap:
85+
### `tasmotaplug.sitemap` Example
8686

8787
```perl
8888
sitemap tasmotaplug label="My Tasmota Plugs" {

0 commit comments

Comments
 (0)