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

ConfigurationParameters Attributes

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

ConfigurationParameters/ConfigurationParameters Attribute

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Attributes/ConfigurationParameters/Reported

[PREFIX]/ConfigurationParameters/Attributes/ConfigurationParameters/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster ConfigurationParameters Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "ConfigurationParameter"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ConfigurationParameters/Attributes/ConfigurationParameters/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ConfigurationParameters/Attributes/ConfigurationParameters/Desired { "value": [<DESIRED_CONFIGURATION_PARAMETERS>,<DESIRED_CONFIGURATION_PARAMETERS>]}
ucl/by-unid/<UNID>/ep0/ConfigurationParameters/Attributes/ConfigurationParameters/Reported { "value": [<REPORTED_CONFIGURATION_PARAMETERS>,<REPORTED_CONFIGURATION_PARAMETERS>]}

ConfigurationParameters/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Attributes/ClusterRevision/Reported

[PREFIX]/ConfigurationParameters/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

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

ConfigurationParameters Command Support

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/SupportedCommands

[PREFIX]/ConfigurationParameters/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/SupportedCommands { "value": ["DiscoverParameter","DefaultResetAllParameters","SetParameter","DiscoverParameterRange","WriteAttributes", "ForceReadAttributes"] }

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

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

ConfigurationParameters Commands

ConfigurationParameters/DiscoverParameter Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/DiscoverParameter

[PREFIX]/ConfigurationParameters/GeneratedCommands/DiscoverParameter

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a ConfigurationParameters/DiscoverParameter command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/DiscoverParameter' -m '{ "ParameterId": <PARAMETER_ID_VALUE> }'

To receive a ConfigurationParameters/DiscoverParameter generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/GeneratedCommands/DiscoverParameter'

ConfigurationParameters/DefaultResetAllParameters Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/DefaultResetAllParameters

[PREFIX]/ConfigurationParameters/GeneratedCommands/DefaultResetAllParameters

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a ConfigurationParameters/DefaultResetAllParameters command under the by-unid topic space:

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

To receive a ConfigurationParameters/DefaultResetAllParameters generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/GeneratedCommands/DefaultResetAllParameters'

ConfigurationParameters/SetParameter Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/SetParameter

[PREFIX]/ConfigurationParameters/GeneratedCommands/SetParameter

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster SetParameter Command Properties",
  "type": "object",
  "properties": {
    "ParameterId": {
      "type": "integer"
    },
    "Value": {
      "type": "integer"
    }
  },
  "required": [
    "ParameterId",
    "Value"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ConfigurationParameters/SetParameter command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/SetParameter' -m '{ "ParameterId": <PARAMETER_ID_VALUE>,"Value": <VALUE_VALUE> }'

To receive a ConfigurationParameters/SetParameter generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/GeneratedCommands/SetParameter'

ConfigurationParameters/DiscoverParameterRange Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/DiscoverParameterRange

[PREFIX]/ConfigurationParameters/GeneratedCommands/DiscoverParameterRange

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ConfigurationParameters Cluster DiscoverParameterRange Command Properties",
  "type": "object",
  "properties": {
    "FirstParameterId": {
      "type": "integer"
    },
    "LastParameterId": {
      "type": "integer"
    }
  },
  "required": [
    "FirstParameterId",
    "LastParameterId"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ConfigurationParameters/DiscoverParameterRange command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/Commands/DiscoverParameterRange' -m '{ "FirstParameterId": <FIRST_PARAMETER_ID_VALUE>,"LastParameterId": <LAST_PARAMETER_ID_VALUE> }'

To receive a ConfigurationParameters/DiscoverParameterRange generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ConfigurationParameters/GeneratedCommands/DiscoverParameterRange'

ConfigurationParameters/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

ConfigurationParameters/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ConfigurationParameters/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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