IlluminanceMeasurement Cluster

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

IlluminanceMeasurement Attributes

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

IlluminanceMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster MeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "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/+/+/IlluminanceMeasurement/Attributes/MeasuredValue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MeasuredValue/Desired { "value": <DESIRED_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MeasuredValue/Reported { "value": <REPORTED_MEASURED_VALUE>}

IlluminanceMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster MinMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "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/+/+/IlluminanceMeasurement/Attributes/MinMeasuredValue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MinMeasuredValue/Desired { "value": <DESIRED_MIN_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MinMeasuredValue/Reported { "value": <REPORTED_MIN_MEASURED_VALUE>}

IlluminanceMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster MaxMeasuredValue Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "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/+/+/IlluminanceMeasurement/Attributes/MaxMeasuredValue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MaxMeasuredValue/Desired { "value": <DESIRED_MAX_MEASURED_VALUE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/MaxMeasuredValue/Reported { "value": <REPORTED_MAX_MEASURED_VALUE>}

IlluminanceMeasurement/Tolerance Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "IlluminanceMeasurement Cluster Tolerance Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "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/+/+/IlluminanceMeasurement/Attributes/Tolerance/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/Tolerance/Desired { "value": <DESIRED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/Tolerance/Reported { "value": <REPORTED_TOLERANCE>}

IlluminanceMeasurement/LightSensorType Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Attributes/LightSensorType/Reported
[PREFIX]/IlluminanceMeasurement/Attributes/LightSensorType/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceMeasurement/Attributes/LightSensorType/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/LightSensorType/Desired { "value": <DESIRED_LIGHT_SENSOR_TYPE>}
ucl/by-unid/<UNID>/ep0/IlluminanceMeasurement/Attributes/LightSensorType/Reported { "value": <REPORTED_LIGHT_SENSOR_TYPE>}

IlluminanceMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

IlluminanceMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/SupportedCommands
[PREFIX]/IlluminanceMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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

IlluminanceMeasurement Commands

IlluminanceMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

IlluminanceMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/IlluminanceMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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