demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/danieldemus/openhab-addons synced 2026-07-29 12:34:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix markdown (#20058)

Browse Source 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
This commit is contained in:
lsiepel
2026-01-13 23:13:18 +01:00
committed by GitHub
parent 182e57cad6
commit 3cfe231fd0
8 changed files with 68 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bundles/org.openhab.binding.astro/README.md
-1
View File
@@ -38,7 +38,6 @@ This binding has its own IconProvider and makes available the following list of
| oh:astro:season | Yes | ![Season](doc/images/season.svg) |
| oh:astro:sun_eclipse | Yes | ![Sun Eclipse](doc/images/sun_eclipse.svg) |
## Channels
- **thing** `sun`
bundles/org.openhab.binding.chatgpt/README.md
+1 -1
View File
@@ -157,7 +157,7 @@ The binding includes a function named `items_control` which can be used by ChatG
> You are the manager of the openHAB smart home. You know how to manage devices in a smart home or provide their current status. You can also answer questions not related to the devices in the house, or, for example, compose a story upon request.
> I will provide information about the smart home; if necessary, you can perform the requested function. If there is not enough information to perform it, ask for clarification briefly, without listing all available devices or parameters.
> If the question is not related to devices in the smart home, answer it briefly — maximum 3 sentences in everyday language.
>
>
> The name, current status, and location of devices are listed in 'Available devices'.
> Use the items_control function only for the requested actions, not for providing current states.
>
bundles/org.openhab.binding.evcc/README.md
+2 -2
View File
@@ -97,7 +97,7 @@ Here you will find items examples sorted by thing.
#### Battery
```java
```java
Number:Energy Evcc_Battery_Capacity "Battery Capacity [%s]" { channel="evcc:battery:demo-server:demo-battery:battery-capacity" }
Switch Evcc_Battery_Controllable "Battery Controllable [%s]" { channel="evcc:battery:demo-server:demo-battery:battery-controllable" }
Number:Power Evcc_Battery_Power "Battery Power [%s]" { channel="evcc:battery:demo-server:demo-battery:battery-power" }
@@ -191,7 +191,7 @@ Switch Evcc_Loadpoint_Vehicle_Welcome_Active "Vehi
#### Plan
Channels plan-weekdays and plan-tz are only available for repeating plans.
Channels plan-weekdays and plan-tz are only available for repeating plans.
```java
Number:Dimensionless Evcc_Plan_Soc "Plan SoC [%s]" { channel="evcc:battery:demo-server:demo-battery:plan-soc" }
bundles/org.openhab.binding.modbus.lambda/README.md
+42 -43
View File
@@ -60,13 +60,13 @@ Heat Pump, Boiler, Buffer and Heating Circuit things use another parameter Subin
| --------- | ------- | -------- | ------------------ | -------------------------------------------------------------------------- |
| Subindex | integer | yes | 0 | Subindex for things of the same Thing type, starting with 0 |
| Thing Type | Range |
| ---------------- | ------- |
| Heatpump | 0..2 |
| Boiler | 0..4 |
| Buffer | 0..4 |
| Solar | 0..2 |
| Heating Circuit | 0..11 |
| Thing Type | Range |
| ---------------- | ------- |
| Heatpump | 0..2 |
| Boiler | 0..4 |
| Buffer | 0..4 |
| Solar | 0..2 |
| Heating Circuit | 0..11 |
## Channels
@@ -101,30 +101,30 @@ This group contains parameters signaling the PV excess to the heat pump.
This group contains general operational information about the heat pump itself.
| Channel ID | Item Type | Read only | Description |
| -------------------------------| --------------------------| --------- | ----------------------------------------------------------------------- |
| heat-pump-error-state | Number | true | Error state (0 = NONE, 1 = MESSAGE, 2 = WARNING, 3 = ALARM, 4 = FAULT) |
| heat-pump-error-number | Number | true | Error number: scrolling through all active error numbers (1..99) |
| heat-pump-state | Number | true | State: See Modbus description manual, link above |
| heat-pump-operating-state | Number | true | Operating State: See Modbus description manual, link above |
| heat-pump-t-flow | Number:Temperature | true | Flow line termperature |
| heat-pump-t-return | Number:Temperature | true | Return line temperature |
| heat-pump-vol-sink | Number:VolumetricFlowRate | true | Volume flow heat sink |
| heat-pump-t-eqin | Number:Temperature | true | Energy source inlet temperature |
| heat-pump-t-eqout | Number:Temperature | true | Energy source outlet temperature |
| heat-pump-vol-source | Number:VolumetricFlowRate | true | Volume flow energy source |
| heat-pump-compressor-rating | Number | true | Compressor unit rating |
| heat-pump-qp-heating | Number:Power | true | Actual heating capacity |
| heat-pump-fi-power-consumption | Number:Power | true | Frequency inverter actual power consumption |
| heat-pump-cop | Number | true | Coefficient of performance |
| heat-pump-request-password | Number | false | Password register to release modbus request registers |
| heat-pump-request-type | Number: | false | Request Type |
| heat-pump-request-t-flow | Number:Temperature | false | Requested flow line termperature |
| heat-pump-request-t-return | Number:Temperature | false | Requested return line temperature |
| heat-pump-request-heat-sink | Number:Temperature | false | Requested temperature difference between flow and return line |
| heat-pump-relais-state | Number:Temperature | true | Heatpump Relais State for 2nd heating stage |
| heat-pump-vdae | Number:Energy | true | Accumulated electrical energy consumption of compressor unit |
| heat-pump-vdaq | Number:Energy | true | Accumulated thermal energy output of compressor unit |
| Channel ID | Item Type | Read only | Description |
|--------------------------------|---------------------------|-----------|------------------------------------------------------------------------------|
| heat-pump-error-state | Number | true | Error state (0 = NONE, 1 = MESSAGE, 2 = WARNING, 3 = ALARM, 4 = FAULT) |
| heat-pump-error-number | Number | true | Error number: scrolling through all active error numbers (1..99) |
| heat-pump-state | Number | true | State: See Modbus description manual, link above |
| heat-pump-operating-state | Number | true | Operating State: See Modbus description manual, link above |
| heat-pump-t-flow | Number:Temperature | true | Flow line termperature |
| heat-pump-t-return | Number:Temperature | true | Return line temperature |
| heat-pump-vol-sink | Number:VolumetricFlowRate | true | Volume flow heat sink |
| heat-pump-t-eqin | Number:Temperature | true | Energy source inlet temperature |
| heat-pump-t-eqout | Number:Temperature | true | Energy source outlet temperature |
| heat-pump-vol-source | Number:VolumetricFlowRate | true | Volume flow energy source |
| heat-pump-compressor-rating | Number | true | Compressor unit rating |
| heat-pump-qp-heating | Number:Power | true | Actual heating capacity |
| heat-pump-fi-power-consumption | Number:Power | true | Frequency inverter actual power consumption |
| heat-pump-cop | Number | true | Coefficient of performance |
| heat-pump-request-password | Number | false | Password register to release modbus request registers |
| heat-pump-request-type | Number: | false | Request Type |
| heat-pump-request-t-flow | Number:Temperature | false | Requested flow line termperature |
| heat-pump-request-t-return | Number:Temperature | false | Requested return line temperature |
| heat-pump-request-heat-sink | Number:Temperature | false | Requested temperature difference between flow and return line |
| heat-pump-relais-state | Number:Temperature | true | Heatpump Relais State for 2nd heating stage |
| heat-pump-vdae | Number:Energy | true | Accumulated electrical energy consumption of compressor unit |
| heat-pump-vdaq | Number:Energy | true | Accumulated thermal energy output of compressor unit |
| heat-pump-vdae-swap | Number:Energy | true | Accumulated electrical energy consumption of compressor unit (DWord swapped) |
| heat-pump-vdaq-swap | Number:Energy | true | Accumulated thermal energy output of compressor unit (DWord swapped) |
@@ -162,16 +162,16 @@ This group contains information about the buffer for the heating circuit.
This group contains information about the solar thermic component.
| Channel ID | Item Type | Read only | Description |
| ------------------------------ | ------------------ | --------- | ------------------------------------------------------------------- |
| solar-error-number | Number | true | Solar Error Number (0 = No error) |
| solar-operating-state | Number | true | Solar Operating State: See Modbus description manual, link above |
| solar-collector-temperature | Number:Temperature | true | Temperature of the solar collector |
| solar-storage-temperature | Number:Temperature | true | Temperature of the solar storage |
| solar-pump-speed | Number | true | Speed of the solar pump |
| solar-heat-quantity | Number:Energy | true | Heat quantity produced by solar |
| solar-power-output | Number:Power | true | Current power output of solar |
| solar-operating-hours | Number | true | Operating hours of solar component |
| Channel ID | Item Type | Read only | Description |
|-----------------------------|--------------------|-----------|------------------------------------------------------------------|
| solar-error-number | Number | true | Solar Error Number (0 = No error) |
| solar-operating-state | Number | true | Solar Operating State: See Modbus description manual, link above |
| solar-collector-temperature | Number:Temperature | true | Temperature of the solar collector |
| solar-storage-temperature | Number:Temperature | true | Temperature of the solar storage |
| solar-pump-speed | Number | true | Speed of the solar pump |
| solar-heat-quantity | Number:Energy | true | Heat quantity produced by solar |
| solar-power-output | Number:Power | true | Current power output of solar |
| solar-operating-hours | Number | true | Operating hours of solar component |
### Heating Circuit Group
@@ -184,7 +184,7 @@ This group contains general operational information about the heating circuit.
| heating-circuit-flow-line-temperature | Number:Temperature | true | Actual temperature flow line sensor |
| heating-circuit-return-line-temperature | Number:Temperature | true | Actual temperature return line sensor |
| heating-circuit-room-device-temperature | Number:Temperature | false | Actual temperature room device sensor |
| heating-circuit-setpoint-flow-line-temperature | Number:Temperature | false | Setpoint temperature flow line |
| heating-circuit-setpoint-flow-line-temperature | Number:Temperature | false | Setpoint temperature flow line |
| heating-circuit-operating-mode | Number | false | Operating Mode: See Modbus description manual, link above |
| heating-circuit-target-temperature-flow-line | Number:Temperature | false | Setpoin temperature flow line (min = 15.0°C; max = 65.0°C) |
| heating-circuit-offset-flow-line-temperature | Number:Temperature | false | Setting for flow line temperature setpoint offset |
@@ -314,4 +314,3 @@ var int power_to_heat-pump = 1000
lambdaemanager_actualpower.sendCommand(power_to_heat-pump)
'''
bundles/org.openhab.binding.shelly/README.md
+3 -3
View File
@@ -1756,7 +1756,7 @@ See notes on discovery of Shelly BLU devices above.
| | lowBattery | Switch | yes | Low battery alert (< 20%) |
| device | gatewayDevice | String | yes | Shelly forwarded last status update (BLU gateway), could vary from packet to packet |
# Shelly BLU Wall Switch 4 (thing-type: shellybluwallswitch4)
## Shelly BLU Wall Switch 4 (thing-type: shellybluwallswitch4)
See notes on discovery of Shelly BLU devices above.
@@ -1782,7 +1782,7 @@ See notes on discovery of Shelly BLU devices above.
| | lowBattery | Switch | yes | Low battery alert (< 20%) |
| device | gatewayDevice | String | yes | Shelly forwarded last status update (BLU gateway), could vary from packet to packet |
# Shelly BLU RC Button 4 (thing-type: shellyblurcbutton4)
## Shelly BLU RC Button 4 (thing-type: shellyblurcbutton4)
See notes on discovery of Shelly BLU devices above.
@@ -1808,7 +1808,7 @@ See notes on discovery of Shelly BLU devices above.
| | lowBattery | Switch | yes | Low battery alert (< 20%) |
| device | gatewayDevice | String | yes | Shelly forwarded last status update (BLU gateway), could vary from packet to packet |
### Shelly BLU Door/Window Sensor (thing-type: shellybludw)
## Shelly BLU Door/Window Sensor (thing-type: shellybludw)
See notes on discovery of Shelly BLU devices above.
bundles/org.openhab.binding.somfycul/README.md
+1 -1
View File
@@ -97,7 +97,7 @@ sitemap home label="Home" {
### Clone Somfy RTS Remote to `somfy-device`
To clone an existing Somfy RTS Remote as a `somfy-device`, have your Somfy RTS remote ready and properly programmed to control your rollershutter. You'll need to have your `somfy-device` `items` set to `Switch` type and use the `program` channel.
To clone an existing Somfy RTS Remote as a `somfy-device`, have your Somfy RTS remote ready and properly programmed to control your rollershutter. You'll need to have your `somfy-device` `items` set to `Switch` type and use the `program` channel.
Use the manufacturers procedure to _copy_ a remote to another remote. Usually this means selecting the channel you wish to copy on your Somfy RTS remote, pressing and holding the `program` or `PROG` button for 2-3 seconds until the rollershutter briefly moves up/down to confirm it is about to be programmed.
Use your `somfy-device` `Switch` `item` to _press_ `program` shortly after to copy the remote channel to this `somfy-device`.
bundles/org.openhab.transform.basicprofiles/README.md
+7 -8
View File
@@ -16,7 +16,6 @@ This bundle provides a list of useful Profiles:
| [Inactivity Profile](#inactivity-profile) | Sets the linked Item On or Off depending whether the Channel has recently produced data |
| [Time-weighted Average Profile](#time-weighted-average-profile) | Collects updates for given duration to calculate time-weighted average value |
## Generic Command Profile
This Profile can be used to send a Command towards the Item when one event of a specified event list is triggered.
@@ -83,10 +82,10 @@ It can be used to debounce Item States/Commands or prevent excessive load on net
### Debounce (Time) Profile Configuration
| Configuration Parameter | Type | Description |
|-------------------------|---------|-----------------------------------------------|
| `toItemDelay` | integer | Timespan in ms before a received value is send to the item. |
| `toHandlerDelay` | integer | Timespan in ms before a received command is passed to the handler. |
| Configuration Parameter | Type | Description |
|-------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------|
| `toItemDelay` | integer | Timespan in ms before a received value is send to the item. |
| `toHandlerDelay` | integer | Timespan in ms before a received command is passed to the handler. |
| `mode` | text | `FIRST` (sends the first value received and discards later values), `LAST` (sends the last value received, discarding earlier values). |
### Debounce (Time) Profile Example
@@ -370,18 +369,18 @@ This profile aggregates all state updates within the configured duration and out
It is useful for reducing high frequency data before it reaches your persistence database, such as measurements from:
- inverters
- smart meters
- smart meters
- power plugs with electric measurement
This profile is only applicable to numeric channels, with or without unit metadata.
The average is calculated solely from state updates sent from the handler to the item.
Commands and item updates originating from rules or the UI are not affected.
Check the semantics of the channel if this profile fits.
Check the semantics of the channel if this profile fits.
E.g. a channel providing _power measurement_ values is a valid candidate to build averages.
A channel providing a status or accumulated value like _total energy production today_ is not a good candidate.
The optional `delta` parameter is used to identify increases / decreases of state values above or equal the configured delta.
This will break the steady time frame but reports rapid changes e.g. for power consumption immediately.
This will break the steady time frame but reports rapid changes e.g. for power consumption immediately.
### Time-weighted Average Profile Configuration
bundles/org.openhab.transform.geocoding/README.md
+12 -12
View File
@@ -1,6 +1,6 @@
# Geocoding Profile Transformation Service
Transformation to convert
Transformation to convert
- geo coordinates into human readable string address (reverse geocoding)
- string address description into geo coordinates (geocoding)
@@ -11,14 +11,14 @@ The reverse geocoding is applied when the channel updates the `Location` with la
These will be resolved into a human readable address.
Reverse geocoding is throttled by the profile with `resolveInterval` to avoid frequent calling.
## Geocoding
Geocoding is applied if you send a string command towards the item.
The API is translating this search string into geo coordinates which are send via the channel towards the handler.
Of course this makes sense only if the channel is declared as writable.
Formulate your string command as precise as possible to avoid ambiguous results.
E.g. _Springfield US_ command will deliver multiple results and only one is chosen for the transformation.
E.g. _Springfield US_ command will deliver multiple results and only one is chosen for the transformation.
Geocoding is not throttled by the profile.
@@ -32,12 +32,12 @@ Geocoding is not throttled by the profile.
| `language` | text | Preferred language of the result. Only necessary if openHAB locale settings shall be overwritten |
Select `provider` which shall be used to resolve addresses.
Currently one provider [Nominatim / OpenStreetMap](#nominatim--openstreetmap-provider) is available which is the default option.
Currently one provider [Nominatim / OpenStreetMap](#nominatim--openstreetmap-provider) is available which is the default option.
The `resolveInterval` defines the minimum time between two reverse geocoding transformations.
An external API is called to resolve the geo coordinates and it shall not be queried too frequent.
Channel updates within the Interval are omitted.
After the configured interval is expired the last received location will be transformed.
After the configured interval is expired the last received location will be transformed.
Minimum configurable interval is 1 minute.
Default is 5 minutes (`5m`).
@@ -46,9 +46,9 @@ Options:
- Address format Rest of World `address_row`: `street` `house-number`, `postcode` `city` `district` as default
- Address format US/UK `address_us`: `house-number` `street`, `city` `district` `postcode`
- Unformatted JSON response: `json`
- Unformatted JSON response: `json`
Note that [address fields](https://nominatim.org/release-docs/latest/api/Output/#addressdetails) may be missing e.g. for rural areas.
Note that [address fields](https://nominatim.org/release-docs/latest/api/Output/#addressdetails) may be missing e.g. for rural areas.
The API calls are performed with your openHAB locale settings.
This can be overwritten with `language` configuration parameter using [Java Locale format](https://www.oracle.com/java/technologies/javase/jdk21-suported-locales.html).
@@ -59,18 +59,18 @@ This can be overwritten with `language` configuration parameter using [Java Loca
Geocoding transformation provider using [Nominatim API for OpenStreetMap](https://nominatim.org/release-docs/latest/) to resolve
- geo coordinates into a human readable string ([reverse geocoding](https://nominatim.org/release-docs/latest/api/Reverse/))
- an address string into geo coordinates ([geocoding](https://nominatim.org/release-docs/latest/api/Search/))
- geo coordinates into a human readable string ([reverse geocoding](https://nominatim.org/release-docs/latest/api/Reverse/))
- an address string into geo coordinates ([geocoding](https://nominatim.org/release-docs/latest/api/Search/))
**You must respect the** [Nominatim Usage Policy](https://operations.osmfoundation.org/policies/nominatim/)!
You need to estimate your call frequency towards the _Nominatim_ provider.
For reverse geocoding the configuration parameter `resolveInterval` with minimum resolve time of 1 minute shall fulfill the throttling requirements.
For geocoding there's no throttling.
Each user needs to respect the maximum allowed frequency of 1 call per second.
The required `User-Agent` is provided by this transformation profile.
The required `User-Agent` is provided by this transformation profile.
Credits to [Nominatim](https://nominatim.org) and [OpenStreetMap](https://www.openstreetmap.org/) to provide this free service!
### Example
### Example
```java
String <itemName> { channel="<locationChannelUID>"[profile="transform:geocoding",provider="nominatim-osm",format="us_address",resolveInterval="10m",language="en-US"]}