CarbonMonoxide Cluster

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

CarbonMonoxide Attributes

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

CarbonMonoxide/MeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/MeasuredValue/Reported
[PREFIX]/CarbonMonoxide/Attributes/MeasuredValue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonMonoxide/Attributes/MeasuredValue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

CarbonMonoxide/MinMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/MinMeasuredValue/Reported
[PREFIX]/CarbonMonoxide/Attributes/MinMeasuredValue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonMonoxide/Attributes/MinMeasuredValue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

CarbonMonoxide/MaxMeasuredValue Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/MaxMeasuredValue/Reported
[PREFIX]/CarbonMonoxide/Attributes/MaxMeasuredValue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonMonoxide/Attributes/MaxMeasuredValue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

CarbonMonoxide/Tolerance Attribute

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Attributes/Tolerance/Reported
[PREFIX]/CarbonMonoxide/Attributes/Tolerance/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/CarbonMonoxide/Attributes/Tolerance/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/CarbonMonoxide/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

CarbonMonoxide/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

CarbonMonoxide Command Support

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/SupportedCommands
[PREFIX]/CarbonMonoxide/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CarbonMonoxide 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 CarbonMonoxide cluster under the by-unid topic space:

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

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

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

CarbonMonoxide Commands

CarbonMonoxide/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

CarbonMonoxide/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/CarbonMonoxide/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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