ShadeConfiguration Cluster

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

ShadeConfiguration Attributes

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

ShadeConfiguration/PhysicalClosedLimit Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/PhysicalClosedLimit/Reported
[PREFIX]/ShadeConfiguration/Attributes/PhysicalClosedLimit/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/PhysicalClosedLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/PhysicalClosedLimit/Desired { "value": <DESIRED_PHYSICAL_CLOSED_LIMIT>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/PhysicalClosedLimit/Reported { "value": <REPORTED_PHYSICAL_CLOSED_LIMIT>}

ShadeConfiguration/MotorStepSize Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/MotorStepSize/Reported
[PREFIX]/ShadeConfiguration/Attributes/MotorStepSize/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/MotorStepSize/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/MotorStepSize/Desired { "value": <DESIRED_MOTOR_STEP_SIZE>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/MotorStepSize/Reported { "value": <REPORTED_MOTOR_STEP_SIZE>}

ShadeConfiguration/Status Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/Status/Reported
[PREFIX]/ShadeConfiguration/Attributes/Status/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/Status/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/Status/Desired { "value": <DESIRED_STATUS>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/Status/Reported { "value": <REPORTED_STATUS>}

ShadeConfiguration/ClosedLimit Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/ClosedLimit/Reported
[PREFIX]/ShadeConfiguration/Attributes/ClosedLimit/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/ClosedLimit/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/ClosedLimit/Desired { "value": <DESIRED_CLOSED_LIMIT>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/ClosedLimit/Reported { "value": <REPORTED_CLOSED_LIMIT>}

ShadeConfiguration/Mode Attribute

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Attributes/Mode/Reported
[PREFIX]/ShadeConfiguration/Attributes/Mode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ShadeConfiguration/Attributes/Mode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/Mode/Desired { "value": <DESIRED_MODE>}
ucl/by-unid/<UNID>/ep0/ShadeConfiguration/Attributes/Mode/Reported { "value": <REPORTED_MODE>}

ShadeConfiguration/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

ShadeConfiguration Command Support

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/SupportedCommands
[PREFIX]/ShadeConfiguration/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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

ShadeConfiguration Commands

ShadeConfiguration/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "ShadeConfigurationStatus"
    },
    "ClosedLimit": {
      "type": "integer"
    },
    "Mode": {
      "type": "ShadeConfigurationMode"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ShadeConfiguration/Commands/WriteAttributes' -m  '{ "Status": <STATUS_VALUE> ,"ClosedLimit": <CLOSED_LIMIT_VALUE> ,"Mode": <MODE_VALUE>  }'

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

ShadeConfiguration/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ShadeConfiguration/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ShadeConfiguration Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "PhysicalClosedLimit",
          "MotorStepSize",
          "Status",
          "ClosedLimit",
          "Mode"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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