Unify Framework UCL MQTT Reference 1.7.0
All Files Pages
DeviceTemperatureConfiguration Cluster

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



DeviceTemperatureConfiguration Attributes

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


DeviceTemperatureConfiguration/CurrentTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/Desired { "value": <DESIRED_CURRENT_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/CurrentTemperature/Reported { "value": <REPORTED_CURRENT_TEMPERATURE>}



DeviceTemperatureConfiguration/MinTempExperienced Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/Desired { "value": <DESIRED_MIN_TEMP_EXPERIENCED>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/MinTempExperienced/Reported { "value": <REPORTED_MIN_TEMP_EXPERIENCED>}



DeviceTemperatureConfiguration/MaxTempExperienced Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/Desired { "value": <DESIRED_MAX_TEMP_EXPERIENCED>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/MaxTempExperienced/Reported { "value": <REPORTED_MAX_TEMP_EXPERIENCED>}



DeviceTemperatureConfiguration/OverTempTotalDwell Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/Desired { "value": <DESIRED_OVER_TEMP_TOTAL_DWELL>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/OverTempTotalDwell/Reported { "value": <REPORTED_OVER_TEMP_TOTAL_DWELL>}



DeviceTemperatureConfiguration/DeviceTempAlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/Desired { "value": <DESIRED_DEVICE_TEMP_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/DeviceTempAlarmMask/Reported { "value": <REPORTED_DEVICE_TEMP_ALARM_MASK>}



DeviceTemperatureConfiguration/LowTempThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/Desired { "value": <DESIRED_LOW_TEMP_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/LowTempThreshold/Reported { "value": <REPORTED_LOW_TEMP_THRESHOLD>}



DeviceTemperatureConfiguration/HighTempThreshold Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/Desired { "value": <DESIRED_HIGH_TEMP_THRESHOLD>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/HighTempThreshold/Reported { "value": <REPORTED_HIGH_TEMP_THRESHOLD>}



DeviceTemperatureConfiguration/LowTempDwellTripPoint Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/Desired { "value": <DESIRED_LOW_TEMP_DWELL_TRIP_POINT>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/LowTempDwellTripPoint/Reported { "value": <REPORTED_LOW_TEMP_DWELL_TRIP_POINT>}



DeviceTemperatureConfiguration/HighTempDwellTripPoint Attribute

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/Reported
[PREFIX]/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/+'
# Example output
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/Desired { "value": <DESIRED_HIGH_TEMP_DWELL_TRIP_POINT>}
ucl/by-unid/<UNID>/ep0/DeviceTemperatureConfiguration/Attributes/HighTempDwellTripPoint/Reported { "value": <REPORTED_HIGH_TEMP_DWELL_TRIP_POINT>}



DeviceTemperatureConfiguration/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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



DeviceTemperatureConfiguration Command Support

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/SupportedCommands
[PREFIX]/DeviceTemperatureConfiguration/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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



DeviceTemperatureConfiguration Commands



DeviceTemperatureConfiguration/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DeviceTemperatureConfiguration Cluster WriteAttributes Command Properties",
"type": "object",
"properties": {
"DeviceTempAlarmMask": {
"type": "DeviceTemperatureConfigurationDeviceTempAlarmMask"
},
"LowTempThreshold": {
"type": "integer"
},
"HighTempThreshold": {
"type": "integer"
},
"LowTempDwellTripPoint": {
"type": "integer"
},
"HighTempDwellTripPoint": {
"type": "integer"
}
},
"required": [
"value"
]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/DeviceTemperatureConfiguration/Commands/WriteAttributes' -m '{ "DeviceTempAlarmMask": <DEVICE_TEMP_ALARM_MASK_VALUE> ,"LowTempThreshold": <LOW_TEMP_THRESHOLD_VALUE> ,"HighTempThreshold": <HIGH_TEMP_THRESHOLD_VALUE> ,"LowTempDwellTripPoint": <LOW_TEMP_DWELL_TRIP_POINT_VALUE> ,"HighTempDwellTripPoint": <HIGH_TEMP_DWELL_TRIP_POINT_VALUE> }'

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



DeviceTemperatureConfiguration/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/DeviceTemperatureConfiguration/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DeviceTemperatureConfiguration Cluster ForceReadAttributes Command Properties",
"type": "object",
"properties": {
"value": {
"type": "array"
"items": {
"type": "string",
"enum": [
"CurrentTemperature",
"MinTempExperienced",
"MaxTempExperienced",
"OverTempTotalDwell",
"DeviceTempAlarmMask",
"LowTempThreshold",
"HighTempThreshold",
"LowTempDwellTripPoint",
"HighTempDwellTripPoint"
]
}
}
},
"required": [
"value"
]
}

Example Mosquitto CLI Tool Usage

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

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

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

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