DehumidificationControl Cluster

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

DehumidificationControl Attributes

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

DehumidificationControl/RelativeHumidity Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/RelativeHumidity/Reported
[PREFIX]/DehumidificationControl/Attributes/RelativeHumidity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/RelativeHumidity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidity/Desired { "value": <DESIRED_RELATIVE_HUMIDITY>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidity/Reported { "value": <REPORTED_RELATIVE_HUMIDITY>}

DehumidificationControl/DehumidificationCooling Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/DehumidificationCooling/Reported
[PREFIX]/DehumidificationControl/Attributes/DehumidificationCooling/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/DehumidificationCooling/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationCooling/Desired { "value": <DESIRED_DEHUMIDIFICATION_COOLING>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationCooling/Reported { "value": <REPORTED_DEHUMIDIFICATION_COOLING>}

DehumidificationControl/RHDehumidificationSetpoint Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/RHDehumidificationSetpoint/Reported
[PREFIX]/DehumidificationControl/Attributes/RHDehumidificationSetpoint/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/RHDehumidificationSetpoint/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RHDehumidificationSetpoint/Desired { "value": <DESIRED_RH_DEHUMIDIFICATION_SETPOINT>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RHDehumidificationSetpoint/Reported { "value": <REPORTED_RH_DEHUMIDIFICATION_SETPOINT>}

DehumidificationControl/RelativeHumidityMode Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/RelativeHumidityMode/Reported
[PREFIX]/DehumidificationControl/Attributes/RelativeHumidityMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/RelativeHumidityMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidityMode/Desired { "value": <DESIRED_RELATIVE_HUMIDITY_MODE>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidityMode/Reported { "value": <REPORTED_RELATIVE_HUMIDITY_MODE>}

DehumidificationControl/DehumidificationLockout Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/DehumidificationLockout/Reported
[PREFIX]/DehumidificationControl/Attributes/DehumidificationLockout/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/DehumidificationLockout/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationLockout/Desired { "value": <DESIRED_DEHUMIDIFICATION_LOCKOUT>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationLockout/Reported { "value": <REPORTED_DEHUMIDIFICATION_LOCKOUT>}

DehumidificationControl/DehumidificationHysteresis Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/DehumidificationHysteresis/Reported
[PREFIX]/DehumidificationControl/Attributes/DehumidificationHysteresis/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/DehumidificationHysteresis/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationHysteresis/Desired { "value": <DESIRED_DEHUMIDIFICATION_HYSTERESIS>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationHysteresis/Reported { "value": <REPORTED_DEHUMIDIFICATION_HYSTERESIS>}

DehumidificationControl/DehumidificationMaxCool Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/DehumidificationMaxCool/Reported
[PREFIX]/DehumidificationControl/Attributes/DehumidificationMaxCool/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/DehumidificationMaxCool/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationMaxCool/Desired { "value": <DESIRED_DEHUMIDIFICATION_MAX_COOL>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/DehumidificationMaxCool/Reported { "value": <REPORTED_DEHUMIDIFICATION_MAX_COOL>}

DehumidificationControl/RelativeHumidityDisplay Attribute

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Attributes/RelativeHumidityDisplay/Reported
[PREFIX]/DehumidificationControl/Attributes/RelativeHumidityDisplay/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DehumidificationControl/Attributes/RelativeHumidityDisplay/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidityDisplay/Desired { "value": <DESIRED_RELATIVE_HUMIDITY_DISPLAY>}
ucl/by-unid/<UNID>/ep0/DehumidificationControl/Attributes/RelativeHumidityDisplay/Reported { "value": <REPORTED_RELATIVE_HUMIDITY_DISPLAY>}

DehumidificationControl/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

DehumidificationControl Command Support

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/SupportedCommands
[PREFIX]/DehumidificationControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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

DehumidificationControl Commands

DehumidificationControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "RHDehumidificationSetpoint": {
      "type": "integer"
    },
    "RelativeHumidityMode": {
      "type": "DehumidificationControlRelativeHumidityMode"
    },
    "DehumidificationLockout": {
      "type": "DehumidificationControlDehumidificationLockout"
    },
    "DehumidificationHysteresis": {
      "type": "integer"
    },
    "DehumidificationMaxCool": {
      "type": "integer"
    },
    "RelativeHumidityDisplay": {
      "type": "DehumidificationControlRelativeHumidityDisplay"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DehumidificationControl/Commands/WriteAttributes' -m  '{ "RHDehumidificationSetpoint": <RH_DEHUMIDIFICATION_SETPOINT_VALUE> ,"RelativeHumidityMode": <RELATIVE_HUMIDITY_MODE_VALUE> ,"DehumidificationLockout": <DEHUMIDIFICATION_LOCKOUT_VALUE> ,"DehumidificationHysteresis": <DEHUMIDIFICATION_HYSTERESIS_VALUE> ,"DehumidificationMaxCool": <DEHUMIDIFICATION_MAX_COOL_VALUE> ,"RelativeHumidityDisplay": <RELATIVE_HUMIDITY_DISPLAY_VALUE>  }'

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

DehumidificationControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/DehumidificationControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DehumidificationControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "RelativeHumidity",
          "DehumidificationCooling",
          "RHDehumidificationSetpoint",
          "RelativeHumidityMode",
          "DehumidificationLockout",
          "DehumidificationHysteresis",
          "DehumidificationMaxCool",
          "RelativeHumidityDisplay"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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