@@ -53949,6 +53949,270 @@ mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Descriptor/Commands/ForceReadAttribute
5394953949<!-- END OF Descriptor Commands Section -->
5395053950<!-- -->
5395153951
53952+ <br><br><br>
53953+
53954+
53955+ <!-- -->
53956+ <!-- -->
53957+ <!-- NEW Page Cluster Support -->
53958+ <!-- -->
53959+ <!-- -->
53960+ \page unify_thermostat UnifyThermostat Cluster
53961+ The following commands and attributes are accepted as JSON payloads for the
53962+ UnifyThermostat cluster.
53963+
53964+ <br><br>
53965+
53966+ <!-- -->
53967+ <!-- START OF UnifyThermostat Attributes Section -->
53968+ <!-- -->
53969+ \section unify_thermostat_attrs UnifyThermostat Attributes
53970+ The following attribute topics are used to retrieve the UnifyThermostat cluster state.
53971+
53972+ <br>
53973+
53974+ \subsection unify_thermostat_attr_operating_state UnifyThermostat/OperatingState Attribute
53975+
53976+ **MQTT Topic Pattern:**
53977+
53978+ ```
53979+ [PREFIX]/UnifyThermostat/Attributes/OperatingState/Reported
53980+ [PREFIX]/UnifyThermostat/Attributes/OperatingState/Desired
53981+ ```
53982+
53983+ **MQTT Payload JSON Schema:**
53984+
53985+ ```json
53986+ {
53987+ "$schema": "http://json-schema.org/draft-07/schema#",
53988+ "title": "UnifyThermostat Cluster OperatingState Attribute Properties",
53989+ "type": "object",
53990+ "properties": {
53991+ "value": {
53992+ "type": "UnifyThermostatOperatingState"
53993+ }
53994+ },
53995+ "required": [
53996+ "value"
53997+ ]
53998+ }
53999+ ```
54000+
54001+
54002+ **Example Mosquitto CLI Tool Usage**
54003+
54004+ To see desired/reported value for OperatingState attribute under the by-unid topic space:
54005+
54006+ ```console
54007+ mosquitto_sub -t 'ucl/by-unid/+/+/UnifyThermostat/Attributes/OperatingState/+'
54008+
54009+ # Example output
54010+
54011+ ucl/by-unid/<UNID>/ep0/UnifyThermostat/Attributes/OperatingState/Desired { "value": <DESIRED_OPERATING_STATE>}
54012+ ucl/by-unid/<UNID>/ep0/UnifyThermostat/Attributes/OperatingState/Reported { "value": <REPORTED_OPERATING_STATE>}
54013+
54014+ ```
54015+
54016+ <br><br>
54017+
54018+
54019+ \subsection unify_thermostat_attr_cluster_revision UnifyThermostat/ClusterRevision Attribute
54020+
54021+ **MQTT Topic Pattern:**
54022+
54023+ ```
54024+ [PREFIX]/UnifyThermostat/Attributes/ClusterRevision/Reported
54025+ [PREFIX]/UnifyThermostat/Attributes/ClusterRevision/Desired
54026+ ```
54027+
54028+ **MQTT Payload JSON Schema:**
54029+
54030+ ```json
54031+ {
54032+ "$schema": "http://json-schema.org/draft-07/schema#",
54033+ "title": "UnifyThermostat Cluster ClusterRevision Attribute Properties",
54034+ "type": "object",
54035+ "properties": {
54036+ "value": {
54037+ "type": "integer"
54038+ }
54039+ },
54040+ "required": [
54041+ "value"
54042+ ]
54043+ }
54044+ ```
54045+
54046+ **Example Mosquitto CLI Tool Usage**
54047+
54048+ To see desired/reported value for ClusterRevision attribute under the by-unid topic space:
54049+
54050+ ```console
54051+ mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Attributes/ClusterRevision/+'
54052+ # Example output
54053+ ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
54054+ ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }
54055+ ```
54056+
54057+ <!-- -->
54058+ <!-- END OF UnifyThermostat Attributes Section -->
54059+ <!-- -->
54060+
54061+ <br><br>
54062+
54063+ <!-- -->
54064+ <!-- START OF UnifyThermostat Supported Commands Section -->
54065+ <!-- -->
54066+ \section unify_thermostat_recv_cmd_support UnifyThermostat Command Support
54067+
54068+ **MQTT Topic Pattern:**
54069+
54070+ ```
54071+ [PREFIX]/UnifyThermostat/SupportedCommands
54072+ [PREFIX]/UnifyThermostat/SupportedGeneratedCommands
54073+ ```
54074+
54075+ **MQTT Payload JSON Schema:**
54076+
54077+ ```json
54078+ {
54079+ "$schema": "http://json-schema.org/draft-07/schema#",
54080+ "title": "UnifyThermostat Command Support Properties",
54081+ "type": "object",
54082+ "properties": {
54083+ "value": {
54084+ "type": "array",
54085+ "items" : {
54086+ "type": "string",
54087+ "enum": [
54088+ ]
54089+ }
54090+ }
54091+ }
54092+ },
54093+ "required": [
54094+ "value"
54095+ ]
54096+ }
54097+ ```
54098+
54099+ **Example Mosquitto CLI Tool Usage**
54100+
54101+ To see supported commands for UnifyThermostat cluster under the by-unid topic space:
54102+
54103+ ```console
54104+ mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyThermostat/SupportedCommands'
54105+ # Example output
54106+ ucl/by-unid/<UNID>/<EP>/UnifyThermostat/SupportedCommands { "value": [] }
54107+ ```
54108+
54109+ To see supported generated commands for UnifyThermostat cluster under the by-unid topic space:
54110+
54111+ ```console
54112+ mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyThermostat/SupportedGeneratedCommands'
54113+ # Example output
54114+ ucl/by-unid/<UNID>/<EP>/UnifyThermostat/SupportedGeneratedCommands { "value": [] }
54115+ ```
54116+
54117+ <!-- -->
54118+ <!-- END OF UnifyThermostat Supported Commands Section -->
54119+ <!-- -->
54120+
54121+ <br><br>
54122+
54123+ <!-- -->
54124+ <!-- START OF UnifyThermostat Commands Section -->
54125+ <!-- -->
54126+ \section unify_thermostat_cmds UnifyThermostat Commands
54127+
54128+ <br><br>
54129+
54130+ \subsection unify_thermostat_write_attr_cmd UnifyThermostat/WriteAttributes Command
54131+
54132+ **MQTT Topic Pattern:**
54133+
54134+ ```
54135+ [PREFIX]/UnifyThermostat/Commands/WriteAttributes
54136+ ```
54137+
54138+ **MQTT Payload JSON Schema:**
54139+
54140+ ```json
54141+ {
54142+ "$schema": "http://json-schema.org/draft-07/schema#",
54143+ "title": "UnifyThermostat Cluster WriteAttributes Command Properties",
54144+ "type": "object",
54145+ "properties": {
54146+ },
54147+ "required": [
54148+ "value"
54149+ ]
54150+ }
54151+ ```
54152+
54153+ **Example Mosquitto CLI Tool Usage**
54154+
54155+ To update all UnifyThermostat attributes under the by-unid topic space:
54156+
54157+ ```console
54158+ mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Commands/WriteAttributes' -m '{ }'
54159+ ```
54160+
54161+ > NOTE: Specify only the list of attributes to write in this command.
54162+ > Unspecified attributes will not be updated.
54163+
54164+ <br><br>
54165+
54166+ \subsection unify_thermostat_force_read_attr_cmd UnifyThermostat/ForceReadAttributes Command
54167+
54168+ **MQTT Topic Pattern:**
54169+
54170+ ```
54171+ [PREFIX]/UnifyThermostat/Commands/ForceReadAttributes
54172+ ```
54173+
54174+ **MQTT Payload JSON Schema:**
54175+
54176+ ```json
54177+ {
54178+ "$schema": "http://json-schema.org/draft-07/schema#",
54179+ "title": "UnifyThermostat Cluster ForceReadAttributes Command Properties",
54180+ "type": "object",
54181+ "properties": {
54182+ "value": {
54183+ "type": "array"
54184+ "items": {
54185+ "type": "string",
54186+ "enum": [
54187+ "OperatingState"
54188+ ]
54189+ }
54190+ }
54191+ },
54192+ "required": [
54193+ "value"
54194+ ]
54195+ }
54196+ ```
54197+
54198+ **Example Mosquitto CLI Tool Usage**
54199+
54200+ To force read all UnifyThermostat attributes under the by-unid topic space (by sending an empty array):
54201+
54202+ ```console
54203+ mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Commands/ForceReadAttributes' -m '{ "value": [] }'
54204+ ```
54205+
54206+ To force read one of the UnifyThermostat attributes under the by-unid topic space:
54207+
54208+ ```console
54209+ mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/UnifyThermostat/Commands/ForceReadAttributes' -m '{ "value": ["OperatingState"] }'
54210+ ```
54211+
54212+ <!-- -->
54213+ <!-- END OF UnifyThermostat Commands Section -->
54214+ <!-- -->
54215+
5395254216
5395354217<br><br><br>
5395454218
@@ -57545,6 +57809,39 @@ mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Descriptor/Commands/ForceReadAttribute
5754557809
5754657810<br><br>
5754757811
57812+ <!-- -->
57813+ <!-- START OF Enum UnifyThermostatOperatingState Section -->
57814+ <!-- -->
57815+ \section enum_unify_thermostat_operating_state UnifyThermostatOperatingState Enum
57816+
57817+ ```json
57818+ {
57819+ "$schema": "http://json-schema.org/draft-07/schema#",
57820+ "title": "UnifyThermostatOperatingState Enum Properties",
57821+ "type": "string",
57822+ "enum": [
57823+ "Off",
57824+ "Heating",
57825+ "Cooling",
57826+ "FanOnly",
57827+ "PendingHeat",
57828+ "PendingCool",
57829+ "Vent/Economizer",
57830+ "AuxHeating",
57831+ "2ndStageHeating",
57832+ "2ndStageCooling",
57833+ "2ndStageAuxHeat",
57834+ "3rdStageAuxHeat"
57835+ ]
57836+ }
57837+ ```
57838+
57839+ <!-- -->
57840+ <!-- END OF Enum UnifyThermostatOperatingState Section -->
57841+ <!-- -->
57842+
57843+ <br><br>
57844+
5754857845<!-- -->
5754957846<!-- START OF Enum WindowCoveringWindowCoveringType Section -->
5755057847<!-- -->
0 commit comments