Skip to content

Commit

Permalink
Multiple binding markdown fixes (#17422)
Browse files Browse the repository at this point in the history
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
  • Loading branch information
lsiepel authored Sep 28, 2024
1 parent 2e7dde9 commit 1a42353
Show file tree
Hide file tree
Showing 209 changed files with 1,892 additions and 1,808 deletions.
2 changes: 1 addition & 1 deletion bundles/org.openhab.automation.groovyscripting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For more information on the available APIs in scripts see the [JSR223 Scripting]

## Code reuse

One can place *.groovy files with Groovy classes under `automation/groovy` configuration directory.
One can place *.groovy files with Groovy classes under `automation/groovy` configuration directory.
Those classes can be imported in JSR-223 scripts or the UI rules action with the usual Groovy `import` statement.

To apply shared code changes, one has to restart the `openHAB Core :: Bundles :: Automation` bundle on the Console or an openHAB instance altogether.
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.automation.jrubyscripting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ items.build do

# dimension Temperature inferred
number_item OutdoorTemp, format: "%.1f %unit%", unit: "°F"

# unit lx, dimension Illuminance, format "%s %unit%" inferred
number_item OutdoorBrightness, state: 10_000 | "lx"
end
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.ahawastecollection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The thing **aha Waste Collection Schedule** provides four channels for the upcom
wasteCollection.things

```java
Thing ahawastecollection:collectionSchedule:wasteCollectionSchedule "aha Abfuhrkalender" [ commune="Isernhagen", street="67269@Rosmarinweg+/+Kirchhorst@Kirchhorst", houseNumber="10", houseNumberAddon="", collectionPlace="67269-0010+" ]
Thing ahawastecollection:collectionSchedule:wasteCollectionSchedule "aha Abfuhrkalender" [ commune="Isernhagen", street="67269@Rosmarinweg+/+Kirchhorst@Kirchhorst", houseNumber="10", houseNumberAddon="", collectionPlace="67269-0010+" ]
```

wasteCollection.items
Expand Down
6 changes: 3 additions & 3 deletions bundles/org.openhab.binding.amberelectric/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A binding that supports the Australian energy retailer Amber's API (<https://www

## Supported Things

- `service` Amber Electric API
- `service` Amber Electric API

## Discovery

Expand All @@ -25,7 +25,7 @@ As a minimum, the IP address is needed:
| 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
| 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
Expand Down Expand Up @@ -53,7 +53,7 @@ String AmberElectric_nemtime { channel="amberelectric:service:AmberElectric:nem-
Number AmberElectric_Renewables { channel="amberelectric:service:AmberElectric:renewables" }
Switch AmberElectric_Spike { channel="amberelectric:service:AmberElectric:spike" }
```

### `amberelectric.sitemap`:

```perl
Expand Down
12 changes: 6 additions & 6 deletions bundles/org.openhab.binding.androidtv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This binding supports two thing types:

## Discovery

All relevant thing types should be added automatically to the inbox through the mDNS discovery process.
All relevant thing types should be added automatically to the inbox through the mDNS discovery process.

In the case of the ShieldTV or PhilipsTV, openHAB will likely create an inbox entry for both a GoogleTV and a ShieldTV or PhilipsTV device.
Only the ShieldTV or PhilipsTV device should be configured, the GoogleTV can be ignored.
Expand All @@ -24,7 +24,7 @@ This could cause undesired effects.

## Binding Configuration

This binding does not require any special configuration files.
This binding does not require any special configuration files.

This binding does require a PIN login process (documented below) upon first connection.

Expand Down Expand Up @@ -161,15 +161,15 @@ KEYPRESS will accept the following commands as strings (case sensitive):
- KEY_MUTE
- KEY_SUBMIT

The list above causes an instantanious "press and release" of each button.
The list above causes an instantanious "press and release" of each button.
If you would like to manually control the press and release of each you may append _PRESS and _RELEASE to the end of each.
(e.g. KEY_FORWARD_PRESS or KEY_FORWARD_RELEASE)

You may also send an ASCII character as a single letter to simulate a key entry (e.g KEY_A, KEY_1, KEY_z).
Use KEY_SUBMIT when full text entry is complete to tell the shield to process the line.
KEY_SUBMIT is automatically sent by KEYBOARD when a command is sent to the channel.

APP will display the currently active app as presented by the AndroidTV.
APP will display the currently active app as presented by the AndroidTV.
You may also send it a command of the app package name (e.g. com.google.android.youtube.tv) to start/change-to that app.

KEYCODE values are listed at the bottom of this README.
Expand All @@ -195,11 +195,11 @@ openhab> openhab:androidtv androidtv:googletv:theater keypress KEY_POWER

## Pin Code Process

For the AndroidTV to be successfully accessed an on-screen PIN authentication is required on the first connection.
For the AndroidTV to be successfully accessed an on-screen PIN authentication is required on the first connection.

To begin the PIN process, send the text "REQUEST" to the pincode channel while watching your AndroidTV.

CLI Example Usage:
CLI Example Usage:

```shell
openhab> openhab:androidtv androidtv:googletv:theater pincode REQUEST
Expand Down
64 changes: 32 additions & 32 deletions bundles/org.openhab.binding.argoclima/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,23 +123,23 @@ Thing argoclima:local:argoHvacLocalDirect "Argo HVAC (connected locally)" @ "Liv
Thing argoclima:local:argoHvacLocalDirectEx "Argo HVAC (connected locally) - extended example (with explicit options)" [
hostname="192.168.0.3",
connectionMode="LOCAL_CONNECTION",
refreshInterval=30,
refreshInterval=30,
hvacListenPort=1001,

// Schedule options (these are valid for all thing types)
schedule1DayOfWeek="[FRI, SAT, SUN, MON]",
schedule1OnTime="7:35",
schedule1DayOfWeek="[FRI, SAT, SUN, MON]",
schedule1OnTime="7:35",
schedule1OffTime="18:00",
schedule2DayOfWeek="[MON, TUE, WED, THU, FRI]",
schedule2DayOfWeek="[MON, TUE, WED, THU, FRI]",
schedule2OnTime="15:00",
schedule2OffTime="22:00",
schedule3DayOfWeek="SUN","SAT", //Alternative syntax for the weekdays list
schedule3OnTime="11:00",
schedule3OffTime="22:00"
schedule3OnTime="11:00",
schedule3OffTime="22:00"
//,resetToFactoryDefaults=true //This triggers a one-shot command each time the thing
// definition is (re)loaded from file.
// definition is (re)loaded from file.
// Use only intermittently - it is not designed with prolonged
// usage via Things text file in mind (mostly a MainUI feature!)
// usage via Things text file in mind (mostly a MainUI feature!)
]

//ADVANCED MODES examples
Expand All @@ -153,19 +153,19 @@ Thing argoclima:local:argoHvacLocalWithPassthroughIndirect "Argo HVAC (accessibl
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",

hvacListenPort=1001,
refreshInterval=30,
useLocalConnection=true,

// Stub server-specific
stubServerPort=8240,
stubServerListenAddresses="7d47:86bd:0bfe:0413:4688:4523:4284:5936","192.168.0.195",
includeDeviceSidePasswordsInProperties="MASKED",
matchAnyIncomingDeviceIp=false,
stubServerPort=8240,
stubServerListenAddresses="7d47:86bd:0bfe:0413:4688:4523:4284:5936","192.168.0.195",
includeDeviceSidePasswordsInProperties="MASKED",
matchAnyIncomingDeviceIp=false,
deviceCpuId="deadbeefdeadbeef", // For direct match to a concrete device (optional)
localDeviceIP="192.168.4.2", // Address in local subnet (used for indirect request matching)

// Pass-through-specific
oemServerAddress="uisetup.ddns.net",
oemServerPort=80
Expand All @@ -174,7 +174,7 @@ Thing argoclima:local:argoHvacLocalWithPassthroughPlusDirectEx "Argo HVAC (acces

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",
connectionMode="REMOTE_API_STUB",
localDeviceIP="192.168.4.2" // Or use matchAnyIncomingDeviceIp=true
]
```
Expand All @@ -185,11 +185,11 @@ Thing argoclima:local:argoHvacLocalWithStub "Argo HVAC (accessible both indirect
Group GArgoClimaHVACRemote "Ulisse 13 DCI ECO - remote mode" ["HVAC"]

Switch ArgoClimaHVACRemote_Power "Power" <switch> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:ac-controls#power"
channel="argoclima:remote:argoHvacRemote:ac-controls#power"
}

String ArgoClimaHVACRemote_Mode "Mode" <climate> (GArgoClimaHVACRemote) ["Control"] {
channel="argoclima:remote:argoHvacRemote:ac-controls#mode"
channel="argoclima:remote:argoHvacRemote:ac-controls#mode"
}

Number:Temperature ArgoClimaHVACRemote_SetTemperature "Set Temperature" <temperature> (GArgoClimaHVACRemote) ["Temperature", "Setpoint"] {
Expand All @@ -201,27 +201,27 @@ Number:Temperature ArgoClimaHVACRemote_SetTemperature "Set Temperature" <temp
}

Number:Temperature ArgoClimaHVACRemote_CurrentTemperature "Current Temperature" <temperature> (GArgoClimaHVACRemote) ["Temperature", "Measurement"] {
channel="argoclima:remote:argoHvacRemote:ac-controls#current-temperature"
channel="argoclima:remote:argoHvacRemote:ac-controls#current-temperature"
}

String ArgoClimaHVACRemote_FanSpeed "Fan Speed" <fan> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:ac-controls#fan-speed"
channel="argoclima:remote:argoHvacRemote:ac-controls#fan-speed"
}

Switch ArgoClimaHVACRemote_EcoMode "Eco Mode" <vacation> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:modes#eco-mode"
channel="argoclima:remote:argoHvacRemote:modes#eco-mode"
}

Switch ArgoClimaHVACRemote_TurboMode "Turbo Mode" <party> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:modes#turbo-mode"
channel="argoclima:remote:argoHvacRemote:modes#turbo-mode"
}

Switch ArgoClimaHVACRemote_NightMode "Night Mode" <moon> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:modes#night-mode"
channel="argoclima:remote:argoHvacRemote:modes#night-mode"
}

String ArgoClimaHVACRemote_ActiveTimer "Active timer" <calendar> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:timers#active-timer"
channel="argoclima:remote:argoHvacRemote:timers#active-timer"
}

Number:Time ArgoClimaHVACRemote_DelayTimer "Delay timer value" <time> (GArgoClimaHVACRemote) ["Setpoint"] {
Expand All @@ -233,17 +233,17 @@ Number:Time ArgoClimaHVACRemote_DelayTimer "Delay timer value" <time> (GArgoCl
}

Switch ArgoClimaHVACRemote_IFeelEnabled "Use iFeel Temperature" <network> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:settings#ifeel-enabled"
channel="argoclima:remote:argoHvacRemote:settings#ifeel-enabled"
}

Switch ArgoClimaHVACRemote_DeviceLights "Device Lights" <light> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:settings#device-lights"
channel="argoclima:remote:argoHvacRemote:settings#device-lights"
}

String ArgoClimaHVACRemote_TemperatureDisplayUnit "Temperature Display Unit []" <settings> (GArgoClimaHVACRemote) {
stateDescription="" [ options="SCALE_CELSIUS=°C,SCALE_FAHRENHEIT=°F" ],
commandDescription="" [ options="SCALE_CELSIUS=°C,SCALE_FAHRENHEIT=°F" ],
channel="argoclima:remote:argoHvacRemote:settings#temperature-display-unit"
channel="argoclima:remote:argoHvacRemote:settings#temperature-display-unit"
}

Number:Dimensionless ArgoClimaHVACRemote_EcoPowerLimit "Power limit in eco mode" <price> (GArgoClimaHVACRemote) ["Setpoint"] {
Expand All @@ -255,15 +255,15 @@ Number:Dimensionless ArgoClimaHVACRemote_EcoPowerLimit "Power limit in eco
}

String ArgoClimaHVACRemote_ModeEx "Extended Mode" <heating> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:unsupported#mode-ex"
channel="argoclima:remote:argoHvacRemote:unsupported#mode-ex"
}

String ArgoClimaHVACRemote_SwingMode "Airflow Direction" <flow> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:unsupported#swing-mode"
channel="argoclima:remote:argoHvacRemote:unsupported#swing-mode"
}

Switch ArgoClimaHVACRemote_FilterMode "Filter Mode" <switch> (GArgoClimaHVACRemote) {
channel="argoclima:remote:argoHvacRemote:unsupported#filter-mode"
channel="argoclima:remote:argoHvacRemote:unsupported#filter-mode"
}
```

Expand All @@ -284,7 +284,7 @@ Frame label="❄ HVAC Control" {
Default item=GArgoClimaHVACRemote label="All settings"
}
Frame label="⛄ HVAC Modes"
{
{
Switch item=ArgoClimaHVACRemote_TurboMode
Switch item=ArgoClimaHVACRemote_NightMode
Switch item=ArgoClimaHVACRemote_EcoMode
Expand All @@ -294,7 +294,7 @@ Frame label="⛄ HVAC Modes"
}
Frame label="⏲ HVAC timers" {
Selection item=ArgoClimaHVACRemote_ActiveTimer mappings=[
NO_TIMER="No Timer", DELAY_TIMER="Delay Timer",
NO_TIMER="No Timer", DELAY_TIMER="Delay Timer",
SCHEDULE_TIMER_1="Schedule 1", SCHEDULE_TIMER_2="Schedule 2", SCHEDULE_TIMER_3="Schedule 3"
]
Setpoint item=ArgoClimaHVACRemote_DelayTimer minValue=10 maxValue=1190 step=10
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.atlona/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This binding supports the following thing types:

## Discovery

Supported things should be discovered automatically upon receipt of periodic SDDP announcements from the switch.
Supported things should be discovered automatically upon receipt of periodic SDDP announcements from the switch.
If the thing is not discovered automatically, login to the switch configuration UI and press the "SDDP" button on the "Network" tab to force the switch to send the SDDP announcement.
If "Telnet Login" is enabled in the switch configuration, you will need to set the username and password in the newly discovered thing before a connection can be made.

Expand Down
6 changes: 3 additions & 3 deletions bundles/org.openhab.binding.avmfritz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ You will find entries like the attached one.
The `identifyer 'tmpFC0F2C-3960B7EE6'` contains the templates AINs you need for using them in rules.

```text
Name 'Demo Template', identifyer 'tmpFC0F2C-3960B7EE6', firmware version '0.1'
Name 'Demo Template', identifyer 'tmpFC0F2C-3960B7EE6', firmware version '0.1'
[aktive] ID 60013, emc 0x0, model 0x0, grouphash=0x0, devicetype 'avm_home_device_type_template', functionbitmask 0x4000, sortid 0, batt perc 255 low 255, pollinterval 0, polltimeout 0, validchangetime: 0
--------------------
```
Expand Down Expand Up @@ -276,7 +276,7 @@ demo.items:
```java
String CallState "Call State [%s]" { channel="avmfritz:fritzbox:1:call_state" }
Call IncomingCall "Incoming call: [%1$s to %2$s]" { channel="avmfritz:fritzbox:1:incoming_call" }
Call IncomingCall "Incoming call: [%1$s to %2$s]" { channel="avmfritz:fritzbox:1:incoming_call" }
Call OutgoingCall "Outgoing call: [%1$s to %2$s]" { channel="avmfritz:fritzbox:1:outgoing_call" }
Call ActiveCall "Call established [%1$s]" { channel="avmfritz:fritzbox:1:active_call" }
String ApplyTemplate "Apply template" { channel="avmfritz:fritzbox:1:apply_template" }
Expand Down Expand Up @@ -346,7 +346,7 @@ sitemap demo label="Main Menu" {
Text item=COMETDECTBattery icon="battery"
Switch item=COMETDECTBatteryLow icon="lowbattery"
}
Frame label="HAN-FUN Contact" {
Text item=HANFUNContactState
}
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.benqprojector/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BenQ Projector Binding

This binding is compatible with BenQ projectors that support the control protocol via the built-in Ethernet port, serial port or USB to serial adapter.
If your projector does not have built-in networking, you can connect to your projector's serial port via a TCP connection using a serial over IP device or by using`ser2net`.
If your projector does not have built-in networking, you can connect to your projector's serial port via a TCP connection using a serial over IP device or by using`ser2net`.

The manufacturer's guide for connecting to the projector and the control protocol can be found in this document: [LX9215_RS232 Control Guide_0_Windows7_Windows8_WinXP.pdf](https://esupportdownload.benq.com/esupport/Projector/Control%20Protocols/LX9215/LX9215_RS232%20Control%20Guide_0_Windows7_Windows8_WinXP.pdf)

Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.bluetooth.airthings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The `Airthings Wave Gen 1` and `Airthings Wave Radon / Wave 2` thing has the fol
| temperature | Number:Temperature | The measured temperature |
| humidity | Number:Dimensionless | The measured humidity |

Note: For the `Airthings Wave Gen 1`, only one channel can be updated at each refreshInterval, so it will take refreshInterval x 4 cycles to sequentially update all 4 channels
Note: For the `Airthings Wave Gen 1`, only one channel can be updated at each refreshInterval, so it will take refreshInterval x 4 cycles to sequentially update all 4 channels

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ _Note that it is planned to generate some part of this based on the XML files wi
| outdoorTemperature | Number:Temperature | R | Outdoor temperature from the external unit. Not always supported/reported.
| commCtrlVersion | String | R | Communication Controller Firmware Version
| remoteCtrlVersion | String | R | Remote Controller Firmware Version
| operationMode | String | R/W | The operation mode of the AC unit. Currently supported values: HEAT, COOL.
| operationMode | String | R/W | The operation mode of the AC unit. Currently supported values: HEAT, COOL.
| fanSpeed | Number | R/W | This is a "virtual channel" : its value is calculated depending on current operation mode. It is the channel to be used to change the fan speed, whatever the current mode is. Fan speed are from 1 to 5. On BRC1H, the device supports 3 speeds: LOW (1), MEDIUM (2-4), MAX (5). Some BRC1H also support an AUTO (0) mode - but not all of them support it (depending on internal unit).
| setpoint | Number:Temperature | R/W | This is a "virtual channel" : its value is calculated depending on current operation mode. It is the channel to be used to change the setpoint, whatever the current mode is.
| homekitCurrentHeatingCoolingMode | String | R | This channel is a "virtual channel" to be used with the HomeKit add-on to implement Thermostat thing. Values supported are the HomeKit addon ones: Off, CoolOn, HeatOn, Auto.
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.bluetooth.enoceanble/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ demo.items:

```java
Dimmer Light_LivingRoom { channel="milight:rgbLed:milight2:4:ledbrightness", channel="bluetooth:ptm215b:bluegiga0:rocker_livingroom:rocker1" [profile="rawrocker-to-on-off"], channel="bluetooth:ptm215b:bluegiga0:rocker_kitchen:rocker1" [profile="rawrocker-to-on-off"] } // We have a combined kitchen / livingroom, so we control the living room lights with switches from the living room and from the kitchen
Switch Light_Kitchen { channel="hue:group:1:kitchen-bulbs:switch", channel="bluetooth:ptm215b:bluegiga0:rocker_kitchen:rocker2" [profile="rawrocker-to-on-off"] }
Switch Light_Kitchen { channel="hue:group:1:kitchen-bulbs:switch", channel="bluetooth:ptm215b:bluegiga0:rocker_kitchen:rocker2" [profile="rawrocker-to-on-off"] }
```
Loading

0 comments on commit 1a42353

Please sign in to comment.