Runtime Object

The runtime object represents the last known thermostat running state. This state is composed from the last interval status message received from a thermostat. It is also updated each time the thermostat posts configuration changes to the server.

The runtime object contains the last 5 minute interval value sent by the thermostat for the past 15 minutes of runtime. The thermostat updates the server every 15 minutes with the last three 5 minute readings.

The actual temperature and humidity will also be updated when the equipment state changes by the thermostat, this may occur at a frequency of 3 minutes, however it is only transmitted when there is an equipment state change on the thermostat.

The runtime object contains two fields, desiredHeatRange and desiredCoolRange, which can be queried and used to determine that any holds being set through the API will not be adjusted. The API caller should check these ranges before calling the setHold function to mitigate against the new set points being adjusted by the server if the values are outside the acceptable ranges.

See Thermostat Interval Report Data for additional information about the interval readings.

The runtime object is read-only.

Properties

Name Type Read Only Required Description
runtimeRev String yes no The current runtime revision. Equivalent in meaning to the runtime revision number in the thermostat summary call.
connected Boolean yes no Whether the thermostat is currently connected to the server.
firstConnected String yes no The UTC date/time stamp of when the thermostat first connected to the ecobee server.
connectDateTime String no no The last recorded connection date and time.
disconnectDateTime String no no The last recorded disconnection date and time.
lastModified String yes no The UTC date/time stamp of when the thermostat was updated. Format: YYYY-MM-DD HH:MM:SS
lastStatusModified String yes no The UTC date/time stamp of when the thermostat last posted its runtime information. Format: YYYY-MM-DD HH:MM:SS
runtimeDate String yes no The UTC date of the last runtime reading. Format: YYYY-MM-DD
runtimeInterval Integer yes no The last 5 minute interval which was updated by the thermostat telemetry update. Subtract 2 from this interval to obtain the beginning interval for the last 3 readings. Multiply by 5 mins to obtain the minutes of the day. Range: 0-287
actualTemperature Integer yes no The current temperature displayed on the thermostat.
actualHumidity Integer yes no The current humidity % shown on the thermostat.
rawTemperature Integer yes no The dry-bulb temperature recorded by the thermostat. When Energy.FeelsLikeMode is set to humidex, Runtime.actualTemperature will report a "feels like" temperature.
showIconMode Integer yes no The currently displayed icon on the thermostat.
desiredHeat Integer yes no The desired heat temperature as per the current running program or active event.
desiredCool Integer yes no The desired cool temperature as per the current running program or active event.
desiredHumidity Integer yes no The desired humidity set point.
desiredDehumidity Integer yes no The desired dehumidification set point.
desiredFanMode String yes no The desired fan mode. Values: auto, on or null if the HVAC system is off and the thermostat is not controlling a fan independently.
desiredHeatRange Integer[] yes no This field provides the possible valid range for which a desiredHeat setpoint can be set to. This value takes into account the thermostat heat temperature limits as well the running program or active events. Values are returned as an Integer array representing the canonical minimum and maximim, e.g. [450,790].
desiredCoolRange Integer[] yes no This field provides the possible valid range for which a desiredCool setpoint can be set to. This value takes into account the thermostat cool temperature limits as well the running program or active events. Values are returned as an Integer array representing the canonical minimum and maximim, e.g. [650,920].

Back To Top