ColorControl Cluster

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

ColorControl Attributes

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

ColorControl/CurrentHue Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CurrentHue/Reported
[PREFIX]/ColorControl/Attributes/CurrentHue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CurrentHue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentHue/Desired { "value": <DESIRED_CURRENT_HUE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentHue/Reported { "value": <REPORTED_CURRENT_HUE>}

ColorControl/CurrentSaturation Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CurrentSaturation/Reported
[PREFIX]/ColorControl/Attributes/CurrentSaturation/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CurrentSaturation/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentSaturation/Desired { "value": <DESIRED_CURRENT_SATURATION>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentSaturation/Reported { "value": <REPORTED_CURRENT_SATURATION>}

ColorControl/RemainingTime Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/RemainingTime/Reported
[PREFIX]/ColorControl/Attributes/RemainingTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/RemainingTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/RemainingTime/Desired { "value": <DESIRED_REMAINING_TIME>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/RemainingTime/Reported { "value": <REPORTED_REMAINING_TIME>}

ColorControl/CurrentX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CurrentX/Reported
[PREFIX]/ColorControl/Attributes/CurrentX/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CurrentX/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentX/Desired { "value": <DESIRED_CURRENTX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentX/Reported { "value": <REPORTED_CURRENTX>}

ColorControl/CurrentY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CurrentY/Reported
[PREFIX]/ColorControl/Attributes/CurrentY/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CurrentY/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentY/Desired { "value": <DESIRED_CURRENTY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CurrentY/Reported { "value": <REPORTED_CURRENTY>}

ColorControl/DriftCompensation Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/DriftCompensation/Reported
[PREFIX]/ColorControl/Attributes/DriftCompensation/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/DriftCompensation/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/DriftCompensation/Desired { "value": <DESIRED_DRIFT_COMPENSATION>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/DriftCompensation/Reported { "value": <REPORTED_DRIFT_COMPENSATION>}

ColorControl/CompensationText Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CompensationText/Reported
[PREFIX]/ColorControl/Attributes/CompensationText/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CompensationText/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CompensationText/Desired { "value": <DESIRED_COMPENSATION_TEXT>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CompensationText/Reported { "value": <REPORTED_COMPENSATION_TEXT>}

ColorControl/ColorTemperatureMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorTemperatureMireds/Reported
[PREFIX]/ColorControl/Attributes/ColorTemperatureMireds/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorTemperatureMireds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTemperatureMireds/Desired { "value": <DESIRED_COLOR_TEMPERATURE_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTemperatureMireds/Reported { "value": <REPORTED_COLOR_TEMPERATURE_MIREDS>}

ColorControl/ColorMode Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorMode/Reported
[PREFIX]/ColorControl/Attributes/ColorMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorMode/Desired { "value": <DESIRED_COLOR_MODE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorMode/Reported { "value": <REPORTED_COLOR_MODE>}

ColorControl/Options Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Options/Reported
[PREFIX]/ColorControl/Attributes/Options/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Options/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Options/Desired { "value": <DESIRED_OPTIONS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Options/Reported { "value": <REPORTED_OPTIONS>}

ColorControl/NumberOfPrimaries Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/NumberOfPrimaries/Reported
[PREFIX]/ColorControl/Attributes/NumberOfPrimaries/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/NumberOfPrimaries/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/NumberOfPrimaries/Desired { "value": <DESIRED_NUMBER_OF_PRIMARIES>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/NumberOfPrimaries/Reported { "value": <REPORTED_NUMBER_OF_PRIMARIES>}

ColorControl/Primary1X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary1X/Reported
[PREFIX]/ColorControl/Attributes/Primary1X/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary1X/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1X/Desired { "value": <DESIRED_PRIMARY1X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1X/Reported { "value": <REPORTED_PRIMARY1X>}

ColorControl/Primary1Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary1Y/Reported
[PREFIX]/ColorControl/Attributes/Primary1Y/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary1Y/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1Y/Desired { "value": <DESIRED_PRIMARY1Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1Y/Reported { "value": <REPORTED_PRIMARY1Y>}

ColorControl/Primary1Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary1Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary1Intensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary1Intensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1Intensity/Desired { "value": <DESIRED_PRIMARY1_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary1Intensity/Reported { "value": <REPORTED_PRIMARY1_INTENSITY>}

ColorControl/Primary2X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary2X/Reported
[PREFIX]/ColorControl/Attributes/Primary2X/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary2X/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2X/Desired { "value": <DESIRED_PRIMARY2X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2X/Reported { "value": <REPORTED_PRIMARY2X>}

ColorControl/Primary2Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary2Y/Reported
[PREFIX]/ColorControl/Attributes/Primary2Y/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary2Y/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2Y/Desired { "value": <DESIRED_PRIMARY2Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2Y/Reported { "value": <REPORTED_PRIMARY2Y>}

ColorControl/Primary2Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary2Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary2Intensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary2Intensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2Intensity/Desired { "value": <DESIRED_PRIMARY2_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary2Intensity/Reported { "value": <REPORTED_PRIMARY2_INTENSITY>}

ColorControl/Primary3X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary3X/Reported
[PREFIX]/ColorControl/Attributes/Primary3X/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary3X/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3X/Desired { "value": <DESIRED_PRIMARY3X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3X/Reported { "value": <REPORTED_PRIMARY3X>}

ColorControl/Primary3Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary3Y/Reported
[PREFIX]/ColorControl/Attributes/Primary3Y/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary3Y/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3Y/Desired { "value": <DESIRED_PRIMARY3Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3Y/Reported { "value": <REPORTED_PRIMARY3Y>}

ColorControl/Primary3Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary3Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary3Intensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary3Intensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3Intensity/Desired { "value": <DESIRED_PRIMARY3_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary3Intensity/Reported { "value": <REPORTED_PRIMARY3_INTENSITY>}

ColorControl/Primary4X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary4X/Reported
[PREFIX]/ColorControl/Attributes/Primary4X/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary4X/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4X/Desired { "value": <DESIRED_PRIMARY4X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4X/Reported { "value": <REPORTED_PRIMARY4X>}

ColorControl/Primary4Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary4Y/Reported
[PREFIX]/ColorControl/Attributes/Primary4Y/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary4Y/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4Y/Desired { "value": <DESIRED_PRIMARY4Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4Y/Reported { "value": <REPORTED_PRIMARY4Y>}

ColorControl/Primary4Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary4Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary4Intensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary4Intensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4Intensity/Desired { "value": <DESIRED_PRIMARY4_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary4Intensity/Reported { "value": <REPORTED_PRIMARY4_INTENSITY>}

ColorControl/Primary5X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary5X/Reported
[PREFIX]/ColorControl/Attributes/Primary5X/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary5X/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5X/Desired { "value": <DESIRED_PRIMARY5X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5X/Reported { "value": <REPORTED_PRIMARY5X>}

ColorControl/Primary5Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary5Y/Reported
[PREFIX]/ColorControl/Attributes/Primary5Y/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary5Y/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5Y/Desired { "value": <DESIRED_PRIMARY5Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5Y/Reported { "value": <REPORTED_PRIMARY5Y>}

ColorControl/Primary5Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary5Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary5Intensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary5Intensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5Intensity/Desired { "value": <DESIRED_PRIMARY5_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary5Intensity/Reported { "value": <REPORTED_PRIMARY5_INTENSITY>}

ColorControl/Primary6X Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary6X/Reported
[PREFIX]/ColorControl/Attributes/Primary6X/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary6X/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6X/Desired { "value": <DESIRED_PRIMARY6X>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6X/Reported { "value": <REPORTED_PRIMARY6X>}

ColorControl/Primary6Y Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary6Y/Reported
[PREFIX]/ColorControl/Attributes/Primary6Y/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary6Y/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6Y/Desired { "value": <DESIRED_PRIMARY6Y>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6Y/Reported { "value": <REPORTED_PRIMARY6Y>}

ColorControl/Primary6Intensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/Primary6Intensity/Reported
[PREFIX]/ColorControl/Attributes/Primary6Intensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/Primary6Intensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6Intensity/Desired { "value": <DESIRED_PRIMARY6_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/Primary6Intensity/Reported { "value": <REPORTED_PRIMARY6_INTENSITY>}

ColorControl/WhitePointX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/WhitePointX/Reported
[PREFIX]/ColorControl/Attributes/WhitePointX/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/WhitePointX/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/WhitePointX/Desired { "value": <DESIRED_WHITE_POINTX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/WhitePointX/Reported { "value": <REPORTED_WHITE_POINTX>}

ColorControl/WhitePointY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/WhitePointY/Reported
[PREFIX]/ColorControl/Attributes/WhitePointY/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/WhitePointY/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/WhitePointY/Desired { "value": <DESIRED_WHITE_POINTY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/WhitePointY/Reported { "value": <REPORTED_WHITE_POINTY>}

ColorControl/ColorPointRX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointRX/Reported
[PREFIX]/ColorControl/Attributes/ColorPointRX/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointRX/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRX/Desired { "value": <DESIRED_COLOR_POINTRX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRX/Reported { "value": <REPORTED_COLOR_POINTRX>}

ColorControl/ColorPointRY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointRY/Reported
[PREFIX]/ColorControl/Attributes/ColorPointRY/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointRY/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRY/Desired { "value": <DESIRED_COLOR_POINTRY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRY/Reported { "value": <REPORTED_COLOR_POINTRY>}

ColorControl/ColorPointRIntensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointRIntensity/Reported
[PREFIX]/ColorControl/Attributes/ColorPointRIntensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointRIntensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRIntensity/Desired { "value": <DESIRED_COLOR_POINTR_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointRIntensity/Reported { "value": <REPORTED_COLOR_POINTR_INTENSITY>}

ColorControl/ColorPointGX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointGX/Reported
[PREFIX]/ColorControl/Attributes/ColorPointGX/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointGX/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGX/Desired { "value": <DESIRED_COLOR_POINTGX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGX/Reported { "value": <REPORTED_COLOR_POINTGX>}

ColorControl/ColorPointGY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointGY/Reported
[PREFIX]/ColorControl/Attributes/ColorPointGY/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointGY/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGY/Desired { "value": <DESIRED_COLOR_POINTGY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGY/Reported { "value": <REPORTED_COLOR_POINTGY>}

ColorControl/ColorPointGIntensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointGIntensity/Reported
[PREFIX]/ColorControl/Attributes/ColorPointGIntensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointGIntensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGIntensity/Desired { "value": <DESIRED_COLOR_POINTG_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointGIntensity/Reported { "value": <REPORTED_COLOR_POINTG_INTENSITY>}

ColorControl/ColorPointBX Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointBX/Reported
[PREFIX]/ColorControl/Attributes/ColorPointBX/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointBX/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBX/Desired { "value": <DESIRED_COLOR_POINTBX>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBX/Reported { "value": <REPORTED_COLOR_POINTBX>}

ColorControl/ColorPointBY Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointBY/Reported
[PREFIX]/ColorControl/Attributes/ColorPointBY/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointBY/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBY/Desired { "value": <DESIRED_COLOR_POINTBY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBY/Reported { "value": <REPORTED_COLOR_POINTBY>}

ColorControl/ColorPointBIntensity Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorPointBIntensity/Reported
[PREFIX]/ColorControl/Attributes/ColorPointBIntensity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorPointBIntensity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBIntensity/Desired { "value": <DESIRED_COLOR_POINTB_INTENSITY>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorPointBIntensity/Reported { "value": <REPORTED_COLOR_POINTB_INTENSITY>}

ColorControl/EnhancedCurrentHue Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/EnhancedCurrentHue/Reported
[PREFIX]/ColorControl/Attributes/EnhancedCurrentHue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/EnhancedCurrentHue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/EnhancedCurrentHue/Desired { "value": <DESIRED_ENHANCED_CURRENT_HUE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/EnhancedCurrentHue/Reported { "value": <REPORTED_ENHANCED_CURRENT_HUE>}

ColorControl/EnhancedColorMode Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/EnhancedColorMode/Reported
[PREFIX]/ColorControl/Attributes/EnhancedColorMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/EnhancedColorMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/EnhancedColorMode/Desired { "value": <DESIRED_ENHANCED_COLOR_MODE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/EnhancedColorMode/Reported { "value": <REPORTED_ENHANCED_COLOR_MODE>}

ColorControl/ColorLoopActive Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopActive/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopActive/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopActive/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopActive/Desired { "value": <DESIRED_COLOR_LOOP_ACTIVE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopActive/Reported { "value": <REPORTED_COLOR_LOOP_ACTIVE>}

ColorControl/ColorLoopDirection Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopDirection/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopDirection/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopDirection/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopDirection/Desired { "value": <DESIRED_COLOR_LOOP_DIRECTION>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopDirection/Reported { "value": <REPORTED_COLOR_LOOP_DIRECTION>}

ColorControl/ColorLoopTime Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopTime/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopTime/Desired { "value": <DESIRED_COLOR_LOOP_TIME>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopTime/Reported { "value": <REPORTED_COLOR_LOOP_TIME>}

ColorControl/ColorLoopStartEnhancedHue Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopStartEnhancedHue/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopStartEnhancedHue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopStartEnhancedHue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopStartEnhancedHue/Desired { "value": <DESIRED_COLOR_LOOP_START_ENHANCED_HUE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopStartEnhancedHue/Reported { "value": <REPORTED_COLOR_LOOP_START_ENHANCED_HUE>}

ColorControl/ColorLoopStoredEnhancedHue Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorLoopStoredEnhancedHue/Reported
[PREFIX]/ColorControl/Attributes/ColorLoopStoredEnhancedHue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorLoopStoredEnhancedHue/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopStoredEnhancedHue/Desired { "value": <DESIRED_COLOR_LOOP_STORED_ENHANCED_HUE>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorLoopStoredEnhancedHue/Reported { "value": <REPORTED_COLOR_LOOP_STORED_ENHANCED_HUE>}

ColorControl/ColorCapabilities Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorCapabilities/Reported
[PREFIX]/ColorControl/Attributes/ColorCapabilities/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorCapabilities/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorCapabilities/Desired { "value": <DESIRED_COLOR_CAPABILITIES>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorCapabilities/Reported { "value": <REPORTED_COLOR_CAPABILITIES>}

ColorControl/ColorTempPhysicalMinMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorTempPhysicalMinMireds/Reported
[PREFIX]/ColorControl/Attributes/ColorTempPhysicalMinMireds/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorTempPhysicalMinMireds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTempPhysicalMinMireds/Desired { "value": <DESIRED_COLOR_TEMP_PHYSICAL_MIN_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTempPhysicalMinMireds/Reported { "value": <REPORTED_COLOR_TEMP_PHYSICAL_MIN_MIREDS>}

ColorControl/ColorTempPhysicalMaxMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/ColorTempPhysicalMaxMireds/Reported
[PREFIX]/ColorControl/Attributes/ColorTempPhysicalMaxMireds/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/ColorTempPhysicalMaxMireds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTempPhysicalMaxMireds/Desired { "value": <DESIRED_COLOR_TEMP_PHYSICAL_MAX_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/ColorTempPhysicalMaxMireds/Reported { "value": <REPORTED_COLOR_TEMP_PHYSICAL_MAX_MIREDS>}

ColorControl/CoupleColorTempToLevelMinMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/Reported
[PREFIX]/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/Desired { "value": <DESIRED_COUPLE_COLOR_TEMP_TO_LEVEL_MIN_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/CoupleColorTempToLevelMinMireds/Reported { "value": <REPORTED_COUPLE_COLOR_TEMP_TO_LEVEL_MIN_MIREDS>}

ColorControl/StartUpColorTemperatureMireds Attribute

MQTT Topic Pattern:

[PREFIX]/ColorControl/Attributes/StartUpColorTemperatureMireds/Reported
[PREFIX]/ColorControl/Attributes/StartUpColorTemperatureMireds/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/ColorControl/Attributes/StartUpColorTemperatureMireds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/StartUpColorTemperatureMireds/Desired { "value": <DESIRED_START_UP_COLOR_TEMPERATURE_MIREDS>}
ucl/by-unid/<UNID>/ep0/ColorControl/Attributes/StartUpColorTemperatureMireds/Reported { "value": <REPORTED_START_UP_COLOR_TEMPERATURE_MIREDS>}

ColorControl/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

ColorControl Command Support

MQTT Topic Pattern:

[PREFIX]/ColorControl/SupportedCommands
[PREFIX]/ColorControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "MoveToHue",
              "MoveHue",
              "StepHue",
              "MoveToSaturation",
              "MoveSaturation",
              "StepSaturation",
              "MoveToHueAndSaturation",
              "MoveToColor",
              "MoveColor",
              "StepColor",
              "MoveToColorTemperature",
              "EnhancedMoveToHue",
              "EnhancedMoveHue",
              "EnhancedStepHue",
              "EnhancedMoveToHueAndSaturation",
              "ColorLoopSet",
              "StopMoveStep",
              "MoveColorTemperature",
              "StepColorTemperature",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/<EP>/ColorControl/SupportedCommands { "value": ["MoveToHue","MoveHue","StepHue","MoveToSaturation","MoveSaturation","StepSaturation","MoveToHueAndSaturation","MoveToColor","MoveColor","StepColor","MoveToColorTemperature","EnhancedMoveToHue","EnhancedMoveHue","EnhancedStepHue","EnhancedMoveToHueAndSaturation","ColorLoopSet","StopMoveStep","MoveColorTemperature","StepColorTemperature","WriteAttributes", "ForceReadAttributes"] }

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

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

ColorControl Commands

ColorControl/MoveToHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToHue
[PREFIX]/ColorControl/GeneratedCommands/MoveToHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToHue Command Properties",
  "type": "object",
  "properties": {
    "Hue": {
      "type": "integer"
    },
    "Direction": {
      "type": "CCDirection"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "Hue",
    "Direction",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToHue' -m  '{ "Hue": <HUE_VALUE>,"Direction": <DIRECTION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToHue'

ColorControl/MoveHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveHue
[PREFIX]/ColorControl/GeneratedCommands/MoveHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveHue Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "CCMoveMode"
    },
    "Rate": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveHue' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveHue'

ColorControl/StepHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StepHue
[PREFIX]/ColorControl/GeneratedCommands/StepHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StepHue Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "CCStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StepHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StepHue' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StepHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StepHue'

ColorControl/MoveToSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToSaturation
[PREFIX]/ColorControl/GeneratedCommands/MoveToSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToSaturation Command Properties",
  "type": "object",
  "properties": {
    "Saturation": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "Saturation",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToSaturation' -m  '{ "Saturation": <SATURATION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToSaturation'

ColorControl/MoveSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveSaturation
[PREFIX]/ColorControl/GeneratedCommands/MoveSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveSaturation Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "CCMoveMode"
    },
    "Rate": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveSaturation' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveSaturation'

ColorControl/StepSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StepSaturation
[PREFIX]/ColorControl/GeneratedCommands/StepSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StepSaturation Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "CCStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StepSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StepSaturation' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StepSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StepSaturation'

ColorControl/MoveToHueAndSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToHueAndSaturation
[PREFIX]/ColorControl/GeneratedCommands/MoveToHueAndSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToHueAndSaturation Command Properties",
  "type": "object",
  "properties": {
    "Hue": {
      "type": "integer"
    },
    "Saturation": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "Hue",
    "Saturation",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToHueAndSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToHueAndSaturation' -m  '{ "Hue": <HUE_VALUE>,"Saturation": <SATURATION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToHueAndSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToHueAndSaturation'

ColorControl/MoveToColor Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToColor
[PREFIX]/ColorControl/GeneratedCommands/MoveToColor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToColor Command Properties",
  "type": "object",
  "properties": {
    "ColorX": {
      "type": "integer"
    },
    "ColorY": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "ColorX",
    "ColorY",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToColor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToColor' -m  '{ "ColorX": <COLORX_VALUE>,"ColorY": <COLORY_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToColor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToColor'

ColorControl/MoveColor Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveColor
[PREFIX]/ColorControl/GeneratedCommands/MoveColor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveColor Command Properties",
  "type": "object",
  "properties": {
    "RateX": {
      "type": "integer"
    },
    "RateY": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "RateX",
    "RateY",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveColor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveColor' -m  '{ "RateX": <RATEX_VALUE>,"RateY": <RATEY_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveColor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveColor'

ColorControl/StepColor Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StepColor
[PREFIX]/ColorControl/GeneratedCommands/StepColor

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StepColor Command Properties",
  "type": "object",
  "properties": {
    "StepX": {
      "type": "integer"
    },
    "StepY": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepX",
    "StepY",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StepColor command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StepColor' -m  '{ "StepX": <STEPX_VALUE>,"StepY": <STEPY_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StepColor generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StepColor'

ColorControl/MoveToColorTemperature Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveToColorTemperature
[PREFIX]/ColorControl/GeneratedCommands/MoveToColorTemperature

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveToColorTemperature Command Properties",
  "type": "object",
  "properties": {
    "ColorTemperatureMireds": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "ColorTemperatureMireds",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveToColorTemperature command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveToColorTemperature' -m  '{ "ColorTemperatureMireds": <COLOR_TEMPERATURE_MIREDS_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveToColorTemperature generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveToColorTemperature'

ColorControl/EnhancedMoveToHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/EnhancedMoveToHue
[PREFIX]/ColorControl/GeneratedCommands/EnhancedMoveToHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedMoveToHue Command Properties",
  "type": "object",
  "properties": {
    "EnhancedHue": {
      "type": "integer"
    },
    "Direction": {
      "type": "CCDirection"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "EnhancedHue",
    "Direction",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/EnhancedMoveToHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/EnhancedMoveToHue' -m  '{ "EnhancedHue": <ENHANCED_HUE_VALUE>,"Direction": <DIRECTION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/EnhancedMoveToHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/EnhancedMoveToHue'

ColorControl/EnhancedMoveHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/EnhancedMoveHue
[PREFIX]/ColorControl/GeneratedCommands/EnhancedMoveHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedMoveHue Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "CCMoveMode"
    },
    "Rate": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/EnhancedMoveHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/EnhancedMoveHue' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/EnhancedMoveHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/EnhancedMoveHue'

ColorControl/EnhancedStepHue Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/EnhancedStepHue
[PREFIX]/ColorControl/GeneratedCommands/EnhancedStepHue

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedStepHue Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "CCStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/EnhancedStepHue command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/EnhancedStepHue' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/EnhancedStepHue generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/EnhancedStepHue'

ColorControl/EnhancedMoveToHueAndSaturation Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/EnhancedMoveToHueAndSaturation
[PREFIX]/ColorControl/GeneratedCommands/EnhancedMoveToHueAndSaturation

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster EnhancedMoveToHueAndSaturation Command Properties",
  "type": "object",
  "properties": {
    "EnhancedHue": {
      "type": "integer"
    },
    "Saturation": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "EnhancedHue",
    "Saturation",
    "TransitionTime",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/EnhancedMoveToHueAndSaturation command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/EnhancedMoveToHueAndSaturation' -m  '{ "EnhancedHue": <ENHANCED_HUE_VALUE>,"Saturation": <SATURATION_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/EnhancedMoveToHueAndSaturation generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/EnhancedMoveToHueAndSaturation'

ColorControl/ColorLoopSet Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/ColorLoopSet
[PREFIX]/ColorControl/GeneratedCommands/ColorLoopSet

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ColorLoopSet Command Properties",
  "type": "object",
  "properties": {
    "UpdateFlags": {
      "type": "ColorLoopSetUpdateFlags"
    },
    "Action": {
      "type": "ColorLoopSetAction"
    },
    "Direction": {
      "type": "CCColorLoopDirection"
    },
    "Time": {
      "type": "integer"
    },
    "StartHue": {
      "type": "integer"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "UpdateFlags",
    "Action",
    "Direction",
    "Time",
    "StartHue",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/ColorLoopSet command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/ColorLoopSet' -m  '{ "UpdateFlags": <UPDATE_FLAGS_VALUE>,"Action": <ACTION_VALUE>,"Direction": <DIRECTION_VALUE>,"Time": <TIME_VALUE>,"StartHue": <START_HUE_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/ColorLoopSet generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/ColorLoopSet'

ColorControl/StopMoveStep Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StopMoveStep
[PREFIX]/ColorControl/GeneratedCommands/StopMoveStep

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StopMoveStep Command Properties",
  "type": "object",
  "properties": {
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StopMoveStep command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StopMoveStep' -m  '{ "OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StopMoveStep generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StopMoveStep'

ColorControl/MoveColorTemperature Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/MoveColorTemperature
[PREFIX]/ColorControl/GeneratedCommands/MoveColorTemperature

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster MoveColorTemperature Command Properties",
  "type": "object",
  "properties": {
    "MoveMode": {
      "type": "CCMoveMode"
    },
    "Rate": {
      "type": "integer"
    },
    "ColorTemperatureMinimumMireds": {
      "type": "CCMinMiredsField"
    },
    "ColorTemperatureMaximumMireds": {
      "type": "CCMaxMiredsField"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "MoveMode",
    "Rate",
    "ColorTemperatureMinimumMireds",
    "ColorTemperatureMaximumMireds",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/MoveColorTemperature command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/MoveColorTemperature' -m  '{ "MoveMode": <MOVE_MODE_VALUE>,"Rate": <RATE_VALUE>,"ColorTemperatureMinimumMireds": <COLOR_TEMPERATURE_MINIMUM_MIREDS_VALUE>,"ColorTemperatureMaximumMireds": <COLOR_TEMPERATURE_MAXIMUM_MIREDS_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/MoveColorTemperature generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/MoveColorTemperature'

ColorControl/StepColorTemperature Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/StepColorTemperature
[PREFIX]/ColorControl/GeneratedCommands/StepColorTemperature

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster StepColorTemperature Command Properties",
  "type": "object",
  "properties": {
    "StepMode": {
      "type": "CCStepMode"
    },
    "StepSize": {
      "type": "integer"
    },
    "TransitionTime": {
      "type": "integer"
    },
    "ColorTemperatureMinimumMireds": {
      "type": "CCMinMiredsField"
    },
    "ColorTemperatureMaximumMireds": {
      "type": "CCMaxMiredsField"
    },
    "OptionsMask": {
      "type": "CCColorOptions"
    },
    "OptionsOverride": {
      "type": "CCColorOptions"
    }
  },
  "required": [
    "StepMode",
    "StepSize",
    "TransitionTime",
    "ColorTemperatureMinimumMireds",
    "ColorTemperatureMaximumMireds",
    "OptionsMask",
    "OptionsOverride"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ColorControl/StepColorTemperature command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/StepColorTemperature' -m  '{ "StepMode": <STEP_MODE_VALUE>,"StepSize": <STEP_SIZE_VALUE>,"TransitionTime": <TRANSITION_TIME_VALUE>,"ColorTemperatureMinimumMireds": <COLOR_TEMPERATURE_MINIMUM_MIREDS_VALUE>,"ColorTemperatureMaximumMireds": <COLOR_TEMPERATURE_MAXIMUM_MIREDS_VALUE>,"OptionsMask": <OPTIONS_MASK_VALUE>,"OptionsOverride": <OPTIONS_OVERRIDE_VALUE> }'

To receive a ColorControl/StepColorTemperature generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/GeneratedCommands/StepColorTemperature'

ColorControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "Options": {
      "type": "CCColorOptions"
    },
    "WhitePointX": {
      "type": "integer"
    },
    "WhitePointY": {
      "type": "integer"
    },
    "ColorPointRX": {
      "type": "integer"
    },
    "ColorPointRY": {
      "type": "integer"
    },
    "ColorPointRIntensity": {
      "type": "integer"
    },
    "ColorPointGX": {
      "type": "integer"
    },
    "ColorPointGY": {
      "type": "integer"
    },
    "ColorPointGIntensity": {
      "type": "integer"
    },
    "ColorPointBX": {
      "type": "integer"
    },
    "ColorPointBY": {
      "type": "integer"
    },
    "ColorPointBIntensity": {
      "type": "integer"
    },
    "StartUpColorTemperatureMireds": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ColorControl/Commands/WriteAttributes' -m  '{ "Options": <OPTIONS_VALUE> ,"WhitePointX": <WHITE_POINTX_VALUE> ,"WhitePointY": <WHITE_POINTY_VALUE> ,"ColorPointRX": <COLOR_POINTRX_VALUE> ,"ColorPointRY": <COLOR_POINTRY_VALUE> ,"ColorPointRIntensity": <COLOR_POINTR_INTENSITY_VALUE> ,"ColorPointGX": <COLOR_POINTGX_VALUE> ,"ColorPointGY": <COLOR_POINTGY_VALUE> ,"ColorPointGIntensity": <COLOR_POINTG_INTENSITY_VALUE> ,"ColorPointBX": <COLOR_POINTBX_VALUE> ,"ColorPointBY": <COLOR_POINTBY_VALUE> ,"ColorPointBIntensity": <COLOR_POINTB_INTENSITY_VALUE> ,"StartUpColorTemperatureMireds": <START_UP_COLOR_TEMPERATURE_MIREDS_VALUE>  }'

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

ColorControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ColorControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ColorControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "CurrentHue",
          "CurrentSaturation",
          "RemainingTime",
          "CurrentX",
          "CurrentY",
          "DriftCompensation",
          "CompensationText",
          "ColorTemperatureMireds",
          "ColorMode",
          "Options",
          "NumberOfPrimaries",
          "Primary1X",
          "Primary1Y",
          "Primary1Intensity",
          "Primary2X",
          "Primary2Y",
          "Primary2Intensity",
          "Primary3X",
          "Primary3Y",
          "Primary3Intensity",
          "Primary4X",
          "Primary4Y",
          "Primary4Intensity",
          "Primary5X",
          "Primary5Y",
          "Primary5Intensity",
          "Primary6X",
          "Primary6Y",
          "Primary6Intensity",
          "WhitePointX",
          "WhitePointY",
          "ColorPointRX",
          "ColorPointRY",
          "ColorPointRIntensity",
          "ColorPointGX",
          "ColorPointGY",
          "ColorPointGIntensity",
          "ColorPointBX",
          "ColorPointBY",
          "ColorPointBIntensity",
          "EnhancedCurrentHue",
          "EnhancedColorMode",
          "ColorLoopActive",
          "ColorLoopDirection",
          "ColorLoopTime",
          "ColorLoopStartEnhancedHue",
          "ColorLoopStoredEnhancedHue",
          "ColorCapabilities",
          "ColorTempPhysicalMinMireds",
          "ColorTempPhysicalMaxMireds",
          "CoupleColorTempToLevelMinMireds",
          "StartUpColorTemperatureMireds"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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