HVAC / Thermostats
Reporting HVAC Device Status
The HTTP integration of HVAC devices uses the following structure:
POST /services/gear/DeviceIntegrationService.svc/UpdateHVACStatus HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"mode": 4,
"fanMode": 1,
"setpoint": 21,
"ambientTemperature": 21.5,
"timestamp": "2021-02-23T14:55:03"
}Parameters
| Name | Description | Data Type |
|---|---|---|
| accessToken | Access token with permissions to update endpoint information. See this page for more information. | text |
| endpointID | Unique endpoint identifier or combination of device address and endpoint address in format [deviceAddress]:endpointAddress (e.g.: [device-1234]:1). These values can be found on the endpoint management page. | numeric |
| mode | Current device mode: 1 = off; 2 = on, auto mode; 3 = on, heat mode; 4 = on, cool mode; 5 = on, dehumidify mode; 6 = on, fan mode. | numeric |
| fanMode | Current fan mode: 1 = auto; 2 = low speed; 3 = medium speed; 4 = high speed. | numeric |
| setpoint | The target temperature, in degrees Celsius. | numeric |
| ambientTemperature | The ambient temperature, in degrees Celsius. | numeric |
| timestamp | Optional value indicating the UTC date and time corresponding to the measurement. The date format must match one of those specified in the date formats section. If the field is omitted, the platform will assume the measurement corresponds to the current date and time. | text |
Last updated on