Unify Framework UCL MQTT Reference 1.7.0
All Files Pages
PressureMeasurement Cluster

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



PressureMeasurement Attributes

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


PressureMeasurement/MeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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



PressureMeasurement/MinMeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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



PressureMeasurement/MaxMeasuredValue Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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



PressureMeasurement/Tolerance Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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



PressureMeasurement/ScaledValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/ScaledValue/Reported
[PREFIX]/PressureMeasurement/Attributes/ScaledValue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/ScaledValue/+'
# Example output
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/ScaledValue/Desired { "value": <DESIRED_SCALED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/ScaledValue/Reported { "value": <REPORTED_SCALED_VALUE>}



PressureMeasurement/MinScaledValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/MinScaledValue/Reported
[PREFIX]/PressureMeasurement/Attributes/MinScaledValue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/MinScaledValue/+'
# Example output
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MinScaledValue/Desired { "value": <DESIRED_MIN_SCALED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MinScaledValue/Reported { "value": <REPORTED_MIN_SCALED_VALUE>}



PressureMeasurement/MaxScaledValue Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/MaxScaledValue/Reported
[PREFIX]/PressureMeasurement/Attributes/MaxScaledValue/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/MaxScaledValue/+'
# Example output
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MaxScaledValue/Desired { "value": <DESIRED_MAX_SCALED_VALUE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/MaxScaledValue/Reported { "value": <REPORTED_MAX_SCALED_VALUE>}



PressureMeasurement/ScaledTolerance Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/ScaledTolerance/Reported
[PREFIX]/PressureMeasurement/Attributes/ScaledTolerance/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/ScaledTolerance/+'
# Example output
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/ScaledTolerance/Desired { "value": <DESIRED_SCALED_TOLERANCE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/ScaledTolerance/Reported { "value": <REPORTED_SCALED_TOLERANCE>}



PressureMeasurement/Scale Attribute

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Attributes/Scale/Reported
[PREFIX]/PressureMeasurement/Attributes/Scale/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PressureMeasurement/Attributes/Scale/+'
# Example output
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/Scale/Desired { "value": <DESIRED_SCALE>}
ucl/by-unid/<UNID>/ep0/PressureMeasurement/Attributes/Scale/Reported { "value": <REPORTED_SCALE>}



PressureMeasurement/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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



PressureMeasurement Command Support

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/SupportedCommands
[PREFIX]/PressureMeasurement/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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



PressureMeasurement Commands



PressureMeasurement/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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



PressureMeasurement/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PressureMeasurement/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

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