PollControl Cluster

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

PollControl Attributes

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

PollControl/CheckInInterval Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/CheckInInterval/Reported
[PREFIX]/PollControl/Attributes/CheckInInterval/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/CheckInInterval/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/CheckInInterval/Desired { "value": <DESIRED_CHECK_IN_INTERVAL>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/CheckInInterval/Reported { "value": <REPORTED_CHECK_IN_INTERVAL>}

PollControl/LongPollInterval Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/LongPollInterval/Reported
[PREFIX]/PollControl/Attributes/LongPollInterval/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/LongPollInterval/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/LongPollInterval/Desired { "value": <DESIRED_LONG_POLL_INTERVAL>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/LongPollInterval/Reported { "value": <REPORTED_LONG_POLL_INTERVAL>}

PollControl/ShortPollInterval Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/ShortPollInterval/Reported
[PREFIX]/PollControl/Attributes/ShortPollInterval/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/ShortPollInterval/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/ShortPollInterval/Desired { "value": <DESIRED_SHORT_POLL_INTERVAL>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/ShortPollInterval/Reported { "value": <REPORTED_SHORT_POLL_INTERVAL>}

PollControl/FastPollTimeout Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/FastPollTimeout/Reported
[PREFIX]/PollControl/Attributes/FastPollTimeout/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/FastPollTimeout/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/FastPollTimeout/Desired { "value": <DESIRED_FAST_POLL_TIMEOUT>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/FastPollTimeout/Reported { "value": <REPORTED_FAST_POLL_TIMEOUT>}

PollControl/CheckInIntervalMin Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/CheckInIntervalMin/Reported
[PREFIX]/PollControl/Attributes/CheckInIntervalMin/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/CheckInIntervalMin/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/CheckInIntervalMin/Desired { "value": <DESIRED_CHECK_IN_INTERVAL_MIN>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/CheckInIntervalMin/Reported { "value": <REPORTED_CHECK_IN_INTERVAL_MIN>}

PollControl/LongPollIntervalMin Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/LongPollIntervalMin/Reported
[PREFIX]/PollControl/Attributes/LongPollIntervalMin/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/LongPollIntervalMin/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/LongPollIntervalMin/Desired { "value": <DESIRED_LONG_POLL_INTERVAL_MIN>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/LongPollIntervalMin/Reported { "value": <REPORTED_LONG_POLL_INTERVAL_MIN>}

PollControl/FastPollTimeoutMax Attribute

MQTT Topic Pattern:

[PREFIX]/PollControl/Attributes/FastPollTimeoutMax/Reported
[PREFIX]/PollControl/Attributes/FastPollTimeoutMax/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PollControl/Attributes/FastPollTimeoutMax/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/FastPollTimeoutMax/Desired { "value": <DESIRED_FAST_POLL_TIMEOUT_MAX>}
ucl/by-unid/<UNID>/ep0/PollControl/Attributes/FastPollTimeoutMax/Reported { "value": <REPORTED_FAST_POLL_TIMEOUT_MAX>}

PollControl/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

PollControl Command Support

MQTT Topic Pattern:

[PREFIX]/PollControl/SupportedCommands
[PREFIX]/PollControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/PollControl/SupportedGeneratedCommands { "value": ["CheckInResponse","FastPollStop","SetLongPollInterval","SetShortPollInterval"] }

PollControl Commands

PollControl/CheckIn Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/CheckIn
[PREFIX]/PollControl/GeneratedCommands/CheckIn

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a PollControl/CheckIn command under the by-unid topic space:

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

To receive a PollControl/CheckIn generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/CheckIn'

PollControl/CheckInResponse Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/CheckInResponse
[PREFIX]/PollControl/GeneratedCommands/CheckInResponse

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster CheckInResponse Command Properties",
  "type": "object",
  "properties": {
    "StartFastPolling": {
      "type": "boolean"
    },
    "FastPollTimeout": {
      "type": "integer"
    }
  },
  "required": [
    "StartFastPolling",
    "FastPollTimeout"
  ]
}

Example Mosquitto CLI Tool Usage

To send a PollControl/CheckInResponse command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/CheckInResponse' -m  '{ "StartFastPolling": <START_FAST_POLLING_VALUE>,"FastPollTimeout": <FAST_POLL_TIMEOUT_VALUE> }'

To receive a PollControl/CheckInResponse generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/CheckInResponse'

PollControl/FastPollStop Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/FastPollStop
[PREFIX]/PollControl/GeneratedCommands/FastPollStop

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a PollControl/FastPollStop command under the by-unid topic space:

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

To receive a PollControl/FastPollStop generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/FastPollStop'

PollControl/SetLongPollInterval Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/SetLongPollInterval
[PREFIX]/PollControl/GeneratedCommands/SetLongPollInterval

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a PollControl/SetLongPollInterval command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/SetLongPollInterval' -m  '{ "NewLongPollInterval": <NEW_LONG_POLL_INTERVAL_VALUE> }'

To receive a PollControl/SetLongPollInterval generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/SetLongPollInterval'

PollControl/SetShortPollInterval Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/SetShortPollInterval
[PREFIX]/PollControl/GeneratedCommands/SetShortPollInterval

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

To send a PollControl/SetShortPollInterval command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/SetShortPollInterval' -m  '{ "NewShortPollInterval": <NEW_SHORT_POLL_INTERVAL_VALUE> }'

To receive a PollControl/SetShortPollInterval generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/GeneratedCommands/SetShortPollInterval'

PollControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PollControl/Commands/WriteAttributes' -m  '{ "CheckInInterval": <CHECK_IN_INTERVAL_VALUE> ,"FastPollTimeout": <FAST_POLL_TIMEOUT_VALUE> , }'

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

PollControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PollControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PollControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "CheckInInterval",
          "LongPollInterval",
          "ShortPollInterval",
          "FastPollTimeout",
          "CheckInIntervalMin",
          "LongPollIntervalMin",
          "FastPollTimeoutMax"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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