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

UnifyHumidityControl Attributes

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

UnifyHumidityControl/ReportingMode Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/ReportingMode/Reported

[PREFIX]/UnifyHumidityControl/Attributes/ReportingMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/ReportingMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/ReportingMode/Desired { "value": <DESIRED_REPORTING_MODE>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/ReportingMode/Reported { "value": <REPORTED_REPORTING_MODE>}

UnifyHumidityControl/SupportedReportingMode Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/SupportedReportingMode/Reported

[PREFIX]/UnifyHumidityControl/Attributes/SupportedReportingMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/SupportedReportingMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/SupportedReportingMode/Desired { "value": <DESIRED_SUPPORTED_REPORTING_MODE>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/SupportedReportingMode/Reported { "value": <REPORTED_SUPPORTED_REPORTING_MODE>}

UnifyHumidityControl/CurrentState Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/CurrentState/Reported

[PREFIX]/UnifyHumidityControl/Attributes/CurrentState/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/CurrentState/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/CurrentState/Desired { "value": <DESIRED_CURRENT_STATE>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/CurrentState/Reported { "value": <REPORTED_CURRENT_STATE>}

UnifyHumidityControl/SupportedSetPoints Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/SupportedSetPoints/Reported

[PREFIX]/UnifyHumidityControl/Attributes/SupportedSetPoints/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/SupportedSetPoints/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/SupportedSetPoints/Desired { "value": <DESIRED_SUPPORTED_SET_POINTS>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/SupportedSetPoints/Reported { "value": <REPORTED_SUPPORTED_SET_POINTS>}

UnifyHumidityControl/HumidifierSetpointMin Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpointMin/Reported

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpointMin/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/HumidifierSetpointMin/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpointMin/Desired { "value": <DESIRED_HUMIDIFIER_SETPOINT_MIN>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpointMin/Reported { "value": <REPORTED_HUMIDIFIER_SETPOINT_MIN>}

UnifyHumidityControl/HumidifierSetpointMax Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpointMax/Reported

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpointMax/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/HumidifierSetpointMax/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpointMax/Desired { "value": <DESIRED_HUMIDIFIER_SETPOINT_MAX>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpointMax/Reported { "value": <REPORTED_HUMIDIFIER_SETPOINT_MAX>}

UnifyHumidityControl/HumidifierSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpoint/Reported

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpoint/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/HumidifierSetpoint/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpoint/Desired { "value": <DESIRED_HUMIDIFIER_SETPOINT>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpoint/Reported { "value": <REPORTED_HUMIDIFIER_SETPOINT>}

UnifyHumidityControl/HumidifierSetpointScale Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpointScale/Reported

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpointScale/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/HumidifierSetpointScale/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpointScale/Desired { "value": <DESIRED_HUMIDIFIER_SETPOINT_SCALE>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpointScale/Reported { "value": <REPORTED_HUMIDIFIER_SETPOINT_SCALE>}

UnifyHumidityControl/HumidifierSetpointPrecision Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpointPrecision/Reported

[PREFIX]/UnifyHumidityControl/Attributes/HumidifierSetpointPrecision/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/HumidifierSetpointPrecision/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpointPrecision/Desired { "value": <DESIRED_HUMIDIFIER_SETPOINT_PRECISION>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/HumidifierSetpointPrecision/Reported { "value": <REPORTED_HUMIDIFIER_SETPOINT_PRECISION>}

UnifyHumidityControl/DehumidifierSetpointMin Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpointMin/Reported

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpointMin/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/DehumidifierSetpointMin/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpointMin/Desired { "value": <DESIRED_DEHUMIDIFIER_SETPOINT_MIN>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpointMin/Reported { "value": <REPORTED_DEHUMIDIFIER_SETPOINT_MIN>}

UnifyHumidityControl/DehumidifierSetpointMax Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpointMax/Reported

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpointMax/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/DehumidifierSetpointMax/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpointMax/Desired { "value": <DESIRED_DEHUMIDIFIER_SETPOINT_MAX>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpointMax/Reported { "value": <REPORTED_DEHUMIDIFIER_SETPOINT_MAX>}

UnifyHumidityControl/DehumidifierSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpoint/Reported

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpoint/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/DehumidifierSetpoint/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpoint/Desired { "value": <DESIRED_DEHUMIDIFIER_SETPOINT>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpoint/Reported { "value": <REPORTED_DEHUMIDIFIER_SETPOINT>}

UnifyHumidityControl/DehumidifierSetpointScale Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpointScale/Reported

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpointScale/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/DehumidifierSetpointScale/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpointScale/Desired { "value": <DESIRED_DEHUMIDIFIER_SETPOINT_SCALE>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpointScale/Reported { "value": <REPORTED_DEHUMIDIFIER_SETPOINT_SCALE>}

UnifyHumidityControl/DehumidifierSetpointPrecision Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpointPrecision/Reported

[PREFIX]/UnifyHumidityControl/Attributes/DehumidifierSetpointPrecision/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/DehumidifierSetpointPrecision/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpointPrecision/Desired { "value": <DESIRED_DEHUMIDIFIER_SETPOINT_PRECISION>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/DehumidifierSetpointPrecision/Reported { "value": <REPORTED_DEHUMIDIFIER_SETPOINT_PRECISION>}

UnifyHumidityControl/AutoSetpointMin Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpointMin/Reported

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpointMin/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/AutoSetpointMin/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpointMin/Desired { "value": <DESIRED_AUTO_SETPOINT_MIN>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpointMin/Reported { "value": <REPORTED_AUTO_SETPOINT_MIN>}

UnifyHumidityControl/AutoSetpointMax Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpointMax/Reported

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpointMax/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/AutoSetpointMax/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpointMax/Desired { "value": <DESIRED_AUTO_SETPOINT_MAX>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpointMax/Reported { "value": <REPORTED_AUTO_SETPOINT_MAX>}

UnifyHumidityControl/AutoSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpoint/Reported

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpoint/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/AutoSetpoint/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpoint/Desired { "value": <DESIRED_AUTO_SETPOINT>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpoint/Reported { "value": <REPORTED_AUTO_SETPOINT>}

UnifyHumidityControl/AutoSetpointScale Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpointScale/Reported

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpointScale/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/AutoSetpointScale/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpointScale/Desired { "value": <DESIRED_AUTO_SETPOINT_SCALE>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpointScale/Reported { "value": <REPORTED_AUTO_SETPOINT_SCALE>}

UnifyHumidityControl/AutoSetpointPrecision Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpointPrecision/Reported

[PREFIX]/UnifyHumidityControl/Attributes/AutoSetpointPrecision/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/UnifyHumidityControl/Attributes/AutoSetpointPrecision/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpointPrecision/Desired { "value": <DESIRED_AUTO_SETPOINT_PRECISION>}
ucl/by-unid/<UNID>/ep0/UnifyHumidityControl/Attributes/AutoSetpointPrecision/Reported { "value": <REPORTED_AUTO_SETPOINT_PRECISION>}

UnifyHumidityControl/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Attributes/ClusterRevision/Reported

[PREFIX]/UnifyHumidityControl/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

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

UnifyHumidityControl Command Support

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/SupportedCommands

[PREFIX]/UnifyHumidityControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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

UnifyHumidityControl Commands

UnifyHumidityControl/ModeSet Command

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Commands/ModeSet

[PREFIX]/UnifyHumidityControl/GeneratedCommands/ModeSet

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a UnifyHumidityControl/ModeSet command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/UnifyHumidityControl/Commands/ModeSet' -m '{ "Mode": <MODE_VALUE> }'

To receive a UnifyHumidityControl/ModeSet generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyHumidityControl/GeneratedCommands/ModeSet'

UnifyHumidityControl/SetpointSet Command

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Commands/SetpointSet

[PREFIX]/UnifyHumidityControl/GeneratedCommands/SetpointSet

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UnifyHumidityControl Cluster SetpointSet Command Properties",
  "type": "object",
  "properties": {
    "Type": {
      "type": "SetpointType"
    },
    "Precision": {
      "type": "integer"
    },
    "Scale": {
      "type": "integer"
    },
    "Value": {
      "type": "integer"
    }
  },
  "required": [
    "Type",
    "Precision",
    "Scale",
    "Value"
  ]
}

Example Mosquitto CLI Tool Usage

To send a UnifyHumidityControl/SetpointSet command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/UnifyHumidityControl/Commands/SetpointSet' -m '{ "Type": <TYPE_VALUE>,"Precision": <PRECISION_VALUE>,"Scale": <SCALE_VALUE>,"Value": <VALUE_VALUE> }'

To receive a UnifyHumidityControl/SetpointSet generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/UnifyHumidityControl/GeneratedCommands/SetpointSet'

UnifyHumidityControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

UnifyHumidityControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/UnifyHumidityControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UnifyHumidityControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ReportingMode",
          "SupportedReportingMode",
          "CurrentState",
          "SupportedSetPoints",
          "HumidifierSetpointMin",
          "HumidifierSetpointMax",
          "HumidifierSetpoint",
          "HumidifierSetpointScale",
          "HumidifierSetpointPrecision",
          "DehumidifierSetpointMin",
          "DehumidifierSetpointMax",
          "DehumidifierSetpoint",
          "DehumidifierSetpointScale",
          "DehumidifierSetpointPrecision",
          "AutoSetpointMin",
          "AutoSetpointMax",
          "AutoSetpoint",
          "AutoSetpointScale",
          "AutoSetpointPrecision"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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