Metering Cluster

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

Metering Attributes

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

Metering/CurrentSummationDelivered Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentSummationDelivered/Reported
[PREFIX]/Metering/Attributes/CurrentSummationDelivered/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentSummationDelivered/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentSummationDelivered/Desired { "value": <DESIRED_CURRENT_SUMMATION_DELIVERED>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentSummationDelivered/Reported { "value": <REPORTED_CURRENT_SUMMATION_DELIVERED>}

Metering/CurrentSummationReceived Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentSummationReceived/Reported
[PREFIX]/Metering/Attributes/CurrentSummationReceived/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentSummationReceived/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentSummationReceived/Desired { "value": <DESIRED_CURRENT_SUMMATION_RECEIVED>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentSummationReceived/Reported { "value": <REPORTED_CURRENT_SUMMATION_RECEIVED>}

Metering/CurrentMaxDemandDelivered Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentMaxDemandDelivered/Reported
[PREFIX]/Metering/Attributes/CurrentMaxDemandDelivered/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentMaxDemandDelivered/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandDelivered/Desired { "value": <DESIRED_CURRENT_MAX_DEMAND_DELIVERED>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandDelivered/Reported { "value": <REPORTED_CURRENT_MAX_DEMAND_DELIVERED>}

Metering/CurrentMaxDemandReceived Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentMaxDemandReceived/Reported
[PREFIX]/Metering/Attributes/CurrentMaxDemandReceived/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentMaxDemandReceived/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandReceived/Desired { "value": <DESIRED_CURRENT_MAX_DEMAND_RECEIVED>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandReceived/Reported { "value": <REPORTED_CURRENT_MAX_DEMAND_RECEIVED>}

Metering/PowerFactor Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/PowerFactor/Reported
[PREFIX]/Metering/Attributes/PowerFactor/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/PowerFactor/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/PowerFactor/Desired { "value": <DESIRED_POWER_FACTOR>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/PowerFactor/Reported { "value": <REPORTED_POWER_FACTOR>}

Metering/ReadingSnapShotTime Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/ReadingSnapShotTime/Reported
[PREFIX]/Metering/Attributes/ReadingSnapShotTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/ReadingSnapShotTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/ReadingSnapShotTime/Desired { "value": <DESIRED_READING_SNAP_SHOT_TIME>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/ReadingSnapShotTime/Reported { "value": <REPORTED_READING_SNAP_SHOT_TIME>}

Metering/CurrentMaxDemandDeliveredTime Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentMaxDemandDeliveredTime/Reported
[PREFIX]/Metering/Attributes/CurrentMaxDemandDeliveredTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentMaxDemandDeliveredTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandDeliveredTime/Desired { "value": <DESIRED_CURRENT_MAX_DEMAND_DELIVERED_TIME>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandDeliveredTime/Reported { "value": <REPORTED_CURRENT_MAX_DEMAND_DELIVERED_TIME>}

Metering/CurrentMaxDemandReceivedTime Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentMaxDemandReceivedTime/Reported
[PREFIX]/Metering/Attributes/CurrentMaxDemandReceivedTime/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentMaxDemandReceivedTime/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandReceivedTime/Desired { "value": <DESIRED_CURRENT_MAX_DEMAND_RECEIVED_TIME>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentMaxDemandReceivedTime/Reported { "value": <REPORTED_CURRENT_MAX_DEMAND_RECEIVED_TIME>}

Metering/DefaultUpdatePeriod Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/DefaultUpdatePeriod/Reported
[PREFIX]/Metering/Attributes/DefaultUpdatePeriod/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/DefaultUpdatePeriod/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/DefaultUpdatePeriod/Desired { "value": <DESIRED_DEFAULT_UPDATE_PERIOD>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/DefaultUpdatePeriod/Reported { "value": <REPORTED_DEFAULT_UPDATE_PERIOD>}

Metering/SupplyStatus Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/SupplyStatus/Reported
[PREFIX]/Metering/Attributes/SupplyStatus/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/SupplyStatus/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/SupplyStatus/Desired { "value": <DESIRED_SUPPLY_STATUS>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/SupplyStatus/Reported { "value": <REPORTED_SUPPLY_STATUS>}

Metering/CurrentInletEnergyCarrierSummation Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentInletEnergyCarrierSummation/Reported
[PREFIX]/Metering/Attributes/CurrentInletEnergyCarrierSummation/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentInletEnergyCarrierSummation/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentInletEnergyCarrierSummation/Desired { "value": <DESIRED_CURRENT_INLET_ENERGY_CARRIER_SUMMATION>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentInletEnergyCarrierSummation/Reported { "value": <REPORTED_CURRENT_INLET_ENERGY_CARRIER_SUMMATION>}

Metering/CurrentOutletEnergyCarrierSummation Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/CurrentOutletEnergyCarrierSummation/Reported
[PREFIX]/Metering/Attributes/CurrentOutletEnergyCarrierSummation/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/CurrentOutletEnergyCarrierSummation/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentOutletEnergyCarrierSummation/Desired { "value": <DESIRED_CURRENT_OUTLET_ENERGY_CARRIER_SUMMATION>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/CurrentOutletEnergyCarrierSummation/Reported { "value": <REPORTED_CURRENT_OUTLET_ENERGY_CARRIER_SUMMATION>}

Metering/InletTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/InletTemperature/Reported
[PREFIX]/Metering/Attributes/InletTemperature/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/InletTemperature/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/InletTemperature/Desired { "value": <DESIRED_INLET_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/InletTemperature/Reported { "value": <REPORTED_INLET_TEMPERATURE>}

Metering/OutletTemperature Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/OutletTemperature/Reported
[PREFIX]/Metering/Attributes/OutletTemperature/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/OutletTemperature/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/OutletTemperature/Desired { "value": <DESIRED_OUTLET_TEMPERATURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/OutletTemperature/Reported { "value": <REPORTED_OUTLET_TEMPERATURE>}

Metering/UnitofMeasure Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/UnitofMeasure/Reported
[PREFIX]/Metering/Attributes/UnitofMeasure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/UnitofMeasure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/UnitofMeasure/Desired { "value": <DESIRED_UNITOF_MEASURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/UnitofMeasure/Reported { "value": <REPORTED_UNITOF_MEASURE>}

Metering/Multiplier Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/Multiplier/Reported
[PREFIX]/Metering/Attributes/Multiplier/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/Multiplier/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/Multiplier/Desired { "value": <DESIRED_MULTIPLIER>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/Multiplier/Reported { "value": <REPORTED_MULTIPLIER>}

Metering/Divisor Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/Divisor/Reported
[PREFIX]/Metering/Attributes/Divisor/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/Divisor/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/Divisor/Desired { "value": <DESIRED_DIVISOR>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/Divisor/Reported { "value": <REPORTED_DIVISOR>}

Metering/SummationFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/SummationFormatting/Reported
[PREFIX]/Metering/Attributes/SummationFormatting/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/SummationFormatting/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/SummationFormatting/Desired { "value": <DESIRED_SUMMATION_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/SummationFormatting/Reported { "value": <REPORTED_SUMMATION_FORMATTING>}

Metering/DemandFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/DemandFormatting/Reported
[PREFIX]/Metering/Attributes/DemandFormatting/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/DemandFormatting/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/DemandFormatting/Desired { "value": <DESIRED_DEMAND_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/DemandFormatting/Reported { "value": <REPORTED_DEMAND_FORMATTING>}

Metering/HistoricalConsumptionFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/HistoricalConsumptionFormatting/Reported
[PREFIX]/Metering/Attributes/HistoricalConsumptionFormatting/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/HistoricalConsumptionFormatting/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/HistoricalConsumptionFormatting/Desired { "value": <DESIRED_HISTORICAL_CONSUMPTION_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/HistoricalConsumptionFormatting/Reported { "value": <REPORTED_HISTORICAL_CONSUMPTION_FORMATTING>}

Metering/MeteringDeviceType Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/MeteringDeviceType/Reported
[PREFIX]/Metering/Attributes/MeteringDeviceType/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/MeteringDeviceType/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/MeteringDeviceType/Desired { "value": <DESIRED_METERING_DEVICE_TYPE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/MeteringDeviceType/Reported { "value": <REPORTED_METERING_DEVICE_TYPE>}

Metering/EnergyCarrierUnitOfMeasure Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/EnergyCarrierUnitOfMeasure/Reported
[PREFIX]/Metering/Attributes/EnergyCarrierUnitOfMeasure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/EnergyCarrierUnitOfMeasure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierUnitOfMeasure/Desired { "value": <DESIRED_ENERGY_CARRIER_UNIT_OF_MEASURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierUnitOfMeasure/Reported { "value": <REPORTED_ENERGY_CARRIER_UNIT_OF_MEASURE>}

Metering/EnergyCarrierSummationFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/EnergyCarrierSummationFormatting/Reported
[PREFIX]/Metering/Attributes/EnergyCarrierSummationFormatting/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/EnergyCarrierSummationFormatting/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierSummationFormatting/Desired { "value": <DESIRED_ENERGY_CARRIER_SUMMATION_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierSummationFormatting/Reported { "value": <REPORTED_ENERGY_CARRIER_SUMMATION_FORMATTING>}

Metering/EnergyCarrierDemandFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/EnergyCarrierDemandFormatting/Reported
[PREFIX]/Metering/Attributes/EnergyCarrierDemandFormatting/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/EnergyCarrierDemandFormatting/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierDemandFormatting/Desired { "value": <DESIRED_ENERGY_CARRIER_DEMAND_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/EnergyCarrierDemandFormatting/Reported { "value": <REPORTED_ENERGY_CARRIER_DEMAND_FORMATTING>}

Metering/TemperatureUnitOfMeasure Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/TemperatureUnitOfMeasure/Reported
[PREFIX]/Metering/Attributes/TemperatureUnitOfMeasure/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/TemperatureUnitOfMeasure/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/TemperatureUnitOfMeasure/Desired { "value": <DESIRED_TEMPERATURE_UNIT_OF_MEASURE>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/TemperatureUnitOfMeasure/Reported { "value": <REPORTED_TEMPERATURE_UNIT_OF_MEASURE>}

Metering/TemperatureFormatting Attribute

MQTT Topic Pattern:

[PREFIX]/Metering/Attributes/TemperatureFormatting/Reported
[PREFIX]/Metering/Attributes/TemperatureFormatting/Desired

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

mosquitto_sub -t 'ucl/by-unid/+/+/Metering/Attributes/TemperatureFormatting/+'
 
# Example output
 
ucl/by-unid/<UNID>/ep0/Metering/Attributes/TemperatureFormatting/Desired { "value": <DESIRED_TEMPERATURE_FORMATTING>}
ucl/by-unid/<UNID>/ep0/Metering/Attributes/TemperatureFormatting/Reported { "value": <REPORTED_TEMPERATURE_FORMATTING>}

Metering/ClusterRevision Attribute

MQTT Topic Pattern:

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

MQTT Payload JSON Schema:

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

Metering Command Support

MQTT Topic Pattern:

[PREFIX]/Metering/SupportedCommands
[PREFIX]/Metering/SupportedGeneratedCommands

MQTT Payload JSON Schema:

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

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

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

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

Metering Commands

Metering/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/Metering/Commands/WriteAttributes

MQTT Payload JSON Schema:

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

Example Mosquitto CLI Tool Usage

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

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

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

Metering/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/Metering/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Metering Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "CurrentSummationDelivered",
          "CurrentSummationReceived",
          "CurrentMaxDemandDelivered",
          "CurrentMaxDemandReceived",
          "PowerFactor",
          "ReadingSnapShotTime",
          "CurrentMaxDemandDeliveredTime",
          "CurrentMaxDemandReceivedTime",
          "DefaultUpdatePeriod",
          "SupplyStatus",
          "CurrentInletEnergyCarrierSummation",
          "CurrentOutletEnergyCarrierSummation",
          "InletTemperature",
          "OutletTemperature",
          "UnitofMeasure",
          "Multiplier",
          "Divisor",
          "SummationFormatting",
          "DemandFormatting",
          "HistoricalConsumptionFormatting",
          "MeteringDeviceType",
          "EnergyCarrierUnitOfMeasure",
          "EnergyCarrierSummationFormatting",
          "EnergyCarrierDemandFormatting",
          "TemperatureUnitOfMeasure",
          "TemperatureFormatting"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

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

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

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

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