Diagnostics Cluster

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

Diagnostics Attributes

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

Diagnostics/NumberOfResets Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NumberOfResets/Reported
[PREFIX]/Diagnostics/Attributes/NumberOfResets/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NumberOfResets/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NumberOfResets/Desired { "value": <DESIRED_NUMBER_OF_RESETS>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NumberOfResets/Reported { "value": <REPORTED_NUMBER_OF_RESETS>}

Diagnostics/PersistentMemoryWrites Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/PersistentMemoryWrites/Reported
[PREFIX]/Diagnostics/Attributes/PersistentMemoryWrites/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/PersistentMemoryWrites/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PersistentMemoryWrites/Desired { "value": <DESIRED_PERSISTENT_MEMORY_WRITES>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PersistentMemoryWrites/Reported { "value": <REPORTED_PERSISTENT_MEMORY_WRITES>}

Diagnostics/MacRxBcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacRxBcast/Reported
[PREFIX]/Diagnostics/Attributes/MacRxBcast/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacRxBcast/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacRxBcast/Desired { "value": <DESIRED_MAC_RX_BCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacRxBcast/Reported { "value": <REPORTED_MAC_RX_BCAST>}

Diagnostics/MacTxBcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacTxBcast/Reported
[PREFIX]/Diagnostics/Attributes/MacTxBcast/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacTxBcast/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxBcast/Desired { "value": <DESIRED_MAC_TX_BCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxBcast/Reported { "value": <REPORTED_MAC_TX_BCAST>}

Diagnostics/MacRxUcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacRxUcast/Reported
[PREFIX]/Diagnostics/Attributes/MacRxUcast/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacRxUcast/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacRxUcast/Desired { "value": <DESIRED_MAC_RX_UCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacRxUcast/Reported { "value": <REPORTED_MAC_RX_UCAST>}

Diagnostics/MacTxUcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacTxUcast/Reported
[PREFIX]/Diagnostics/Attributes/MacTxUcast/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacTxUcast/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcast/Desired { "value": <DESIRED_MAC_TX_UCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcast/Reported { "value": <REPORTED_MAC_TX_UCAST>}

Diagnostics/MacTxUcastRetry Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacTxUcastRetry/Reported
[PREFIX]/Diagnostics/Attributes/MacTxUcastRetry/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacTxUcastRetry/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcastRetry/Desired { "value": <DESIRED_MAC_TX_UCAST_RETRY>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcastRetry/Reported { "value": <REPORTED_MAC_TX_UCAST_RETRY>}

Diagnostics/MacTxUcastFail Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/MacTxUcastFail/Reported
[PREFIX]/Diagnostics/Attributes/MacTxUcastFail/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/MacTxUcastFail/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcastFail/Desired { "value": <DESIRED_MAC_TX_UCAST_FAIL>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/MacTxUcastFail/Reported { "value": <REPORTED_MAC_TX_UCAST_FAIL>}

Diagnostics/APSRxBcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSRxBcast/Reported
[PREFIX]/Diagnostics/Attributes/APSRxBcast/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSRxBcast/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSRxBcast/Desired { "value": <DESIRED_APS_RX_BCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSRxBcast/Reported { "value": <REPORTED_APS_RX_BCAST>}

Diagnostics/APSTxBcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSTxBcast/Reported
[PREFIX]/Diagnostics/Attributes/APSTxBcast/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSTxBcast/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxBcast/Desired { "value": <DESIRED_APS_TX_BCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxBcast/Reported { "value": <REPORTED_APS_TX_BCAST>}

Diagnostics/APSRxUcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSRxUcast/Reported
[PREFIX]/Diagnostics/Attributes/APSRxUcast/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSRxUcast/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSRxUcast/Desired { "value": <DESIRED_APS_RX_UCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSRxUcast/Reported { "value": <REPORTED_APS_RX_UCAST>}

Diagnostics/APSTxUcastSuccess Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSTxUcastSuccess/Reported
[PREFIX]/Diagnostics/Attributes/APSTxUcastSuccess/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSTxUcastSuccess/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastSuccess/Desired { "value": <DESIRED_APS_TX_UCAST_SUCCESS>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastSuccess/Reported { "value": <REPORTED_APS_TX_UCAST_SUCCESS>}

Diagnostics/APSTxUcastRetry Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSTxUcastRetry/Reported
[PREFIX]/Diagnostics/Attributes/APSTxUcastRetry/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSTxUcastRetry/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastRetry/Desired { "value": <DESIRED_APS_TX_UCAST_RETRY>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastRetry/Reported { "value": <REPORTED_APS_TX_UCAST_RETRY>}

Diagnostics/APSTxUcastFail Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSTxUcastFail/Reported
[PREFIX]/Diagnostics/Attributes/APSTxUcastFail/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSTxUcastFail/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastFail/Desired { "value": <DESIRED_APS_TX_UCAST_FAIL>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSTxUcastFail/Reported { "value": <REPORTED_APS_TX_UCAST_FAIL>}

Diagnostics/RouteDiscInitiated Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/RouteDiscInitiated/Reported
[PREFIX]/Diagnostics/Attributes/RouteDiscInitiated/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/RouteDiscInitiated/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/RouteDiscInitiated/Desired { "value": <DESIRED_ROUTE_DISC_INITIATED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/RouteDiscInitiated/Reported { "value": <REPORTED_ROUTE_DISC_INITIATED>}

Diagnostics/NeighborAdded Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NeighborAdded/Reported
[PREFIX]/Diagnostics/Attributes/NeighborAdded/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NeighborAdded/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborAdded/Desired { "value": <DESIRED_NEIGHBOR_ADDED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborAdded/Reported { "value": <REPORTED_NEIGHBOR_ADDED>}

Diagnostics/NeighborRemoved Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NeighborRemoved/Reported
[PREFIX]/Diagnostics/Attributes/NeighborRemoved/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NeighborRemoved/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborRemoved/Desired { "value": <DESIRED_NEIGHBOR_REMOVED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborRemoved/Reported { "value": <REPORTED_NEIGHBOR_REMOVED>}

Diagnostics/NeighborStale Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NeighborStale/Reported
[PREFIX]/Diagnostics/Attributes/NeighborStale/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NeighborStale/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborStale/Desired { "value": <DESIRED_NEIGHBOR_STALE>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NeighborStale/Reported { "value": <REPORTED_NEIGHBOR_STALE>}

Diagnostics/JoinIndication Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/JoinIndication/Reported
[PREFIX]/Diagnostics/Attributes/JoinIndication/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/JoinIndication/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/JoinIndication/Desired { "value": <DESIRED_JOIN_INDICATION>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/JoinIndication/Reported { "value": <REPORTED_JOIN_INDICATION>}

Diagnostics/ChildMoved Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/ChildMoved/Reported
[PREFIX]/Diagnostics/Attributes/ChildMoved/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/ChildMoved/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/ChildMoved/Desired { "value": <DESIRED_CHILD_MOVED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/ChildMoved/Reported { "value": <REPORTED_CHILD_MOVED>}

Diagnostics/NWKFCFailure Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NWKFCFailure/Reported
[PREFIX]/Diagnostics/Attributes/NWKFCFailure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NWKFCFailure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NWKFCFailure/Desired { "value": <DESIRED_NWKFC_FAILURE>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NWKFCFailure/Reported { "value": <REPORTED_NWKFC_FAILURE>}

Diagnostics/APSFCFailure Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSFCFailure/Reported
[PREFIX]/Diagnostics/Attributes/APSFCFailure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSFCFailure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSFCFailure/Desired { "value": <DESIRED_APSFC_FAILURE>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSFCFailure/Reported { "value": <REPORTED_APSFC_FAILURE>}

Diagnostics/APSUnauthorizedKey Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSUnauthorizedKey/Reported
[PREFIX]/Diagnostics/Attributes/APSUnauthorizedKey/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSUnauthorizedKey/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSUnauthorizedKey/Desired { "value": <DESIRED_APS_UNAUTHORIZED_KEY>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSUnauthorizedKey/Reported { "value": <REPORTED_APS_UNAUTHORIZED_KEY>}

Diagnostics/NWKDecryptFailures Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/NWKDecryptFailures/Reported
[PREFIX]/Diagnostics/Attributes/NWKDecryptFailures/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/NWKDecryptFailures/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NWKDecryptFailures/Desired { "value": <DESIRED_NWK_DECRYPT_FAILURES>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/NWKDecryptFailures/Reported { "value": <REPORTED_NWK_DECRYPT_FAILURES>}

Diagnostics/APSDecryptFailures Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/APSDecryptFailures/Reported
[PREFIX]/Diagnostics/Attributes/APSDecryptFailures/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/APSDecryptFailures/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSDecryptFailures/Desired { "value": <DESIRED_APS_DECRYPT_FAILURES>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/APSDecryptFailures/Reported { "value": <REPORTED_APS_DECRYPT_FAILURES>}

Diagnostics/PacketBufferAllocateFailures Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/PacketBufferAllocateFailures/Reported
[PREFIX]/Diagnostics/Attributes/PacketBufferAllocateFailures/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/PacketBufferAllocateFailures/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PacketBufferAllocateFailures/Desired { "value": <DESIRED_PACKET_BUFFER_ALLOCATE_FAILURES>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PacketBufferAllocateFailures/Reported { "value": <REPORTED_PACKET_BUFFER_ALLOCATE_FAILURES>}

Diagnostics/RelayedUcast Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/RelayedUcast/Reported
[PREFIX]/Diagnostics/Attributes/RelayedUcast/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/RelayedUcast/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/RelayedUcast/Desired { "value": <DESIRED_RELAYED_UCAST>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/RelayedUcast/Reported { "value": <REPORTED_RELAYED_UCAST>}

Diagnostics/PHYToMACQueueLimitReached Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/PHYToMACQueueLimitReached/Reported
[PREFIX]/Diagnostics/Attributes/PHYToMACQueueLimitReached/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/PHYToMACQueueLimitReached/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PHYToMACQueueLimitReached/Desired { "value": <DESIRED_PHY_TO_MAC_QUEUE_LIMIT_REACHED>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PHYToMACQueueLimitReached/Reported { "value": <REPORTED_PHY_TO_MAC_QUEUE_LIMIT_REACHED>}

Diagnostics/PacketValidateDropCount Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/PacketValidateDropCount/Reported
[PREFIX]/Diagnostics/Attributes/PacketValidateDropCount/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/PacketValidateDropCount/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PacketValidateDropCount/Desired { "value": <DESIRED_PACKET_VALIDATE_DROP_COUNT>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/PacketValidateDropCount/Reported { "value": <REPORTED_PACKET_VALIDATE_DROP_COUNT>}

Diagnostics/AverageMACRetryPerAPSMessageSent Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/Reported
[PREFIX]/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/Desired { "value": <DESIRED_AVERAGE_MAC_RETRY_PER_APS_MESSAGE_SENT>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/AverageMACRetryPerAPSMessageSent/Reported { "value": <REPORTED_AVERAGE_MAC_RETRY_PER_APS_MESSAGE_SENT>}

Diagnostics/LastMessageLQI Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/LastMessageLQI/Reported
[PREFIX]/Diagnostics/Attributes/LastMessageLQI/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/LastMessageLQI/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/LastMessageLQI/Desired { "value": <DESIRED_LAST_MESSAGELQI>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/LastMessageLQI/Reported { "value": <REPORTED_LAST_MESSAGELQI>}

Diagnostics/LastMessageRSSI Attribute

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Attributes/LastMessageRSSI/Reported
[PREFIX]/Diagnostics/Attributes/LastMessageRSSI/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Diagnostics/Attributes/LastMessageRSSI/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/LastMessageRSSI/Desired { "value": <DESIRED_LAST_MESSAGERSSI>}
ucl/by-unid/<UNID>/ep0/Diagnostics/Attributes/LastMessageRSSI/Reported { "value": <REPORTED_LAST_MESSAGERSSI>}

Diagnostics/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

Diagnostics Command Support

MQTT Topic Pattern:

[PREFIX]/Diagnostics/SupportedCommands
[PREFIX]/Diagnostics/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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

Diagnostics Commands

Diagnostics/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

Diagnostics/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Diagnostics/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Diagnostics Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "NumberOfResets",
          "PersistentMemoryWrites",
          "MacRxBcast",
          "MacTxBcast",
          "MacRxUcast",
          "MacTxUcast",
          "MacTxUcastRetry",
          "MacTxUcastFail",
          "APSRxBcast",
          "APSTxBcast",
          "APSRxUcast",
          "APSTxUcastSuccess",
          "APSTxUcastRetry",
          "APSTxUcastFail",
          "RouteDiscInitiated",
          "NeighborAdded",
          "NeighborRemoved",
          "NeighborStale",
          "JoinIndication",
          "ChildMoved",
          "NWKFCFailure",
          "APSFCFailure",
          "APSUnauthorizedKey",
          "NWKDecryptFailures",
          "APSDecryptFailures",
          "PacketBufferAllocateFailures",
          "RelayedUcast",
          "PHYToMACQueueLimitReached",
          "PacketValidateDropCount",
          "AverageMACRetryPerAPSMessageSent",
          "LastMessageLQI",
          "LastMessageRSSI"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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