IlluminanceLevelSensing Cluster

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

IlluminanceLevelSensing Attributes

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

IlluminanceLevelSensing/LevelStatus Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Attributes/LevelStatus/Reported
[PREFIX]/IlluminanceLevelSensing/Attributes/LevelStatus/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceLevelSensing/Attributes/LevelStatus/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/LevelStatus/Desired { "value": <DESIRED_LEVEL_STATUS>}
ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/LevelStatus/Reported { "value": <REPORTED_LEVEL_STATUS>}

IlluminanceLevelSensing/LightSensorType Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

IlluminanceLevelSensing/IlluminanceTargetLevel Attribute

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/Reported
[PREFIX]/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/Desired { "value": <DESIRED_ILLUMINANCE_TARGET_LEVEL>}
ucl/by-unid/<UNID>/ep0/IlluminanceLevelSensing/Attributes/IlluminanceTargetLevel/Reported { "value": <REPORTED_ILLUMINANCE_TARGET_LEVEL>}

IlluminanceLevelSensing/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

IlluminanceLevelSensing Command Support

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/SupportedCommands
[PREFIX]/IlluminanceLevelSensing/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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

IlluminanceLevelSensing Commands

IlluminanceLevelSensing/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/IlluminanceLevelSensing/Commands/WriteAttributes' -m  '{ "IlluminanceTargetLevel": <ILLUMINANCE_TARGET_LEVEL_VALUE>  }'

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

IlluminanceLevelSensing/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/IlluminanceLevelSensing/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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