PumpConfigurationAndControl Cluster

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

PumpConfigurationAndControl Attributes

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

PumpConfigurationAndControl/MaxPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxPressure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxPressure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxPressure/Desired { "value": <DESIRED_MAX_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxPressure/Reported { "value": <REPORTED_MAX_PRESSURE>}

PumpConfigurationAndControl/MaxSpeed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxSpeed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxSpeed/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxSpeed/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxSpeed/Desired { "value": <DESIRED_MAX_SPEED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxSpeed/Reported { "value": <REPORTED_MAX_SPEED>}

PumpConfigurationAndControl/MaxFlow Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxFlow/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxFlow/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxFlow/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxFlow/Desired { "value": <DESIRED_MAX_FLOW>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxFlow/Reported { "value": <REPORTED_MAX_FLOW>}

PumpConfigurationAndControl/MinConstPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstPressure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinConstPressure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstPressure/Desired { "value": <DESIRED_MIN_CONST_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstPressure/Reported { "value": <REPORTED_MIN_CONST_PRESSURE>}

PumpConfigurationAndControl/MaxConstPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstPressure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxConstPressure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstPressure/Desired { "value": <DESIRED_MAX_CONST_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstPressure/Reported { "value": <REPORTED_MAX_CONST_PRESSURE>}

PumpConfigurationAndControl/MinCompPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinCompPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinCompPressure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinCompPressure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinCompPressure/Desired { "value": <DESIRED_MIN_COMP_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinCompPressure/Reported { "value": <REPORTED_MIN_COMP_PRESSURE>}

PumpConfigurationAndControl/MaxCompPressure Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxCompPressure/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxCompPressure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxCompPressure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxCompPressure/Desired { "value": <DESIRED_MAX_COMP_PRESSURE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxCompPressure/Reported { "value": <REPORTED_MAX_COMP_PRESSURE>}

PumpConfigurationAndControl/MinConstSpeed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstSpeed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstSpeed/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinConstSpeed/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstSpeed/Desired { "value": <DESIRED_MIN_CONST_SPEED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstSpeed/Reported { "value": <REPORTED_MIN_CONST_SPEED>}

PumpConfigurationAndControl/MaxConstSpeed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstSpeed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstSpeed/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxConstSpeed/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstSpeed/Desired { "value": <DESIRED_MAX_CONST_SPEED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstSpeed/Reported { "value": <REPORTED_MAX_CONST_SPEED>}

PumpConfigurationAndControl/MinConstFlow Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstFlow/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstFlow/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinConstFlow/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstFlow/Desired { "value": <DESIRED_MIN_CONST_FLOW>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstFlow/Reported { "value": <REPORTED_MIN_CONST_FLOW>}

PumpConfigurationAndControl/MaxConstFlow Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstFlow/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstFlow/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxConstFlow/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstFlow/Desired { "value": <DESIRED_MAX_CONST_FLOW>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstFlow/Reported { "value": <REPORTED_MAX_CONST_FLOW>}

PumpConfigurationAndControl/MinConstTemp Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstTemp/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MinConstTemp/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MinConstTemp/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstTemp/Desired { "value": <DESIRED_MIN_CONST_TEMP>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MinConstTemp/Reported { "value": <REPORTED_MIN_CONST_TEMP>}

PumpConfigurationAndControl/MaxConstTemp Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstTemp/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/MaxConstTemp/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/MaxConstTemp/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstTemp/Desired { "value": <DESIRED_MAX_CONST_TEMP>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/MaxConstTemp/Reported { "value": <REPORTED_MAX_CONST_TEMP>}

PumpConfigurationAndControl/PumpStatus Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/PumpStatus/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/PumpStatus/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/PumpStatus/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/PumpStatus/Desired { "value": <DESIRED_PUMP_STATUS>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/PumpStatus/Reported { "value": <REPORTED_PUMP_STATUS>}

PumpConfigurationAndControl/EffectiveOperationMode Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/Desired { "value": <DESIRED_EFFECTIVE_OPERATION_MODE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/EffectiveOperationMode/Reported { "value": <REPORTED_EFFECTIVE_OPERATION_MODE>}

PumpConfigurationAndControl/EffectiveControlMode Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/EffectiveControlMode/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/EffectiveControlMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/EffectiveControlMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/EffectiveControlMode/Desired { "value": <DESIRED_EFFECTIVE_CONTROL_MODE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/EffectiveControlMode/Reported { "value": <REPORTED_EFFECTIVE_CONTROL_MODE>}

PumpConfigurationAndControl/Capacity Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/Capacity/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/Capacity/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/Capacity/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Capacity/Desired { "value": <DESIRED_CAPACITY>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Capacity/Reported { "value": <REPORTED_CAPACITY>}

PumpConfigurationAndControl/Speed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/Speed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/Speed/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/Speed/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Speed/Desired { "value": <DESIRED_SPEED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Speed/Reported { "value": <REPORTED_SPEED>}

PumpConfigurationAndControl/LifetimeRunningHours Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/Desired { "value": <DESIRED_LIFETIME_RUNNING_HOURS>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/LifetimeRunningHours/Reported { "value": <REPORTED_LIFETIME_RUNNING_HOURS>}

PumpConfigurationAndControl/Power Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/Power/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/Power/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/Power/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Power/Desired { "value": <DESIRED_POWER>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/Power/Reported { "value": <REPORTED_POWER>}

PumpConfigurationAndControl/LifetimeEnergyConsumed Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/Desired { "value": <DESIRED_LIFETIME_ENERGY_CONSUMED>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/LifetimeEnergyConsumed/Reported { "value": <REPORTED_LIFETIME_ENERGY_CONSUMED>}

PumpConfigurationAndControl/OperationMode Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/OperationMode/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/OperationMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/OperationMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/OperationMode/Desired { "value": <DESIRED_OPERATION_MODE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/OperationMode/Reported { "value": <REPORTED_OPERATION_MODE>}

PumpConfigurationAndControl/ControlMode Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/ControlMode/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/ControlMode/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/ControlMode/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/ControlMode/Desired { "value": <DESIRED_CONTROL_MODE>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/ControlMode/Reported { "value": <REPORTED_CONTROL_MODE>}

PumpConfigurationAndControl/AlarmMask Attribute

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Attributes/AlarmMask/Reported
[PREFIX]/PumpConfigurationAndControl/Attributes/AlarmMask/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/PumpConfigurationAndControl/Attributes/AlarmMask/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/AlarmMask/Desired { "value": <DESIRED_ALARM_MASK>}
ucl/by-unid/<UNID>/ep0/PumpConfigurationAndControl/Attributes/AlarmMask/Reported { "value": <REPORTED_ALARM_MASK>}

PumpConfigurationAndControl/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

PumpConfigurationAndControl Command Support

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/SupportedCommands
[PREFIX]/PumpConfigurationAndControl/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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

PumpConfigurationAndControl Commands

PumpConfigurationAndControl/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "LifetimeRunningHours": {
      "type": "integer"
    },
    "Power": {
      "type": "integer"
    },
    "OperationMode": {
      "type": "PumpOperationMode"
    },
    "ControlMode": {
      "type": "PumpControlMode"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/PumpConfigurationAndControl/Commands/WriteAttributes' -m  '{ "LifetimeRunningHours": <LIFETIME_RUNNING_HOURS_VALUE> ,"Power": <POWER_VALUE> ,"OperationMode": <OPERATION_MODE_VALUE> ,"ControlMode": <CONTROL_MODE_VALUE> , }'

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

PumpConfigurationAndControl/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/PumpConfigurationAndControl/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PumpConfigurationAndControl Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "MaxPressure",
          "MaxSpeed",
          "MaxFlow",
          "MinConstPressure",
          "MaxConstPressure",
          "MinCompPressure",
          "MaxCompPressure",
          "MinConstSpeed",
          "MaxConstSpeed",
          "MinConstFlow",
          "MaxConstFlow",
          "MinConstTemp",
          "MaxConstTemp",
          "PumpStatus",
          "EffectiveOperationMode",
          "EffectiveControlMode",
          "Capacity",
          "Speed",
          "LifetimeRunningHours",
          "Power",
          "LifetimeEnergyConsumed",
          "OperationMode",
          "ControlMode",
          "AlarmMask"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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