WindowCovering Cluster

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

WindowCovering Attributes

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

WindowCovering/WindowCoveringType Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/WindowCoveringType/Reported
[PREFIX]/WindowCovering/Attributes/WindowCoveringType/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/WindowCoveringType/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/WindowCoveringType/Desired { "value": <DESIRED_WINDOW_COVERING_TYPE>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/WindowCoveringType/Reported { "value": <REPORTED_WINDOW_COVERING_TYPE>}

WindowCovering/PhysicalClosedLimitLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/PhysicalClosedLimitLift/Reported
[PREFIX]/WindowCovering/Attributes/PhysicalClosedLimitLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/PhysicalClosedLimitLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/PhysicalClosedLimitLift/Desired { "value": <DESIRED_PHYSICAL_CLOSED_LIMIT_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/PhysicalClosedLimitLift/Reported { "value": <REPORTED_PHYSICAL_CLOSED_LIMIT_LIFT>}

WindowCovering/PhysicalClosedLimitTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/PhysicalClosedLimitTilt/Reported
[PREFIX]/WindowCovering/Attributes/PhysicalClosedLimitTilt/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/PhysicalClosedLimitTilt/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/PhysicalClosedLimitTilt/Desired { "value": <DESIRED_PHYSICAL_CLOSED_LIMIT_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/PhysicalClosedLimitTilt/Reported { "value": <REPORTED_PHYSICAL_CLOSED_LIMIT_TILT>}

WindowCovering/CurrentPositionLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/CurrentPositionLift/Reported
[PREFIX]/WindowCovering/Attributes/CurrentPositionLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/CurrentPositionLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionLift/Desired { "value": <DESIRED_CURRENT_POSITION_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionLift/Reported { "value": <REPORTED_CURRENT_POSITION_LIFT>}

WindowCovering/CurrentPositionTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/CurrentPositionTilt/Reported
[PREFIX]/WindowCovering/Attributes/CurrentPositionTilt/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/CurrentPositionTilt/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionTilt/Desired { "value": <DESIRED_CURRENT_POSITION_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionTilt/Reported { "value": <REPORTED_CURRENT_POSITION_TILT>}

WindowCovering/NumberOfActuationsLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/NumberOfActuationsLift/Reported
[PREFIX]/WindowCovering/Attributes/NumberOfActuationsLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/NumberOfActuationsLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/NumberOfActuationsLift/Desired { "value": <DESIRED_NUMBER_OF_ACTUATIONS_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/NumberOfActuationsLift/Reported { "value": <REPORTED_NUMBER_OF_ACTUATIONS_LIFT>}

WindowCovering/NumberOfActuationsTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/NumberOfActuationsTilt/Reported
[PREFIX]/WindowCovering/Attributes/NumberOfActuationsTilt/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/NumberOfActuationsTilt/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/NumberOfActuationsTilt/Desired { "value": <DESIRED_NUMBER_OF_ACTUATIONS_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/NumberOfActuationsTilt/Reported { "value": <REPORTED_NUMBER_OF_ACTUATIONS_TILT>}

WindowCovering/ConfigOrStatus Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/ConfigOrStatus/Reported
[PREFIX]/WindowCovering/Attributes/ConfigOrStatus/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/ConfigOrStatus/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/ConfigOrStatus/Desired { "value": <DESIRED_CONFIG_OR_STATUS>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/ConfigOrStatus/Reported { "value": <REPORTED_CONFIG_OR_STATUS>}

WindowCovering/CurrentPositionLiftPercentage Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/CurrentPositionLiftPercentage/Reported
[PREFIX]/WindowCovering/Attributes/CurrentPositionLiftPercentage/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/CurrentPositionLiftPercentage/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionLiftPercentage/Desired { "value": <DESIRED_CURRENT_POSITION_LIFT_PERCENTAGE>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionLiftPercentage/Reported { "value": <REPORTED_CURRENT_POSITION_LIFT_PERCENTAGE>}

WindowCovering/CurrentPositionTiltPercentage Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/CurrentPositionTiltPercentage/Reported
[PREFIX]/WindowCovering/Attributes/CurrentPositionTiltPercentage/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/CurrentPositionTiltPercentage/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionTiltPercentage/Desired { "value": <DESIRED_CURRENT_POSITION_TILT_PERCENTAGE>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/CurrentPositionTiltPercentage/Reported { "value": <REPORTED_CURRENT_POSITION_TILT_PERCENTAGE>}

WindowCovering/InstalledOpenLimitLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/InstalledOpenLimitLift/Reported
[PREFIX]/WindowCovering/Attributes/InstalledOpenLimitLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/InstalledOpenLimitLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledOpenLimitLift/Desired { "value": <DESIRED_INSTALLED_OPEN_LIMIT_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledOpenLimitLift/Reported { "value": <REPORTED_INSTALLED_OPEN_LIMIT_LIFT>}

WindowCovering/InstalledClosedLimitLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/InstalledClosedLimitLift/Reported
[PREFIX]/WindowCovering/Attributes/InstalledClosedLimitLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/InstalledClosedLimitLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledClosedLimitLift/Desired { "value": <DESIRED_INSTALLED_CLOSED_LIMIT_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledClosedLimitLift/Reported { "value": <REPORTED_INSTALLED_CLOSED_LIMIT_LIFT>}

WindowCovering/InstalledOpenLimitTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/InstalledOpenLimitTilt/Reported
[PREFIX]/WindowCovering/Attributes/InstalledOpenLimitTilt/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/InstalledOpenLimitTilt/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledOpenLimitTilt/Desired { "value": <DESIRED_INSTALLED_OPEN_LIMIT_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledOpenLimitTilt/Reported { "value": <REPORTED_INSTALLED_OPEN_LIMIT_TILT>}

WindowCovering/InstalledClosedLimitTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/InstalledClosedLimitTilt/Reported
[PREFIX]/WindowCovering/Attributes/InstalledClosedLimitTilt/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/InstalledClosedLimitTilt/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledClosedLimitTilt/Desired { "value": <DESIRED_INSTALLED_CLOSED_LIMIT_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/InstalledClosedLimitTilt/Reported { "value": <REPORTED_INSTALLED_CLOSED_LIMIT_TILT>}

WindowCovering/VelocityLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/VelocityLift/Reported
[PREFIX]/WindowCovering/Attributes/VelocityLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/VelocityLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/VelocityLift/Desired { "value": <DESIRED_VELOCITY_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/VelocityLift/Reported { "value": <REPORTED_VELOCITY_LIFT>}

WindowCovering/AccelerationTimeLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/AccelerationTimeLift/Reported
[PREFIX]/WindowCovering/Attributes/AccelerationTimeLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/AccelerationTimeLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/AccelerationTimeLift/Desired { "value": <DESIRED_ACCELERATION_TIME_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/AccelerationTimeLift/Reported { "value": <REPORTED_ACCELERATION_TIME_LIFT>}

WindowCovering/DecelerationTimeLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/DecelerationTimeLift/Reported
[PREFIX]/WindowCovering/Attributes/DecelerationTimeLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/DecelerationTimeLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/DecelerationTimeLift/Desired { "value": <DESIRED_DECELERATION_TIME_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/DecelerationTimeLift/Reported { "value": <REPORTED_DECELERATION_TIME_LIFT>}

WindowCovering/Mode Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster Mode Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "WindowCoveringMode"
    }
  },
  "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/+/+/WindowCovering/Attributes/Mode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/Mode/Desired { "value": <DESIRED_MODE>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/Mode/Reported { "value": <REPORTED_MODE>}

WindowCovering/IntermediateSetpointsLift Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/IntermediateSetpointsLift/Reported
[PREFIX]/WindowCovering/Attributes/IntermediateSetpointsLift/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/IntermediateSetpointsLift/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/IntermediateSetpointsLift/Desired { "value": <DESIRED_INTERMEDIATE_SETPOINTS_LIFT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/IntermediateSetpointsLift/Reported { "value": <REPORTED_INTERMEDIATE_SETPOINTS_LIFT>}

WindowCovering/IntermediateSetpointsTilt Attribute

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Attributes/IntermediateSetpointsTilt/Reported
[PREFIX]/WindowCovering/Attributes/IntermediateSetpointsTilt/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/WindowCovering/Attributes/IntermediateSetpointsTilt/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/IntermediateSetpointsTilt/Desired { "value": <DESIRED_INTERMEDIATE_SETPOINTS_TILT>}
ucl/by-unid/<UNID>/ep0/WindowCovering/Attributes/IntermediateSetpointsTilt/Reported { "value": <REPORTED_INTERMEDIATE_SETPOINTS_TILT>}

WindowCovering/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

WindowCovering Command Support

MQTT Topic Pattern:

[PREFIX]/WindowCovering/SupportedCommands
[PREFIX]/WindowCovering/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "UpOrOpen",
              "DownOrClose",
              "Stop",
              "GoToLiftValue",
              "GoToLiftPercentage",
              "GoToTiltValue",
              "GoToTiltPercentage",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/WindowCovering/SupportedCommands { "value": ["UpOrOpen","DownOrClose","Stop","GoToLiftValue","GoToLiftPercentage","GoToTiltValue","GoToTiltPercentage","WriteAttributes", "ForceReadAttributes"] }

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

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

WindowCovering Commands

WindowCovering/UpOrOpen Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/UpOrOpen
[PREFIX]/WindowCovering/GeneratedCommands/UpOrOpen

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a WindowCovering/UpOrOpen command under the by-unid topic space:

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

To receive a WindowCovering/UpOrOpen generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/UpOrOpen'

WindowCovering/DownOrClose Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/DownOrClose
[PREFIX]/WindowCovering/GeneratedCommands/DownOrClose

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a WindowCovering/DownOrClose command under the by-unid topic space:

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

To receive a WindowCovering/DownOrClose generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/DownOrClose'

WindowCovering/Stop Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/Stop
[PREFIX]/WindowCovering/GeneratedCommands/Stop

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a WindowCovering/Stop command under the by-unid topic space:

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

To receive a WindowCovering/Stop generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/Stop'

WindowCovering/GoToLiftValue Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/GoToLiftValue
[PREFIX]/WindowCovering/GeneratedCommands/GoToLiftValue

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a WindowCovering/GoToLiftValue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/GoToLiftValue' -m  '{ "LiftValue": <LIFT_VALUE_VALUE> }'

To receive a WindowCovering/GoToLiftValue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/GoToLiftValue'

WindowCovering/GoToLiftPercentage Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/GoToLiftPercentage
[PREFIX]/WindowCovering/GeneratedCommands/GoToLiftPercentage

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a WindowCovering/GoToLiftPercentage command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/GoToLiftPercentage' -m  '{ "PercentageLiftValue": <PERCENTAGE_LIFT_VALUE_VALUE> }'

To receive a WindowCovering/GoToLiftPercentage generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/GoToLiftPercentage'

WindowCovering/GoToTiltValue Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/GoToTiltValue
[PREFIX]/WindowCovering/GeneratedCommands/GoToTiltValue

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a WindowCovering/GoToTiltValue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/GoToTiltValue' -m  '{ "TiltValue": <TILT_VALUE_VALUE> }'

To receive a WindowCovering/GoToTiltValue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/GoToTiltValue'

WindowCovering/GoToTiltPercentage Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/GoToTiltPercentage
[PREFIX]/WindowCovering/GeneratedCommands/GoToTiltPercentage

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a WindowCovering/GoToTiltPercentage command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/GoToTiltPercentage' -m  '{ "PercentageTiltValue": <PERCENTAGE_TILT_VALUE_VALUE> }'

To receive a WindowCovering/GoToTiltPercentage generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/GeneratedCommands/GoToTiltPercentage'

WindowCovering/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "VelocityLift": {
      "type": "integer"
    },
    "AccelerationTimeLift": {
      "type": "integer"
    },
    "DecelerationTimeLift": {
      "type": "integer"
    },
    "Mode": {
      "type": "WindowCoveringMode"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/WindowCovering/Commands/WriteAttributes' -m  '{ "VelocityLift": <VELOCITY_LIFT_VALUE> ,"AccelerationTimeLift": <ACCELERATION_TIME_LIFT_VALUE> ,"DecelerationTimeLift": <DECELERATION_TIME_LIFT_VALUE> ,"Mode": <MODE_VALUE> , }'

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

WindowCovering/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/WindowCovering/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WindowCovering Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "WindowCoveringType",
          "PhysicalClosedLimitLift",
          "PhysicalClosedLimitTilt",
          "CurrentPositionLift",
          "CurrentPositionTilt",
          "NumberOfActuationsLift",
          "NumberOfActuationsTilt",
          "ConfigOrStatus",
          "CurrentPositionLiftPercentage",
          "CurrentPositionTiltPercentage",
          "InstalledOpenLimitLift",
          "InstalledClosedLimitLift",
          "InstalledOpenLimitTilt",
          "InstalledClosedLimitTilt",
          "VelocityLift",
          "AccelerationTimeLift",
          "DecelerationTimeLift",
          "Mode",
          "IntermediateSetpointsLift",
          "IntermediateSetpointsTilt"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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