Skip to content

Commit

Permalink
Add chapter headings for examples (#18195)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Lobstein <[email protected]>
  • Loading branch information
mlobstein authored Jan 27, 2025
1 parent 05e45e0 commit dfea7a1
Show file tree
Hide file tree
Showing 12 changed files with 59 additions and 60 deletions.
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.benqprojector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This binding supports two thing types based on the connection used: `projector-s

## Discovery

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.
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.
Serial port or serial over IP connections must be configured manually.

## Binding Configuration
Expand Down Expand Up @@ -68,7 +68,7 @@ Some notes:

## Full Example

things/benq.things:
### `benq.things` Example

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

```

items/benq.items
### `benq.items` Example

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

sitemaps/benq.sitemap
### `benq.sitemap` Example

```perl
sitemap benq label="BenQ Projector" {
Expand Down
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.epsonprojector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This binding supports two thing types based on the connection used: `projector-s

## Discovery

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.
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.
Serial port or serial over IP connections must be configured manually.

## Binding Configuration
Expand Down Expand Up @@ -109,7 +109,7 @@ connection: &conEpson
## Full Example
things/epson.things:
### `epson.things` Example

```java
// serial port connection
Expand All @@ -120,7 +120,7 @@ epsonprojector:projector-tcp:hometheater "Projector" [ host="192.168.0.10", port
```

items/epson.items
### `epson.items` Example

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

sitemaps/epson.sitemap
### `epson.sitemap` Example

```perl
sitemap epson label="Epson Projector"
Expand Down
14 changes: 7 additions & 7 deletions bundles/org.openhab.binding.kaleidescape/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,15 +140,15 @@ The following channels are available:

## Full Example

kaleidescape.things:
### `kaleidescape.things` Example

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

kaleidescape.items:
### `kaleidescape.items` Example

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

ksecondsformat.js:
### `ksecondsformat.js` Example

```javascript
(function(timestamp) {
Expand All @@ -260,7 +260,7 @@ ksecondsformat.js:
})(input)
```

kaleidescape.sitemap:
### `kaleidescape.sitemap` Example

```perl
sitemap kaleidescape label="Kaleidescape" {
Expand Down Expand Up @@ -350,7 +350,7 @@ sitemap kaleidescape label="Kaleidescape" {
}
```

kaleidescape.rules:
### `kaleidescape.rules` Example

```java
var int lightPercent
Expand Down Expand Up @@ -379,7 +379,7 @@ when
then
var volEvt = newState.toString()

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

Expand Down Expand Up @@ -459,7 +459,7 @@ then
}
end

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

rule "Load selected item Metadata"
Expand Down
6 changes: 3 additions & 3 deletions bundles/org.openhab.binding.monopriceaudio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Note that `dnd`, `page` and `keypad` are not available on all thing types.

## Full Example

monoprice.things:
### `monoprice.things` Example

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

monoprice.items:
### `monoprice.items` Example

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

monoprice.sitemap:
### `monoprice.sitemap` Example

```perl
sitemap monoprice label="Audio Control" {
Expand Down
12 changes: 6 additions & 6 deletions bundles/org.openhab.binding.nuvo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ The following channels are available:

## Full Example

nuvo.things:
### `nuvo.things` Example

```java
// serial port connection
Expand All @@ -138,7 +138,7 @@ nuvo:amplifier:myamp "Nuvo WHA" [ host="192.168.0.10", port=5006, numZones=6, cl
```

nuvo.items:
### `nuvo.items` Example

```java
// system
Expand Down Expand Up @@ -240,7 +240,7 @@ String nuvo_s6_button_press "Button: [%s]" { channel="nuvo:amplifier:myamp:sourc
```

nuvo.sitemap:
### `nuvo.sitemap` Example

```perl
sitemap nuvo label="Audio Control" {
Expand Down Expand Up @@ -345,7 +345,7 @@ sitemap nuvo label="Audio Control" {
```

nuvo.rules:
### `nuvo.rules` Example

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

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.

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

```java
rule "Turn off all zones except caller zone"
Expand Down Expand Up @@ -545,7 +545,7 @@ By using these rules, it is possible to have artist, album and track names displ
Global Favorites selection and Menu selections from the custom menus described above are also processed by these rules.
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.

nuvo-advanced.rules:
#### `nuvo-advanced.rules.rules` Example

```java
import java.text.Normalizer
Expand Down
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.oppo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ The following channels are available:
## Full Example
oppo.things:
### `oppo.things` Example

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

oppo.items:
### `oppo.items` Example

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

secondsformat.js:
### `secondsformat.js` Example

```javascript
(function(timestamp) {
Expand All @@ -190,7 +190,7 @@ secondsformat.js:
})(input)
```

oppo.sitemap:
### `oppo.sitemap` Example

```perl
sitemap oppo label="Oppo Blu-ray" {
Expand Down
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.panasonicbdp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Multiple Things can be added if more than one player is to be controlled.
## Discovery

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

## Binding Configuration

Expand Down Expand Up @@ -84,14 +84,14 @@ The following channels are available:

## Full Example

panasonicbdp.things:
### `panasonicbdp.things` Example

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

panasonicbdp.items:
### `panasonicbdp.items` Example

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

panasonicbdp.sitemap:
### `panasonicbdp.sitemap` Example

```perl
sitemap panasonicbdp label="Panasonic Blu-ray" {
Expand Down
12 changes: 6 additions & 6 deletions bundles/org.openhab.binding.radiothermostat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Multiple Things can be added if more than one thermostat is to be controlled.
## Discovery

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

## Thing Configuration

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

## Full Example

radiotherm.map:
### `radiotherm.map` Example

```text
UNDEF_stus=-
Expand Down Expand Up @@ -144,14 +144,14 @@ NULL_over=-
```

radiotherm.things:
### `radiotherm.things` Example

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

radiotherm.items:
### `radiotherm.items` Example

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

radiotherm.sitemap:
### `radiotherm.sitemap` Example

```perl
sitemap radiotherm label="My Thermostat" {
Expand Down Expand Up @@ -228,7 +228,7 @@ sitemap radiotherm label="My Thermostat" {
}
```
radiotherm.rules:
### `radiotherm.rules` Example
```java
rule "Send my thermostat command"
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.roku/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Multiple Things can be added if more than one Roku is to be controlled.
## Discovery

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

## Binding Configuration

Expand Down
6 changes: 3 additions & 3 deletions bundles/org.openhab.binding.tasmotaplug/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ If the number of channels must be increased, delete the Thing and re-create it w

## Full Example

tasmotaplug.things:
### `tasmotaplug.things` Example

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

tasmotaplug.items:
### `tasmotaplug.items` Example

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

tasmotaplug.sitemap:
### `tasmotaplug.sitemap` Example

```perl
sitemap tasmotaplug label="My Tasmota Plugs" {
Expand Down
Loading

0 comments on commit dfea7a1

Please sign in to comment.