GetThermostat
GET
Get Thermostat
Get data for a specific thermostat
Responses will differ based on specific device, equipment setup, and model type. (e.g., some devices do not have a local time-based schedule)
{
"displayedOutdoorHumidity": 67,
"vacationHold": {
"enabled": false
},
"currentSchedulePeriod": {
"day": "Thursday",
"period": "Away"
},
"scheduleCapabilities": {
"availableScheduleTypes": [
"None",
"Geofenced",
"TimedNorthAmerica"
],
"schedulableFan": false
},
"scheduleType": {
"scheduleType": "Timed",
"scheduleSubType": "NA"
},
"scheduleStatus": "Resume",
"allowedTimeIncrements": 15,
"settings": {
"hardwareSettings": {
"brightness": 0,
"maxBrightness": 5
},
"fan": {
"allowedModes": [
"On",
"Auto",
"Circulate"
],
"changeableValues": {
"mode": "On"
}
},
"temperatureMode": {
"air": true
},
"specialMode": {
"autoChangeoverActive": false,
"emergencyHeatActive": false
}
},
"deviceClass": "Thermostat",
"deviceType": "Thermostat",
"deviceID": "LCC-00D02DAB5CBE",
"userDefinedDeviceName": "TSeries",
"name": "TSeries",
"isAlive": true,
"isUpgrading": false,
"isProvisioned": true,
"macID": "00D02DAB5CBE",
"deviceSettings": {},
"units": "Fahrenheit",
"indoorTemperature": 73,
"outdoorTemperature": 46,
"allowedModes": [
"EmergencyHeat",
"Heat",
"Off",
"Cool",
"Auto"
],
"deadband": 0,
"hasDualSetpointStatus": false,
"minHeatSetpoint": 50,
"maxHeatSetpoint": 90,
"minCoolSetpoint": 50,
"maxCoolSetpoint": 90,
"changeableValues": {
"mode": "Heat",
"autoChangeoverActive": false,
"emergencyHeatActive": false,
"heatSetpoint": 62,
"coolSetpoint": 85,
"thermostatSetpointStatus": "NoHold",
"nextPeriodTime": "18:00:00",
"endHeatSetpoint": 62,
"endCoolSetpoint": 85,
"heatCoolMode": "Heat"
},
"operationStatus": {
"mode": "EquipmentOff",
"fanRequest": false,
"circulationFanRequest": false
}
}
| Field Name/Location | Data Type | Definition |
|---|---|---|
| displayedOutdoorHumidity | Integer | Outdoor humidity reading (from weather data), should be treated as percentage |
| vacationHold | Object | |
| vacationHold.enabled | Boolean | Is vacation hold enabled? |
| scheduleCapabilities | Object | |
| scheduleCapabilities.availableScheduleTypes | Array | List of available schedule types |
| scheduleCapabilities.schedulableFan | Boolean | Is the fan mode scheduleable? |
| scheduleType | Object | |
| scheduleType.scheduleType | String | Current schedule type |
| scheduleType.scheduleSubType | String | Current schedule sub-type |
| scheduleStatus | String | Current status of schedule |
| allowedTimeIncrements | Integer | Allowed time increments of the timed schedule (in minutes) |
| settings | Object | |
| settings.hardwareSettings | Object | |
| settings.hardwareSettings.brightness | Integer | Current brightness setting |
| settings.hardwareSettings.maxBrightness | Integer | Maximum brightness setting |
| settings.fan | Object | |
| settings.fan.allowedModes | Array | Array of allowed fan modes |
| settings.fan.changeableValues | Object | List of writeable fan settings |
| settings.temperatureMode | Object | |
| settings.temperatureMode.air | Boolean | |
| settings.specialMode | Object | |
| settings.specialMode.autoChangeoverActive | Boolean | Will exist if device has this mode enabled, true or false based on running in that mode |
| settings.specialMode.emergencyHeatActive | Boolean | Will exist if device has this mode enabled, true or false based on running in that mode |
| deviceClass | String | Class of device |
| deviceType | String | Type of device |
| deviceID | String | Unique ID of device. "LCC-" == T-Series, "TCC-" == Honeywell Home Round |
| userDefinedDeviceName | String | User defined name of the device. Shown in the mobile app. |
| name | String | Device name |
| isAlive | Boolean | true == device online. false == device offline |
| isProvisioned | Boolean | Is the device provisioned correctly or not |
| macID | String | Unique MACID of the device |
| deviceSettings | Object | |
| units | String | Units used on device (Celsius or Fahrenheit) |
| indoorTemperature | Integer or Float | Current display temperature on device. Whole numbers for F units or .5 increments for C units. |
| outdoorTemperature | Integer or Float | Current outdoor temperature based on location data. |
| allowedModes | Array | List of allowed modes for the device, also be sure to doublecheck settings.specialMode for Round. |
| deadband | Integer | Required separation between high and low setpoints. Default for Thermostats is 0. |
| hasDualSetpointStatus | Boolean | Indicates whether the thermostat maintains separate heat and cool setpoint status value. |
| minHeatSetpoint | Integer or Float | The lower limit for the heating setpoint (e.g., thermostat won't let you decrease heat setpoint below this value.) Configurable locally; not changeable remotely. |
| maxHeatSetpoint | Integer or Float | The upper limit for the heating setpoint (e.g., thermostat won't let you increase heat setpoint above this value.) Configurable locally; not changeable remotely. |
| minCoolSetpoint | Integer or Float | The lower limit for the cooling setpoint (e.g., thermostat won't let you decrease cool setpoint below this value.) Configurable locally; not changeable remotely. |
| maxCoolSetpoint | Integer or Float | The upper limit for the cooling setpoint (e.g., thermostat won't let you increase cool setpoint above this value.) Configurable locally; not changeable remotely. |
| changeableValues.mode | String | Current mode of the thermostat. |
| changeableValues.autoChangeoverActive | Boolean | If field is set in the response then the thermostat supports autochangeover to be controlled independent of mode. If field is not set in the response then the thermostat does not support autochangeover. |
| changeableValues.emergencyHeatActive | Boolean | Indicates if emergency heating is active. When this field is returned (it is nullable and does not have to be in the response) - it means that the device handles emergency heating independently of the mode. When this field is returned (it is nullable and does not have to be in the response) - device will not accept EmergencyHeat as an allowed value. When emergency heating is active you cannot set thermostat's mode to other value than Off and you cannot change autochangeover. |
| changeableValues.heatSetpoint | Decimal | Current heating setpoint. |
| changeableValues.coolSetpoint | Decimal | Current cooling setpoint. |
| changeableValues.thermostatSetpointStatus | String | Signifies current setpoint state. TemporaryHold, HoldUntil, PermanentHold, VacationHold, NoHold |
| changeableValues.holdUntil | timeSpan | Time in 15 minutes intervals (the maximum value is 92 = 11:45 PM), meaning depends on other properties. |
| changeableValues.nextPeriodTime | timeSpan | Indicates when next schedule period starts |
| changeableValues.endHeatSetpoint | Decimal | The heating setpoint that would occur if the current hold ended now. If there is no hold, or if the thermostat cannot control heating, then this value is not present. |
| changeableValues.endCoolSetpoint | Decimal | The cooling setpoint that would occur if the current hold ended now. If there is no hold, or if the thermostat cannot control cooling, then this value is not present. |
| changeableValues.heatCoolMode | String | Heat cool mode when system switch is in Auto mode. |
| operationStatus | Object | Details around operation status of the equipment. |
| operationStatus.mode | String | Current running (relay status) of the equipment. |
| operationStatus.fanRequest | Boolean | Current running (relay status) of the fan. |
| operationStatus.circulationFanRequest | Boolean | Current running (relay status) of the fan circulate mode. |
| smartAway | Object | Settings that will take effect when nobody is home (via Geofencing). Null when reported means smart away is not available. |
| indoorHumidity | Decimal | Indoor humidity rating as a percentage |
| indoorHumidityStatus | String | Status of humidity sensor. Measured, NotAvailable, or SensorFault. |
Resource URL
https://api.honeywell.com/v2 /devices/thermostats/{deviceId}
Query Parameters
| Name | Values | Description |
|---|---|---|
|
apikey
(required) |
Your API Key |
|
|
locationId
(required) |
LocationID for the requested device |
Request Body
deviceId DeviceID for the requested device true
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Resource Summary |
|
|
Security |
|
|
Category |
Thermostat |
Working...