[Documentation] Markdown improvements n to s (#13948)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
committed by
GitHub
GitHub
parent
d73218d882
commit
1ca9baf157
@@ -17,7 +17,7 @@ Write mode needs to be enabled in the thing configuration and for safety reasons
|
||||
This binding supports direct serial port connection (RS-485 adapter needed) to heat pump but also UDP connection via NibeGW software.
|
||||
|
||||
| Thing type | Description |
|
||||
|-----------------|--------------------------------------------------|
|
||||
| --------------- | ------------------------------------------------ |
|
||||
| f1x45-serial | Serial port connected F1145 and F1245 Heat Pumps |
|
||||
| f1x45-udp | UDP connected Nibe F1145 and F1245 Heat Pumps |
|
||||
| f1x45-simulator | Simulator for Nibe F1145 and F1245 Heat Pumps |
|
||||
@@ -36,7 +36,7 @@ This binding supports direct serial port connection (RS-485 adapter needed) to h
|
||||
|
||||
## Discovery
|
||||
|
||||
Discovery is not supported.
|
||||
Discovery is not supported.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -65,7 +65,7 @@ PRODINo boards have built-in Ethernet and RS-485 ports.
|
||||
Arduino code is available [here](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/Arduino/NibeGW).
|
||||
|
||||
Arduino code can be build via Arduino IDE.
|
||||
For more details see [www.arduino.cc](https://www.arduino.cc/en/Main/Software).
|
||||
For more details see [www.arduino.cc](https://www.arduino.cc/en/Main/Software).
|
||||
NibeGW configuration (such IP addresses, ports, etc) can be adapted directly by editing the code files.
|
||||
PRODINo ESP32 Ethernet v1 also supports dynamic configuration and OTA updates via Wi-Fi access point.
|
||||
|
||||
@@ -73,7 +73,7 @@ PRODINo ESP32 Ethernet v1 also supports dynamic configuration and OTA updates vi
|
||||
|
||||
C code is available [here](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/RasPi).
|
||||
|
||||
To build the C code use:
|
||||
To build the C code use:
|
||||
|
||||
```shell
|
||||
gcc -std=gnu99 -o nibegw nibegw.c
|
||||
@@ -122,51 +122,49 @@ The following information is useful when configuring things via thing configurat
|
||||
|
||||
Thing examples:
|
||||
|
||||
```
|
||||
```java
|
||||
nibeheatpump:f1x45-udp:myPump [hostName="192.168.1.50", port=9999]
|
||||
```
|
||||
|
||||
```
|
||||
```java
|
||||
nibeheatpump:f1x45-udp:myPump [hostName="192.168.1.50", port=9999, readCommandsPort=10000, writeCommandsPort=10001, refreshInterval=30, enableReadCommands=true, enableWriteCommands=true, enableWriteCommandsToRegisters="44266, 47004"]
|
||||
```
|
||||
|
||||
All supported configuration parameters for UDP connection:
|
||||
|
||||
| Property | Type | Default | Required | Description |
|
||||
|---------------------------------|---------|---------|----------|-------------|
|
||||
| hostName | String | | Yes | Network address of the Nibe heat pump |
|
||||
| port | Integer | 9999 | No | UDP port to listening data packets from the NibeGW |
|
||||
| readCommandsPort | Integer | 9999 | No | UDP port to send read commands to the NibeGW |
|
||||
| writeCommandsPort | Integer | 10000 | No | UDP port to send write commands to the NibeGW |
|
||||
| refreshInterval | Integer | 60 | No | States how often a refresh shall occur in seconds |
|
||||
| enableReadCommands | Boolean | false | No | Enable read commands to read additional variable from Nibe heat pump which are not included to data readout messages. This is experimental feature, use it at your own risk! |
|
||||
| enableWriteCommands | Boolean | false | No | Enable write commands to change Nibe heat pump settings. This is experimental feature, use it at your own risk! |
|
||||
| enableWriteCommandsToRegisters | String | | No | Comma separated list of registers, which are allowed to write to Nibe heat pump. E.g. 44266, 47004 |
|
||||
| throttleTime | Integer | 0 | No | Throttle incoming data read out messages from heat pump. 0 = throttle is disabled, otherwise throttle time in milliseconds. |
|
||||
| Property | Type | Default | Required | Description |
|
||||
| ------------------------------ | ------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| hostName | String | | Yes | Network address of the Nibe heat pump |
|
||||
| port | Integer | 9999 | No | UDP port to listening data packets from the NibeGW |
|
||||
| readCommandsPort | Integer | 9999 | No | UDP port to send read commands to the NibeGW |
|
||||
| writeCommandsPort | Integer | 10000 | No | UDP port to send write commands to the NibeGW |
|
||||
| refreshInterval | Integer | 60 | No | States how often a refresh shall occur in seconds |
|
||||
| enableReadCommands | Boolean | false | No | Enable read commands to read additional variable from Nibe heat pump which are not included to data readout messages. This is experimental feature, use it at your own risk! |
|
||||
| enableWriteCommands | Boolean | false | No | Enable write commands to change Nibe heat pump settings. This is experimental feature, use it at your own risk! |
|
||||
| enableWriteCommandsToRegisters | String | | No | Comma separated list of registers, which are allowed to write to Nibe heat pump. E.g. 44266, 47004 |
|
||||
| throttleTime | Integer | 0 | No | Throttle incoming data read out messages from heat pump. 0 = throttle is disabled, otherwise throttle time in milliseconds. |
|
||||
|
||||
### Serial port connection
|
||||
|
||||
Thing example:
|
||||
|
||||
```
|
||||
```java
|
||||
nibeheatpump:f1x45-serial:myPump [serialPort="/dev/ttyUSB0"]
|
||||
```
|
||||
|
||||
|
||||
All supported configuration parameters for serial port connection:
|
||||
|
||||
| Property | Type | Default | Required | Description |
|
||||
|---------------------------------|---------|---------|----------|-------------|
|
||||
| serialPort | String | | Yes | Network address of the Nibe heat pump |
|
||||
| refreshInterval | Integer | 60 | No | States how often a refresh shall occur in seconds |
|
||||
| enableReadCommands | Boolean | false | No | Enable read commands to read additional variable from Nibe heat pump which are not included to data readout messages. This is experimental feature, use it at your own risk! |
|
||||
| enableWriteCommands | Boolean | false | No | Enable write commands to change Nibe heat pump settings. This is experimental feature, use it at your own risk! |
|
||||
| enableWriteCommandsToRegisters | String | | No | Comma separated list of registers, which are allowed to write to Nibe heat pump. E.g. 44266, 47004 |
|
||||
| sendAckToMODBUS40 | Boolean | true | No | Binding emulates MODBUS40 device and send protocol acknowledges to heat pump |
|
||||
| sendAckToRMU40 | Boolean | false | No | Binding emulates RMU40 device and send protocol acknowledges to heat pump |
|
||||
| sendAckToSMS40 | Boolean | false | No | Binding emulates SMS40 device and send protocol acknowledges to heat pump |
|
||||
| throttleTime | Integer | 0 | No | Throttle incoming data read out messages from heat pump. 0 = throttle is disabled, otherwise throttle time in milliseconds. |
|
||||
|
||||
| Property | Type | Default | Required | Description |
|
||||
| ------------------------------ | ------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| serialPort | String | | Yes | Network address of the Nibe heat pump |
|
||||
| refreshInterval | Integer | 60 | No | States how often a refresh shall occur in seconds |
|
||||
| enableReadCommands | Boolean | false | No | Enable read commands to read additional variable from Nibe heat pump which are not included to data readout messages. This is experimental feature, use it at your own risk! |
|
||||
| enableWriteCommands | Boolean | false | No | Enable write commands to change Nibe heat pump settings. This is experimental feature, use it at your own risk! |
|
||||
| enableWriteCommandsToRegisters | String | | No | Comma separated list of registers, which are allowed to write to Nibe heat pump. E.g. 44266, 47004 |
|
||||
| sendAckToMODBUS40 | Boolean | true | No | Binding emulates MODBUS40 device and send protocol acknowledges to heat pump |
|
||||
| sendAckToRMU40 | Boolean | false | No | Binding emulates RMU40 device and send protocol acknowledges to heat pump |
|
||||
| sendAckToSMS40 | Boolean | false | No | Binding emulates SMS40 device and send protocol acknowledges to heat pump |
|
||||
| throttleTime | Integer | 0 | No | Throttle incoming data read out messages from heat pump. 0 = throttle is disabled, otherwise throttle time in milliseconds. |
|
||||
|
||||
## Channels
|
||||
|
||||
@@ -175,7 +173,7 @@ All supported configuration parameters for serial port connection:
|
||||
This binding currently supports following channels for F1x45 pump models:
|
||||
|
||||
| Channel Type ID | Item Type | Min | Max | Type | Description | Values |
|
||||
|-----------------|-----------|-------------|------------|---------|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | --------- | ----------- | ---------- | ------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| 40004 | Number | -32767 | 32767 | Setting | BT1 Outdoor temp | |
|
||||
| 40005 | Number | -32767 | 32767 | Setting | EP23-BT2 Supply temp S4 | |
|
||||
| 40006 | Number | -32767 | 32767 | Setting | EP22-BT2 Supply temp S3 | |
|
||||
@@ -807,10 +805,10 @@ This binding currently supports following channels for F1x45 pump models:
|
||||
| 47370 | Switch | 0 | 1 | Setting | Allow Additive Heating | |
|
||||
| 47371 | Switch | 0 | 1 | Setting | Allow Heating | |
|
||||
| 47372 | Switch | 0 | 1 | Setting | Allow Cooling | |
|
||||
| 47374 | Number | -200 | 400 | Setting | Start Temperature Cooling | |
|
||||
| 47374 | Number | -200 | 400 | Setting | Start Temperature Cooling | |
|
||||
| 47375 | Number | -200 | 400 | Setting | Stop Temperature Heating | |
|
||||
| 47376 | Number | -250 | 400 | Setting | Stop Temperature Additive | |
|
||||
| 47377 | Number | 0 | 48 | Setting | Outdoor Filter Time | |
|
||||
| 47377 | Number | 0 | 48 | Setting | Outdoor Filter Time | |
|
||||
| 47378 | Number | 10 | 250 | Setting | Max diff. comp. | |
|
||||
| 47379 | Number | 10 | 240 | Setting | Max diff. add. | |
|
||||
| 47380 | Switch | 0 | 1 | Setting | Low brine out autoreset | |
|
||||
@@ -847,8 +845,8 @@ This binding currently supports following channels for F1x45 pump models:
|
||||
| 47543 | Number | 10 | 150 | Setting | Cooling DM diff | |
|
||||
| 47570 | String | 0 | 255 | Setting | Operational mode | 0=Auto, 1=Manual, 2=Add. heat only |
|
||||
| 48043 | String | 0 | 10 | Setting | Holiday - Activated | 0=inactive, 10=active |
|
||||
| 48046 | Number | -10 | 10 | Setting | Heat Offset Holiday | |
|
||||
| 48047 | String | -1 | 2 | Setting | Hot water mode Holiday | -1 = off, 0 = economy, 1 = normal, 2 = luxury |
|
||||
| 48046 | Number | -10 | 10 | Setting | Heat Offset Holiday | |
|
||||
| 48047 | String | -1 | 2 | Setting | Hot water mode Holiday | -1 = off, 0 = economy, 1 = normal, 2 = luxury |
|
||||
| 48053 | Number | 0 | 100 | Setting | FLM 2 speed 4 | |
|
||||
| 48054 | Number | 0 | 100 | Setting | FLM 2 speed 3 | |
|
||||
| 48055 | Number | 0 | 100 | Setting | FLM 2 speed 2 | |
|
||||
@@ -925,7 +923,7 @@ This binding currently supports following channels for F1x45 pump models:
|
||||
This binding currently supports following channels for F1x55 pump models:
|
||||
|
||||
| Channel Type ID | Item Type | Min | Max | Type | Description | Values |
|
||||
|-----------------|-----------|-------------|------------|---------|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | --------- | ----------- | ---------- | ------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| 32260 | Number | 0 | 255 | Setting | NIBE Inverter 216-state | |
|
||||
| 40004 | Number | -32767 | 32767 | Setting | BT1 Outdoor Temperature | |
|
||||
| 40005 | Number | -32767 | 32767 | Setting | EP23-BT2 Supply temp S4 | |
|
||||
@@ -1903,11 +1901,10 @@ This binding currently supports following channels for F1x55 pump models:
|
||||
| 49381 | Switch | 0 | 1 | Setting | External ERS 2 accessory bypass at heat | |
|
||||
| 49430 | Number | 0 | 255 | Setting | AUX ERS Fire Place Guard | |
|
||||
|
||||
|
||||
### SMO40
|
||||
|
||||
To keep this documentation light, all parameters are documented in the NIBE ModbusManager except of:
|
||||
| Channel Type ID | Item Type | Min | Max | Type | Description | Values |
|
||||
|-----------------|-----------|-------------|------------|---------|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 45780 | Number | 0 | 120 | Setting | Silent Mode Frequency 1 (defined in the service-menu) | |
|
||||
| 49806 | Number | 0 | 120 | Setting | Silent Mode Frequency 2 (defined in the service-menu) | |
|
||||
| Channel Type ID | Item Type | Min | Max | Type | Description | Values |
|
||||
| --------------- | --------- | --- | --- | ------- | ----------------------------------------------------- | ------ |
|
||||
| 45780 | Number | 0 | 120 | Setting | Silent Mode Frequency 1 (defined in the service-menu) | |
|
||||
| 49806 | Number | 0 | 120 | Setting | Silent Mode Frequency 2 (defined in the service-menu) | |
|
||||
|
||||
Reference in New Issue
Block a user