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

IASZone Attributes

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

IASZone/ZoneState Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ZoneState/Reported

[PREFIX]/IASZone/Attributes/ZoneState/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/ZoneState/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneState/Desired { "value": <DESIRED_ZONE_STATE>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneState/Reported { "value": <REPORTED_ZONE_STATE>}

IASZone/ZoneType Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ZoneType/Reported

[PREFIX]/IASZone/Attributes/ZoneType/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/ZoneType/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneType/Desired { "value": <DESIRED_ZONE_TYPE>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneType/Reported { "value": <REPORTED_ZONE_TYPE>}

IASZone/ZoneStatus Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ZoneStatus/Reported

[PREFIX]/IASZone/Attributes/ZoneStatus/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/ZoneStatus/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneStatus/Desired { "value": <DESIRED_ZONE_STATUS>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneStatus/Reported { "value": <REPORTED_ZONE_STATUS>}

IASZone/IASCIEAddress Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/IASCIEAddress/Reported

[PREFIX]/IASZone/Attributes/IASCIEAddress/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/IASCIEAddress/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/IASCIEAddress/Desired { "value": <DESIRED_IASCIE_ADDRESS>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/IASCIEAddress/Reported { "value": <REPORTED_IASCIE_ADDRESS>}

IASZone/ZoneID Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ZoneID/Reported

[PREFIX]/IASZone/Attributes/ZoneID/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/ZoneID/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneID/Desired { "value": <DESIRED_ZONEID>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/ZoneID/Reported { "value": <REPORTED_ZONEID>}

IASZone/NumberOfZoneSensitivityLevelsSupported Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/Reported

[PREFIX]/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/Desired { "value": <DESIRED_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/NumberOfZoneSensitivityLevelsSupported/Reported { "value": <REPORTED_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED>}

IASZone/CurrentZoneSensitivityLevel Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/CurrentZoneSensitivityLevel/Reported

[PREFIX]/IASZone/Attributes/CurrentZoneSensitivityLevel/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IASZone/Attributes/CurrentZoneSensitivityLevel/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/CurrentZoneSensitivityLevel/Desired { "value": <DESIRED_CURRENT_ZONE_SENSITIVITY_LEVEL>}
ucl/by-unid/<UNID>/ep0/IASZone/Attributes/CurrentZoneSensitivityLevel/Reported { "value": <REPORTED_CURRENT_ZONE_SENSITIVITY_LEVEL>}

IASZone/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/IASZone/Attributes/ClusterRevision/Reported

[PREFIX]/IASZone/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

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

IASZone Command Support

MQTT Topic Pattern:

[PREFIX]/IASZone/SupportedCommands

[PREFIX]/IASZone/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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

IASZone Commands

IASZone/ZoneEnrollResponse Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/ZoneEnrollResponse

[PREFIX]/IASZone/GeneratedCommands/ZoneEnrollResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneEnrollResponse Command Properties",
  "type": "object",
  "properties": {
    "EnrollResponseCode": {
      "type": "ZoneEnrollResponseEnrollResponseCode"
    },
    "ZoneID": {
      "type": "integer"
    }
  },
  "required": [
    "EnrollResponseCode",
    "ZoneID"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/ZoneEnrollResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/ZoneEnrollResponse' -m '{ "EnrollResponseCode": <ENROLL_RESPONSE_CODE_VALUE>,"ZoneID": <ZONEID_VALUE> }'

To receive a IASZone/ZoneEnrollResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/ZoneEnrollResponse'

IASZone/ZoneStatusChangeNotification Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/ZoneStatusChangeNotification

[PREFIX]/IASZone/GeneratedCommands/ZoneStatusChangeNotification

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneStatusChangeNotification Command Properties",
  "type": "object",
  "properties": {
    "ZoneStatus": {
      "type": "IasZoneStatus"
    },
    "ExtendedStatus": {
      "type": "ZoneStatusChangeNotificationExtendedStatus"
    },
    "ZoneID": {
      "type": "integer"
    },
    "Delay": {
      "type": "integer"
    }
  },
  "required": [
    "ZoneStatus",
    "ExtendedStatus",
    "ZoneID",
    "Delay"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/ZoneStatusChangeNotification command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/ZoneStatusChangeNotification' -m '{ "ZoneStatus": <ZONE_STATUS_VALUE>,"ExtendedStatus": <EXTENDED_STATUS_VALUE>,"ZoneID": <ZONEID_VALUE>,"Delay": <DELAY_VALUE> }'

To receive a IASZone/ZoneStatusChangeNotification generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/ZoneStatusChangeNotification'

IASZone/InitiateNormalOperationMode Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/InitiateNormalOperationMode

[PREFIX]/IASZone/GeneratedCommands/InitiateNormalOperationMode

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a IASZone/InitiateNormalOperationMode command under the by-unid topic space:

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

To receive a IASZone/InitiateNormalOperationMode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/InitiateNormalOperationMode'

IASZone/ZoneEnrollRequest Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/ZoneEnrollRequest

[PREFIX]/IASZone/GeneratedCommands/ZoneEnrollRequest

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ZoneEnrollRequest Command Properties",
  "type": "object",
  "properties": {
    "ZoneType": {
      "type": "IasZoneType"
    },
    "ManufacturerCode": {
      "type": "integer"
    }
  },
  "required": [
    "ZoneType",
    "ManufacturerCode"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/ZoneEnrollRequest command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/ZoneEnrollRequest' -m '{ "ZoneType": <ZONE_TYPE_VALUE>,"ManufacturerCode": <MANUFACTURER_CODE_VALUE> }'

To receive a IASZone/ZoneEnrollRequest generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/ZoneEnrollRequest'

IASZone/InitiateTestMode Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/InitiateTestMode

[PREFIX]/IASZone/GeneratedCommands/InitiateTestMode

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster InitiateTestMode Command Properties",
  "type": "object",
  "properties": {
    "TestModeDuration": {
      "type": "integer"
    },
    "CurrentZoneSensitivityLevel": {
      "type": "integer"
    }
  },
  "required": [
    "TestModeDuration",
    "CurrentZoneSensitivityLevel"
  ]
}

Example Mosquitto CLI Tool Usage

To send a IASZone/InitiateTestMode command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/InitiateTestMode' -m '{ "TestModeDuration": <TEST_MODE_DURATION_VALUE>,"CurrentZoneSensitivityLevel": <CURRENT_ZONE_SENSITIVITY_LEVEL_VALUE> }'

To receive a IASZone/InitiateTestMode generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/GeneratedCommands/InitiateTestMode'

IASZone/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IASZone/Commands/WriteAttributes' -m '{ "IASCIEAddress": <IASCIE_ADDRESS_VALUE> ,"CurrentZoneSensitivityLevel": <CURRENT_ZONE_SENSITIVITY_LEVEL_VALUE> }'

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

IASZone/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/IASZone/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IASZone Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ZoneState",
          "ZoneType",
          "ZoneStatus",
          "IASCIEAddress",
          "ZoneID",
          "NumberOfZoneSensitivityLevelsSupported",
          "CurrentZoneSensitivityLevel"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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