Thermostat Cluster

The following commands and attributes are accepted as JSON payloads for the Thermostat cluster.

Thermostat Attributes

The following attribute topics are used to retrieve the Thermostat cluster state.

Thermostat/LocalTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/LocalTemperature/Reported
[PREFIX]/Thermostat/Attributes/LocalTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster LocalTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LocalTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/LocalTemperature/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/LocalTemperature/Desired { "value": <DESIRED_LOCAL_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/LocalTemperature/Reported { "value": <REPORTED_LOCAL_TEMPERATURE>}

Thermostat/OutdoorTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OutdoorTemperature/Reported
[PREFIX]/Thermostat/Attributes/OutdoorTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OutdoorTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OutdoorTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OutdoorTemperature/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OutdoorTemperature/Desired { "value": <DESIRED_OUTDOOR_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OutdoorTemperature/Reported { "value": <REPORTED_OUTDOOR_TEMPERATURE>}

Thermostat/Occupancy Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/Occupancy/Reported
[PREFIX]/Thermostat/Attributes/Occupancy/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster Occupancy Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatOccupancy"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Occupancy attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/Occupancy/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/Occupancy/Desired { "value": <DESIRED_OCCUPANCY>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/Occupancy/Reported { "value": <REPORTED_OCCUPANCY>}

Thermostat/AbsMinHeatSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AbsMinHeatSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/AbsMinHeatSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AbsMinHeatSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AbsMinHeatSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AbsMinHeatSetpointLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMinHeatSetpointLimit/Desired { "value": <DESIRED_ABS_MIN_HEAT_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMinHeatSetpointLimit/Reported { "value": <REPORTED_ABS_MIN_HEAT_SETPOINT_LIMIT>}

Thermostat/AbsMaxHeatSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AbsMaxHeatSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/AbsMaxHeatSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AbsMaxHeatSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AbsMaxHeatSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AbsMaxHeatSetpointLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMaxHeatSetpointLimit/Desired { "value": <DESIRED_ABS_MAX_HEAT_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMaxHeatSetpointLimit/Reported { "value": <REPORTED_ABS_MAX_HEAT_SETPOINT_LIMIT>}

Thermostat/AbsMinCoolSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AbsMinCoolSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/AbsMinCoolSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AbsMinCoolSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AbsMinCoolSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AbsMinCoolSetpointLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMinCoolSetpointLimit/Desired { "value": <DESIRED_ABS_MIN_COOL_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMinCoolSetpointLimit/Reported { "value": <REPORTED_ABS_MIN_COOL_SETPOINT_LIMIT>}

Thermostat/AbsMaxCoolSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AbsMaxCoolSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/AbsMaxCoolSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AbsMaxCoolSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AbsMaxCoolSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AbsMaxCoolSetpointLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMaxCoolSetpointLimit/Desired { "value": <DESIRED_ABS_MAX_COOL_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AbsMaxCoolSetpointLimit/Reported { "value": <REPORTED_ABS_MAX_COOL_SETPOINT_LIMIT>}

Thermostat/PICoolingDemand Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/PICoolingDemand/Reported
[PREFIX]/Thermostat/Attributes/PICoolingDemand/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster PICoolingDemand Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PICoolingDemand attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/PICoolingDemand/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/PICoolingDemand/Desired { "value": <DESIRED_PI_COOLING_DEMAND>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/PICoolingDemand/Reported { "value": <REPORTED_PI_COOLING_DEMAND>}

Thermostat/PIHeatingDemand Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/PIHeatingDemand/Reported
[PREFIX]/Thermostat/Attributes/PIHeatingDemand/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster PIHeatingDemand Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PIHeatingDemand attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/PIHeatingDemand/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/PIHeatingDemand/Desired { "value": <DESIRED_PI_HEATING_DEMAND>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/PIHeatingDemand/Reported { "value": <REPORTED_PI_HEATING_DEMAND>}

Thermostat/HVACSystemTypeConfiguration Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/HVACSystemTypeConfiguration/Reported
[PREFIX]/Thermostat/Attributes/HVACSystemTypeConfiguration/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster HVACSystemTypeConfiguration Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatHVACSystemTypeConfiguration"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for HVACSystemTypeConfiguration attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/HVACSystemTypeConfiguration/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/HVACSystemTypeConfiguration/Desired { "value": <DESIRED_HVAC_SYSTEM_TYPE_CONFIGURATION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/HVACSystemTypeConfiguration/Reported { "value": <REPORTED_HVAC_SYSTEM_TYPE_CONFIGURATION>}

Thermostat/LocalTemperatureCalibration Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/LocalTemperatureCalibration/Reported
[PREFIX]/Thermostat/Attributes/LocalTemperatureCalibration/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster LocalTemperatureCalibration Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for LocalTemperatureCalibration attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/LocalTemperatureCalibration/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/LocalTemperatureCalibration/Desired { "value": <DESIRED_LOCAL_TEMPERATURE_CALIBRATION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/LocalTemperatureCalibration/Reported { "value": <REPORTED_LOCAL_TEMPERATURE_CALIBRATION>}

Thermostat/OccupiedCoolingSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedCoolingSetpoint/Reported
[PREFIX]/Thermostat/Attributes/OccupiedCoolingSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedCoolingSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedCoolingSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedCoolingSetpoint/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedCoolingSetpoint/Desired { "value": <DESIRED_OCCUPIED_COOLING_SETPOINT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedCoolingSetpoint/Reported { "value": <REPORTED_OCCUPIED_COOLING_SETPOINT>}

Thermostat/OccupiedHeatingSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedHeatingSetpoint/Reported
[PREFIX]/Thermostat/Attributes/OccupiedHeatingSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedHeatingSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedHeatingSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedHeatingSetpoint/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedHeatingSetpoint/Desired { "value": <DESIRED_OCCUPIED_HEATING_SETPOINT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedHeatingSetpoint/Reported { "value": <REPORTED_OCCUPIED_HEATING_SETPOINT>}

Thermostat/UnoccupiedCoolingSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedCoolingSetpoint/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedCoolingSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedCoolingSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedCoolingSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedCoolingSetpoint/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedCoolingSetpoint/Desired { "value": <DESIRED_UNOCCUPIED_COOLING_SETPOINT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedCoolingSetpoint/Reported { "value": <REPORTED_UNOCCUPIED_COOLING_SETPOINT>}

Thermostat/UnoccupiedHeatingSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedHeatingSetpoint/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedHeatingSetpoint/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedHeatingSetpoint Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedHeatingSetpoint attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedHeatingSetpoint/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedHeatingSetpoint/Desired { "value": <DESIRED_UNOCCUPIED_HEATING_SETPOINT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedHeatingSetpoint/Reported { "value": <REPORTED_UNOCCUPIED_HEATING_SETPOINT>}

Thermostat/MinHeatSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MinHeatSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/MinHeatSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MinHeatSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinHeatSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MinHeatSetpointLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinHeatSetpointLimit/Desired { "value": <DESIRED_MIN_HEAT_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinHeatSetpointLimit/Reported { "value": <REPORTED_MIN_HEAT_SETPOINT_LIMIT>}

Thermostat/MaxHeatSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MaxHeatSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/MaxHeatSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MaxHeatSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxHeatSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MaxHeatSetpointLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MaxHeatSetpointLimit/Desired { "value": <DESIRED_MAX_HEAT_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MaxHeatSetpointLimit/Reported { "value": <REPORTED_MAX_HEAT_SETPOINT_LIMIT>}

Thermostat/MinCoolSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MinCoolSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/MinCoolSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MinCoolSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinCoolSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MinCoolSetpointLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinCoolSetpointLimit/Desired { "value": <DESIRED_MIN_COOL_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinCoolSetpointLimit/Reported { "value": <REPORTED_MIN_COOL_SETPOINT_LIMIT>}

Thermostat/MaxCoolSetpointLimit Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MaxCoolSetpointLimit/Reported
[PREFIX]/Thermostat/Attributes/MaxCoolSetpointLimit/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MaxCoolSetpointLimit Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxCoolSetpointLimit attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MaxCoolSetpointLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MaxCoolSetpointLimit/Desired { "value": <DESIRED_MAX_COOL_SETPOINT_LIMIT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MaxCoolSetpointLimit/Reported { "value": <REPORTED_MAX_COOL_SETPOINT_LIMIT>}

Thermostat/MinSetpointDeadBand Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/MinSetpointDeadBand/Reported
[PREFIX]/Thermostat/Attributes/MinSetpointDeadBand/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster MinSetpointDeadBand Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinSetpointDeadBand attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/MinSetpointDeadBand/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinSetpointDeadBand/Desired { "value": <DESIRED_MIN_SETPOINT_DEAD_BAND>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/MinSetpointDeadBand/Reported { "value": <REPORTED_MIN_SETPOINT_DEAD_BAND>}

Thermostat/RemoteSensing Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/RemoteSensing/Reported
[PREFIX]/Thermostat/Attributes/RemoteSensing/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster RemoteSensing Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatRemoteSensing"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RemoteSensing attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/RemoteSensing/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/RemoteSensing/Desired { "value": <DESIRED_REMOTE_SENSING>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/RemoteSensing/Reported { "value": <REPORTED_REMOTE_SENSING>}

Thermostat/ControlSequenceOfOperation Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ControlSequenceOfOperation/Reported
[PREFIX]/Thermostat/Attributes/ControlSequenceOfOperation/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ControlSequenceOfOperation Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatControlSequenceOfOperation"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ControlSequenceOfOperation attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ControlSequenceOfOperation/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ControlSequenceOfOperation/Desired { "value": <DESIRED_CONTROL_SEQUENCE_OF_OPERATION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ControlSequenceOfOperation/Reported { "value": <REPORTED_CONTROL_SEQUENCE_OF_OPERATION>}

Thermostat/SystemMode Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/SystemMode/Reported
[PREFIX]/Thermostat/Attributes/SystemMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SystemMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatSystemMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SystemMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/SystemMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SystemMode/Desired { "value": <DESIRED_SYSTEM_MODE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SystemMode/Reported { "value": <REPORTED_SYSTEM_MODE>}

Thermostat/AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/AlarmMask/Reported
[PREFIX]/Thermostat/Attributes/AlarmMask/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster AlarmMask Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatAlarmMask"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AlarmMask attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/AlarmMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AlarmMask/Desired { "value": <DESIRED_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/AlarmMask/Reported { "value": <REPORTED_ALARM_MASK>}

Thermostat/ThermostatRunningMode Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ThermostatRunningMode/Reported
[PREFIX]/Thermostat/Attributes/ThermostatRunningMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ThermostatRunningMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatThermostatRunningMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ThermostatRunningMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ThermostatRunningMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatRunningMode/Desired { "value": <DESIRED_THERMOSTAT_RUNNING_MODE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatRunningMode/Reported { "value": <REPORTED_THERMOSTAT_RUNNING_MODE>}

Thermostat/StartOfWeek Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/StartOfWeek/Reported
[PREFIX]/Thermostat/Attributes/StartOfWeek/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster StartOfWeek Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatStartOfWeek"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for StartOfWeek attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/StartOfWeek/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/StartOfWeek/Desired { "value": <DESIRED_START_OF_WEEK>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/StartOfWeek/Reported { "value": <REPORTED_START_OF_WEEK>}

Thermostat/NumberOfWeeklyTransitions Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/NumberOfWeeklyTransitions/Reported
[PREFIX]/Thermostat/Attributes/NumberOfWeeklyTransitions/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster NumberOfWeeklyTransitions Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfWeeklyTransitions attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/NumberOfWeeklyTransitions/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/NumberOfWeeklyTransitions/Desired { "value": <DESIRED_NUMBER_OF_WEEKLY_TRANSITIONS>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/NumberOfWeeklyTransitions/Reported { "value": <REPORTED_NUMBER_OF_WEEKLY_TRANSITIONS>}

Thermostat/NumberOfDailyTransitions Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/NumberOfDailyTransitions/Reported
[PREFIX]/Thermostat/Attributes/NumberOfDailyTransitions/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster NumberOfDailyTransitions Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NumberOfDailyTransitions attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/NumberOfDailyTransitions/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/NumberOfDailyTransitions/Desired { "value": <DESIRED_NUMBER_OF_DAILY_TRANSITIONS>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/NumberOfDailyTransitions/Reported { "value": <REPORTED_NUMBER_OF_DAILY_TRANSITIONS>}

Thermostat/TemperatureSetpointHold Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/TemperatureSetpointHold/Reported
[PREFIX]/Thermostat/Attributes/TemperatureSetpointHold/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster TemperatureSetpointHold Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatTemperatureSetpointHold"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TemperatureSetpointHold attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/TemperatureSetpointHold/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/TemperatureSetpointHold/Desired { "value": <DESIRED_TEMPERATURE_SETPOINT_HOLD>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/TemperatureSetpointHold/Reported { "value": <REPORTED_TEMPERATURE_SETPOINT_HOLD>}

Thermostat/TemperatureSetpointHoldDuration Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/TemperatureSetpointHoldDuration/Reported
[PREFIX]/Thermostat/Attributes/TemperatureSetpointHoldDuration/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster TemperatureSetpointHoldDuration Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for TemperatureSetpointHoldDuration attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/TemperatureSetpointHoldDuration/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/TemperatureSetpointHoldDuration/Desired { "value": <DESIRED_TEMPERATURE_SETPOINT_HOLD_DURATION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/TemperatureSetpointHoldDuration/Reported { "value": <REPORTED_TEMPERATURE_SETPOINT_HOLD_DURATION>}

Thermostat/ThermostatProgrammingOperationMode Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ThermostatProgrammingOperationMode/Reported
[PREFIX]/Thermostat/Attributes/ThermostatProgrammingOperationMode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ThermostatProgrammingOperationMode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatThermostatProgrammingOperationMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ThermostatProgrammingOperationMode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ThermostatProgrammingOperationMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatProgrammingOperationMode/Desired { "value": <DESIRED_THERMOSTAT_PROGRAMMING_OPERATION_MODE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatProgrammingOperationMode/Reported { "value": <REPORTED_THERMOSTAT_PROGRAMMING_OPERATION_MODE>}

Thermostat/ThermostatRunningState Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ThermostatRunningState/Reported
[PREFIX]/Thermostat/Attributes/ThermostatRunningState/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ThermostatRunningState Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatThermostatRunningState"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ThermostatRunningState attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ThermostatRunningState/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatRunningState/Desired { "value": <DESIRED_THERMOSTAT_RUNNING_STATE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ThermostatRunningState/Reported { "value": <REPORTED_THERMOSTAT_RUNNING_STATE>}

Thermostat/SetpointChangeSource Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/SetpointChangeSource/Reported
[PREFIX]/Thermostat/Attributes/SetpointChangeSource/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetpointChangeSource Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatSetpointChangeSource"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SetpointChangeSource attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/SetpointChangeSource/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeSource/Desired { "value": <DESIRED_SETPOINT_CHANGE_SOURCE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeSource/Reported { "value": <REPORTED_SETPOINT_CHANGE_SOURCE>}

Thermostat/SetpointChangeAmount Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/SetpointChangeAmount/Reported
[PREFIX]/Thermostat/Attributes/SetpointChangeAmount/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetpointChangeAmount Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SetpointChangeAmount attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/SetpointChangeAmount/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeAmount/Desired { "value": <DESIRED_SETPOINT_CHANGE_AMOUNT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeAmount/Reported { "value": <REPORTED_SETPOINT_CHANGE_AMOUNT>}

Thermostat/SetpointChangeSourceTimestamp Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/SetpointChangeSourceTimestamp/Reported
[PREFIX]/Thermostat/Attributes/SetpointChangeSourceTimestamp/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetpointChangeSourceTimestamp Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "UTC"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SetpointChangeSourceTimestamp attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/SetpointChangeSourceTimestamp/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeSourceTimestamp/Desired { "value": <DESIRED_SETPOINT_CHANGE_SOURCE_TIMESTAMP>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/SetpointChangeSourceTimestamp/Reported { "value": <REPORTED_SETPOINT_CHANGE_SOURCE_TIMESTAMP>}

Thermostat/OccupiedSetback Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedSetback/Reported
[PREFIX]/Thermostat/Attributes/OccupiedSetback/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedSetback Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedSetback attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedSetback/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetback/Desired { "value": <DESIRED_OCCUPIED_SETBACK>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetback/Reported { "value": <REPORTED_OCCUPIED_SETBACK>}

Thermostat/OccupiedSetbackMin Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedSetbackMin/Reported
[PREFIX]/Thermostat/Attributes/OccupiedSetbackMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedSetbackMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedSetbackMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedSetbackMin/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetbackMin/Desired { "value": <DESIRED_OCCUPIED_SETBACK_MIN>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetbackMin/Reported { "value": <REPORTED_OCCUPIED_SETBACK_MIN>}

Thermostat/OccupiedSetbackMax Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/OccupiedSetbackMax/Reported
[PREFIX]/Thermostat/Attributes/OccupiedSetbackMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster OccupiedSetbackMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for OccupiedSetbackMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/OccupiedSetbackMax/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetbackMax/Desired { "value": <DESIRED_OCCUPIED_SETBACK_MAX>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/OccupiedSetbackMax/Reported { "value": <REPORTED_OCCUPIED_SETBACK_MAX>}

Thermostat/UnoccupiedSetback Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedSetback/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedSetback/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedSetback Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedSetback attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedSetback/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetback/Desired { "value": <DESIRED_UNOCCUPIED_SETBACK>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetback/Reported { "value": <REPORTED_UNOCCUPIED_SETBACK>}

Thermostat/UnoccupiedSetbackMin Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedSetbackMin/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedSetbackMin/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedSetbackMin Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedSetbackMin attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedSetbackMin/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetbackMin/Desired { "value": <DESIRED_UNOCCUPIED_SETBACK_MIN>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetbackMin/Reported { "value": <REPORTED_UNOCCUPIED_SETBACK_MIN>}

Thermostat/UnoccupiedSetbackMax Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/UnoccupiedSetbackMax/Reported
[PREFIX]/Thermostat/Attributes/UnoccupiedSetbackMax/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster UnoccupiedSetbackMax Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UnoccupiedSetbackMax attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/UnoccupiedSetbackMax/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetbackMax/Desired { "value": <DESIRED_UNOCCUPIED_SETBACK_MAX>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/UnoccupiedSetbackMax/Reported { "value": <REPORTED_UNOCCUPIED_SETBACK_MAX>}

Thermostat/EmergencyHeatDelta Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/EmergencyHeatDelta/Reported
[PREFIX]/Thermostat/Attributes/EmergencyHeatDelta/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster EmergencyHeatDelta Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for EmergencyHeatDelta attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/EmergencyHeatDelta/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/EmergencyHeatDelta/Desired { "value": <DESIRED_EMERGENCY_HEAT_DELTA>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/EmergencyHeatDelta/Reported { "value": <REPORTED_EMERGENCY_HEAT_DELTA>}

Thermostat/ACType Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACType/Reported
[PREFIX]/Thermostat/Attributes/ACType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACType/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACType/Desired { "value": <DESIRED_AC_TYPE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACType/Reported { "value": <REPORTED_AC_TYPE>}

Thermostat/ACCapacity Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACCapacity/Reported
[PREFIX]/Thermostat/Attributes/ACCapacity/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACCapacity Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCapacity attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACCapacity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCapacity/Desired { "value": <DESIRED_AC_CAPACITY>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCapacity/Reported { "value": <REPORTED_AC_CAPACITY>}

Thermostat/ACRefrigerantType Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACRefrigerantType/Reported
[PREFIX]/Thermostat/Attributes/ACRefrigerantType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACRefrigerantType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACRefrigerantType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACRefrigerantType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACRefrigerantType/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACRefrigerantType/Desired { "value": <DESIRED_AC_REFRIGERANT_TYPE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACRefrigerantType/Reported { "value": <REPORTED_AC_REFRIGERANT_TYPE>}

Thermostat/ACCompressorType Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACCompressorType/Reported
[PREFIX]/Thermostat/Attributes/ACCompressorType/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACCompressorType Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACCompressorType"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCompressorType attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACCompressorType/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCompressorType/Desired { "value": <DESIRED_AC_COMPRESSOR_TYPE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCompressorType/Reported { "value": <REPORTED_AC_COMPRESSOR_TYPE>}

Thermostat/ACErrorCode Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACErrorCode/Reported
[PREFIX]/Thermostat/Attributes/ACErrorCode/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACErrorCode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACErrorCode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACErrorCode attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACErrorCode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACErrorCode/Desired { "value": <DESIRED_AC_ERROR_CODE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACErrorCode/Reported { "value": <REPORTED_AC_ERROR_CODE>}

Thermostat/ACLouverPosition Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACLouverPosition/Reported
[PREFIX]/Thermostat/Attributes/ACLouverPosition/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACLouverPosition Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACLouverPosition"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACLouverPosition attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACLouverPosition/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACLouverPosition/Desired { "value": <DESIRED_AC_LOUVER_POSITION>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACLouverPosition/Reported { "value": <REPORTED_AC_LOUVER_POSITION>}

Thermostat/ACCoilTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACCoilTemperature/Reported
[PREFIX]/Thermostat/Attributes/ACCoilTemperature/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACCoilTemperature Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCoilTemperature attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACCoilTemperature/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCoilTemperature/Desired { "value": <DESIRED_AC_COIL_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCoilTemperature/Reported { "value": <REPORTED_AC_COIL_TEMPERATURE>}

Thermostat/ACCapacityFormat Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ACCapacityFormat/Reported
[PREFIX]/Thermostat/Attributes/ACCapacityFormat/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ACCapacityFormat Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "ThermostatACCapacityFormat"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ACCapacityFormat attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/+/Thermostat/Attributes/ACCapacityFormat/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCapacityFormat/Desired { "value": <DESIRED_AC_CAPACITY_FORMAT>}
ucl/by-unid/<UNID>/ep0/Thermostat/Attributes/ACCapacityFormat/Reported { "value": <REPORTED_AC_CAPACITY_FORMAT>}

Thermostat/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/Thermostat/Attributes/ClusterRevision/Reported
[PREFIX]/Thermostat/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/Thermostat/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/Thermostat/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

Thermostat Command Support

MQTT Topic Pattern:

[PREFIX]/Thermostat/SupportedCommands
[PREFIX]/Thermostat/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "SetpointRaiseOrLower",
              "GetWeeklyScheduleResponse",
              "SetWeeklySchedule",
              "GetRelayStatusLogResponse",
              "GetWeeklySchedule",
              "ClearWeeklySchedule",
              "GetRelayStatusLog",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for Thermostat cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Thermostat/SupportedCommands { "value": ["SetpointRaiseOrLower","SetWeeklySchedule","GetWeeklySchedule","ClearWeeklySchedule","GetRelayStatusLog","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for Thermostat cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Thermostat/SupportedGeneratedCommands { "value": ["GetWeeklyScheduleResponse","GetRelayStatusLogResponse",] }

Thermostat Commands

Thermostat/SetpointRaiseOrLower Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/SetpointRaiseOrLower
[PREFIX]/Thermostat/GeneratedCommands/SetpointRaiseOrLower

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetpointRaiseOrLower Command Properties",
  "type": "object",
  "properties": {
    "Mode": {
      "type": "SetpointRaiseOrLowerMode"
    },
    "Amount": {
      "type": "integer"
    }
  },
  "required": [
    "Mode",
    "Amount"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/SetpointRaiseOrLower command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/SetpointRaiseOrLower' -m  '{ "Mode": <MODE_VALUE>,"Amount": <AMOUNT_VALUE> }'

To receive a Thermostat/SetpointRaiseOrLower generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/SetpointRaiseOrLower'

Thermostat/GetWeeklyScheduleResponse Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/GetWeeklyScheduleResponse
[PREFIX]/Thermostat/GeneratedCommands/GetWeeklyScheduleResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster GetWeeklyScheduleResponse Command Properties",
  "type": "object",
  "properties": {
    "NumberOfTransitions": {
      "type": "integer"
    },
    "DayOfWeek": {
      "type": "TstatScheduleDOW"
    },
    "Mode": {
      "type": "TstatScheduleMode"
    },
    "Transitions": {
      "type": "array",
      "items": {
        "type": "TransitionType"
      }
 
  },
  "required": [
    "NumberOfTransitions",
    "DayOfWeek",
    "Mode",
    "Transitions"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/GetWeeklyScheduleResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/GetWeeklyScheduleResponse' -m  '{ "NumberOfTransitions": <NUMBER_OF_TRANSITIONS_VALUE>,"DayOfWeek": <DAY_OF_WEEK_VALUE>,"Mode": <MODE_VALUE>,"Transitions": <TRANSITIONS_VALUE> }'

To receive a Thermostat/GetWeeklyScheduleResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/GetWeeklyScheduleResponse'

Thermostat/SetWeeklySchedule Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/SetWeeklySchedule
[PREFIX]/Thermostat/GeneratedCommands/SetWeeklySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster SetWeeklySchedule Command Properties",
  "type": "object",
  "properties": {
    "NumberOfTransitions": {
      "type": "integer"
    },
    "DayOfWeek": {
      "type": "TstatScheduleDOW"
    },
    "Mode": {
      "type": "TstatScheduleMode"
    },
    "Transitions": {
      "type": "array",
      "items": {
        "type": "TransitionType"
      }
 
  },
  "required": [
    "NumberOfTransitions",
    "DayOfWeek",
    "Mode",
    "Transitions"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/SetWeeklySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/SetWeeklySchedule' -m  '{ "NumberOfTransitions": <NUMBER_OF_TRANSITIONS_VALUE>,"DayOfWeek": <DAY_OF_WEEK_VALUE>,"Mode": <MODE_VALUE>,"Transitions": <TRANSITIONS_VALUE> }'

To receive a Thermostat/SetWeeklySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/SetWeeklySchedule'

Thermostat/GetRelayStatusLogResponse Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/GetRelayStatusLogResponse
[PREFIX]/Thermostat/GeneratedCommands/GetRelayStatusLogResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster GetRelayStatusLogResponse Command Properties",
  "type": "object",
  "properties": {
    "TimeOfDay": {
      "type": "integer"
    },
    "RelayStatus": {
      "type": "GetRelayStatusLogResponseRelayStatus"
    },
    "LocalTemperature": {
      "type": "integer"
    },
    "HumidityPercentage": {
      "type": "integer"
    },
    "SetPoint": {
      "type": "integer"
    },
    "UnreadEntries": {
      "type": "integer"
    }
  },
  "required": [
    "TimeOfDay",
    "RelayStatus",
    "LocalTemperature",
    "HumidityPercentage",
    "SetPoint",
    "UnreadEntries"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/GetRelayStatusLogResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/GetRelayStatusLogResponse' -m  '{ "TimeOfDay": <TIME_OF_DAY_VALUE>,"RelayStatus": <RELAY_STATUS_VALUE>,"LocalTemperature": <LOCAL_TEMPERATURE_VALUE>,"HumidityPercentage": <HUMIDITY_PERCENTAGE_VALUE>,"SetPoint": <SET_POINT_VALUE>,"UnreadEntries": <UNREAD_ENTRIES_VALUE> }'

To receive a Thermostat/GetRelayStatusLogResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/GetRelayStatusLogResponse'

Thermostat/GetWeeklySchedule Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/GetWeeklySchedule
[PREFIX]/Thermostat/GeneratedCommands/GetWeeklySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster GetWeeklySchedule Command Properties",
  "type": "object",
  "properties": {
    "DaysToReturn": {
      "type": "TstatScheduleDOW"
    },
    "ModeToReturn": {
      "type": "TstatScheduleMode"
    }
  },
  "required": [
    "DaysToReturn",
    "ModeToReturn"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/GetWeeklySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/GetWeeklySchedule' -m  '{ "DaysToReturn": <DAYS_TO_RETURN_VALUE>,"ModeToReturn": <MODE_TO_RETURN_VALUE> }'

To receive a Thermostat/GetWeeklySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/GetWeeklySchedule'

Thermostat/ClearWeeklySchedule Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/ClearWeeklySchedule
[PREFIX]/Thermostat/GeneratedCommands/ClearWeeklySchedule

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ClearWeeklySchedule Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/ClearWeeklySchedule command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/ClearWeeklySchedule' -m  '{  }'

To receive a Thermostat/ClearWeeklySchedule generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/ClearWeeklySchedule'

Thermostat/GetRelayStatusLog Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/GetRelayStatusLog
[PREFIX]/Thermostat/GeneratedCommands/GetRelayStatusLog

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster GetRelayStatusLog Command Properties",
  "type": "object",
  "properties": {
  },
  "required": [
  ]
}

Example Mosquitto CLI Tool Usage

To send a Thermostat/GetRelayStatusLog command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/GetRelayStatusLog' -m  '{  }'

To receive a Thermostat/GetRelayStatusLog generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/GeneratedCommands/GetRelayStatusLog'

Thermostat/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "HVACSystemTypeConfiguration": {
      "type": "ThermostatHVACSystemTypeConfiguration"
    },
    "LocalTemperatureCalibration": {
      "type": "integer"
    },
    "OccupiedCoolingSetpoint": {
      "type": "integer"
    },
    "OccupiedHeatingSetpoint": {
      "type": "integer"
    },
    "UnoccupiedCoolingSetpoint": {
      "type": "integer"
    },
    "UnoccupiedHeatingSetpoint": {
      "type": "integer"
    },
    "MinHeatSetpointLimit": {
      "type": "integer"
    },
    "MaxHeatSetpointLimit": {
      "type": "integer"
    },
    "MinCoolSetpointLimit": {
      "type": "integer"
    },
    "MaxCoolSetpointLimit": {
      "type": "integer"
    },
    "MinSetpointDeadBand": {
      "type": "integer"
    },
    "RemoteSensing": {
      "type": "ThermostatRemoteSensing"
    },
    "ControlSequenceOfOperation": {
      "type": "ThermostatControlSequenceOfOperation"
    },
    "SystemMode": {
      "type": "ThermostatSystemMode"
    },
    "TemperatureSetpointHold": {
      "type": "ThermostatTemperatureSetpointHold"
    },
    "TemperatureSetpointHoldDuration": {
      "type": "integer"
    },
    "ThermostatProgrammingOperationMode": {
      "type": "ThermostatThermostatProgrammingOperationMode"
    },
    "OccupiedSetback": {
      "type": "integer"
    },
    "UnoccupiedSetback": {
      "type": "integer"
    },
    "EmergencyHeatDelta": {
      "type": "integer"
    },
    "ACType": {
      "type": "ThermostatACType"
    },
    "ACCapacity": {
      "type": "integer"
    },
    "ACRefrigerantType": {
      "type": "ThermostatACRefrigerantType"
    },
    "ACCompressorType": {
      "type": "ThermostatACCompressorType"
    },
    "ACErrorCode": {
      "type": "ThermostatACErrorCode"
    },
    "ACLouverPosition": {
      "type": "ThermostatACLouverPosition"
    },
    "ACCapacityFormat": {
      "type": "ThermostatACCapacityFormat"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all Thermostat attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/WriteAttributes' -m  '{ "HVACSystemTypeConfiguration": <HVAC_SYSTEM_TYPE_CONFIGURATION_VALUE> ,"LocalTemperatureCalibration": <LOCAL_TEMPERATURE_CALIBRATION_VALUE> ,"OccupiedCoolingSetpoint": <OCCUPIED_COOLING_SETPOINT_VALUE> ,"OccupiedHeatingSetpoint": <OCCUPIED_HEATING_SETPOINT_VALUE> ,"UnoccupiedCoolingSetpoint": <UNOCCUPIED_COOLING_SETPOINT_VALUE> ,"UnoccupiedHeatingSetpoint": <UNOCCUPIED_HEATING_SETPOINT_VALUE> ,"MinHeatSetpointLimit": <MIN_HEAT_SETPOINT_LIMIT_VALUE> ,"MaxHeatSetpointLimit": <MAX_HEAT_SETPOINT_LIMIT_VALUE> ,"MinCoolSetpointLimit": <MIN_COOL_SETPOINT_LIMIT_VALUE> ,"MaxCoolSetpointLimit": <MAX_COOL_SETPOINT_LIMIT_VALUE> ,"MinSetpointDeadBand": <MIN_SETPOINT_DEAD_BAND_VALUE> ,"RemoteSensing": <REMOTE_SENSING_VALUE> ,"ControlSequenceOfOperation": <CONTROL_SEQUENCE_OF_OPERATION_VALUE> ,"SystemMode": <SYSTEM_MODE_VALUE> ,"TemperatureSetpointHold": <TEMPERATURE_SETPOINT_HOLD_VALUE> ,"TemperatureSetpointHoldDuration": <TEMPERATURE_SETPOINT_HOLD_DURATION_VALUE> ,"ThermostatProgrammingOperationMode": <THERMOSTAT_PROGRAMMING_OPERATION_MODE_VALUE> ,"OccupiedSetback": <OCCUPIED_SETBACK_VALUE> ,"UnoccupiedSetback": <UNOCCUPIED_SETBACK_VALUE> ,"EmergencyHeatDelta": <EMERGENCY_HEAT_DELTA_VALUE> ,"ACType": <AC_TYPE_VALUE> ,"ACCapacity": <AC_CAPACITY_VALUE> ,"ACRefrigerantType": <AC_REFRIGERANT_TYPE_VALUE> ,"ACCompressorType": <AC_COMPRESSOR_TYPE_VALUE> ,"ACErrorCode": <AC_ERROR_CODE_VALUE> ,"ACLouverPosition": <AC_LOUVER_POSITION_VALUE> ,"ACCapacityFormat": <AC_CAPACITY_FORMAT_VALUE>  }'

‍NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

Thermostat/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Thermostat/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Thermostat Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "LocalTemperature",
          "OutdoorTemperature",
          "Occupancy",
          "AbsMinHeatSetpointLimit",
          "AbsMaxHeatSetpointLimit",
          "AbsMinCoolSetpointLimit",
          "AbsMaxCoolSetpointLimit",
          "PICoolingDemand",
          "PIHeatingDemand",
          "HVACSystemTypeConfiguration",
          "LocalTemperatureCalibration",
          "OccupiedCoolingSetpoint",
          "OccupiedHeatingSetpoint",
          "UnoccupiedCoolingSetpoint",
          "UnoccupiedHeatingSetpoint",
          "MinHeatSetpointLimit",
          "MaxHeatSetpointLimit",
          "MinCoolSetpointLimit",
          "MaxCoolSetpointLimit",
          "MinSetpointDeadBand",
          "RemoteSensing",
          "ControlSequenceOfOperation",
          "SystemMode",
          "AlarmMask",
          "ThermostatRunningMode",
          "StartOfWeek",
          "NumberOfWeeklyTransitions",
          "NumberOfDailyTransitions",
          "TemperatureSetpointHold",
          "TemperatureSetpointHoldDuration",
          "ThermostatProgrammingOperationMode",
          "ThermostatRunningState",
          "SetpointChangeSource",
          "SetpointChangeAmount",
          "SetpointChangeSourceTimestamp",
          "OccupiedSetback",
          "OccupiedSetbackMin",
          "OccupiedSetbackMax",
          "UnoccupiedSetback",
          "UnoccupiedSetbackMin",
          "UnoccupiedSetbackMax",
          "EmergencyHeatDelta",
          "ACType",
          "ACCapacity",
          "ACRefrigerantType",
          "ACCompressorType",
          "ACErrorCode",
          "ACLouverPosition",
          "ACCoilTemperature",
          "ACCapacityFormat"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all Thermostat attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the Thermostat attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Thermostat/Commands/ForceReadAttributes' -m  '{ "value": ["LocalTemperature"] }'