Alarms Cluster

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

Alarms Attributes

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

Alarms/AlarmCount Attribute

MQTT Topic Pattern:

[PREFIX]/Alarms/Attributes/AlarmCount/Reported
[PREFIX]/Alarms/Attributes/AlarmCount/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Alarms/Attributes/AlarmCount/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Alarms/Attributes/AlarmCount/Desired { "value": <DESIRED_ALARM_COUNT>}
ucl/by-unid/<UNID>/ep0/Alarms/Attributes/AlarmCount/Reported { "value": <REPORTED_ALARM_COUNT>}

Alarms/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

Alarms Command Support

MQTT Topic Pattern:

[PREFIX]/Alarms/SupportedCommands
[PREFIX]/Alarms/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "ResetAlarm",
              "Alarm",
              "ResetAllAlarms",
              "GetAlarmResponse",
              "GetAlarm",
              "ResetAlarmLog",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/Alarms/SupportedCommands { "value": ["ResetAlarm","ResetAllAlarms","GetAlarm","ResetAlarmLog","WriteAttributes", "ForceReadAttributes"] }

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

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

Alarms Commands

Alarms/ResetAlarm Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/ResetAlarm
[PREFIX]/Alarms/GeneratedCommands/ResetAlarm

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster ResetAlarm Command Properties",
  "type": "object",
  "properties": {
    "AlarmCode": {
      "type": "ResetAlarmAlarmCode"
    },
    "ClusterIdentifier": {
      "type": "clusterId"
    }
  },
  "required": [
    "AlarmCode",
    "ClusterIdentifier"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/ResetAlarm command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/ResetAlarm' -m  '{ "AlarmCode": <ALARM_CODE_VALUE>,"ClusterIdentifier": <CLUSTER_IDENTIFIER_VALUE> }'

To receive a Alarms/ResetAlarm generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/ResetAlarm'

Alarms/Alarm Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/Alarm
[PREFIX]/Alarms/GeneratedCommands/Alarm

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster Alarm Command Properties",
  "type": "object",
  "properties": {
    "AlarmCode": {
      "type": "AlarmAlarmCode"
    },
    "ClusterIdentifier": {
      "type": "clusterId"
    }
  },
  "required": [
    "AlarmCode",
    "ClusterIdentifier"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/Alarm command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/Alarm' -m  '{ "AlarmCode": <ALARM_CODE_VALUE>,"ClusterIdentifier": <CLUSTER_IDENTIFIER_VALUE> }'

To receive a Alarms/Alarm generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/Alarm'

Alarms/ResetAllAlarms Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/ResetAllAlarms
[PREFIX]/Alarms/GeneratedCommands/ResetAllAlarms

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a Alarms/ResetAllAlarms command under the by-unid topic space:

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

To receive a Alarms/ResetAllAlarms generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/ResetAllAlarms'

Alarms/GetAlarmResponse Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/GetAlarmResponse
[PREFIX]/Alarms/GeneratedCommands/GetAlarmResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Alarms Cluster GetAlarmResponse Command Properties",
  "type": "object",
  "properties": {
    "Status": {
      "type": "zclStatus"
    },
    "AlarmCode": {
      "type": "GetAlarmResponseAlarmCode"
    },
    "ClusterIdentifier": {
      "type": "clusterId"
    },
    "TimeStamp": {
      "type": "integer"
    }
  },
  "required": [
    "Status",
    "AlarmCode",
    "ClusterIdentifier",
    "TimeStamp"
  ]
}

Example Mosquitto CLI Tool Usage

To send a Alarms/GetAlarmResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/Commands/GetAlarmResponse' -m  '{ "Status": <STATUS_VALUE>,"AlarmCode": <ALARM_CODE_VALUE>,"ClusterIdentifier": <CLUSTER_IDENTIFIER_VALUE>,"TimeStamp": <TIME_STAMP_VALUE> }'

To receive a Alarms/GetAlarmResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/GetAlarmResponse'

Alarms/GetAlarm Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/GetAlarm
[PREFIX]/Alarms/GeneratedCommands/GetAlarm

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a Alarms/GetAlarm command under the by-unid topic space:

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

To receive a Alarms/GetAlarm generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/GetAlarm'

Alarms/ResetAlarmLog Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/ResetAlarmLog
[PREFIX]/Alarms/GeneratedCommands/ResetAlarmLog

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a Alarms/ResetAlarmLog command under the by-unid topic space:

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

To receive a Alarms/ResetAlarmLog generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/Alarms/GeneratedCommands/ResetAlarmLog'

Alarms/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

Alarms/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Alarms/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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