ThermostatUserInterfaceConfiguration Cluster

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

ThermostatUserInterfaceConfiguration Attributes

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

ThermostatUserInterfaceConfiguration/TemperatureDisplayMode Attribute

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/Reported
[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/Desired { "value": <DESIRED_TEMPERATURE_DISPLAY_MODE>}
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/TemperatureDisplayMode/Reported { "value": <REPORTED_TEMPERATURE_DISPLAY_MODE>}

ThermostatUserInterfaceConfiguration/KeypadLockout Attribute

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/Reported
[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/Desired { "value": <DESIRED_KEYPAD_LOCKOUT>}
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/KeypadLockout/Reported { "value": <REPORTED_KEYPAD_LOCKOUT>}

ThermostatUserInterfaceConfiguration/ScheduleProgrammingVisibility Attribute

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/Reported
[PREFIX]/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/Desired { "value": <DESIRED_SCHEDULE_PROGRAMMING_VISIBILITY>}
ucl/by-unid/<UNID>/ep0/ThermostatUserInterfaceConfiguration/Attributes/ScheduleProgrammingVisibility/Reported { "value": <REPORTED_SCHEDULE_PROGRAMMING_VISIBILITY>}

ThermostatUserInterfaceConfiguration/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

ThermostatUserInterfaceConfiguration Command Support

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/SupportedCommands
[PREFIX]/ThermostatUserInterfaceConfiguration/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration 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 ThermostatUserInterfaceConfiguration cluster under the by-unid topic space:

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

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

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

ThermostatUserInterfaceConfiguration Commands

ThermostatUserInterfaceConfiguration/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ThermostatUserInterfaceConfiguration Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "TemperatureDisplayMode": {
      "type": "ThermostatUserInterfaceConfigurationTemperatureDisplayMode"
    },
    "KeypadLockout": {
      "type": "ThermostatUserInterfaceConfigurationKeypadLockout"
    },
    "ScheduleProgrammingVisibility": {
      "type": "ThermostatUserInterfaceConfigurationScheduleProgrammingVisibility"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ThermostatUserInterfaceConfiguration/Commands/WriteAttributes' -m  '{ "TemperatureDisplayMode": <TEMPERATURE_DISPLAY_MODE_VALUE> ,"KeypadLockout": <KEYPAD_LOCKOUT_VALUE> ,"ScheduleProgrammingVisibility": <SCHEDULE_PROGRAMMING_VISIBILITY_VALUE>  }'

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

ThermostatUserInterfaceConfiguration/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ThermostatUserInterfaceConfiguration/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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