Skip to content

Commit 80bd5bf

Browse files
lo92frlo92fr
authored
[siemenshvac] Initial contribution (openhab#14263)
Signed-off-by: Laurent ARNAL <[email protected]>
1 parent 0786bfd commit 80bd5bf

File tree

58 files changed

+7087
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+7087
-0
lines changed

‎bom/openhab-addons/pom.xml

+5
Original file line numberDiff line numberDiff line change
@@ -1626,6 +1626,11 @@
16261626
<artifactId>org.openhab.binding.shelly</artifactId>
16271627
<version>${project.version}</version>
16281628
</dependency>
1629+
<dependency>
1630+
<groupId>org.openhab.addons.bundles</groupId>
1631+
<artifactId>org.openhab.binding.siemenshvac</artifactId>
1632+
<version>${project.version}</version>
1633+
</dependency>
16291634
<dependency>
16301635
<groupId>org.openhab.addons.bundles</groupId>
16311636
<artifactId>org.openhab.binding.siemensrds</artifactId>

‎bundles/org.openhab.binding.siemenshvac/NOTICE

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
This content is produced and maintained by the openHAB project.
2+
3+
* Project home: https://www.openhab.org
4+
5+
== Declared Project Licenses
6+
7+
This program and the accompanying materials are made available under the terms
8+
of the Eclipse Public License 2.0 which is available at
9+
https://www.eclipse.org/legal/epl-2.0/.
10+
11+
== Source Code
12+
13+
https://github.com/openhab/openhab-addons
14+
15+
== Third-party Content
16+
17+
RuntimeTypeAdapterFactory
18+
* License: Apache License, Version 2.0
19+
* Project: https://github.com/google/gson
20+
* Source: https://github.com/google/gson/blob/main/extras/src/main/java/com/google/gson/typeadapters/RuntimeTypeAdapterFactory.java

‎bundles/org.openhab.binding.siemenshvac/README.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# SiemensHVAC Binding
2+
3+
This binding provides support for the Siemens HVAC controller ecosystem, and the Web Gateway interface OZW672.
4+
A typical system is composed of:
5+
6+
![Diagram](doc/Diagram.png)
7+
8+
There's a lot of different HVAC controllers depending on model in lot of different PAC constructors.
9+
Siemens RVS41.813/327 inside a Atlantic Hybrid Duo was used for the development, and is fully supported and tested.
10+
11+
Siemens have a complete set of controller references under the name "Siemens Albatros".
12+
Here is a picture of such device.
13+
You can also find this device in other types of heating systems: boiler or solar based.
14+
15+
![](doc/Albatros.jpg)
16+
17+
You will find some information about the OZW672.01 gateway on the Siemens web site:
18+
19+
[OZW 672 Page](https://hit.sbt.siemens.com/RWD/app.aspx?rc=FR&lang=fr&module=Catalog&action=ShowProduct&key=BPZ:OZW672.01)
20+
21+
With this binding, you will be able to:
22+
23+
- Consult the different parameters of your system, like temperature, current heating mode, water temperature, and many more.
24+
- Modify the functioning mode of your device: temperature set point, heating mode, and others.
25+
26+
The OZW672 gateway supports many different languages (about 16).
27+
The binding should work with all language choices, but is currently tested more thoroughly with French and English as configured language.
28+
If you use another language, and find some issues, you can report them on the openHAB forum.
29+
30+
## Discovery
31+
32+
Discovery of Gateway can be done using UPnP.
33+
Just switch off/on your gateway to make it annonce itself on the network.
34+
The gateway should appear in the Inbox a few minutes after.
35+
Be aware what you will have to modify the password in Gateway parameters just after the discovery to make it work properly.
36+
Be also aware that first initialization is a little long because the binding needs to read all the metadata from the device.
37+
38+
Currently test was done with the OZW672.x series.
39+
No test was conducted using the OZW772.x series, the code will currently not handle initialization of an OZW772 gateway.
40+
You can request support in the community forum, if you have the gateway model and want it to be supported.
41+
42+
Discovery of HVAC device inside your PAC (controller of type RVS...) have to be done through the Scan button inside the binding.
43+
Go to the Thing page, click on the "+" button, select the SiemensHVAC binding, and then click Scan.
44+
Your device should appear on the page after a few seconds.
45+
Only test in real conditions with RVS41.813/327 have been done, but it should work with all other types as the API interface is standard.
46+
47+
## Bridge Configuration
48+
49+
Parameter | Required | Default | Description
50+
----------------|----------------|----------------|------------------
51+
baseUrl | yes | | The address of the OZW672 devices
52+
userName | yes | Administrator | The user name to log into the OZW672
53+
userPass | yes | | The user password to log into the OZW672
54+
55+
## Channels
56+
57+
Channels are auto-discovered, you will find them on the RVS things.
58+
They are organized the same way as the LCD screen of your PAC device, by top level menu functionality, and sub-functionalities.
59+
Each channel is strongly typed, so for example, for heating mode, openHAB will provide you with a list of choices supported by the device.
60+
61+
Channel | Description | Type | Unit | Security Access Level | ReadOnly | Advanced
62+
--------------------------------|---------------------------------------------------------------------------------------------------|-------------------------------|----------|-------------------------|-----------|----------
63+
1724#1725-optgmode-hc1 | Set Operating mode heat circuit 1 (`Automatic`, `Comfort`, `Reduced`, `Protection`) | operating-mode-hc | | | R/W | true
64+
1724#1726-roomtemp-comfsetp-hc1 | Romm temperature comfort setpoint HC1 | room-temp-comfort-setpoint-hc | | | R/W | true
65+
66+
## Full Example
67+
68+
Things file `.things`
69+
70+
```java
71+
Bridge siemenshvac:ozw:ozw672_FF00F445 "Ozw672" [ baseUrl="https://192.168.254.42/", userName="Administrator", userPassword="mypass" ]
72+
{
73+
Thing rvs41-813-327 00770000756A "RVS41.813/327" [ ]
74+
{
75+
Type room-temp-comfort-setpoint-hc : testChannelTemperature "TestChannelTemperature" [ id="1726" ]
76+
Type operating-mode-hc : testChannelCC1 "TestChannelCC1" [ id="1725" ]
77+
}
78+
}
79+
```
80+
81+
82+
Items file `.items`
83+
84+
```java
85+
Contact Boiler_State_Pump_HWSb "HWS Pump State [%s]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:2237#2259-ppechargeecs" }
86+
Number Boiler_State_HWS "HWS State [%s]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:2032#2035-etat-ecs" }
87+
Number:Temperature Flow_Temperature_Real "Flow Temparature Real [%.1f °C]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:2237#2248-valreelletempdep-cc1" }
88+
Number:Temperature Flow_Temperature_Setpoint "Flow Temperature Setpoint [%.1f °C]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:2237#2249-constdepresultcc1" }
89+
Number Hour_fct_HWS "HWS Hour function" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:2237#2263-heuresfoncpompeecs" }
90+
Number Nb_Start_HWS "HWS Number of start [%.1f]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:2237#2266-comptdemarresel-ecs" }
91+
Number:Temperature Thermostat_Temperature "Thermostat tempeature [%.1f °C]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:2237#2246-tambact-cc1" }
92+
Number:Temperature Thermostat_Setpoint "Thermostat setpoint [%.1f °C]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:1724#1726-consconfort-ta-cc1" }
93+
Number Heat_Mode "Heat mode [%s]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:1724#1725-regime-cc1" }
94+
95+
Number:Temperature Thermostat_Setpoint_bis "Temperature [%.1f °C]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:testChannelTemperature " }
96+
Number Heat_Mode_bis "Heat mode [%s]" { channel = "siemenshvac:rvs41-813-327:ozw672_FF00F445:00770000756A:testChannelCC1" }
97+
98+
```

‎bundles/org.openhab.binding.siemenshvac/doc/Albatros.jpg

45 KB
Loading

‎bundles/org.openhab.binding.siemenshvac/doc/Diagram.png

177 KB
Loading

‎bundles/org.openhab.binding.siemenshvac/pom.xml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
4+
5+
<modelVersion>4.0.0</modelVersion>
6+
7+
<parent>
8+
<groupId>org.openhab.addons.bundles</groupId>
9+
<artifactId>org.openhab.addons.reactor.bundles</artifactId>
10+
<version>4.2.0-SNAPSHOT</version>
11+
</parent>
12+
13+
<artifactId>org.openhab.binding.siemenshvac</artifactId>
14+
15+
<name>openHAB Add-ons :: Bundles :: SiemensHvac Binding</name>
16+
17+
<build>
18+
<plugins>
19+
<plugin>
20+
<groupId>org.codehaus.mojo</groupId>
21+
<artifactId>build-helper-maven-plugin</artifactId>
22+
<executions>
23+
<execution>
24+
<goals>
25+
<goal>add-source</goal>
26+
</goals>
27+
<phase>generate-sources</phase>
28+
<configuration>
29+
<sources>
30+
<source>src/3rdparty/java</source>
31+
</sources>
32+
</configuration>
33+
</execution>
34+
</executions>
35+
</plugin>
36+
</plugins>
37+
</build>
38+
</project>

0 commit comments

Comments
 (0)