Unify Framework UCL MQTT Reference 1.7.0
All Files Pages
WindSpeedMeasurement Cluster

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



WindSpeedMeasurement Attributes

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


WindSpeedMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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



WindSpeedMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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



WindSpeedMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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



WindSpeedMeasurement/Tolerance Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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



WindSpeedMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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



WindSpeedMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/SupportedCommands
[PREFIX]/WindSpeedMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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



WindSpeedMeasurement Commands



WindSpeedMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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



WindSpeedMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/WindSpeedMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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