Author: HCA Central Version: 4 Added to Library: 10-Nov-23 HCAVersion needed: 17.0.36 Keywords: Class Requirements: Review Ecobee technical note (#611) before using.
IMPORTANT: Don't forget to create an "ecobee" folder in the root of the computer that runs the HCA Server application. This file is used to store the Ecobee access tokens and will always be very small. Extra Info Link: Here
Package Description: What's new:
Now sets a tag on the thermostat object with name Bee_LastStatusModified. The tag value is the local time of when the thermostat posted data to the Ecobee cloud. If this date-time gets too old the Ecobee thermostat could be offline.
What's new:
Complete redesign of previous version.
1. No global variables
2. Support up to 4 thermostats with up to 10 remote sensors each
3. Automatically creates thermostat devices when discovered.
4. The remote sensor data is now saved as tags on the thermostat objects
5. The last status of the thermostat - temperature, setpoints, fan etc - saved as a tag on the thermostat object.
6. New auxiliary programs to set the thermostat to Away climate ("Set Away Mode") and to cancel setpoint hold ("Set Normal Mode")
7. Much better protection of access tokens in a file and better reauthorization logic when the access expires.
Program Description: Main Class implementation program for Ecobee
Parameters:
Name | Type | Description | Default |
---|---|---|---|
DeviceName | Value | HCA Name of the Ecobee device | |
DeviceId | Value | Ecobee assigned device id | |
Code | Value | Operation code. See documentation for a thermostat class | |
Data | Value | Operation data. See documentation for a thermostat class |
Program Description: Handles updating Ecobee with changes but not too quickly as the Ecobee Cloud prevents that.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
DeviceName | Value | HCA Device name | |
DeviceId | Value | Ecobee assigned device Id |
Program Description: Ecobee connector program for the user to start the process
Program Description: Ecobee connector program for the user to finish the process
Program Description: Poll the Ecobee for current status and sensor data. If the device id parameter is supplied as "" then creates device objects for all thermostats.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
deviceId | Value | The Id assigned to the Ecobee device |
Program Description: Reauthorize Ecobee access and save new tokedn in the token file
Program Description: Finds the thermostat object with the supplied device id
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id | Value | ID of the thermostat wanted |
Program Description: Start this program, supplying the name of the thermostat to put into "Away' climate.
Return value: Returns 0 if worked or an error message
Parameters:
Name | Type | Description | Default |
---|---|---|---|
DeviceName | Value | HCA Name of the device. For example, Entry - Thermostat |
Program Description: Start this program, supplying the name of the thermostat to put into Normal mode and to cancel any holds.
Return value: Returns 0 if worked, an error message if not
Parameters:
Name | Type | Description | Default |
---|---|---|---|
DeviceName | Value | HCA Name of the device. For example, Entry - Thermostat |