Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[radiothermostat] RadioThermostat Binding - initial contribution #7266

Merged
merged 36 commits into from
Jun 24, 2020
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
a143408
RadioThermostat Binding - initial contribution
mlobstein Mar 31, 2020
2082b2d
remove HTTPException
mlobstein Apr 1, 2020
af112f4
update ui before sending command; slow response time caused the ui va…
mlobstein Apr 1, 2020
00343ed
Add discovery service from billfor
mlobstein Apr 8, 2020
2c1ed9b
make hold function a switch and improve examples in readme
mlobstein Apr 13, 2020
29400b5
Merge pull request #1 from openhab/2.5.x
mlobstein Apr 13, 2020
caae683
Merge branch '2.5.x' into RadioThermostat
mlobstein Apr 13, 2020
37d791e
Merge pull request #2 from openhab/2.5.x
mlobstein Apr 19, 2020
f43c452
Merge branch '2.5.x' into RadioThermostat
mlobstein Apr 19, 2020
7f1529b
a couple more tweaks and increment pom version to 2.5.5
mlobstein Apr 19, 2020
5affb52
some changes per review comments
mlobstein Apr 20, 2020
8e3b104
format runtime output
mlobstein Apr 21, 2020
2a7a732
Cleanup 'advanced' tag attribute usage on channel-types in thing-type…
mlobstein May 4, 2020
2ae6d1b
Code review changes
mlobstein May 22, 2020
5c1f7e3
Remove Thread.sleep
mlobstein May 22, 2020
64f506f
update pom version to 2.5.6
mlobstein May 23, 2020
f068374
Remove org.apache.commons.lang dependency
mlobstein May 26, 2020
07232c4
Add @NonNullByDefault annotations
mlobstein May 27, 2020
82462cd
Merge pull request #3 from openhab/2.5.x
mlobstein May 27, 2020
c32d416
apply spotless and label name fixes
mlobstein May 27, 2020
54603bd
Merge branch '2.5.x' into RadioThermostat
mlobstein May 27, 2020
b6ca717
Temp value needs to have decimal places
mlobstein May 27, 2020
05043d3
code review changes
mlobstein May 28, 2020
57f1143
fix hold switch bug
mlobstein May 28, 2020
0ae2ac1
remove httpClient from discovery service
mlobstein May 28, 2020
2a7d0c7
refactor to async http and other review changes
mlobstein May 29, 2020
74d92c0
additional review changes
mlobstein May 29, 2020
c758c94
add missing return
mlobstein May 29, 2020
a2c0aa1
improve number parsing
mlobstein May 30, 2020
87c5705
couple more changes
mlobstein May 30, 2020
542afbb
fix some warnings
mlobstein Jun 1, 2020
5d548cc
Merge pull request #4 from openhab/2.5.x
mlobstein Jun 4, 2020
a748961
fix compilier warnings
mlobstein Jun 9, 2020
41709ef
Merge pull request #5 from openhab/2.5.x
mlobstein Jun 24, 2020
d290815
Merge branch '2.5.x' into RadioThermostat
mlobstein Jun 24, 2020
76e8f56
Update pom version and format README
mlobstein Jun 24, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@
/bundles/org.openhab.binding.powermax/ @lolodomo
/bundles/org.openhab.binding.pulseaudio/ @peuter
/bundles/org.openhab.binding.pushbullet/ @hakan42
/bundles/org.openhab.binding.radiothermostat/ @mlobstein
/bundles/org.openhab.binding.regoheatpump/ @crnjan
/bundles/org.openhab.binding.rfxcom/ @martinvw @paulianttila
/bundles/org.openhab.binding.rme/ @kgoderis
Expand Down
5 changes: 5 additions & 0 deletions bom/openhab-addons/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -791,6 +791,11 @@
<artifactId>org.openhab.binding.pushbullet</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.openhab.addons.bundles</groupId>
<artifactId>org.openhab.binding.radiothermostat</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.openhab.addons.bundles</groupId>
<artifactId>org.openhab.binding.regoheatpump</artifactId>
Expand Down
32 changes: 32 additions & 0 deletions bundles/org.openhab.binding.radiothermostat/.classpath
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="src" output="target/classes" path="src/main/java">
<attributes>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="src" output="target/test-classes" path="src/test/java">
<attributes>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
<attribute name="test" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="output" path="target/classes"/>
</classpath>
23 changes: 23 additions & 0 deletions bundles/org.openhab.binding.radiothermostat/.project
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>org.openhab.binding.radiothermostat</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.m2e.core.maven2Builder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.jdt.core.javanature</nature>
<nature>org.eclipse.m2e.core.maven2Nature</nature>
</natures>
</projectDescription>
13 changes: 13 additions & 0 deletions bundles/org.openhab.binding.radiothermostat/NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This content is produced and maintained by the openHAB project.

* Project home: https://www.openhab.org

== Declared Project Licenses

This program and the accompanying materials are made available under the terms
of the Eclipse Public License 2.0 which is available at
https://www.eclipse.org/legal/epl-2.0/.

== Source Code

https://github.com/openhab/openhab-addons
203 changes: 203 additions & 0 deletions bundles/org.openhab.binding.radiothermostat/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
# RadioThermostat Binding

This binding connects RadioThermostat/3M Filtrete models CT30, CT50/3M50, CT80, etc. with built-in Wi-Fi module to openHAB.

The binding retrieves and periodically updates all basic system information from the thermostat. The main thermostat functions such
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a line break after every sentence throughout the README, thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

got it

as thermostat mode, fan mode, temperature set point and hold mode can be controlled. System run-time information and humidity readings
are polled less frequently and can be disabled completely if not desired. Humidity information is available only when using a CT80
thermostat and I have noticed that the humidity reported is very inaccurate.

The main caveat for using this binding is to keep in mind that the web server in the thermostat is very slow. Do not over load it
with excessive amounts of simultaneous commands. When changing the thermostat mode, the current temperature set point is cleared and
a refresh of the thermostat data is done to get the new mode's set point. Since retrieving the thermostat's data is the slowest
operation, it will take several seconds after changing the mode before the new set point is displayed. The 'Program Mode' command
is untested and according to the published API is only available on a CT80 Rev B.

## Supported Things

There is exactly one supported thing type, which represents the thermostat.
It has the `rtherm` id.
Multiple Things can be added if more than one thermostat is to be controlled.

## Discovery

Auto-discovery is supported if the thermostat can be located on the local network using SSDP. Otherwise the thing must be manually added.

## Binding Configuration

The binding has no configuration options, all configuration is done at Thing level.

## Thing Configuration

The thing has a few configuration parameters:

| Parameter | Description |
|-----------------|-----------------------------------------------------------------------------------------------------------|
| hostName | The host name or IP address of the thermostat. Mandatory. |
| refresh | Overrides the refresh interval of the thermostat data. Optional, the default is 2 minutes. |
| logRefresh | Overrides the refresh interval of the run-time logs & humidity data. Optional, the default is 10 minutes. |
| disableLogs | Disable retrieval of run-time logs from the thermostat. Optional, the default is 0. |
| disableHumidity | Disable retrieval of humidity information from the thermostat. Optional, the default is 0. |

## Channels

The thermostat information that is retrieved is available as these channels:

| Channel ID | Item Type | Description |
|------------------------|----------------------|---------------------------------------------------------------------------|
| temperature | Number:Temperature | The current temperature reading of the thermostat |
| humidity | Number | The current humidity reading of the thermostat (CT80 only) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| humidity | Number | The current humidity reading of the thermostat (CT80 only) |
| humidity | Number:Dimensionless | The current humidity reading of the thermostat (CT80 only) |

| mode | Number | The current operating mode of the HVAC system |
| fan_mode | Number | The current operating mode of the fan |
| program_mode | Number | The program schedule that the thermostat is running (CT80 Rev B only) |
| set_point | Number:Temperature | The current temperature set point of the thermostat |
| status | Number | Indicates the current running status of the HVAC system |
| fan_status | Number | Indicates the current fan status of the HVAC system |
| override | Number | Indicates if the normal program set-point has been manually overridden |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Make it a Switch item-type to indicate the user overrode the setpoint.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did this to match the display on the thermostat (using transform in the example) and because it is read-only in the api. It can't be turned off so having a switch here would be confusing IMHO.

| hold | Switch | Indicates if the current set point temperature is to be held indefinitely |
| day | Number | The current day of the week reported by the thermostat (0 = Monday) |
| hour | Number | The current hour of the day reported by the thermostat (24 hr) |
| minute | Number | The current minute past the hour reported by the thermostat |
| dt_stamp | String | The current day of the week and time reported by the thermostat (E HH:mm) |
| last_update | DateTime | Last successful contact with thermostat |
| today_heat_runtime | Number | The total number of minutes of heating run-time today |
| today_cool_runtime | Number | The total number of minutes of cooling run-time today |
| yesterday_heat_runtime | Number | The total number of minutes of heating run-time yesterday |
| yesterday_cool_runtime | Number | The total number of minutes of cooling run-time yesterday |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| today_heat_runtime | Number | The total number of minutes of heating run-time today |
| today_cool_runtime | Number | The total number of minutes of cooling run-time today |
| yesterday_heat_runtime | Number | The total number of minutes of heating run-time yesterday |
| yesterday_cool_runtime | Number | The total number of minutes of cooling run-time yesterday |
| today_heat_runtime | Number:Time | The total number of minutes of heating run-time today |
| today_cool_runtime | Number:Time | The total number of minutes of cooling run-time today |
| yesterday_heat_runtime | Number:Time | The total number of minutes of heating run-time yesterday |
| yesterday_cool_runtime | Number:Time | The total number of minutes of cooling run-time yesterday |

| json_cmd | String | Send JSON directly to the thermostat on the /tstat endpoint |

## Full Example

radiotherm.map:

```text
UNDEF_stus=-
NULL_stus=-
-_stus=-
0_stus=Off
1_stus=Heating
2_stus=Cooling
UNDEF_fstus=-
NULL_fstus=-
-_fstus=-
0_fstus=Off
1_fstus=On
UNDEF_mode=-
NULL_mode=-
-_mode=-
0_mode=Off
1_mode=Heat
2_mode=Cool
3_mode=Auto
UNDEF_fan=-
NULL_fan=-
-_fan=-
0_fan=Auto
1_fan=Auto/Circulate
2_fan=On
UNDEF_pgm=-
NULL_pgm=-
-_pgm=-
-1_pgm=None
0_pgm=Program A
1_pgm=Program B
2_pgm=Vacation
3_pgm=Holiday
UNDEF_over=-
NULL_over=-
-_over=-
0_over=No
1_over=Yes

```

radiotherm.things:

```java
radiothermostat:rtherm:mytherm1 "My 1st floor thermostat" [ hostName="192.168.10.1", refresh=2, logRefresh=10, disableLogs=0, disableHumidity=0 ]
radiothermostat:rtherm:mytherm2 "My 2nd floor thermostat" [ hostName="mythermhost2", refresh=1, logRefresh=20, disableLogs=1, disableHumidity=1 ]
```

radiotherm.items:

```java
Number:Temperature Therm_Temp "Current Temperature [%.1f °F] " <temperature> { channel="radiothermostat:rtherm:mytherm1:temperature" }
// Humidity only supported on CT80
Number Therm_Hum "Current Humidity [%d %%]" <temperature> { channel="radiothermostat:rtherm:mytherm1:humidity" }
Number Therm_Mode "Thermostat Mode [MAP(radiotherm.map):%s_mode]" { channel="radiothermostat:rtherm:mytherm1:mode" }
// The Auto/Circulate option will only appear for CT80
Number Therm_Fmode "Fan Mode [MAP(radiotherm.map):%s_fan]" { channel="radiothermostat:rtherm:mytherm1:fan_mode" }
// Program Mode only supported on CT80 Rev B
Number Therm_Pmode "Program Mode [MAP(radiotherm.map):%s_pgm]" { channel="radiothermostat:rtherm:mytherm1:program_mode" }
Number:Temperature Therm_Setpt "Set Point [%d]" <temperature> { channel="radiothermostat:rtherm:mytherm1:set_point" }
Number Therm_Status "Status [MAP(radiotherm.map):%s_stus]" { channel="radiothermostat:rtherm:mytherm1:status" }
Number Therm_FanStatus "Fan Status [MAP(radiotherm.map):%s_fstus]" { channel="radiothermostat:rtherm:mytherm1:fan_status" }
Number Therm_Override "Override [MAP(radiotherm.map):%s_over]" { channel="radiothermostat:rtherm:mytherm1:override" }
Switch Therm_Hold "Hold" { channel="radiothermostat:rtherm:mytherm1:hold" }

Number Therm_Day "Thermostat Day [%s]" { channel="radiothermostat:rtherm:mytherm1:day" }
Number Therm_Hour "Thermostat Hour [%s]" { channel="radiothermostat:rtherm:mytherm1:hour" }
Number Therm_Minute "Thermostat Minute [%s]" { channel="radiothermostat:rtherm:mytherm1:minute" }
String Therm_Dstmp "Thermostat DateStamp [%s]" <time> { channel="radiothermostat:rtherm:mytherm1:dt_stamp" }
DateTime Therm_Lastupd "Thermostat Last Updated [%1$tl:%1$tM %1$tp]" <time> { channel="radiothermostat:rtherm:mytherm1:last_update" }

Number:Time Therm_todayheat "Today's Heating Runtime [%d %unit%]" { channel="radiothermostat:rtherm:mytherm1:today_heat_runtime" }
Number:Time Therm_todaycool "Today's Cooling Runtime [%d %unit%]" { channel="radiothermostat:rtherm:mytherm1:today_cool_runtime" }
Number:Time Therm_yesterdayheat "Yesterday's Heating Runtime [%d %unit%]" { channel="radiothermostat:rtherm:mytherm1:yesterday_heat_runtime" }
Number:Time Therm_yesterdaycool "Yesterday's Cooling Runtime [%d %unit%]" { channel="radiothermostat:rtherm:mytherm1:yesterday_cool_runtime" }

// Channel to send JSON commands directly to the thermostat
String Therm_jsoncmd "Send JSON to direct to thermostat [%s]" { channel="radiothermostat:rtherm:mytherm1:json_cmd" }

// A virtual switch used to trigger a rule to send a json command to the thermostat
Switch Therm_mysetting "Send my preferred setting"
```

radiotherm.sitemap:

```perl
sitemap radiotherm label="My Thermostat" {
Frame label="My 1st floor thermostat" {
Text item=Therm_Temp icon="temperature" valuecolor=[>76="orange",>67.5="green",<=67.5="blue"]
// Humidity only supported on CT80
Text item=Therm_Hum icon="humidity"
Setpoint item=Therm_Setpt label="Target temperature [%d °F]" visibility=[Therm_Mode==1,Therm_Mode==2] icon="temperature" minValue=60 maxValue=85 step=1
Selection item=Therm_Mode icon="climate"
Selection item=Therm_Fmode icon="fan"
// Program Mode only supported on CT80 Rev B
Selection item=Therm_Pmode icon="smoke"
Text item=Therm_Status icon="climate"
Text item=Therm_FanStatus icon="flow"
Text item=Therm_Override icon="smoke"
Switch item=Therm_Hold icon="smoke"

// Virtual switch/button to trigger a rule to send a custom command
// The ON value displays in the button
Switch item=Therm_mysetting mappings=[ON="Heat, 58, hold"]

Text item=Therm_Day
Text item=Therm_Hour
Text item=Therm_Minute
Text item=Therm_Dstmp
Text item=Therm_Lastupd

Text item=Therm_todayheat
Text item=Therm_todaycool
Text item=Therm_yesterdayheat
Text item=Therm_yesterdaycool
}
}
```

radiotherm.rules:

```java
rule "Send my thermostat command"
when
Item Therm_mysetting received command
then
// JSON to send directly to the thermostat's '/tstat' endpoint
// See RadioThermostat_CT50_Honeywell_Wifi_API_V1.3.pdf for more detail
Therm_jsoncmd.sendCommand('{"hold":1, "t_heat":' + "58" + ', "tmode":1}')
end
```
17 changes: 17 additions & 0 deletions bundles/org.openhab.binding.radiothermostat/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.openhab.addons.bundles</groupId>
<artifactId>org.openhab.addons.reactor.bundles</artifactId>
<version>2.5.6-SNAPSHOT</version>
mlobstein marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As 2.5.6 has just been release, we have to ask you to change this version for a very last time, promised ;-)

Suggested change
<version>2.5.6-SNAPSHOT</version>
<version>2.5.7-SNAPSHOT</version>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! Thanks @kaikreuzer

</parent>

<artifactId>org.openhab.binding.radiothermostat</artifactId>

<name>openHAB Add-ons :: Bundles :: RadioThermostat Binding</name>

</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<features name="org.openhab.binding.radiothermostat-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.4.0">
<repository>mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features</repository>

<feature name="openhab-binding-radiothermostat" description="Radio Thermostat Binding" version="${project.version}">
<feature>openhab-runtime-base</feature>
<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.radiothermostat/${project.version}</bundle>
</feature>
</features>
Loading