From 4cb2df5674af58198586df868951be6151f0e9f5 Mon Sep 17 00:00:00 2001 From: mlobstein Date: Fri, 16 Feb 2024 01:24:29 -0600 Subject: [PATCH] [radiothermostat] Add units to README (#16411) * Add units and minor edits Signed-off-by: Michael Lobstein --- .../README.md | 74 ++++++++++--------- 1 file changed, 38 insertions(+), 36 deletions(-) diff --git a/bundles/org.openhab.binding.radiothermostat/README.md b/bundles/org.openhab.binding.radiothermostat/README.md index eb918c40e5bbc..77c536a344a96 100644 --- a/bundles/org.openhab.binding.radiothermostat/README.md +++ b/bundles/org.openhab.binding.radiothermostat/README.md @@ -47,14 +47,16 @@ If one or more time or setpoint fields are left blank in a given schedule and th A heating or cooling schedule with all fields left blank will be ignored by the binding. In that case, the existing schedule on the thermostat will remain untouched. +### Cloud Service Discontinued + The MyRadioThermostat/EnergyHub cloud service that previously enabled remote control and scheduling of the thermostat is now defunct. As such, disabling cloud connectivity on a thermostat that was previously connected to the cloud service may slightly improve the speed and reliability of accessing the local API. The thermostat can de-provisioned from the cloud by issuing the following `curl` commands: ```shell -curl http://$THERMOSTAT_IP/cloud -d '{"enabled":0}' -X POST -curl http://$THERMOSTAT_IP/cloud -d '{"authkey":""}' -X POST +curl http://$THERMOSTAT_IP/cloud -d '{"enabled":0}' +curl http://$THERMOSTAT_IP/cloud -d '{"authkey":""}' ``` ### Some notes @@ -62,7 +64,7 @@ curl http://$THERMOSTAT_IP/cloud -d '{"authkey":""}' -X POST - 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. -- Clock sync will not occur if `override` flag is on (i.e. the program setpoint has been manually overridden) because syncing time will reset the temperature back to the program setpoint. +- Clock sync will not occur while the `override` flag is on (i.e. the program setpoint has been manually overridden) because syncing time will reset the temperature back to the program setpoint. - The `override` flag is not reported correctly on older thermostat versions (i.e. /tstat/model reports v1.09) - The 'Program Mode' command is untested and according to the published API is only available on a CT80 Rev B. - Humidity information is available only when using a CT80 thermostat. @@ -72,28 +74,28 @@ curl http://$THERMOSTAT_IP/cloud -d '{"authkey":""}' -X POST 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: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 | -| hold | Switch | Indicates if the current set point temperature is to be held indefinitely | -| remote_temp | Number:Temperature | Override the internal temperature as read by the thermostat's temperature sensor; Set to -1 to return to internal temperature mode | -| 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) | -| 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 | -| message | String (Write Only) | Used to display a number in the upper left 'price message' area of the thermostat's screen where the time is normally displayed | +| Channel ID | Item Type | Description | +|------------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| temperature | Number:Temperature | The current temperature reading (°F) of the thermostat | +| 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 (°F) 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 | +| hold | Switch | Indicates if the current set point temperature is to be held indefinitely | +| remote_temp | Number:Temperature | Override the internal temperature (°F) as read by the thermostat's temperature sensor; Set to -1 to return to internal temperature mode | +| 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) | +| 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 | +| message | String (Write Only) | Used to display a number in the upper left 'price message' area of the thermostat's screen where the time is normally displayed | ## Full Example @@ -158,25 +160,25 @@ Number Therm_Mode "Thermostat Mode [MAP(radiotherm.map):%s_mode]" 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]" { channel="radiothermostat:rtherm:mytherm1:set_point" } +Number:Temperature Therm_Setpt "Set Point [%d]" { 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 [%d]" { channel="radiothermostat:rtherm:mytherm1:day" } -Number Therm_Hour "Thermostat Hour [%d]" { channel="radiothermostat:rtherm:mytherm1:hour" } -Number Therm_Minute "Thermostat Minute [%d]" { channel="radiothermostat:rtherm:mytherm1:minute" } -String Therm_Dstmp "Thermostat DateStamp [%s]"