public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Documentation] Markdown improvements n to s (#13948)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-14 16:52:43 +01:00
committed by GitHub
parent d73218d882
commit 1ca9baf157
106 changed files with 4506 additions and 4729 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
bundles/org.openhab.binding.regoheatpump/README.md
View File

@@ -2,8 +2,8 @@
The Rego heat pump binding supports:
* Rego 6xx controllers family and
* Husdata interface.
- Rego 6xx controllers family and
- Husdata interface.
## The Rego 6xx family
@@ -23,8 +23,8 @@ Serial communication is using 19200 bps, 8 bit, no parity, 1 stop bit.
Two connection types are supported:
* TCP/IP and
* serial (RS232).
- TCP/IP and
- serial (RS232).
#### TCP/IP connection
@@ -44,13 +44,13 @@ There are other projects providing ESP firmware with similar functionality, i.e.
Configuration of the TCP/IP thing:
- address: the hostname/IP address of the transparent bridge on the local network - mandatory,
- tcpPort: the port number to use to connect to the transparent bridge - optional, defaults to 9265,
- refreshInterval: refresh interval in seconds, used to fetch new values from the heat pump - optional, defaults to 60 seconds.
- address: the hostname/IP address of the transparent bridge on the local network - mandatory,
- tcpPort: the port number to use to connect to the transparent bridge - optional, defaults to 9265,
- refreshInterval: refresh interval in seconds, used to fetch new values from the heat pump - optional, defaults to 60 seconds.
Example thing definition:
```
```java
regoheatpump:ipRego6xx:ivtIP [ address="192.168.2.50", tcpPort="9265" ]
```
@@ -60,12 +60,12 @@ In order to connect directly to the rego 6xx controller, one needs to adjust the
Parameters:
- portName: the name of the serial port on your computer - mandatory,
- refreshInterval: refresh interval in seconds, used to fetch new values from the heat pump - optional, defaults to 60 seconds.
- portName: the name of the serial port on your computer - mandatory,
- refreshInterval: refresh interval in seconds, used to fetch new values from the heat pump - optional, defaults to 60 seconds.
Example thing definition:
```
```java
regoheatpump:serialRego6xx:ivtSerial [ portName="COM3" ]
```
@@ -161,8 +161,8 @@ Above list is informational, please consult with the Husdata interface provider
Two connection types are supported:
* TCP/IP and
* serial (RS232).
- TCP/IP and
- serial (RS232).
#### TCP/IP connection
@@ -172,12 +172,12 @@ There are many existing project providing such functionality, i.e. [ser2net](htt
Configuration of the TCP/IP thing:
- address: the hostname/IP address of the transparent bridge on the local network - mandatory,
- tcpPort: the port number to use to connect to the transparent bridge - optional, defaults to 9265.
- address: the hostname/IP address of the transparent bridge on the local network - mandatory,
- tcpPort: the port number to use to connect to the transparent bridge - optional, defaults to 9265.
Example thing definition:
```
```java
regoheatpump:ipHusdata:ivtIP [ address="192.168.2.50", tcpPort="9265" ]
```
@@ -187,11 +187,11 @@ One can connect the Husdata interface directly to a computer that runs openHAB.
Parameters:
- portName: the name of the serial port on your computer - mandatory.
- portName: the name of the serial port on your computer - mandatory.
Example thing definition:
```
```java
regoheatpump:serialHusdata:ivtSerial [ portName="COM3" ]
```