Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple binding markdown fixes #17422

Merged
merged 12 commits into from
Sep 28, 2024
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
4 changes: 2 additions & 2 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
1 change: 1 addition & 0 deletions bundles/org.openhab.binding.ekey/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ R=RFID
```

transform/ekey_names.map [NO spaces allowed]

```text
-1=Unspecified
1=JohnDoe
Expand Down
14 changes: 6 additions & 8 deletions bundles/org.openhab.binding.ephemeris/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ The binding will search your Jollyday event definition files in the sub folder `

The binding handles the following Things:

* default holiday data (`holiday`)
* custom holiday file (`custom`)
* daysets (`dayset`)
* weekend (`weekend`)
- default holiday data (`holiday`)
- custom holiday file (`custom`)
- daysets (`dayset`)
- weekend (`weekend`)

## Discovery

Expand All @@ -24,7 +24,6 @@ There is no configuration at binding level.

## Thing Configuration


### `custom` Thing Configuration

| Name | Type | Description | Default | Required | Advanced |
Expand All @@ -39,7 +38,6 @@ The file has to use the syntax described here : https://www.openhab.org/docs/con
|-----------------|---------|---------------------------|---------|----------|----------|
| name | text | Name of the dayset used | N/A | yes | no |


## Channels

### `weekend` Channels
Expand Down Expand Up @@ -80,15 +78,15 @@ The file has to use the syntax described here : https://www.openhab.org/docs/con

## Full Example

### Thing Configuration
### Thing Example

```java
Thing ephemeris:holiday:local "Holidays"
Thing ephemeris:weekend:local "Week-end"
Thing ephemeris:custom:events "Event" [fileName="events.xml"]
```

### Item Configuration
### Item Example

```java
String ToD_Event_Current "Event Today" <calendar> (gEvents) {channel="ephemeris:custom:events:title-today"}
Expand Down
20 changes: 10 additions & 10 deletions bundles/org.openhab.binding.evcc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,11 @@ Please note that you have to replace _\<N\>_ with your loadpoint id/number.

Those channels exist:

* 1 per configured loadpoint with `chargerFeatureHeating = false`:
* These channels point to the heating device that is currently active/connected at/to the loadpoint
* Please note that you have to replace _\<N\>_ with your loadpoint id/number
* 1 per configured vehicle:
* Please note that you have to replace _\<ID\>_ with your vehicle id/name
- 1 per configured loadpoint with `chargerFeatureHeating = false`:
- These channels point to the heating device that is currently active/connected at/to the loadpoint
- Please note that you have to replace _\<N\>_ with your loadpoint id/number
- 1 per configured vehicle:
- Please note that you have to replace _\<ID\>_ with your vehicle id/name

| Channel | Type | Read/Write | Description |
|----------------------------------------------------|----------------------|------------|--------------------------------------------------------------------------|
Expand All @@ -126,11 +126,11 @@ Those channels exist:

Those channels exist:

* 1 per configured loadpoint with `chargerFeatureHeating = true`:
* These channels point to the heating device that is currently active/connected at/to the loadpoint
* Please note that you have to replace _\<N\>_ with your loadpoint id/number
* 1 per configured heating device:
* Please note that you have to replace _\<ID\>_ with your heating device id/name
- 1 per configured loadpoint with `chargerFeatureHeating = true`:
- These channels point to the heating device that is currently active/connected at/to the loadpoint
- Please note that you have to replace _\<N\>_ with your loadpoint id/number
- 1 per configured heating device:
- Please note that you have to replace _\<ID\>_ with your heating device id/name

| Channel | Type | Read/Write | Description |
|---------------------------------------------------------|--------------------|------------|-----------------------------------------------------------------------|
Expand Down
1 change: 1 addition & 0 deletions bundles/org.openhab.binding.fronius/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ You can retrieve the actions as follows:
```java
val froniusInverterActions = getActions("fronius", "fronius:powerinverter:mybridge:myinverter")
```

:::

::: tab JS
Expand Down
5 changes: 3 additions & 2 deletions bundles/org.openhab.binding.homematic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ homematic:bridge:NAME
- **bridge** the type, fixed
- **name** the name of the bridge

### Example
### Bridge Configuration Example

#### Minimum configuration

Expand Down Expand Up @@ -448,7 +448,7 @@ Adds multiple virtual datapoints to the HM-Dis-WM55 and HM-Dis-EP-WM55 devices t

**Note:** The HM-Dis-EP-WM55 has only a black and white display and therefore does not support datapoints for colored lines. In addition, only lines 1-3 can be set.

#### Example
#### Button Example

Display text at line 1,3 and 5 when the bottom button on the display is pressed

Expand Down Expand Up @@ -734,6 +734,7 @@ The problem can be solved by increasing the `bufferSize` value in the bridge con

openHAB and the CCU are using different values for the same state of a rollershutter.
Examples: HmIP-BROLL, HmIP-FROLL, HmIP-BBL, HmIP-FBL and HmIP-DRBLI4

| | Open | Closed |
| ------- | ---- | ------ |
| openHAB | 0% | 100% |
Expand Down
6 changes: 3 additions & 3 deletions bundles/org.openhab.binding.mercedesme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -787,9 +787,9 @@ If you want to dive deeper see [Troubleshooting](#troubleshooting) `feature-capa

In order to be able to analyze problems 3 advanced channels are placed in the vehicle group.

* `feature-capabilities` - showing which feature your vehicle is equipped with
* `command-capabilities` - showing which commands can be sent to your vehicle
* `proto-update` - latest update of your vehicle data
- `feature-capabilities` - showing which feature your vehicle is equipped with
- `command-capabilities` - showing which commands can be sent to your vehicle
- `proto-update` - latest update of your vehicle data

In case you find problems regarding this binding add items to these 3 channels.
The items are reporting Strings in JSON format.
Expand Down
Loading