ProtocolController/RFTelemetry Cluster

The following commands and attributes are accepted as JSON payloads for the ProtocolController-RFTelemetry cluster.

ProtocolController/RFTelemetry Attributes

The following attribute topics are used to retrieve the ProtocolController-RFTelemetry cluster state.

ProtocolController-RFTelemetry/TxReportEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/Reported
[PREFIX]/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/+'
 
# Example output
 
ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/Desired { "value": <DESIRED_TX_REPORT_ENABLED>}
ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Attributes/TxReportEnabled/Reported { "value": <REPORTED_TX_REPORT_ENABLED>}

ProtocolController-RFTelemetry/PTIEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Attributes/PTIEnabled/Reported
[PREFIX]/ProtocolController/RFTelemetry/Attributes/PTIEnabled/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/ProtocolController/RFTelemetry/Attributes/PTIEnabled/+'
 
# Example output
 
ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Attributes/PTIEnabled/Desired { "value": <DESIRED_PTI_ENABLED>}
ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Attributes/PTIEnabled/Reported { "value": <REPORTED_PTI_ENABLED>}

ProtocolController/RFTelemetry/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Attributes/ClusterRevision/Reported
[PREFIX]/ProtocolController/RFTelemetry/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

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

ProtocolController/RFTelemetry Command Support

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/SupportedCommands
[PREFIX]/ProtocolController/RFTelemetry/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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

ProtocolController/RFTelemetry Commands

ProtocolController/RFTelemetry/TxReport Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Commands/TxReport
[PREFIX]/ProtocolController/RFTelemetry/GeneratedCommands/TxReport

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ProtocolController/RFTelemetry Cluster TxReport Command Properties",
  "type": "object",
  "properties": {
    "SourceUNID": {
      "type": "string"
    },
    "DestinationUNID": {
      "type": "string"
    },
    "TransmissionSuccessful": {
      "type": "boolean"
    },
    "TransmissionTimeMs": {
      "type": "integer"
    },
    "TxPowerdBm": {
      "type": "integer"
    },
    "TxChannel": {
      "type": "integer"
    },
    "RoutingAttempts": {
      "type": "integer"
    },
    "RouteChanged": {
      "type": "boolean"
    },
    "TransmissionSpeed": {
      "type": "TxReportTransmissionSpeed"
    },
    "MeasuredNoiseFloordBm": {
      "type": "integer"
    },
    "LastRouteRepeaters": {
      "type": "array",
      "items": {
        "type": "string"
      }
,
    "IncomingRSSIRepeaters": {
      "type": "array",
      "items": {
        "type": "integer"
      }
,
    "AckRSSI": {
      "type": "integer"
    },
    "AckChannel": {
      "type": "integer"
    },
    "LastRouteFailedLinkFunctionalUNID": {
      "type": "string"
    },
    "LastRouteFailedLinkNonFunctionalUNID": {
      "type": "string"
    },
    "DestinationAckTxPowerdBm": {
      "type": "integer"
    },
    "DestinationAckMeasuredRSSI": {
      "type": "integer"
    },
    "DestinationAckMeasuredNoiseFloor": {
      "type": "integer"
    }
  },
  "required": [
    "SourceUNID",
    "DestinationUNID",
    "TransmissionSuccessful",
    "TransmissionTimeMs",
    "TxPowerdBm",
    "TxChannel",
    "RoutingAttempts",
    "RouteChanged",
    "TransmissionSpeed",
    "MeasuredNoiseFloordBm",
    "LastRouteRepeaters",
    "IncomingRSSIRepeaters",
    "AckRSSI",
    "AckChannel",
    "LastRouteFailedLinkFunctionalUNID",
    "LastRouteFailedLinkNonFunctionalUNID",
    "DestinationAckTxPowerdBm",
    "DestinationAckMeasuredRSSI",
    "DestinationAckMeasuredNoiseFloor"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ProtocolController/RFTelemetry/TxReport command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/Commands/TxReport' -m  '{ "SourceUNID": <SOURCEUNID_VALUE>,"DestinationUNID": <DESTINATIONUNID_VALUE>,"TransmissionSuccessful": <TRANSMISSION_SUCCESSFUL_VALUE>,"TransmissionTimeMs": <TRANSMISSION_TIME_MS_VALUE>,"TxPowerdBm": <TX_POWERD_BM_VALUE>,"TxChannel": <TX_CHANNEL_VALUE>,"RoutingAttempts": <ROUTING_ATTEMPTS_VALUE>,"RouteChanged": <ROUTE_CHANGED_VALUE>,"TransmissionSpeed": <TRANSMISSION_SPEED_VALUE>,"MeasuredNoiseFloordBm": <MEASURED_NOISE_FLOORD_BM_VALUE>,"LastRouteRepeaters": <LAST_ROUTE_REPEATERS_VALUE>,"IncomingRSSIRepeaters": <INCOMING_RSSI_REPEATERS_VALUE>,"AckRSSI": <ACKRSSI_VALUE>,"AckChannel": <ACK_CHANNEL_VALUE>,"LastRouteFailedLinkFunctionalUNID": <LAST_ROUTE_FAILED_LINK_FUNCTIONALUNID_VALUE>,"LastRouteFailedLinkNonFunctionalUNID": <LAST_ROUTE_FAILED_LINK_NON_FUNCTIONALUNID_VALUE>,"DestinationAckTxPowerdBm": <DESTINATION_ACK_TX_POWERD_BM_VALUE>,"DestinationAckMeasuredRSSI": <DESTINATION_ACK_MEASUREDRSSI_VALUE>,"DestinationAckMeasuredNoiseFloor": <DESTINATION_ACK_MEASURED_NOISE_FLOOR_VALUE> }'

To receive a ProtocolController/RFTelemetry/TxReport generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ProtocolController/RFTelemetry/GeneratedCommands/TxReport'

ProtocolController/RFTelemetry/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To update all ProtocolController/RFTelemetry attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ProtocolController/RFTelemetry/Commands/WriteAttributes' -m  '{ "TxReportEnabled": <TX_REPORT_ENABLED_VALUE> ,"PTIEnabled": <PTI_ENABLED_VALUE>  }'

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

ProtocolController/RFTelemetry/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ProtocolController/RFTelemetry/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

To force read one of the ProtocolController/RFTelemetry attributes under the by-unid topic space:

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