UnifyFanControl Cluster

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

UnifyFanControl Attributes

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

UnifyFanControl/ZWaveFanMode Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyFanControl/Attributes/ZWaveFanMode/Reported
[PREFIX]/UnifyFanControl/Attributes/ZWaveFanMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyFanControl/Attributes/ZWaveFanMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyFanControl/Attributes/ZWaveFanMode/Desired { "value": <DESIRED_Z_WAVE_FAN_MODE>}
ucl/by-unid/<UNID>/ep0/UnifyFanControl/Attributes/ZWaveFanMode/Reported { "value": <REPORTED_Z_WAVE_FAN_MODE>}

UnifyFanControl/ZWaveSupportedFanMode Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyFanControl/Attributes/ZWaveSupportedFanMode/Reported
[PREFIX]/UnifyFanControl/Attributes/ZWaveSupportedFanMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyFanControl/Attributes/ZWaveSupportedFanMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyFanControl/Attributes/ZWaveSupportedFanMode/Desired { "value": <DESIRED_Z_WAVE_SUPPORTED_FAN_MODE>}
ucl/by-unid/<UNID>/ep0/UnifyFanControl/Attributes/ZWaveSupportedFanMode/Reported { "value": <REPORTED_Z_WAVE_SUPPORTED_FAN_MODE>}

UnifyFanControl/ZWaveFanState Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyFanControl/Attributes/ZWaveFanState/Reported
[PREFIX]/UnifyFanControl/Attributes/ZWaveFanState/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyFanControl/Attributes/ZWaveFanState/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyFanControl/Attributes/ZWaveFanState/Desired { "value": <DESIRED_Z_WAVE_FAN_STATE>}
ucl/by-unid/<UNID>/ep0/UnifyFanControl/Attributes/ZWaveFanState/Reported { "value": <REPORTED_Z_WAVE_FAN_STATE>}

UnifyFanControl/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

UnifyFanControl Command Support

MQTT Topic Pattern:

[PREFIX]/UnifyFanControl/SupportedCommands
[PREFIX]/UnifyFanControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyFanControl/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/UnifyFanControl/SupportedCommands { "value": ["SetFanMode","TurnOff","WriteAttributes", "ForceReadAttributes"] }

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

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

UnifyFanControl Commands

UnifyFanControl/SetFanMode Command

MQTT Topic Pattern:

[PREFIX]/UnifyFanControl/Commands/SetFanMode
[PREFIX]/UnifyFanControl/GeneratedCommands/SetFanMode

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a UnifyFanControl/SetFanMode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/UnifyFanControl/Commands/SetFanMode' -m  '{ "FanMode": <FAN_MODE_VALUE> }'

To receive a UnifyFanControl/SetFanMode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyFanControl/GeneratedCommands/SetFanMode'

UnifyFanControl/TurnOff Command

MQTT Topic Pattern:

[PREFIX]/UnifyFanControl/Commands/TurnOff
[PREFIX]/UnifyFanControl/GeneratedCommands/TurnOff

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a UnifyFanControl/TurnOff command under the by-unid topic space:

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

To receive a UnifyFanControl/TurnOff generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyFanControl/GeneratedCommands/TurnOff'

UnifyFanControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/UnifyFanControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/UnifyFanControl/Commands/WriteAttributes' -m  '{ "ZWaveFanMode": <Z_WAVE_FAN_MODE_VALUE> , }'

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

UnifyFanControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/UnifyFanControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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