Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: openhab/openhab-addons
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: main
Choose a base ref
...
head repository: dimalo/openhab2-addons
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref

There isn’t anything to compare.

openhab:main and dimalo:master are entirely different commit histories.

41 changes: 21 additions & 20 deletions addons/binding/org.openhab.binding.regoheatpump/README.md
Original file line number Diff line number Diff line change
@@ -2,14 +2,15 @@

The Rego heat pump binding supports:

* Rego 6xx controllers family and
* Husdata interface.
* Rego 6xx controllers family and
* Husdata interface.

## The Rego 6xx family

The Rego 6xx controllers family is used in many heat pumps, like IVT/Bosch/Autotherm/Carrier and others.
The Rego 6xx controllers family is used in many heat pumps such as IVT/Bosch/Autotherm/Carrier and others.

Rego 6xx unit contain an interface marked as service. Header of this interface is close to the control unit. This is 5V (TTL) serial interface and is connected by a 9 pin can/d-sub connector. Pinout:
Rego 6xx unit contain an interface marked as service.
Header of this interface is close to the control unit. This is 5V (TTL) serial interface and is connected by a 9 pin can/d-sub connector. Pinout:

2 - RxD
3 - TxD
@@ -22,12 +23,13 @@ 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

A transparent bridge between the serial interface of the heat pump and network (i.e. wifi) is used. This way no additional wires are required between heat pump and computer, running openhab.
A transparent bridge between the serial interface of the heat pump and network (i.e. wifi) is used.
This way no additional wires are required between heat pump and computer, running openhab.

There are many existing project providing such functionality, i.e. [ser2net](http://ser2net.sourceforge.net/).

@@ -37,13 +39,14 @@ Board:

![board](doc/board.png)

The code running on the ESP module can be found [here](https://github.com/crnjan/esp8266-bridge). There are other projects providing ESP firmware with similar functionality, i.e. [ESP-LINK](https://github.com/jeelabs/esp-link), but did not test with those.
The code running on the ESP module can be found [here](https://github.com/crnjan/esp8266-bridge).
There are other projects providing ESP firmware with similar functionality, i.e. [ESP-LINK](https://github.com/jeelabs/esp-link), but did not test with those.

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:

@@ -57,16 +60,15 @@ 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:

```
regoheatpump:serialRego6xx:ivtSerial [ portName="COM3" ]
```


### Channels

Below is the list of supported channels, all values are read only:
@@ -147,8 +149,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

@@ -158,8 +160,8 @@ 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:

@@ -173,15 +175,14 @@ 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:

```
regoheatpump:serialHusdata:ivtSerial [ portName="COM3" ]
```


### Channels

Below is the list of supported channels, all values are read only:
715 changes: 362 additions & 353 deletions addons/binding/org.openhab.binding.rfxcom/README.md

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions addons/binding/org.openhab.binding.rme/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# RME Binding

This binding integrates the RME RainManager rain water pump and management system
This binding is for the RME RainManager rain water pump and management system

## Supported Things

Manager

## Thing Configuration

The Thing configuration requires the name of the serial port that is used to connect the ESH host with the RME unit
The Thing configuration requires the name of the serial port that is used to connect the host with the RME unit

## Channels

All devices support some of the following channels:

| Channel Type ID | Item Type | Description |
|-----------------|------------------------|--------------|----------------- |------------- |
| waterlevel | Number | Indicates the % the cistern is filled with water |
| mode | String | Indicates the operation mode of the RME Rain Manager, Automatic or Manual |
| source | String | Indicates water source used to supply water, e.g cistern or city |
| exitpump | Switch | Indicates whether the exit pump is switched on |
| entrypump | Switch | Indicates whether the entry pump is switched on |
| Channel Type ID | Item Type | Description | | |
|-----------------|-----------|---------------------------------------------------------------------------|---|---|
| waterlevel | Number | Indicates the % the cistern is filled with water | | |
| mode | String | Indicates the operation mode of the RME Rain Manager, Automatic or Manual | | |
| source | String | Indicates water source used to supply water, e.g cistern or city | | |
| exitpump | Switch | Indicates whether the exit pump is switched on | | |
| entrypump | Switch | Indicates whether the entry pump is switched on | | |

## Full Example
## Example

.things

52 changes: 25 additions & 27 deletions addons/binding/org.openhab.binding.rotelra1x/README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,60 @@
# Rotel Amplifier Binding

Connects to a Rotel RA11 or RA12 integrated amplifier via a serial (RS232) interface. The Rotel amplifiers supported by this binding also include an integrated DAC unit. To use the binding, connect a serial cable between the amplifier and the computer running openHAB.
Connects to a Rotel RA11 or RA12 integrated amplifier via a serial (RS232) interface.
The Rotel amplifiers supported by this binding also include an integrated DAC unit.
To use the binding, connect a serial cable between the amplifier and the computer running openHAB.

## Overview

This binding implements the serial protocol specified by Rotel in their documentation. The protocol allows one to control the amplifier, to query its state, and to receive live updates of changed values. For example, when turning the volume knob, the unit sends updates as different volumes are set.

This binding implements the serial protocol specified by Rotel in their documentation.
The protocol allows one to control the amplifier, to query its state, and to receive live updates of changed values.
For example, when turning the volume knob, the unit sends updates as different volumes are set.

## Supported things

* Rotel Amplifier. Each thing represent an amplifier unit, connected
over a RS232 connection.
* Rotel Amplifier. Each thing represent an amplifier unit, connected over an RS232 connection.

## Discovery

Auto-discovery is not supported -- things can be added manually.
Auto-discovery is not supported; things can be added manually.

## Thing configuration

The thing has the following configuration parameter:

| Parameter | Parameter name | Description |
|----------------|-------------------------------------------------------------------------------------------------------------------|
| Serial port | port | Specifies the name of the serial port used to communicate with the device. (String) |
| Maximum volume | maximum-volume | This is the value to send to the amplifier when the volume channel is set to 100 % (1). (Integer)|
| Parameter | Parameter name | Description |
|----------------|--------------------------------------------------------------------------------------------------------------------|
| Serial port | port | Specifies the name of the serial port used to communicate with the device. (String) |
| Maximum volume | maximum-volume | This is the value to send to the amplifier when the volume channel is set to 100 % (1). (Integer) |

(1) The RA11's max. volume is 96, but it is still supported to use 100 as the maximum volume, only the volume will not increase when going beyond 96 %.


## Channel summary

| Channel ID | Item Type | Description |
|------------|-----------|--------------------------------------------------------------------------------------------------|
| power | Switch | Controls and reports the power state (soft on/off) |
| volume | Dimmer | Volume control. |
| mute | Switch | Enable / disable mute. |
| source | String | Selects from a list of input sources (see options). |
| frequency | Number | Reports the current sampling frequency if playing from a digital input. |
| brightness | Dimmer | Sets the backlight level of the display. Maps from percentage to 6 levels (can't be turned off). |
| Channel ID | Item Type | Description |
|------------|-----------|-------------------------------------------------------------------------------------------------|
| power | Switch | Controls and reports the power state (soft on/off) |
| volume | Dimmer | Volume control |
| mute | Switch | Enable / disable mute |
| source | String | Selects from a list of input sources (see options) |
| frequency | Number | Reports the current sampling frequency if playing from a digital input |
| brightness | Dimmer | Sets the backlight level of the display. Maps from percentage to 6 levels (can't be turned off) |

All channels are updated in real time if modified by other means, e.g. by the remote control.


## Configuration example

The following lines
can be added to the configuration files in order to set up an amplifier at serial port `/dev/ttyS0`.
The following lines can be added to the configuration files in order to set up an amplifier at serial port `/dev/ttyS0`.

*demo.things
demo.things

```
Thing rotelra1x:amp:living_room_amp [ port="/dev/ttyS0" ]
```

*demo.items
demo.items

```
Switch Amp_Power "On/off" { channel="rotelra1x:amp:living_room_amp:power" }
@@ -64,8 +65,7 @@ Number Amp_Frequency "Frequency" { channel="rotelra1x:amp:l
Dimmer Amp_Brightness "Display brightness" <light> { channel="rotelra1x:amp:living_room_amp:brightness" }
```


*demo.sitemap:
demo.sitemap:

```
sitemap demo label="Main Menu"
@@ -83,6 +83,4 @@ sitemap demo label="Main Menu"

## References

Rotel serial protocol is available here: http://www.rotel.com/sites/default/files/product/rs232/RA12%20Protocol.pdf .


Rotel serial protocol is available here: <http://www.rotel.com/sites/default/files/product/rs232/RA12%20Protocol.pdf>.
299 changes: 155 additions & 144 deletions addons/binding/org.openhab.binding.russound/README.md

Large diffs are not rendered by default.