UnifyThermostat Cluster

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

UnifyThermostat Attributes

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

UnifyThermostat/ThermostatMode Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyThermostat/Attributes/ThermostatMode/Reported
[PREFIX]/UnifyThermostat/Attributes/ThermostatMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyThermostat/Attributes/ThermostatMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyThermostat/Attributes/ThermostatMode/Desired { "value": <DESIRED_THERMOSTAT_MODE>}
ucl/by-unid/<UNID>/ep0/UnifyThermostat/Attributes/ThermostatMode/Reported { "value": <REPORTED_THERMOSTAT_MODE>}

UnifyThermostat/SupportedThermostatMode Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyThermostat/Attributes/SupportedThermostatMode/Reported
[PREFIX]/UnifyThermostat/Attributes/SupportedThermostatMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyThermostat/Attributes/SupportedThermostatMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyThermostat/Attributes/SupportedThermostatMode/Desired { "value": <DESIRED_SUPPORTED_THERMOSTAT_MODE>}
ucl/by-unid/<UNID>/ep0/UnifyThermostat/Attributes/SupportedThermostatMode/Reported { "value": <REPORTED_SUPPORTED_THERMOSTAT_MODE>}

UnifyThermostat/OperatingState Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyThermostat/Attributes/OperatingState/Reported
[PREFIX]/UnifyThermostat/Attributes/OperatingState/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyThermostat/Attributes/OperatingState/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyThermostat/Attributes/OperatingState/Desired { "value": <DESIRED_OPERATING_STATE>}
ucl/by-unid/<UNID>/ep0/UnifyThermostat/Attributes/OperatingState/Reported { "value": <REPORTED_OPERATING_STATE>}

UnifyThermostat/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UnifyThermostat 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>/UnifyThermostat/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

UnifyThermostat Command Support

MQTT Topic Pattern:

[PREFIX]/UnifyThermostat/SupportedCommands
[PREFIX]/UnifyThermostat/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UnifyThermostat Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyThermostat/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/UnifyThermostat/SupportedCommands { "value": [] }

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

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

UnifyThermostat Commands

UnifyThermostat/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/UnifyThermostat/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UnifyThermostat Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "ThermostatMode": {
      "type": "UnifyThermostatThermostatMode"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Commands/WriteAttributes' -m  '{ "ThermostatMode": <THERMOSTAT_MODE_VALUE> , }'

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

UnifyThermostat/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/UnifyThermostat/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UnifyThermostat Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ThermostatMode",
          "SupportedThermostatMode",
          "OperatingState"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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