Skip to main content

Fields

callForHeat : Boolean

Whether the zone is calling for heat.

code : Zone

Code name of the zone.

currentOperation : ZoneCurrentOperation

Current operation.

displayName : String

User determined name for a zone.

emergency : Boolean

Default mode, if the zone loses connection to the primary sensor.

enabled : Boolean

Enabled allows zone to heat when callForHeat is True.

heatDemand : Boolean

Whether there is demand for heat (True) or not (False).

previousOperation : ZonePreviousOperation

Previous operation.

primarySensor : String

Primary sensor for the zone.

All associated sensors and ADCs.

zoneType : ZoneType

What the zone is used for (heating, water etc).

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "callForHeat": true, "code": "WATER", "currentOperation": ZoneCurrentOperation, "displayName": "I-up-value-eat-especially", "emergency": true, "enabled": true, "heatDemand": true, "previousOperation": ZonePreviousOperation, "primarySensor": "authority-run-that-often-ok", "sensors": ADCSensorConfiguration, "zoneType": "HEAT" }