Basic Cluster

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

Basic Attributes

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

Basic/ZCLVersion Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ZCLVersion/Reported
[PREFIX]/Basic/Attributes/ZCLVersion/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ZCLVersion/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ZCLVersion/Desired { "value": <DESIRED_ZCL_VERSION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ZCLVersion/Reported { "value": <REPORTED_ZCL_VERSION>}

Basic/ApplicationVersion Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ApplicationVersion/Reported
[PREFIX]/Basic/Attributes/ApplicationVersion/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ApplicationVersion/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ApplicationVersion/Desired { "value": <DESIRED_APPLICATION_VERSION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ApplicationVersion/Reported { "value": <REPORTED_APPLICATION_VERSION>}

Basic/StackVersion Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/StackVersion/Reported
[PREFIX]/Basic/Attributes/StackVersion/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/StackVersion/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/StackVersion/Desired { "value": <DESIRED_STACK_VERSION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/StackVersion/Reported { "value": <REPORTED_STACK_VERSION>}

Basic/HWVersion Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/HWVersion/Reported
[PREFIX]/Basic/Attributes/HWVersion/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/HWVersion/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/HWVersion/Desired { "value": <DESIRED_HW_VERSION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/HWVersion/Reported { "value": <REPORTED_HW_VERSION>}

Basic/ManufacturerName Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ManufacturerName/Reported
[PREFIX]/Basic/Attributes/ManufacturerName/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ManufacturerName/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ManufacturerName/Desired { "value": <DESIRED_MANUFACTURER_NAME>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ManufacturerName/Reported { "value": <REPORTED_MANUFACTURER_NAME>}

Basic/ModelIdentifier Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ModelIdentifier/Reported
[PREFIX]/Basic/Attributes/ModelIdentifier/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ModelIdentifier/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ModelIdentifier/Desired { "value": <DESIRED_MODEL_IDENTIFIER>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ModelIdentifier/Reported { "value": <REPORTED_MODEL_IDENTIFIER>}

Basic/DateCode Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/DateCode/Reported
[PREFIX]/Basic/Attributes/DateCode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/DateCode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DateCode/Desired { "value": <DESIRED_DATE_CODE>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DateCode/Reported { "value": <REPORTED_DATE_CODE>}

Basic/PowerSource Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/PowerSource/Reported
[PREFIX]/Basic/Attributes/PowerSource/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/PowerSource/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/PowerSource/Desired { "value": <DESIRED_POWER_SOURCE>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/PowerSource/Reported { "value": <REPORTED_POWER_SOURCE>}

Basic/GenericDevice-Class Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/GenericDevice-Class/Reported
[PREFIX]/Basic/Attributes/GenericDevice-Class/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster GenericDevice-Class Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BasicGenericDevice-Class"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/GenericDevice-Class/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/GenericDevice-Class/Desired { "value": <DESIRED_GENERIC_DEVICE_CLASS>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/GenericDevice-Class/Reported { "value": <REPORTED_GENERIC_DEVICE_CLASS>}

Basic/GenericDevice-Type Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/GenericDevice-Type/Reported
[PREFIX]/Basic/Attributes/GenericDevice-Type/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster GenericDevice-Type Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "BasicGenericDevice-Type"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/GenericDevice-Type/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/GenericDevice-Type/Desired { "value": <DESIRED_GENERIC_DEVICE_TYPE>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/GenericDevice-Type/Reported { "value": <REPORTED_GENERIC_DEVICE_TYPE>}

Basic/ProductCode Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ProductCode/Reported
[PREFIX]/Basic/Attributes/ProductCode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ProductCode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductCode/Desired { "value": <DESIRED_PRODUCT_CODE>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductCode/Reported { "value": <REPORTED_PRODUCT_CODE>}

Basic/ProductURL Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ProductURL/Reported
[PREFIX]/Basic/Attributes/ProductURL/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ProductURL/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductURL/Desired { "value": <DESIRED_PRODUCTURL>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductURL/Reported { "value": <REPORTED_PRODUCTURL>}

Basic/ManufacturerVersionDetails Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ManufacturerVersionDetails/Reported
[PREFIX]/Basic/Attributes/ManufacturerVersionDetails/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ManufacturerVersionDetails/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ManufacturerVersionDetails/Desired { "value": <DESIRED_MANUFACTURER_VERSION_DETAILS>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ManufacturerVersionDetails/Reported { "value": <REPORTED_MANUFACTURER_VERSION_DETAILS>}

Basic/SerialNumber Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/SerialNumber/Reported
[PREFIX]/Basic/Attributes/SerialNumber/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/SerialNumber/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/SerialNumber/Desired { "value": <DESIRED_SERIAL_NUMBER>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/SerialNumber/Reported { "value": <REPORTED_SERIAL_NUMBER>}

Basic/ProductLabel Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/ProductLabel/Reported
[PREFIX]/Basic/Attributes/ProductLabel/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/ProductLabel/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductLabel/Desired { "value": <DESIRED_PRODUCT_LABEL>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/ProductLabel/Reported { "value": <REPORTED_PRODUCT_LABEL>}

Basic/LocationDescription Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/LocationDescription/Reported
[PREFIX]/Basic/Attributes/LocationDescription/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/LocationDescription/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/LocationDescription/Desired { "value": <DESIRED_LOCATION_DESCRIPTION>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/LocationDescription/Reported { "value": <REPORTED_LOCATION_DESCRIPTION>}

Basic/PhysicalEnvironment Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/PhysicalEnvironment/Reported
[PREFIX]/Basic/Attributes/PhysicalEnvironment/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/PhysicalEnvironment/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/PhysicalEnvironment/Desired { "value": <DESIRED_PHYSICAL_ENVIRONMENT>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/PhysicalEnvironment/Reported { "value": <REPORTED_PHYSICAL_ENVIRONMENT>}

Basic/DeviceEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/DeviceEnabled/Reported
[PREFIX]/Basic/Attributes/DeviceEnabled/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/DeviceEnabled/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DeviceEnabled/Desired { "value": <DESIRED_DEVICE_ENABLED>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DeviceEnabled/Reported { "value": <REPORTED_DEVICE_ENABLED>}

Basic/AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/AlarmMask/Reported
[PREFIX]/Basic/Attributes/AlarmMask/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/AlarmMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/AlarmMask/Desired { "value": <DESIRED_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/AlarmMask/Reported { "value": <REPORTED_ALARM_MASK>}

Basic/DisableLocalConfig Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/DisableLocalConfig/Reported
[PREFIX]/Basic/Attributes/DisableLocalConfig/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/DisableLocalConfig/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DisableLocalConfig/Desired { "value": <DESIRED_DISABLE_LOCAL_CONFIG>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/DisableLocalConfig/Reported { "value": <REPORTED_DISABLE_LOCAL_CONFIG>}

Basic/SWBuildID Attribute

MQTT Topic Pattern:

[PREFIX]/Basic/Attributes/SWBuildID/Reported
[PREFIX]/Basic/Attributes/SWBuildID/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Basic/Attributes/SWBuildID/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Basic/Attributes/SWBuildID/Desired { "value": <DESIRED_SW_BUILDID>}
ucl/by-unid/<UNID>/ep0/Basic/Attributes/SWBuildID/Reported { "value": <REPORTED_SW_BUILDID>}

Basic/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

Basic Command Support

MQTT Topic Pattern:

[PREFIX]/Basic/SupportedCommands
[PREFIX]/Basic/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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

Basic Commands

Basic/ResetToFactoryDefaults Command

MQTT Topic Pattern:

[PREFIX]/Basic/Commands/ResetToFactoryDefaults
[PREFIX]/Basic/GeneratedCommands/ResetToFactoryDefaults

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a Basic/ResetToFactoryDefaults command under the by-unid topic space:

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

To receive a Basic/ResetToFactoryDefaults generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Basic/GeneratedCommands/ResetToFactoryDefaults'

Basic/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Basic/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "LocationDescription": {
      "type": "string"
    },
    "PhysicalEnvironment": {
      "type": "BasicPhysicalEnvironment"
    },
    "DeviceEnabled": {
      "type": "boolean"
    },
    "AlarmMask": {
      "type": "BasicAlarmMask"
    },
    "DisableLocalConfig": {
      "type": "BasicDisableLocalConfig"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Basic/Commands/WriteAttributes' -m  '{ "LocationDescription": <LOCATION_DESCRIPTION_VALUE> ,"PhysicalEnvironment": <PHYSICAL_ENVIRONMENT_VALUE> ,"DeviceEnabled": <DEVICE_ENABLED_VALUE> ,"AlarmMask": <ALARM_MASK_VALUE> ,"DisableLocalConfig": <DISABLE_LOCAL_CONFIG_VALUE> , }'

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

Basic/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Basic/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ZCLVersion",
          "ApplicationVersion",
          "StackVersion",
          "HWVersion",
          "ManufacturerName",
          "ModelIdentifier",
          "DateCode",
          "PowerSource",
          "GenericDevice-Class",
          "GenericDevice-Type",
          "ProductCode",
          "ProductURL",
          "ManufacturerVersionDetails",
          "SerialNumber",
          "ProductLabel",
          "LocationDescription",
          "PhysicalEnvironment",
          "DeviceEnabled",
          "AlarmMask",
          "DisableLocalConfig",
          "SWBuildID"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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