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

Markdown catchup (#19885)

Browse Source 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
This commit is contained in:
lsiepel
2025-12-29 16:57:59 +01:00
committed by GitHub
parent a5063ed45e
commit 31de70d188
28 changed files with 154 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bundles/org.openhab.binding.automower/README.md
+1 -2
View File
@@ -42,13 +42,12 @@ In addition to periodic polling, the binding also receives event-triggered notif
`work-area:`
- none
- none
`stay-out-zone:`
- none
## Channels
### `automower` Channels
bundles/org.openhab.binding.avmfritz/README.md
+1 -1
View File
@@ -38,7 +38,7 @@ For AHA functionality, the router has to run at least on firmware FRITZ!OS 6.00
> e.g. FRITZ!DECT 200 is now called FRITZ!Smart Energy 200 or FRITZ!DECT 302 is now called FRITZ!Smart Thermo 302.
> Otherwise, everything will remain typically FRITZ!.
> FRITZ!Smart contains FRITZ!DECT's convenience, sophisticated technology, and familiar ease of use.
> In terms of technology, the FRITZ!Smart products are identical with FRITZ!DECT.
> In terms of technology, the FRITZ!Smart products are identical with FRITZ!DECT.
### FRITZ!DECT 200 / FRITZ!DECT 210
bundles/org.openhab.binding.bambulab/README.md
+5 -5
View File
@@ -22,10 +22,10 @@ While cloud mode is theoretically possible, it is not supported by the addon dev
}
```
* `00ABCDEFG123456` → Serial number
* `12345678` → Access code
- `00ABCDEFG123456` → Serial number
- `12345678` → Access code
2. **Enter the details in openHAB**
1. **Enter the details in openHAB**
- **Serial number** → Enter the serial number from the config file
- **Access code** → Enter the access code from the config file
@@ -50,9 +50,9 @@ Use this value as the `username` in the configuration (advanced field) with the
To obtain an access token, you can use the `requestLoginCode` and `requestAccessCode` actions available on the printer thing.
1. **Request Login Code**: Use the `requestLoginCode` action with your Bambu Lab username (email) and password. This will send a 6-digit verification code to your email address.
1. **Request Login Code**: Use the `requestLoginCode` action with your Bambu Lab username (email) and password. This will send a 6-digit verification code to your email address.
![Request Login Code](doc/RequestLoginCode.png)
2. **Request Access Code**: Once you receive the verification code, use the `requestAccessCode` action with your Bambu Lab username (email) and the received 6-digit code. This will retrieve the access token and automatically update the printer thing's configuration with the new `accessCode` and set the `hostname` to `us.mqtt.bambulab.com`.
1. **Request Access Code**: Once you receive the verification code, use the `requestAccessCode` action with your Bambu Lab username (email) and the received 6-digit code. This will retrieve the access token and automatically update the printer thing's configuration with the new `accessCode` and set the `hostname` to `us.mqtt.bambulab.com`.
![Request Access Code](doc/RequestAccessCode.png)
Alternatively, you can use the `bambu.sh` script as described below:
bundles/org.openhab.binding.boschindego/README.md
+1 -1
View File
@@ -25,7 +25,7 @@ To authorize, please follow these steps:
- With developer tools showing on the right, go to [Bosch Indego login page](https://prodindego.b2clogin.com/prodindego.onmicrosoft.com/b2c_1a_signup_signin/oauth2/v2.0/authorize?redirect_uri=com.bosch.indegoconnect://login&client_id=65bb8c9d-1070-4fb4-aa95-853618acc876&response_type=code&scope=openid%20offline_access%20https://prodindego.onmicrosoft.com/indego-mobile-api/Indego.Mower.User) again.
- "Please wait..." should now be displayed.
- Find the `authresp` and copy the code: `com.bosch.indegoconnect://login/?code=<copy this>`
- Use the openHAB console to authorize with this code: `openhab:boschindego authorize <bridgeId> <paste code>`
- Use the openHAB console to authorize with this code: `openhab:boschindego authorize <bridgeId> <paste code>`
### `indego` Thing Configuration
bundles/org.openhab.binding.chatgpt/README.md
+15 -17
View File
@@ -64,9 +64,7 @@ In this case, the item names must follow the naming convention '\<Location>_***'
## Full Examples
### Prerequisites
**Thing Configuration**
### Thing Configuration
```java
Thing chatgpt:account:1 [
@@ -88,9 +86,9 @@ Thing chatgpt:account:1 [
### Example: Improving messages
**Items**
#### Items
```
```java
String Weather_Announcement { channel="chatgpt:account:1:chat" }
String Morning_Message { channel="chatgpt:account:1:morningMessage" }
@@ -98,7 +96,7 @@ Number Temperature_Forecast_Low
Number Temperature_Forecast_High
```
**Rules**
#### Rules
```java
rule "Weather forecast update"
@@ -136,23 +134,23 @@ The state updates can be used for a text-to-speech output and they will give you
### Example: Item control using voice
**Item**
#### Item
```
```java
Dimmer Kitchen_Dimmer "Kitchen main light" [ "ChatGPT" ]
```
**UI Configuration of the HLI Service**
#### UI Configuration of the HLI Service
To enable the HLI service, go to Settings -> Voice and choose "ChatGPT Human Language Interpreter".
**For voice control**
#### For voice control
A text-to-speech service must be configured in the HLI Service.
Use the HLI service as with e.g. a keyword recognizer, SST and a TTS module to start listening on a keyword, get from speach to text with the SST module, have it interpreted by ChatGPT through the HLI part of this plugin and read out to you via TTS.
**Explanation**
#### Explanation
The binding includes a function named `items_control` which can be used by ChatGPT to send commands to items and output their status. To enable ChatGPT to access that function, the ChatGPT _Thing_ (not the channel) needs to be configured with a system message like
@@ -171,26 +169,26 @@ The important bits of the message are to mention the list of 'Available devices'
### Example: Item control with a simple chat
**UI Configuration of the HLI Service**
#### UI Configuration of the HLI Service
To enable the HLI service, go to Settings -> Voice and choose "ChatGPT Human Language Interpreter".
**Items**
#### Items
For chat input and output
```
```java
String hli_chat_input "ChatGPT HLI Input" [Setpoint]
String hli_chat_output "ChatGPT HLI Output" [Calculation]
```
For having something to control
```
```java
Dimmer Kitchen_Dimmer "Kitchen main light" [ "ChatGPT" ]
```
**Rule**
#### Rule
This (UI defined) rule will read the current text from `hli_chat_input` upon change, interpret with the _default_ interpreter (you should have set ChatGPT to be that interpreter in `UI Configuration of the HLI Service`) and write the interpretation result to the item `hli_chat_output` or, depending on the message, trigger an update for your items (never both).
@@ -216,6 +214,6 @@ actions:
type: script.ScriptAction
```
**Further Instructions**
#### Further Instructions
You can now add an input field with a "send" button to you UI, to update `hli_chat_input`, and an output field (e.g. a label) to display the response in `hli_chat_output`
bundles/org.openhab.binding.homewizard/README.md
-1
View File
@@ -153,7 +153,6 @@ For DSMR5 meters this is generally once per second, for older versions the frequ
| total_liter | Number:Volume | Total water usage in cubic meters. | v1 |
| active_liter | Number:VolumetricFlowRate | The active water usage in liters per minute. | v1 |
## Full Example
### `homewizard.things` Example
bundles/org.openhab.binding.icloud/README.md
+2 -1
View File
@@ -13,7 +13,8 @@ You will need to provide the account password to the Binding.
## Discovery
An iCloud account can be added as a Thing and needs to be configured with your ID and password.
The devices registered to this account will then be automatically discovered. If not, it might be necessary to log in to https://www.icloud.com/ and accept the terms of use, verify account security settings, or complete any pending account setup steps.
The devices registered to this account will then be automatically discovered.
If not, it might be necessary to log in to <https://www.icloud.com/> and accept the terms of use, verify account security settings, or complete any pending account setup steps.
## Binding Configuration
bundles/org.openhab.binding.knx/AGENTS.md
+9 -1
View File
@@ -5,6 +5,7 @@
You are now a **KNX expert** working on the openHAB KNX binding - connecting openHAB with **KNX installations** (European standard for home and building automation).
### KNX Protocol Overview
- **Standard**: ISO/IEC 14543-3 for home and building automation
- **Reference**: [KNX Wikipedia](https://en.wikipedia.org/wiki/KNX)
- **Applications**: Lighting, HVAC, security, energy management
@@ -30,12 +31,14 @@ Purpose: To enable interworking between different KNX devices, the data represen
**Official DPT Specification**: [KNX DPT Reference PDF](https://support.knx.org/hc/en-us/article_attachments/15392631105682)
**Common DPT Categories:**
- **DPT 1.x**: Boolean (switches, binary sensors)
- **DPT 5.x**: 8-bit unsigned (dimming, blinds)
- **DPT 9.x**: 16-bit float (temperature, humidity)
- **DPT 14.x**: 32-bit float (energy, power)
## KNX Security Support
- **KNX IP Secure**: Fully supported for both secure interfaces and secure routers
- **KNX Data Secure**: Read-only support - can decode secure data but cannot send Data Secure telegrams
@@ -44,15 +47,18 @@ Purpose: To enable interworking between different KNX devices, the data represen
### Testing & Debugging
#### KNX-Specific Testing
- **Mock Infrastructure**: Use Calimero test utilities for unit tests
- **Hardware Testing**: Requires KNX IP Interface and ETS software
- **DPT Validation**: Test all supported data type conversions
#### Code Coverage
Results available in `target/site/jacoco/index.html` after running tests (as per root AGENTS.md).
#### Debug Logging
```properties
```shell
# KNX-specific debug logging, set to DEBUG or TRACE
log:set DEBUG tuwien.auto.calimero
log:set DEBUG org.openhab.binding.knx
@@ -61,11 +67,13 @@ log:set DEBUG org.openhab.binding.knx
## Common KNX Issues
### Troubleshooting
- **Gateway Discovery**: KNXnet/IP multicast issues in containerized environments
- **Group Address Conflicts**: Validate ETS project configuration
- **DPT Mismatches**: Ensure correct openHAB ↔ KNX data type mapping
### Hardware Requirements
- **KNX IP Interface**: Required for real KNX network testing
- **ETS Software**: KNX Engineering Tool Software for device configuration
- **Test Devices**: Various KNX actuators/sensors for comprehensive testing
bundles/org.openhab.binding.lgwebos/README.md
+8 -9
View File
@@ -29,10 +29,10 @@ The binding broadcasts a search message via UDP on the network in order to disco
Please note, that if you are running openHAB in a Docker container you have several alternatives for this binding to work:
* use macvlan or host networking
* manually configure the device:
* host and access key for basic functionality
* mac address and broadcast address to be able to turn on the TV
- use macvlan or host networking
- manually configure the device:
- host and access key for basic functionality
- mac address and broadcast address to be able to turn on the TV
## Thing Configuration
@@ -57,12 +57,11 @@ Example: If your TV has the IP address `192.168.0.123`, the broadcast address is
In addition forwarding of broadcast packets needs to be enabled:
* net.ipv4.icmp_echo_ignore_broadcasts=0
* net.ipv4.conf.all.bc_forwarding=1
* net.ipv4.conf.${interface}.bc_forwarding=1
See for example [here](https://www.devwithimagination.com/2020/06/15/homebridge-docker-and-wake-on-lan/) for instructions how to do that.
- net.ipv4.icmp_echo_ignore_broadcasts=0
- net.ipv4.conf.all.bc_forwarding=1
- net.ipv4.conf.${interface}.bc_forwarding=1
See, for example, [this guide on Homebridge, Docker, and Wake-on-LAN](https://www.devwithimagination.com/2020/06/15/homebridge-docker-and-wake-on-lan/) for instructions on enabling broadcast forwarding.
### Configuration in .things file
bundles/org.openhab.binding.linky/README.md
+3 -4
View File
@@ -254,7 +254,7 @@ The retrieved information is available in multiple groups.
#### Dynamic Thing Channels
The binding (as of openHAB 5.1.0) supports reading consumption indexes from the Enedis website.
This makes it possible to view consumption for different tariffs such as *heures pleines / heures creuses* or *tempo*.
This makes it possible to view consumption for different tariffs such as _heures pleines / heures creuses_ or _tempo_.
To handle this, binding will create a new set of channels for daily, weekly, monthly, and yearly groups.
@@ -264,7 +264,6 @@ You will have two different sets of indexes:
These are the default indexes returned by Enedis. The naming uses base indexes, so there is no direct way to know which tariff each index corresponds to.
Channels will be named as follows:
consumptionSupplierIdx0, consumptionSupplierIdx1, ..., consumptionSupplierIdx9
consumptionDistributorIdx0, consumptionDistributorIdx1, ..., consumptionDistributorIdx3
@@ -278,7 +277,7 @@ For example:
daily#heuresPleines, daily#heuresCreuses, daily#bleuHeuresCreuses,
daily#bleuHeuresPleines, daily#redHeuresCreuses, ...
⚠️ **Warning:**
⚠️ **Warning:**
Dynamic channels and indexes are currently only supported with the **EnedisWebBridge**.
Support for other bridges will be introduced later, once Enedis provides an API to access this data.
@@ -320,7 +319,7 @@ Number Linky_Tempo "Linky Tempo Day [%s]" channel="linky:tempo-calendar:local:te
### Displaying Information Graph
Using the timeseries channel and the binding version in openHAB 5.1.0, you will be able to easily create a chart to show the consumption graph.
Using the timeseries channel and the binding version in openHAB 5.1.0, you will be able to easily create a chart to show the consumption graph.
To do this, you need to enable a timeseries persistence framework.
Graph definitions will look like this:
bundles/org.openhab.binding.matter/README.md
+7 -7
View File
@@ -592,16 +592,16 @@ The following attributes can be set on the Fan Mode item or the Group item to se
A `ModeSelect` device exposes a device which responds to user defined selectable modes.
This can be used to model items which may not conform to other devices types.
`ModeSelect` items (or groups) must provide a mapping of Matter modes to openHAB state values via the metadata option `modes`. The format is a comma-separated list where each entry follows:
```
```text
<stateValue>:<label>[:<semanticTag>[:<semanticTag>...]]
```
* `stateValue` – the exact openHAB state string you will send/receive (e.g. `off`, `auto`, `heat`, '0').
* `label` – human-readable label presented to Matter clients.
* `semanticTag` – optional semantic hint in `namespace.tag` form (see the [Semantic Tags](#semantic-tags) appendix for valid values).
- `stateValue` – the exact openHAB state string you will send/receive (e.g. `off`, `auto`, `heat`, '0').
- `label` – human-readable label presented to Matter clients.
- `semanticTag` – optional semantic hint in `namespace.tag` form (see the [Semantic Tags](#semantic-tags) appendix for valid values).
At least one mode must be supplied.
@@ -617,8 +617,8 @@ A note on semantic tags:
- If used, you can not mix different semantic namespaces as seen in the example above where `switches` is the base namespace being used for all tags.
- These are provided by the Matter spec, but its up to clients (like Apple, Alexa, Google....) to interpret these tags (or not).
- Each ecosystem will likely differ in its use of these tags.
- They are provided here for maximum flexiblity but are not guarenteed to have any affect.
- Each ecosystem will likely differ in its use of these tags.
- They are provided here for maximum flexibility but are not guarenteed to have any affect.
</details>
bundles/org.openhab.binding.meross/README.md
+9 -9
View File
@@ -38,18 +38,18 @@ Moreover, the devices should be in an online status.
## Bridge Configuration
| Name | Type | Description | Default | Required | Advanced |
|----------|------|----------------------------------------------------------|----------------------------|----------|----------|
| hostname | text | Meross Hostname or IP address (for Europe located users) | https://iotx-eu.meross.com | yes | yes |
| email | text | Email of your Meross Account | N/A | yes | no |
| password | text | Password of your Meross Account | N/A | yes | no |
| Name | Type | Description | Default | Required | Advanced |
|----------|------|----------------------------------------------------------|------------------------------|----------|----------|
| hostname | text | Meross Hostname or IP address (for Europe located users) | <https://iotx-eu.meross.com> | yes | yes |
| email | text | Email of your Meross Account | N/A | yes | no |
| password | text | Password of your Meross Account | N/A | yes | no |
### Other host locations
| Location | Hostname |
|--------------|----------------------------|
| Asia-Pacific | https://iotx-ap.meross.com |
| US | https://iotx-us.meross.com |
| Location | Hostname |
|--------------|------------------------------|
| Asia-Pacific | <https://iotx-ap.meross.com> |
| US | <https://iotx-us.meross.com> |
If you are outside of Europe, please set the appropriate `Hostname`.
bundles/org.openhab.binding.mideaac/README.md
+41 -41
View File
@@ -29,53 +29,53 @@ No binding configuration is required.
## Thing Configuration
| Parameter | Required ? | Comment | Default | Advanced |
|---------------|-------------|-------------------------------------------------------------------|---------------------------|----------|
| ipAddress | Yes | IP Address of the device. | | |
| ipPort | Yes | IP port of the device | 6444 | Yes |
| deviceId | Yes | ID of the device. Leave 0 to do ID discovery. | 0 | Yes |
| cloud | Yes for V.3 | Your Cloud Provider name (or default). | NetHome Plus | |
| email | No | Email for your cloud account (or default). | nethome+us@mailinator.com | |
| password | No | Password for your cloud account (or default). | password1 | |
| token | Yes for V.3 | Secret Token - Retrieved from cloud | | Yes |
| key | Yes for V.3 | Secret Key - Retrieved from cloud | | Yes |
| pollingTime | Yes | Frequency to Poll AC Status in seconds. Minimum is 30. | 60 seconds | |
| keyTokenUpdate| No | Frequency to update key-token from cloud in hours. Minimum is 24 | 0 hours (disabled) | Yes |
| energyPoll | Yes | Frequency to poll energy data (if supported) | 0 minutes (disabled) | |
| timeout | Yes | Socket connection timeout in seconds. Min. is 2, max. 10. | 4 seconds | Yes |
| promptTone | Yes | "Ding" tone when command is received and executed. | false | |
| version | Yes | Version 3 has token, key and cloud requirements. | 3 | Yes |
| energyDecode | Yes | Binary Coded Decimal (BCD) = true. Big-endian = false. | true | Yes |
| Parameter | Required ? | Comment | Default | Advanced |
|----------------|-------------|-------------------------------------------------------------------|-----------------------------|----------|
| ipAddress | Yes | IP Address of the device. | | |
| ipPort | Yes | IP port of the device | 6444 | Yes |
| deviceId | Yes | ID of the device. Leave 0 to do ID discovery. | 0 | Yes |
| cloud | Yes for V.3 | Your Cloud Provider name (or default). | NetHome Plus | |
| email | No | Email for your cloud account (or default). | <nethome+us@mailinator.com> | |
| password | No | Password for your cloud account (or default). | password1 | |
| token | Yes for V.3 | Secret Token - Retrieved from cloud | | Yes |
| key | Yes for V.3 | Secret Key - Retrieved from cloud | | Yes |
| pollingTime | Yes | Frequency to Poll AC Status in seconds. Minimum is 30. | 60 seconds | |
| keyTokenUpdate | No | Frequency to update key-token from cloud in hours. Minimum is 24 | 0 hours (disabled) | Yes |
| energyPoll | Yes | Frequency to poll energy data (if supported) | 0 minutes (disabled) | |
| timeout | Yes | Socket connection timeout in seconds. Min. is 2, max. 10. | 4 seconds | Yes |
| promptTone | Yes | "Ding" tone when command is received and executed. | false | |
| version | Yes | Version 3 has token, key and cloud requirements. | 3 | Yes |
| energyDecode | Yes | Binary Coded Decimal (BCD) = true. Big-endian = false. | true | Yes |
## Channels
Following channels are available:
Note: After discovery, the Thing properties dropdown on the Thing UI page will show what channels and modes your device supports.
| Channel | Type | Description | Read only | Advanced |
|----------------------|--------------------|--------------------------------------------------------------------------------------------------------|-----------|----------|
| power | Switch | Turn the AC on or off. | | |
| target-temperature | Number:Temperature | Target temperature. | | |
| operational-mode | String | Operational modes: OFF, AUTO, COOL, DRY, HEAT, FAN ONLY | | |
| fan-speed | String | Fan speeds: OFF (turns off), SILENT, LOW, MEDIUM, HIGH, AUTO. Not all modes supported by all units. | | |
| swing-mode | String | Swing mode: OFF, VERTICAL, HORIZONTAL, BOTH. Not all modes supported by all units. | | |
| eco-mode | Switch | Eco mode - Cool only (Temperature is set to 24 C (75 F) and fan on AUTO) | | |
| turbo-mode | Switch | Turbo mode, "Boost" in Midea Air app, long press "+" on IR Remote Controller. COOL and HEAT mode only. | | |
| sleep-function | Switch | Sleep function ("Moon with a star" icon on IR Remote Controller). | | |
| indoor-temperature | Number:Temperature | Indoor temperature measured in the room, where internal unit is installed. | Yes | |
| outdoor-temperature | Number:Temperature | Outdoor temperature by external unit. Some units do not report reading when off. | Yes | |
| temperature-unit | Switch | Sets the LED display on the evaporator to Fahrenheit (true) or Celsius (false). | | Yes |
| on-timer | String | Sets the future time to turn on the AC. | | Yes |
| off-timer | String | Sets the future time to turn off the AC. | | Yes |
| screen-display | Switch | If device supports across LAN, turns off the LED display. | | Yes |
| maximum-humidity | Number | If device supports, allows setting the maximum humidity in DRY mode | | Yes
| humidity | Number | If device supports, the indoor room humidity. | Yes | Yes |
| energy-consumption | Number | If device supports, cumulative Kilowatt-Hours usage | Yes | Yes |
| current-draw | Number | If device supports, instantaneous amperage usage | Yes | Yes |
| power-consumption | Number | If device supports, instantaneous wattage reading | Yes | Yes |
| appliance-error | Switch | If device supports, appliance error notification | Yes | Yes |
| filter-status | Switch | If device supports, notification that filter needs cleaning | Yes | Yes |
| auxiliary-heat | Switch | If device supports, auxiliary heat (On or Off) | Yes | Yes |
| Channel | Type | Description | Read only | Advanced |
|---------------------|--------------------|--------------------------------------------------------------------------------------------------------|-----------|----------|
| power | Switch | Turn the AC on or off. | | |
| target-temperature | Number:Temperature | Target temperature. | | |
| operational-mode | String | Operational modes: OFF, AUTO, COOL, DRY, HEAT, FAN ONLY | | |
| fan-speed | String | Fan speeds: OFF (turns off), SILENT, LOW, MEDIUM, HIGH, AUTO. Not all modes supported by all units. | | |
| swing-mode | String | Swing mode: OFF, VERTICAL, HORIZONTAL, BOTH. Not all modes supported by all units. | | |
| eco-mode | Switch | Eco mode - Cool only (Temperature is set to 24 C (75 F) and fan on AUTO) | | |
| turbo-mode | Switch | Turbo mode, "Boost" in Midea Air app, long press "+" on IR Remote Controller. COOL and HEAT mode only. | | |
| sleep-function | Switch | Sleep function ("Moon with a star" icon on IR Remote Controller). | | |
| indoor-temperature | Number:Temperature | Indoor temperature measured in the room, where internal unit is installed. | Yes | |
| outdoor-temperature | Number:Temperature | Outdoor temperature by external unit. Some units do not report reading when off. | Yes | |
| temperature-unit | Switch | Sets the LED display on the evaporator to Fahrenheit (true) or Celsius (false). | | Yes |
| on-timer | String | Sets the future time to turn on the AC. | | Yes |
| off-timer | String | Sets the future time to turn off the AC. | | Yes |
| screen-display | Switch | If device supports across LAN, turns off the LED display. | | Yes |
| maximum-humidity | Number | If device supports, allows setting the maximum humidity in DRY mode | | Yes |
| humidity | Number | If device supports, the indoor room humidity. | Yes | Yes |
| energy-consumption | Number | If device supports, cumulative Kilowatt-Hours usage | Yes | Yes |
| current-draw | Number | If device supports, instantaneous amperage usage | Yes | Yes |
| power-consumption | Number | If device supports, instantaneous wattage reading | Yes | Yes |
| appliance-error | Switch | If device supports, appliance error notification | Yes | Yes |
| filter-status | Switch | If device supports, notification that filter needs cleaning | Yes | Yes |
| auxiliary-heat | Switch | If device supports, auxiliary heat (On or Off) | Yes | Yes |
## Examples
bundles/org.openhab.binding.miio/README.md
+2 -3
View File
@@ -6338,7 +6338,7 @@ Note, not all the values need to be in the json file, e.g. a subset of the param
| Channel | Type | Description | Comment |
|----------------------------|----------------------|------------------------------------------|------------|
| fault | Number | Heater - Device Fault | Value mapping `["0"="No Error","1"="NTC Connect Error","2"="High Temperature Alarm","3"="EEPROM Error","4"="Multi Errors"]` |
| fault | Number | Heater - Device Fault | Value mapping `["0"="No Error","1"="NTC Connect Error","2"="High Temperature Alarm","3"="EEPROM Error","4"="Multi Errors"]` |
| on | Switch | Heater - Power | |
| target-temperature | Number:Temperature | Heater - Target Temperature | |
| alarm | Switch | Alarm - Alarm | |
@@ -6354,7 +6354,7 @@ Note, not all the values need to be in the json file, e.g. a subset of the param
| Channel | Type | Description | Comment |
|----------------------------|----------------------|------------------------------------------|------------|
| on | Switch | Heater - Power | |
| fault | Number | Heater - Device Fault | Value mapping `["0"="No Error","1"="NTC Connect Error","2"="High Temperature Alarm","3"="EEPROM Error","4"="Multi Errors"]` |
| fault | Number | Heater - Device Fault | Value mapping `["0"="No Error","1"="NTC Connect Error","2"="High Temperature Alarm","3"="EEPROM Error","4"="Multi Errors"]` |
| target-temperature | Number:Temperature | Heater - Target Temperature | |
| alarm | Switch | Alarm - Alarm | |
| countdown-time | Number:Time | Countdown - Countdown Time | |
@@ -13270,7 +13270,6 @@ Number lp_autooff_delay "Low Power Limit Time" (G_powerstrip) {channel="miio:bas
Number lp_threshold "Low Power Threshold" (G_powerstrip) {channel="miio:basic:powerstrip:lp_threshold"}
```
### Country Servers
Known country Servers: cn, de, i2, ru, sg, us
bundles/org.openhab.binding.modbus.lambda/README.md
+7 -6
View File
@@ -26,7 +26,7 @@ Note, that the things will show up under the Modbus binding.
A Modbus Bridge has to be installed before installing the above mentioned things.
The binding supports installations with more than one Heat Pump, Boiler, Buffer, Heating Circuit.
For each of these parts you have to provide the Subindex of your Thing in the configurations section, usually using the User Interface.
For each of these parts you have to provide the Subindex of your Thing in the configurations section, usually using the User Interface.
So if you have two Heating Circuits use 0 for the first and 1 for the second Heating Circuit.
Handling of General System Settings (Base Adress 200) is not supported (yet). Solar functions (Base Address 4000) are now supported.
Some of the registers noted RW in the manual are read only in the binding.
@@ -37,7 +37,7 @@ This extension does not support autodiscovery. The things need to be added manua
## Thing Configuration
You first need to set up a TCP Modbus bridge according to the Modbus documentation.
You first need to set up a TCP Modbus bridge according to the Modbus documentation.
A typical modbus bridge configuration would look like this:
```java
@@ -72,7 +72,7 @@ Heat Pump, Boiler, Buffer and Heating Circuit things use another parameter Subin
Channels within the things are grouped into channel groups.
### General:
### General
### Ambient Group
@@ -116,7 +116,7 @@ This group contains general operational information about the heat pump itself.
| 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-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 |
@@ -157,6 +157,7 @@ This group contains information about the buffer for the heating circuit.
| buffer-request-heat-sink-temperature-difference | Number:Temperature | false | Requested temperature difference between flow line and return line |
| buffer-request-heating-capacity | Number:Power | false | Requested capacity |
| maximum-buffer-temperature | Number:Temperature | false | Setting for maximum buffer temperature ) |
### Solar Group
This group contains information about the solar thermic component.
@@ -228,8 +229,8 @@ Number:Temperature lambdabuffer_requestreturnlinetemperature "Request Return L
Number:Temperature lambdabuffer_requestheatsinktemperature "Requested Heat Sink Temperature Difference" (lambdabuffer) { channel="modbus:buffer:Lambda_Bridge:lambdabuffer:buffer-group#buffer-request-heat-sink-temperature" }
Number:Power lambdabuffer_requestheatingcapacity "Requested Heating Capacity" (lambdabuffer) { channel="modbus:buffer:Lambda_Bridge:lambdabuffer:buffer-group#buffer-request-heating-capacity" }
Number:Temperature lambdabuffer_maximumbuffertemperature "Maximum Buffer Temperature" (lambdabuffer) { channel="modbus:buffer:Lambda_Bridge:lambdabuffer:buffer-group#maximum-buffer-temperature" }
```
```
### Items Lambda General
```java
bundles/org.openhab.binding.modbus.stiebeleltron/README.md
+16 -17
View File
@@ -11,7 +11,7 @@ About the ISG plus (only German, French and Italian)
<https://www.stiebel-eltron.ch/de/home/produkte-loesungen/erneuerbare_energien/regelung_energiemanagement/isg-plus/isg-plus.html>
SG Ready (Smart Grid) functions only supported with ISG plus version.
Note about the new ISG version "*ISG connect*": it is unknown, if this binding supports it.
Note about the new ISG version "_ISG connect_": it is unknown, if this binding supports it.
## Supported Things
@@ -23,11 +23,11 @@ Note, that the things will show up under the Modbus binding.
| Stiebel Eltron Heat Pump | heatpump | A Stiebel Eltron Heat Pump connected through modbus to an ISG |
| Stiebel Eltron Heat Pump (WPM compatible) | stiebeleltron-heatpump-allwpm | A Stiebel Eltron Heat Pump (WPM compatible) Thing with extended function support connected through Modbus to an ISG |
The first Thing *Stiebel Eltron Heat Pump* and its channel IDs have been kept for compatibility reasons.
It's recommended to switch to the second Thing *Stiebel Eltron Heat Pump (WPM compatible)* as it supports the retrieval of much more information from a compatible heat pump controller (WPM).
The first Thing _Stiebel Eltron Heat Pump_ and its channel IDs have been kept for compatibility reasons.
It's recommended to switch to the second Thing _Stiebel Eltron Heat Pump (WPM compatible)_ as it supports the retrieval of much more information from a compatible heat pump controller (WPM).
Supported controllers are WPMsystem, WPM3 and WPM3i.
If the SG Ready (Smart Grid Ready) polling is enabled using configuration parameter *pollSgReady*, the controller id is retrieved and visible in the appropriate channel.
If the id is known, it can be set in the configuration parameter *wpmControllerId*.
If the SG Ready (Smart Grid Ready) polling is enabled using configuration parameter _pollSgReady_, the controller id is retrieved and visible in the appropriate channel.
If the id is known, it can be set in the configuration parameter _wpmControllerId_.
The binding functions without the correct controller id as it checks the retrieved values and sets unavailable channels fix to NULL.
## Discovery
@@ -51,7 +51,6 @@ The following configuration parameters are valid for the `stiebeleltron-heatpump
| refresh | integer | no | 5 | Poll interval in seconds. Increase this if you encounter connection errors |
| maxTries | integer | no | 3 | Number of retries before giving up reading from this Thing |
| Parameter | Type | Required | Default if omitted | Description |
| --------------- | ------- | -------- | ------------------ | ------------------------------------------------------------------------------------ |
| allowResetCmds | boolean | no | false | Flag to enable execution of supported reset commands (use with care; see note below) |
@@ -70,13 +69,13 @@ Bridge modbus:tcp:bridge [ host="10.0.0.2", port=502, id=1 ] {
## Channels
Channels are grouped into channel groups.
The heat pump Thing *Stiebel Eltron Heat Pump (WPM compatible)* supports more channels dependant on the available heat pump type.
The heat pump Thing _Stiebel Eltron Heat Pump (WPM compatible)_ supports more channels dependant on the available heat pump type.
### System State Groups
This groups contain general state information about the heat pump.
#### Channels supported by the legacy Thing *Stiebel Eltron Heat Pump*
#### Channels supported by the legacy Thing _Stiebel Eltron Heat Pump_
| Channel ID | Item Type | Read only | Description |
| ---------------- | --------- | --------- | ------------------------------------------------------------- |
@@ -128,7 +127,7 @@ Note: The column WPM is for WPMsystem.
This group contains system paramters of the heat pump.
#### Channels supported by Thing *Stiebel Eltron Heat Pump*
#### Channels supported by Thing _Stiebel Eltron Heat Pump_
| Channel ID | Item Type | Read only | Description |
| --------------------------- | ------------------ | --------- | ------------------------------------------------------------------------------------------------ |
@@ -178,7 +177,7 @@ Channel 'restart-isg': The binding only accepts command 1 - command 2 (service k
This group contains general operational information about the device.
#### Channels supported by Thing *Stiebel Eltron Heat Pump*
#### Channels supported by Thing _Stiebel Eltron Heat Pump_
| Channel ID | Item Type | Read only | Description |
| -------------------------- | -------------------- | --------- | ----------------------------------------------------- |
@@ -251,13 +250,13 @@ Note: The column WPM is for WPMsystem.
#### Note
The last block can be available for up to 6 heat pumps. The number of available heat pumps shall be set with the configuration paramaeter *nrOfHps*.
The last block can be available for up to 6 heat pumps. The number of available heat pumps shall be set with the configuration parameter _nrOfHps_.
### Energy Information Group
This group contains information about the energy consumption and delivery of the heat pump.
#### Channels supported by things *Stiebel Eltron Heat Pump*
#### Channels supported by things _Stiebel Eltron Heat Pump_
| Channel ID | Item Type | Read only | Description |
| -----------------------------------| ------------- | --------- | -------------------------------------------------------|
@@ -316,11 +315,11 @@ Note: The column WPM is for WPMsystem.
#### Note
The last block can be available for up to 6 heat pumps. The number of available heat pumps shall be set with the configuration paramaeter *nrOfHps*.
The last block can be available for up to 6 heat pumps. The number of available heat pumps shall be set with the configuration parameter _nrOfHps_.
### SG Ready - Energy Management Settings
The following channels are only available for the thing *Stiebel Eltron Heat Pump (WPM compatible)*
The following channels are only available for the thing _Stiebel Eltron Heat Pump (WPM compatible)_
| Channel ID | Item Type | Read only | Description |
| -----------------------| ----------| --------- | -----------------------|
@@ -329,14 +328,14 @@ The following channels are only available for the thing *Stiebel Eltron Heat Pum
### SG Ready - Energy Management System Information
The following channels are only available for the thing *Stiebel Eltron Heat Pump (WPM compatible)*
The following channels are only available for the thing _Stiebel Eltron Heat Pump (WPM compatible)_
| Channel ID | Item Type | Read only | Description |
| ---------------------------------- | ----------| --------- | -----------------------------------|
| sg-ready-operating-state | Number | true | SG Ready Operating State |
| sg-ready-controller-identification | Number | true | SG Ready Controller Identification |
## Full Example for the Thing *Stiebel Eltron Heat Pump*
## Full Example for the Thing _Stiebel Eltron Heat Pump_
### Thing Configuration
@@ -446,7 +445,7 @@ Bridge modbus:tcp:bridge "Stiebel Modbus TCP"[ host="hostname|ip", port=502, id=
Thing modbus:stiebeleltron-heatpump-allwpm:stiebelEltronWpmComp "Stiebel Eltron Heat Pump (WPM compatible)" (modbus:tcp:bridge) @"Room" [ ]
```
### Item Configuration *Stiebel Eltron Heat Pump (WPM compatible)*
### Item Configuration _Stiebel Eltron Heat Pump (WPM compatible)_
```java
Contact stiebel_eltron_heat_pump_allwpm_hc1_pump_active "HC1 Pump Active" <pump> { channel="modbus:stiebeleltron-heatpump-allwpm:stiebelEltronWpmComp:systemStateAllWpm#hc1-pump-active" }
bundles/org.openhab.binding.mqtt/README.md
+1 -1
View File
@@ -105,7 +105,7 @@ This behaviour can be controlled with a configuration parameter.
- **enableDiscovery**: If set to true, enables discovery on this broker; if set to false, disables discovery services on this broker.
## Supported Channels
## Broker Channels
You can extend your broker connection bridges with a channel:
bundles/org.openhab.binding.roborock/README.md
+2 -2
View File
@@ -17,8 +17,8 @@ After (manually) adding a Roborock Account bridge, registered vacuums will be au
## `account` Bridge Configuration
Account configuration is necessary.
The easiest way to do this is from the UI.
Account configuration is necessary.
The easiest way to do this is from the UI.
Just add a new thing, select the Roborock binding, then Roborock Account Binding Thing, and enter the email for your Roborock account. If the email is valid, you will be send an email with a verification code. Once received, update the twofa field and hit save.
| Thing Parameter | Default Value | Required | Advanced | Description |
bundles/org.openhab.binding.sagercaster/README.md
+1 -1
View File
@@ -6,7 +6,7 @@ The Sager Weathercaster is a scientific instrument for accurate prediction of th
- To operate, this binding will need to use channel values provided by other means (e.g. Weather Binding, Netatmo, a 1-Wire personal weather station...)
- This binding buffers readings up to 6 hours before producing reliable weather forecasts (wind direction and sea level pressure).
- This binding buffers readings up to 6 hours before producing reliable weather forecasts (wind direction and sea level pressure).
For these reasons, this binding is not a binding in the usual sense.
bundles/org.openhab.binding.sbus/README.md
+5 -4
View File
@@ -190,8 +190,8 @@ Number Lux_Sensor "Light Level [%.0f lux]" <sun> { channel="sbus:lux-sensor:mybr
9-in-1 sensors are multi-function sensors that combine motion detection, light level measurement, and dry contact monitoring in a single physical unit. To configure a 9-in-1 sensor in openHAB, you need to create **three separate things** that all reference the same physical sensor:
1. **contact-sensor** (type: `02ca`) - For dry contact channels
2. **motion-sensor** - For motion detection
3. **lux-sensor** - For light level sensing
1. **motion-sensor** - For motion detection
1. **lux-sensor** - For light level sensing
All three things must use the **same subnet ID and unit ID** to represent the same physical sensor.
@@ -226,8 +226,8 @@ Thing lux-sensor sensor_lux [ id=85, refresh=0 ] {
The `contact-sensor` thing type supports two different sensor types via the `type` parameter:
- **`012c`** (default): 012C dry contact sensors
- **`02ca`**: 02CA multi-sensor dry contacts
- **`012c`** (default): 012C dry contact sensors
- **`02ca`**: 02CA multi-sensor dry contacts
Choose the appropriate type based on your hardware.
@@ -247,6 +247,7 @@ This is useful for:
### Color Control and On/Off Functionality
The Color item type in openHAB inherently supports both color selection and on/off functionality:
- The color picker controls hue and saturation
- The brightness component (0-100%) functions as the on/off control
- When brightness is 0%, the light is OFF
bundles/org.openhab.binding.sedif/README.md
+7 -7
View File
@@ -2,7 +2,7 @@
This binding enables you to retrieve water consumption data for consumers in the Île-de-France region of France.
It is based on the new Sedif - Eau Ile de France website : https://www.sedif.com/.
It is based on the new Sedif - Eau Ile de France website: <https://www.sedif.com/>.
## Supported Things
@@ -17,7 +17,7 @@ To retrieve data, you need a `gateway` bridge linked to your Sedif Web account.
You will need to create an account prior to configuring your bridge.
Go to the login page and click on the "Je crée mon espace" button:
https://connexion.leaudiledefrance.fr/s/login/
<https://connexion.leaudiledefrance.fr/s/login/>
After this, add your bridge and fill in your username and password.
@@ -41,7 +41,7 @@ You can find it on the Sedif website, under the section "Tous mes contrats".
You will see a list where the first column labeled "Contrat" is the contractId.
If you have multiple meters on the same contract, you will also need to get your(s) meterId's.
MeterId is displayed at the contract details page.
MeterId is displayed at the contract details page.
Just click on the contract number in the contract list, and you will have a detailed pages with a label Compteur n°D08MAxxxxxx.
Note that you do not need to create the meter manually.
@@ -54,9 +54,9 @@ Once you create the gateway, the inbox will be populated automatically with all
```java
Thing sedif:meter:meter1 "Sedif Meter 1" (sedif:gateway:local)
[
contractId="907....", meterId="D08MA......"
]
[
contractId="907....", meterId="D08MA......"
]
``
### Meter Thing Channels
@@ -117,7 +117,7 @@ Number:Volume ConsoDayMinus3 "Conso Day-3 [%.0f %unit%]" <energy> { chann
Number:Volume ConsoWeekly "Weekly Conso [%.0f %unit%]" <energy> { channel="sedif:meter:meter1:weekly-consumption#consumption" }
Number:Volume ConsoThisWeek "Conso This Week [%.0f %unit%]" <energy> { channel="sedif:meter:meter1:weekly-consumption#thisWeek" }
Number:Volume ConsoThisWeek "Conso This Week [%.0f %unit%]" <energy> { channel="sedif:meter:meter1:weekly-consumption#thisWeek" }
Number:Volume ConsoLastWeek "Conso Last Week [%.0f %unit%]" <energy> { channel="sedif:meter:meter1:weekly-consumption#lastWeek" }
Number:Volume ConsoWeekMinus2 "Conso Week - 2 [%.0f %unit%]" <energy> { channel="sedif:meter:meter1:weekly-consumption#week-2" }
bundles/org.openhab.binding.serial/README.md
+3 -3
View File
@@ -18,9 +18,9 @@ A Serial Bridge thing (`serialBridge`) represents a single serial port.
The bridge supports a String channel which is set to the currently received data from the serial port.
Sending a command to this channel sends the command as a string to the serial port.
To communicate with protocols requiring binary data it is possible to select a special 'HEX' charset.
This results into all binary data being converted into space-separacted hexadecimal strings that can be parsed using regular expressions.
In this mode, the input data is also expected to be encoded as hexadecimal characters.
To communicate with protocols requiring binary data it is possible to select a special 'HEX' charset.
This results into all binary data being converted into space-separacted hexadecimal strings that can be parsed using regular expressions.
In this mode, the input data is also expected to be encoded as hexadecimal characters.
The bridge also supports a String channel which encodes the received data as the string representation of a RawType to handle data that is
not supported by the REST interface.
bundles/org.openhab.binding.shelly/README.md
+1 -3
View File
@@ -1808,8 +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.
@@ -1886,7 +1885,6 @@ See notes on discovery of Shelly BLU devices above.
| device | gatewayDevice | String | yes | Shelly forwarded last status update (BLU gateway), could vary from packet to packet |
## Shelly Wall Displays
| Group | Channel | Type | read-only | Description |
bundles/org.openhab.binding.solarforecast/README.md
+4 -4
View File
@@ -155,7 +155,7 @@ It's optional for `fs-site` and `smart-fs-site` but can be used for comparison o
### ForecastSolar Plane Configuration
Following parameters are needed for each `fs-plane`.
Following parameters are needed for each `fs-plane`.
| Name | Type | Description | Default | Required | Advanced |
|-----------------|---------|------------------------------------------------------------------------------|---------|----------|----------|
@@ -200,7 +200,7 @@ This is mandatory for `adjustable-fs-plane` and `smart-fs-plane`.
| calculationItemPersistence | text | Persistence service to query calculation item values | N/A |
| holdingTime | integer | Time to wait in minutes from first prediction to adjust forecast | 120 |
**Strict requirement** for `calculationItemName` type is `Number:Power`_or_ `Number:Energy`.
**Strict requirement** for `calculationItemName` type is `Number:Power`_or_ `Number:Energy`.
Values without unit will be rejected.
The name `calculationItemName` shall be the calculation item directly corresponding to this plane.
Check if this item is frequently updated and not e.g. 15 minutes behind because this will have a negative impact on the forecast correction.
@@ -209,8 +209,8 @@ The `calculationItemPersistence` shall point to the persistence service storing
All installed persistence services are given as options.
Parameter `holdingTime` defines the time between the first forecast prediction and when corrections shall start.
The correction shall not start at *early stages*.
Rationale: If correction starts too early values may differ a lot.
The correction shall not start at _early stages_.
Rationale: If correction starts too early values may differ a lot.
E.g. forecast predicts 0.1 kWh but real production is 0.001 kWh results into [massive correction factors](https://doc.forecast.solar/actual).
## ForecastSolar Channels
bundles/org.openhab.binding.solarman/README.md
+1 -1
View File
@@ -179,7 +179,7 @@ Thing solarman:logger:local [ hostname="x.x.x.x", inverterType="deye_sg04lp3", s
}
```
Note the **readOnly="false"** part here, which will make channel accept commands and write data to invertor register.
Note the **readOnly="false"** part here, which will make channel accept commands and write data to invertor register.
## Full Example
bundles/org.openhab.binding.somfycul/README.md
-1
View File
@@ -95,7 +95,6 @@ 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.
bundles/org.openhab.binding.viessmann/README.md
+1 -1
View File
@@ -156,7 +156,7 @@ Thing viessmann:device:heating "Heating Device" @ "Home" [
- Added new `account` and `gateway` things for gateway selection.
Existing `device` things can be switched manually to the new `gateway` as bridge.
After that, the `bridge` thing can be removed.
- Reorganization of channel-types: Starting the binding takes about 3 minutes
- Reorganization of channel-types: Starting the binding takes about 3 minutes
and results in the following warnings, which will not occur on the next restart:
```text
bundles/org.openhab.io.homekit/README.md
+1 -1
View File
@@ -3,7 +3,7 @@
This is an add-on that exposes your openHAB system as a bridge over the HomeKit protocol.
This integration **exports** openHAB Items to a HomeKit controller, so you can control openHAB from the Home app on Apple devices.
Do not confuse this with the HomeKit **binding** (https://www.openhab.org/addons/bindings/homekit/) which **imports** data from HomeKit accessories so that you can control them directly from openHAB.
Do not confuse this with the HomeKit **binding** (<https://www.openhab.org/addons/bindings/homekit/>) which **imports** data from HomeKit accessories so that you can control them directly from openHAB.
Using this add-on, you will be able to control your openHAB system using Apple's Siri, or any of a number of HomeKit enabled iOS apps.
In order to do so, you will need to make some configuration changes.