This Use Case is solely to allocate a Message Code to be recorded in the ESME Event Log when an authenticated ZSE Select Available Emergency Credit command is received by the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| PECS02 | Activate Emergency Credit on ESME from PPMID | 0x0117 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | HAN Only Message |
| Message Type | ZSE specified |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | N/A |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| (none) |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|
| Target | |
|---|---|
| Message Code | 0x0117 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|
This Use Case is for a PPMID to send an Active Emergency Credit Command to a Smart Meter.
| Use Case | Title | Message Code |
|---|---|---|
| PCS02 | Activate Emergency Credit on GSME from PPMID | 0x0090 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | HAN Only Message |
| Message Type | SME.C.PPMID-GSME |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1499 |
SMETS 4.5.3.1 |
EmergencyCredit | select | Activate emergency credit if emergency credit can be activated. |
Method | Method |
| Target | GSME |
|---|---|
| Message Code | 0x0090 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1499 | SMETS 4.5.3.1 | EmergencyCredit: select | -- | -- | Prepayment: 0x0705 |
This Use Case is for remotely activating the emergency credit on the Smart Meter. If, after the Device has executed this Command, emergency credit is activated on the Device then the Device shall return a Response indicating the Command executed successfully. This shall be so regardless of whether emergency credit was activated on the Device prior to the Command's execution or not. If, after the Device has executed this Command, Emergency Credit is not activated on the Device, then the Device shall return a Response indicating the Command did not execute successfully. In such cases, the ZSE Default Response command responding to the 'Select Available Emergency Credit' command shall report a status of FAILURE (0x01) and the response to the DLMS COSEM 'invoke_credit' method invocation shall report a result of 'other-reason (250)'.
| Use Case | Title | Message Code |
|---|---|---|
| ECS09 | Activate Emergency Credit Remotely on ESME | 0x0020 |
| GCS06 | Activate Emergency Credit Remotely on GSME | 0x0070 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 2.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1050 |
SMETS 4.6.5.8 SMETS 5.6.3.1 / 5.7.5.15 |
EmergencyCredit | select | Activate emergency credit if emergency credit can be activated. |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x0020 |
See SMETS (Activate Emergency Credit).
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1050 |
SMETS 5.6.3.1 / 5.7.5.15 |
EmergencyCredit: select | 112 | 0-0:19.10.1.255 | M | 3 | invoke_credit | integer | 0 |
| Target | GSME |
|---|---|
| Message Code | 0x0070 |
See SMETS (Activate Emergency Credit).
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1050 | SMETS 4.6.5.8 | EmergencyCredit: select | -- | -- | Prepayment: 0x0705 |
This Use Case adds a Device to the 'whitelist' on the Communications Hub.
The 'whitelist' is called the CHF Device Log in CHTS.
If a Device is not on this whitelist, it cannot communicate over the HAN.
If a CH receives a CCS01 Command for a Device whose Device ID is already in its CHF Device Log, the CH shall discard the key parameter in the register_device method invocation without processing that parameter. For clarity, such a CCS01 Command shall not affect any Link Key held by the CH and the register_device method shall return a result of 'success' in the corresponding action-result-action. Having authenticated the Command, the CHF shall add the Device to its CHF Device Log and so send a CS14 Alert containing the updated CHF Device Log. For clarity and in line with CS14 requirements, since the CHF has not established a TC Link Key to use with the Device at this point, the value of the hashed_TC_link_key field shall be a zero length string in this Alert.
The CHF shall then check whether the value in the ieee_address parameter is for a Device Entity Identifier in its CHF Historic Device Log.
If it is not in its CHF Historic Device Log, the CHF shall allow SMHAN joining based on the Install Code specified in the key parameter, for the period specified in the join_timeout parameter.
If the value in the ieee_address parameter is for a Device Entity Identifier in its CHF Historic Device Log, the CHF shall, for the period specified in the join_timeout parameter, allow communications based on the associated TC Link Key in the CHF Historic Device Log.
If communications with the Device using that historic TC Link Key begin within the period specified in the join_timeout parameter, the CHF shall record that historic TC Link Key against the Device's Entity Identifier in its CHF Device Log. Since this changes the CHF Device Log, the CHF shall send a CS14 Alert containing the Device?s Entity Identifier and the associated Hash of this re-used TC Link Key.
If communications with the Device using that historic TC Link Key do not begin within the period specified in the join_timeout parameter, the CHF shall then allow SMHAN joining using the Install Code specified in the key parameter for the period specified in the join_timeout parameter.
| Use Case | Title | Message Code |
|---|---|---|
| CCS01 | Add Device to CHF device log | 0x0001 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 8.11 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1004 |
CHTS 4.5.1.2 |
DeviceLog(CHF) | addEntry | Add an entry to the Device Log using the details in entryToBeAdded |
Method | Method |
| 1000 |
CHTS 4.5.1.2 |
DeviceLog(CHF) | methodInput: entryToBeAdded.credentialsType | The type of installationCredentials supplied for a device to be added by the addEntry method |
Method Input | ENUMERATION |
| 1001 |
CHTS 4.5.1.2 |
DeviceLog(CHF) | methodInput: entryToBeAdded.deviceType | The type of the device to be added by the addEntry method. In addition to the values of this enumeration in the Blue Book, the CHF shall support the value 254 for GPF and interpret the value accordingly. |
Method Input | ENUMERATION |
| 1002 |
CHTS 4.5.1.2 |
DeviceLog(CHF) | methodInput: entryToBeAdded.entityIdentifier | Device Identifier of a device to be added by the addEntry method |
Method Input | OCTET-STRING |
| 1003 |
CHTS 4.5.1.2 |
DeviceLog(CHF) | methodInput: entryToBeAdded.installationCredentials | Installation Credentials of the device to be added by the addEntry method |
Method Input | OCTET-STRING |
| Target | CHF |
|---|---|
| Message Code | 0x0001 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1004 |
CHTS 4.5.1.2 |
DeviceLog(CHF): addEntry | 104 | 0-0:30.3.0.255 | M | 1 | register_device | - | ||
| 1002 |
CHTS 4.5.1.2 |
DeviceLog(CHF): methodInput: entryToBeAdded.entityIdentifier | 104 | 0-0:30.3.0.255 | M | 1 | register_device:register_device.ieee_address | octet-string(8) | - | Input parameter of register_device method. This is the Entity Identifier in an octet-string(8) as allocated at manufacture |
| 1000 |
CHTS 4.5.1.2 |
DeviceLog(CHF): methodInput: entryToBeAdded.credentialsType | 104 | 0-0:30.3.0.255 | M | 1 | register_device:register_device.key_type | enum | 1 | Input parameter of register_device method. Specifies the type of information in data.key: (1) = Install code |
| 1003 |
CHTS 4.5.1.2 |
DeviceLog(CHF): methodInput: entryToBeAdded.installationCredentials | 104 | 0-0:30.3.0.255 | M | 1 | register_device:register_device.key | octet-string(16) | - | Input parameter of register_device method. The octet-string containing an Install Code. As per Table 5-10 of the ZSE specification, this is a 16 octet string (so is a 128 bit install code). Note that it does not include the 16 bit CRC |
| 1001 |
CHTS 4.5.1.2 |
DeviceLog(CHF): methodInput: entryToBeAdded.deviceType | 104 | 0-0:30.3.0.255 | M | 1 | register_device:register_device.device_type | enum | - | Input parameter of register_device method. Specifies the type of the device. In terms of SMETS definitions, the valid values are: 0 = ESME 1 = GSME 13 = HC ALCS (HAN Connected Auxiliary Load Control Switch) 128 = IHD 130 = CAD (Consumer Access Device) 132 = PPMID |
| 985 |
(DLMS) |
DeviceLog(CHF): joiningTimePeriod | 104 | 0-0:30.3.0.255 | A | 3 | join_timeout | long-unsigned | - | The time joining remains open in seconds after the enable_disable_joining attribute is set to true |
| 984 |
(DLMS) |
DeviceLog(CHF): allowsDevicesOnToTheHAN | 104 | 0-0:30.3.0.255 | A | 2 | enable_disable_joining | boolean | ||0x01 | Setting to TRUE opens the HAN for device joining. The device will reset the value to false after join_timeout seconds |
This Use Case is for adjusting the credit mode meter balance on the GSME.
The adjustment of this meter balance in this Use Case is an incremental/decremental adjustment, rather than an absolute setting of this meter balance. This Use Case adjusts the ZSE attribute BillToDateDelivered. Consumption causes this attribute to increase, as opposed to the SMETS Meter Balance which decreases with consumption. Therefore the GSME shall subtract the adjustment provided as a parameter in this Use Case from BillToDateDelivered.
| Use Case | Title | Message Code |
|---|---|---|
| GCS40c | Adjust Credit Mode Meter Balance on the GSME | 0x00C0 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 1.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1785 |
SMETS 4.5.3.6 |
MeterBalance | method: adjustCreditMode | Applies the adjustment |
Method | Method |
| 1844 |
SMETS 4.5.3.6 |
MeterBalance | methodInput: adjustmentValue | The amount by which the Meter Balance is to be adjusted |
Method Input | INTEGER |
| Target | GSME |
|---|---|
| Message Code | 0x00C0 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1785 | SMETS 4.5.3.6 | MeterBalance: adjustCreditMode | ENUM8 | Credit Adjustment Type 3 = incremental, applies to Metering:BillToDateDelivered
This is a GBZ-specific interpretation of the Credit Adjustment command |
Prepayment: 0x0705 | Credit Adjustment : 0x05 | ZCL Default Response : 0x0B |
| 1844 | SMETS 4.5.3.6 | MeterBalance: methodInput: adjustmentValue | INT32 | Credit Adjustment Value -0x7FFFFFFF -
+0x7FFFFFFF |
This Use Case is for setting the credit mode meter balance on the GSME to Zero.
| Use Case | Title | Message Code |
|---|---|---|
| GCS40d | Reset Credit Mode Meter Balance on the GSME | 0x00C2 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 1.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1786 |
SMETS 4.5.3.19 |
MeterBalance | resetCreditMode | set MeterBalance(credit mode).value = 0 |
Method | Method |
| Target | GSME |
|---|---|
| Message Code | 0x00C2 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1786 | SMETS 4.5.3.19 | MeterBalance: resetCreditMode | ENUM8 | Credit Adjustment Type 2 = absolute, applies to Metering:BillToDateDelivered
This is a GBZ-specific interpretation of the Credit Adjustment command |
Prepayment: 0x0705 |
This Use Case is for adjusting the meter balance on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS04a | Adjust Meter Balance on the ESME | 0x001C |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 1.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1045 |
SMETS 4.5.3.6 SMETS 5.6.3.6 / 5.7.5.22 |
MeterBalance | adjust | Applies the adjustment |
Method | Method |
| 1047 |
SMETS 4.5.3.6 SMETS 5.6.3.6 / 5.7.5.22 |
MeterBalance | methodInput: adjustmentValue | The value of the adjustment |
Method Input | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x001C |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1045 |
SMETS 5.6.3.6 / 5.7.5.22 |
MeterBalance: adjust | 112 | 0-0:19.10.0.255 | M | 1 | update_amount | double-long | - | Method to adjust meter balance by the amount specified |
| 1047 |
SMETS 5.6.3.6 / 5.7.5.22 |
MeterBalance: methodInput: adjustmentValue | 112 | 0-0:19.10.0.255 | M | 1 | update_amount:data | double-long | - | the change to meter balance (in millipence) |
This Use Case is for setting the meter balance on the ESME to Zero.
In processing an authentic Command, the ESME shall undertake the processing required by the SMETS 'Reset Meter Balance' function.
| Use Case | Title | Message Code |
|---|---|---|
| ECS04b | Reset Meter Balance on the ESME | 0x00B3 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 1.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1048 |
SMETS 4.5.3.19 SMETS 5.6.3.29 |
AccumulatedDebtRegister | reset | set AccumulatedDebtRegister.value = 0 |
Method | Method |
| 7 |
SMETS 4.5.3.19 SMETS 5.6.3.29 |
EmergencyCreditBalance | reset | In line with ZSE, the Emergency Credit Balance shall be equal to the Emergency Credit Limit whenever there is no Emergency Credit owing, and so must have that value when this Use Case successfully completes. Therefore, whenever ESME actions an ECS04b Command containing a set_amount_ to_value method with a zero value on object with OBIS code 0-0:19.10.1.255, it shall, having responded to that Command, then set the corresponding current_credit_amount attribute value to the value of the Emergency Credit Limit. |
Method | Method |
| 1049 |
SMETS 4.5.3.19 SMETS 5.6.3.29 |
MeterBalance | reset | set MeterBalance.value = 0 |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x00B3 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1049 |
SMETS 5.6.3.29 |
MeterBalance: reset | 112 | 0-0:19.10.0.255 | M | 2 | set_amount_to_value | double-long | ||0x00000000 | |
| 7 |
SMETS 5.6.3.29 |
EmergencyCreditBalance: reset | 112 | 0-0:19.10.1.255 | M | 2 | set_amount_to_value | double-long | ||0x00000000 | |
| 1048 |
SMETS 5.6.3.29 |
AccumulatedDebtRegister: reset | 112 | 0-0:19.10.2.255 | M | 2 | set_amount_to_value | double-long | ||0x00000000 |
This Use Case is for adjusting the prepayment mode meter balance on the GSME.
The adjustment of this meter balance in this Use Case is an incremental/decremental adjustment, rather than an absolute setting of this meter balance.
The prepayment mode meter balance is held in a separate ZigBee Cluster to the credit mode meter balance. This Use Case therefore covers GSME Prepayment only. See GCS40c/GCS40d for interacting with the credit mode balance.
| Use Case | Title | Message Code |
|---|---|---|
| GCS40a | Adjust Prepayment Mode Meter Balance on the GSME | 0x0086 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 1.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1045 |
SMETS 4.5.3.6 SMETS 5.6.3.6 / 5.7.5.22 |
MeterBalance | adjust | Applies the adjustment |
Method | Method |
| 1047 |
SMETS 4.5.3.6 SMETS 5.6.3.6 / 5.7.5.22 |
MeterBalance | methodInput: adjustmentValue | The value of the adjustment |
Method Input | INTEGER |
| Target | GSME |
|---|---|
| Message Code | 0x0086 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1045 | SMETS 4.5.3.6 | MeterBalance: adjust | ENUM8 | Credit Adjustment Type 0 = incremental |
Prepayment: 0x0705 | Credit Adjustment : 0x05 | ZCL Default Response : 0x0B |
| 1047 | SMETS 4.5.3.6 | MeterBalance: methodInput: adjustmentValue | INT32 | Credit Adjustment Value -0x7FFFFFFF -
+0x7FFFFFFF |
This Use Case is for setting the prepayment mode meter balance on the GSME to Zero.
The prepayment mode meter balance is held in a separate ZigBee Cluster to the credit mode meter balance. This Use Case therefore covers GSME Prepayment only. See GCS40c/GCS40d for interacting with the credit mode balance.
In processing an authentic Command, the GSME shall undertake the processing required by the SMETS 'Reset Meter Balance' function.
| Use Case | Title | Message Code |
|---|---|---|
| GCS40b | Reset Prepayment Mode Meter Balance on the GSME | 0x00B4 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 1.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1048 |
SMETS 4.5.3.19 SMETS 5.6.3.29 |
AccumulatedDebtRegister | reset | set AccumulatedDebtRegister.value = 0 |
Method | Method |
| 7 |
SMETS 4.5.3.19 SMETS 5.6.3.29 |
EmergencyCreditBalance | reset | In line with ZSE, the Emergency Credit Balance shall be equal to the Emergency Credit Limit whenever there is no Emergency Credit owing, and so must have that value when this Use Case successfully completes. Therefore, whenever ESME actions an ECS04b Command containing a set_amount_ to_value method with a zero value on object with OBIS code 0-0:19.10.1.255, it shall, having responded to that Command, then set the corresponding current_credit_amount attribute value to the value of the Emergency Credit Limit. |
Method | Method |
| 1049 |
SMETS 4.5.3.19 SMETS 5.6.3.29 |
MeterBalance | reset | set MeterBalance.value = 0 |
Method | Method |
| Target | GSME |
|---|---|
| Message Code | 0x00B4 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 7 | SMETS 4.5.3.19 | EmergencyCreditBalance: reset | ENUM8 | Credit Adjustment Type 1 = absolute |
Prepayment: 0x0705 | Credit Adjustment : 0x05 | ZCL Default Response : 0x0B |
| 1048 | SMETS 4.5.3.19 | AccumulatedDebtRegister: reset | ENUM8 | Credit Adjustment Type 1 = absolute |
|||
| 1049 | SMETS 4.5.3.19 | MeterBalance: reset | ENUM8 | Credit Adjustment Type 1 = absolute |
This Use Case is solely to allocate a Message Code to be recorded in the ESME Event Log when an authenticated ZSE Consumer Top Up command is received by the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| PECS01 | Apply Prepayment Top Up to an ESME using PPMID | 0x0116 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | HAN Only Message |
| Message Type | ZSE specified |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | N/A |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| (none) |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|
| Target | |
|---|---|
| Message Code | 0x0116 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|
This Use Case is for a PPMID to add credit to a Smart Meter.
| Use Case | Title | Message Code |
|---|---|---|
| PCS01 | Apply Prepayment Top Up to a GSME using PPMID | 0x009B |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | HAN Only Message |
| Message Type | SME.C.PPMID-GSME |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 90 |
SMETS 4.5.3.3 |
PrepaymentCredit | methodInput: creditToken | Input parameter to addCreditMethod |
Method Input | OCTET-STRING |
| Target | GSME |
|---|---|
| Message Code | 0x009B |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 90 | SMETS 4.5.3.3 | PrepaymentCredit: methodInput: creditToken | OCTETSTRING[n] | TopUp Code n = 20; UTRN |
Prepayment: 0x0705 |
This Use Case enables a UTRN to be applied to a meter to top up the meter balance. See also section 14.
| Use Case | Title | Message Code |
|---|---|---|
| CS01a | Apply Prepayment Top Up to an ESME | 0x0007 |
| CS01b | Apply Prepayment Top Up to a GSME | 0x0097 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC but with additional cryptographic processing specified in GBCS Sections 14.3.4 and 14.3.5 |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 2.2 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| See GBCS |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1164 |
SMETS 5.6.3.3 |
PrepaymentCredit | addCredit | Function to process a prepayment credit, the parameter passed being the prepayment credit |
Method | Method |
| 1165 |
SMETS 4.5.3.3 SMETS 5.6.3.3 |
PrepaymentCredit | methodInput: creditToken | The 20 digit UTRN as a 20 octet long octet string in visible string format |
Method Input | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x0007 |
See SMETS (Add Credit).
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1164 |
SMETS 5.6.3.3 |
PrepaymentCredit: addCredit | 115 | 0-0:19.40.0.255 | M | 1 | enter | - | ||
| 1165 |
SMETS 5.6.3.3 |
PrepaymentCredit: methodInput: creditToken | 115 | 0-0:19.40.0.255 | M | 1 | enter:data | octet-string(20) | - |
| Target | GSME |
|---|---|
| Message Code | 0x0097 |
See SMETS (Add Credit).
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1165 | SMETS 4.5.3.3 | PrepaymentCredit: methodInput: creditToken | OCTETSTRING[n] | TopUp Code n = 20; UTRN |
Prepayment: 0x0705 |
This Use Case is to remotely arm the Load Switch/Valve on the Smart Meter.
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 7.3 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 945 |
SMETS 4.5.3.7 SMETS 5.6.3.7 |
SupplyState | arm | This arms the supply if the conditions required in SMETS are met. |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x0051 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 945 |
SMETS 5.6.3.7 |
SupplyState: arm | 9 | 0-0:10.0.106.255 | M | 1 | execute:data | long-unsigned | ||0x0036 | Script 54 = remote Supply Arm |
| Target | GSME |
|---|---|
| Message Code | 0x0085 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 945 | SMETS 4.5.3.7 | SupplyState: arm | ENUM8 | Proposed Supply Status (after Implementation) 1= Arm supply |
Metering: 0x0702 |
This Use Case is for clearing the Auxiliary Controller Event Log, with its SMETS meaning.
| Use Case | Title | Message Code |
|---|---|---|
| ECS15c | Clear Auxiliary Controller Event Log | 0x00C1 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 3.3 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1784 |
SMETS 5.6.3.8 / 9.5.2.3 |
AuxiliaryControllerEventLog | clear | Clears the Auxiliary Controller Event Log |
Method | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00C1 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1784 |
SMETS 5.6.3.8 / 9.5.2.3 |
AuxiliaryControllerEventLog: clear | 7 | 0-17:99.98.2.255 | M | 1 | reset | integer | 0 |
This Use Case is for clearing the Event Log on a Device.
This Use Case covers clearing the Event Log only; the Security Log is not allowed to be cleared via a remote Command.
| Use Case | Title | Message Code |
|---|---|---|
| CS11 | Clear ZigBee Device Event Log | 0x0015 |
| ECS15a | Clear ESME Event Log | 0x0024 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 3.3 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 668 |
SMETS 4.5.3.8 SMETS 5.6.3.9 / 5.7.5.16 / 9.5.2.4 CHTS 4.5.1.3 / 4.5.4.2 |
EventLog(incGPF) | clear | Clears the event log |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x0024 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 668 |
SMETS 5.6.3.9 / 5.7.5.16 / 9.5.2.4 CHTS 4.5.1.3 / 4.5.4.2 |
EventLog(incGPF): clear | 7 | 0-0:99.98.0.255 | M | 1 | reset | integer | 0 |
| Target | GPF; GSME |
|---|---|
| Message Code | 0x0015 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 668 | SMETS 4.5.3.8 | EventLog(incGPF): clear | UINT8 | Log ID 0x03 (General Event Log) |
Events: 0x0709 |
This Use Case is to turn daily resetting of the ESME Tariff Block Counter Matrix on or off.
| Use Case | Title | Message Code |
|---|---|---|
| ECS48 | Configure daily resetting of Tariff Block Counter Matrix | 0x00DB |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.26 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1966 |
SMETS 5.7.4.7 |
TariffBlockCounterMatrix | dailyResetting | Specifies whether daily resetting of the ESME Tariff Block Counter Matrix is on or off. |
Configuration data | BOOLEAN |
| Target | ESME |
|---|---|
| Message Code | 0x00DB |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1966 |
SMETS 5.7.4.7 |
TariffBlockCounterMatrix: dailyResetting | 22 | 0-0:15.1.0.255 | A | 4 | execution_time:execution_time[1..1].execution_time_date | EXCEPTIONAL | - | See Section 18.2.1 of the GBCS for encoding of this field |
This Use Case is for the Critical Sensitive Alert relating to the periodic provision of the Billing Data Log from the Smart Meter to the DCC Service User (Supplier).
Alert code: 0x8F0A. This Use Case returns only the most recent entry from the log.
| Use Case | Title | Message Code |
|---|---|---|
| ECS68 | ESME Critical Sensitive Alert (Billing Data Log) | 0x0061 |
| GCS53 | Push Billing Data Log as an Alert | 0x008B |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.A.C |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | A1 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 520 |
SMETS 4.6.5.3; CHTS 4.5.2 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.activeImportRegisterValue/consumption | the register value recorded |
Operational data | INTEGER |
| 1477 |
SMETS 4.6.5.3; CHTS 4.5.2 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.Block[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 1800 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.secondaryActiveImportRegisterValue/consumption | the register value recorded |
Operational data | INTEGER |
| 1801 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.secondaryTariffTOU[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 1478 |
SMETS 4.6.5.3; CHTS 4.5.2 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 525 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..48].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 527 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block1.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 529 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block2.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 531 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block3.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 533 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block4.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 607 |
SMETS 4.6.5.3; CHTS 4.5.2 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.timestamp | The UTC date-time at which the corresponding snapshot was taken |
Operational data | DATE-TIME |
| 1796 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | readLog | This alert contains the most recent entry from billing data log ( calendar triggered ). |
Method | Method |
| Sensitive |
| Target | |
|---|---|
| Message Code | 0x0061 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 607 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timestamp | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 520 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.activeImportRegisterValue/consumption | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.activeImportRegisterValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1800 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.secondaryActiveImportRegisterValue/consumption | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.secondaryActiveImportRegisterValue | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 525 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..48].RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOURegisterValues[1..48].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1801 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.secondaryTariffTOU[1..4].RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.secondaryTariffTOURegisterValues[1..4].value | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 527 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block1.RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOUBlock1RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 529 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block2.RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOUBlock2RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 531 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block3.RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOUBlock3RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 533 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block4.RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOUBlock4RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1796 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): readLog | 30 | 0-0:43.2.11.255 | M | 1 | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | |
|---|---|
| Message Code | 0x008B |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 520 | SMETS 4.6.5.3; CHTS 4.5.2 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.activeImportRegisterValue/consumption | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
Metering: 0x0702 | (Response/pushed): | Publish Snapshot: 0x06 |
| 1477 | SMETS 4.6.5.3; CHTS 4.5.2 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.Block[1..4].RegisterMatrixValue | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
|||
| 1478 | SMETS 4.6.5.3; CHTS 4.5.2 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..4].RegisterMatrixValue | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
|||
| 607 | SMETS 4.6.5.3; CHTS 4.5.2 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timestamp | -- | -- |
| Encrypted attributes - see section 8 |
This Use Case is for managing debt for Time Debt Registers 1 and 2, and the Payment Debt Register; and configuring the debt repayments on the Smart Meter.
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 2.3 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1151 |
SMETS 4.6.4.8 SMETS 5.7.4.11 |
DebtRecoveryperPayment | valueCurrent | Integer representing percentage of each payment taken to recover debt. This is a number between 0 and 10,000 ( so, for example, 3000 represents 30% ) |
Configuration data | INTEGER |
| 1116 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[1] | amountNext | charge per periodNext |
Configuration data | INTEGER |
| 1153 |
SMETS 5.7.4.12 |
DebtRecoveryRates[1] | activateNext | Activates the 'Next' values |
Method | Method |
| 1185 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[1] | periodNext | Period over which amountNext is to be recovered. The valid periods are hour (3600 seconds), day (86,400 seconds) |
Configuration data | INTEGER |
| 1110 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[1] | scalerNext | -5 for Gas; variable for Electricity (power of 10 to apply when interpreting the amountNext) |
Configuration data | INTEGER |
| 1117 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[2] | amountNext | charge per periodNext |
Configuration data | INTEGER |
| 1154 |
SMETS 5.7.4.12 |
DebtRecoveryRates[2] | activateNext | Activates the 'Next' values |
Method | Method |
| 1186 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[2] | periodNext | Period over which amountNext is to be recovered. The valid periods are hour (3600 seconds), day (86,400 seconds) |
Configuration data | INTEGER |
| 1111 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[2] | scalerNext | -5 for Gas; variable for Electricity (power of 10 to apply when interpreting the amountNext) |
Configuration data | INTEGER |
| 1158 |
SMETS 4.6.5.13 SMETS 5.6.3.5 / 5.7.5.23 |
PaymentDebtRegister | adjust | PaymentDebtRegister.value is to be adjusted by the amount specified in the adjust method invocation. May be called internally (by prepay credit processing) or externally |
Method | Method |
| 1161 |
SMETS 4.6.5.13 SMETS 5.6.3.5 / 5.7.5.23 |
PaymentDebtRegister | methodInput: adjustmentValue | The amount of the adjustment |
Method Input | INTEGER |
| 1159 |
SMETS 4.5.3.5 / 4.6.5.21 SMETS 5.6.3.5 / 5.7.5.36 |
TimeDebtRegisters[1] | adjust | Adjust TimeDebtRegister[1] value by the amount specified in the method invocation |
Method | Method |
| 1162 |
SMETS 4.5.3.5 / 4.6.5.21 SMETS 5.6.3.5 / 5.7.5.36 |
TimeDebtRegisters[1] | methodInput: adjustmentValue | The amount of the adjustment |
Method Input | INTEGER |
| 1160 |
SMETS 4.5.3.5 / 4.6.5.21 SMETS 5.6.3.5 / 5.7.5.36 |
TimeDebtRegisters[2] | adjust | Adjust TimeDebtRegisters[2] value by the amount specified in the method invocation |
Method | Method |
| 1163 |
SMETS 4.5.3.5 / 4.6.5.21 SMETS 5.6.3.5 / 5.7.5.36 |
TimeDebtRegisters[2] | methodInput: adjustmentValue | The amount of the adjustment |
Method Input | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x001E |
See SMETS (Adjust Debt).
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1104 |
(DLMS) |
DebtRecoveryRates[1]: valueNext.commodityScale | 113 | 0-0:19.20.1.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1110 |
SMETS 5.7.4.12 |
DebtRecoveryRates[1]: scalerNext | 113 | 0-0:19.20.1.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.price_scale | integer | - | |
| 1122 |
(DLMS) |
DebtRecoveryRates[1]: valueNext.classID | 113 | 0-0:19.20.1.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.class_id | long-unsigned | 0 | |
| 1134 |
(DLMS) |
DebtRecoveryRates[1]: valueNext.LN | 113 | 0-0:19.20.1.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1098 |
(DLMS) |
DebtRecoveryRates[1]: valueNext.attribute_index | 113 | 0-0:19.20.1.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.attribute_index | integer | 0 | |
| 1128 |
(DLMS) |
DebtRecoveryRates[1]: valueNext.index | 113 | 0-0:19.20.1.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1116 |
SMETS 5.7.4.12 |
DebtRecoveryRates[1]: amountNext | 113 | 0-0:19.20.1.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1105 |
(DLMS) |
DebtRecoveryRates[2]: valueNext.commodityScale | 113 | 0-0:19.20.2.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1111 |
SMETS 5.7.4.12 |
DebtRecoveryRates[2]: scalerNext | 113 | 0-0:19.20.2.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.price_scale | integer | - | |
| 1123 |
(DLMS) |
DebtRecoveryRates[2]: valueNext.classID | 113 | 0-0:19.20.2.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.class_id | long-unsigned | 0 | |
| 1135 |
(DLMS) |
DebtRecoveryRates[2]: valueNext.LN | 113 | 0-0:19.20.2.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1099 |
(DLMS) |
DebtRecoveryRates[2]: valueNext.attribute_index | 113 | 0-0:19.20.2.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.attribute_index | integer | 0 | |
| 1129 |
(DLMS) |
DebtRecoveryRates[2]: valueNext.index | 113 | 0-0:19.20.2.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1117 |
SMETS 5.7.4.12 |
DebtRecoveryRates[2]: amountNext | 113 | 0-0:19.20.2.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1151 |
SMETS 5.7.4.11 |
DebtRecoveryperPayment: valueCurrent | 113 | 0-0:19.20.3.255 | A | 13 | proportion | long-unsigned | ||
| 1185 |
SMETS 5.7.4.12 |
DebtRecoveryRates[1]: periodNext | 113 | 0-0:19.20.1.255 | A | 8 | period | double-long-unsigned | - | |
| 1186 |
SMETS 5.7.4.12 |
DebtRecoveryRates[2]: periodNext | 113 | 0-0:19.20.2.255 | A | 8 | period | double-long-unsigned | - | |
| 1153 |
SMETS 5.7.4.12 |
DebtRecoveryRates[1]: activateNext | 113 | 0-0:19.20.1.255 | M | 2 | activate_passive_unit_charge | integer | 0 | |
| 1154 |
SMETS 5.7.4.12 |
DebtRecoveryRates[2]: activateNext | 113 | 0-0:19.20.2.255 | M | 2 | activate_passive_unit_charge | integer | 0 | |
| 1158 |
SMETS 5.6.3.5 / 5.7.5.23 |
PaymentDebtRegister: adjust | 113 | 0-0:19.20.3.255 | M | 4 | update_total_amount_remaining | double-long | - | |
| 1161 |
SMETS 5.6.3.5 / 5.7.5.23 |
PaymentDebtRegister: methodInput: adjustmentValue | 113 | 0-0:19.20.3.255 | M | 4 | update_total_amount_remaining:data | double-long | - | the amount of the adjustment (in millipence) |
| 1159 |
SMETS 5.6.3.5 / 5.7.5.36 |
TimeDebtRegisters[1]: adjust | 113 | 0-0:19.20.1.255 | M | 4 | update_total_amount_remaining | double-long | - | |
| 1162 |
SMETS 5.6.3.5 / 5.7.5.36 |
TimeDebtRegisters[1]: methodInput: adjustmentValue | 113 | 0-0:19.20.1.255 | M | 4 | update_total_amount_remaining:data | double-long | - | the amount of the adjustment (in millipence) |
| 1160 |
SMETS 5.6.3.5 / 5.7.5.36 |
TimeDebtRegisters[2]: adjust | 113 | 0-0:19.20.2.255 | M | 4 | update_total_amount_remaining | double-long | - | |
| 1163 |
SMETS 5.6.3.5 / 5.7.5.36 |
TimeDebtRegisters[2]: methodInput: adjustmentValue | 113 | 0-0:19.20.2.255 | M | 4 | update_total_amount_remaining:data | double-long | - | the amount of the adjustment (in millipence) |
| Target | GSME |
|---|---|
| Message Code | 0x006E |
See SMETS (Adjust Debt).
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1151 | SMETS 4.6.4.8 | DebtRecoveryperPayment: valueCurrent | UINT16 | Debt Recovery Balance Percentage Time-based debt: set to 0 |
Prepayment: 0x0705 | Change Debt : 0x02 | ZCL Default Response : 0x0B |
| 1116 | SMETS 4.6.4.9 | DebtRecoveryRates[1]: amountNext | INT32 | Debt Recovery Amount 0 - 0xFFFFFFFF |
|||
| 1185 | SMETS 4.6.4.9 | DebtRecoveryRates[1]: periodNext | ENUM8 | Debt Recovery Frequency 0x00 = per hour
0x01 = per day |
|||
| 1117 | SMETS 4.6.4.9 | DebtRecoveryRates[2]: amountNext | INT32 | Debt Recovery Amount 0 - 0xFFFFFFFF |
|||
| 1186 | SMETS 4.6.4.9 | DebtRecoveryRates[2]: periodNext | ENUM8 | Debt Recovery Frequency 0x00 = per hour
0x01 = per day |
|||
| 1158 | SMETS 4.6.5.13 | PaymentDebtRegister: adjust | ENUM8 | Debt Amount Type 5 = incremental |
|||
| 1161 | SMETS 4.6.5.13 | PaymentDebtRegister: methodInput: adjustmentValue | INT32 | Debt Amount -0x7FFFFFFF - 0x7FFFFFFF |
|||
| 1159 | SMETS 4.5.3.5 / 4.6.5.21 | TimeDebtRegisters[1]: adjust | ENUM8 | Debt Amount Type 1 = Incremental |
|||
| 1162 | SMETS 4.5.3.5 / 4.6.5.21 | TimeDebtRegisters[1]: methodInput: adjustmentValue | INT32 | Debt Amount -0x7FFFFFFF - 0x7FFFFFFF |
|||
| 1160 | SMETS 4.5.3.5 / 4.6.5.21 | TimeDebtRegisters[2]: adjust | ENUM8 | Debt Amount Type 3 = Incremental |
|||
| 1163 | SMETS 4.5.3.5 / 4.6.5.21 | TimeDebtRegisters[2]: methodInput: adjustmentValue | INT32 | Debt Amount -0x7FFFFFFF - 0x7FFFFFFF |
Whenever an IEEE address is added to or removed from the CHF Device Log and whenever a Hashed TC Link Key changes in the CHF Device Log, the Communications Hub Function shall generate and send an instance of this Alert which contains a back up version of the data in the 'whitelist' (the CHF Device Log). The Alert Code shall be 0x8F12. The value of the hashed_TC_link_key field shall only be populated where the devices has established a TC link key. Where the Device has not established such a TC link key, the field sent shall be a zero length string.
| Use Case | Title | Message Code |
|---|---|---|
| CS14 | Device Addition To / Removal From HAN Whitelist Alerts | 0x0018 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.A.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1006 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | alertOutput: backupDateTime | The date-time at which this change was made by the Comms Hub to its Device Log (the corresponding Alert for which shall always be addressed to the Access Control Broker) |
Operational data | DATE-TIME |
| 1008 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | alertOutput: devices[0..16].device.deviceidentifier | The device identifiers for the devices on the HAN after a change has been made by the Comms Hub to its Device Log (the corresponding Alert for which shall always be addressed to the Access Control Broker) |
Operational data | OCTET-STRING |
| 1007 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | alertOutput: devices[0..16].device.securityDetails | The security details required for any future restore of the corresponding device on the HAN after a change has been made by the Comms Hub to its Device Log (the corresponding Alert for which shall always be addressed to the Access Control Broker) |
Operational data | OCTET-STRING |
| 1009 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | alertOutput: hanIdentifier | The identifier for the HAN a change made by the Comms Hub to its Device Log (the corresponding Alert for which shall always be addressed to the Access Control Broker) |
Constant data | OCTET-STRING |
| Target | All |
|---|---|
| Message Code | 0x0018 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1006 |
CHTS 4.6.2.1 |
DeviceLog(CHF): alertOutput: backupDateTime | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN.date-time | octet-string(12) | - | Return parameter of backup_PAN method. The CH shall place the 'data' structure returned by this method in the alert-body. This date-time is formatted as per 4.1.6.1 of the Blue Book |
| 1009 |
CHTS 4.6.2.1 |
DeviceLog(CHF): alertOutput: hanIdentifier | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN.extended_PAN_ID | octet-string(8) | - | Return parameter of backup_PAN method. The CH shall place the 'data' structure returned by this method in the alert-body. |
| 1008 |
CHTS 4.6.2.1 |
DeviceLog(CHF): alertOutput: devices[0..16].device.deviceidentifier | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN.devices_to_backup[0..16].device_to_backup.MAC_address | octet-string(8) | - | Return parameter of backup_PAN method. The CH shall place the 'data' structure returned by this method in the alert-body. This is the Entity Identifier in an octet-string(8) as allocated at manufacture |
| 1007 |
CHTS 4.6.2.1 |
DeviceLog(CHF): alertOutput: devices[0..16].device.securityDetails | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN.devices_to_backup[0..16].device_to_backup.hashed_TC_link_key | octet-string(16) | - | Return parameter of backup_PAN method. The CH shall place the 'data' structure returned by this method in the alert-body. octet-string(16) |
This Use Case is for disabling Privacy PIN protection on the Smart Meter.
| Use Case | Title | Message Code |
|---|---|---|
| ECS14 | Disable Privacy PIN Protection on ESME | 0x0023 |
| GCS11 | Disable Privacy PIN Protection on GSME | 0x0073 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 3.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1390 |
SMETS 4.5.3.9 |
DisablePrivacyPinProtection | disableProtection | Disables PIN protection in the meter. |
Method | Method |
| 89 |
SMETS 5.6.3.10 |
DisablePrivacyPinProtection | value | Disables PIN protection in the meter. |
Configuration data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x0023 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 89 |
SMETS 5.6.3.10 |
DisablePrivacyPinProtection: value | 1 | 0-0:94.44.3.1 | A | 2 | value | octet-string(0) | - | A string length of zero is sent, on receipt the meter shall disable PIN protection. |
| Target | GSME |
|---|---|
| Message Code | 0x0073 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1390 | SMETS 4.5.3.9 | DisablePrivacyPinProtection: disableProtection | ENUM8 | Password Type 2 = Access to the Consumer Menu.
A string length of zero is sent, on receipt the meter shall disable PIN protection. |
Device Management: 0x0708 |
See GBCS Section 7.2.9.1.
| Use Case | Title | Message Code |
|---|---|---|
| ECS101 | Limit APC [n] Level Command processed | 0x0121 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.A.C |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1979 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelCommandProcessed | apcDirectionAndNumber | The most significant nibble of the octet shall be 0x1 (indicating output), or 0x2 (indicating input) and the least significant shall be 0xn, where n is the value in APC [n] and APC [n] is the APC affected, so a value between 1 and 5 inclusive. |
Alert | INTEGER |
| 1977 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelCommandProcessed | apcLimitPeriodEnd | The date-time for the end of the APC [n] Limit Period, which its SMETS meaning |
Alert | DATE-TIME |
| 1978 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelCommandProcessed | apcLimitPeriodStart | The date-time for the start of the APC [n] Limit Period, which its SMETS meaning |
Alert | DATE-TIME |
| 1980 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelCommandProcessed | resultingLevel | The value 'p' where this Alert relates to output, or 'q' where it relates to input, where 'p' and 'q' are as per GBCS Section 7.3.6.1 |
Alert | INTEGER |
| Target | See GBCS |
|---|---|
| Message Code | 0x0121 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1979 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelCommandProcessed: apcDirectionAndNumber | Not specified | Not specified | A | Not specified | apc_direction_and_number | unsigned | - | |
| 1978 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelCommandProcessed: apcLimitPeriodStart | Not specified | Not specified | A | Not specified | apc_limit_period_start | octet-string(12) | - | |
| 1977 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelCommandProcessed: apcLimitPeriodEnd | Not specified | Not specified | A | Not specified | apc_limit_period_end | octet-string(12) | - | |
| 1980 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelCommandProcessed: resultingLevel | Not specified | Not specified | A | Not specified | resulting_level | unsigned | - |
See GBCS Section 7.2.9.1.
| Use Case | Title | Message Code |
|---|---|---|
| ECS102 | Limit APC [n] Level ended or cancelled | 0x0122 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.A.C |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1981 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelEndedOrCancelled | apcDirectionAndNumber | The most significant nibble of the octet shall be 0x1 (indicating output) and the least significant shall be 0xn, where n is the value in APC [n] and APC [n] is the APC affected, so a value between 1 and 5 inclusive. |
Alert | INTEGER |
| 1982 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelEndedOrCancelled | resultingLevel | The value 'p' where this Alert relates to output, or 'q' where it relates to input, where 'p' and 'q' are as per GBCS Section 7.3.6.1 |
Alert | INTEGER |
| Target | See GBCS |
|---|---|
| Message Code | 0x0122 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1981 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelEndedOrCancelled: apcDirectionAndNumber | Not specified | Not specified | A | Not specified | apc_direction_and_number | unsigned | - | |
| 1982 |
SMETS 5.29.1.1 / 9.5.2.16 |
LimitAPC[n]LevelEndedOrCancelled: resultingLevel | Not specified | Not specified | A | Not specified | resulting_level | unsigned | - |
This Use Case is for limiting the commanded state of one of the Auxiliary Proportional Controllers.
| Use Case | Title | Message Code |
|---|---|---|
| ECS47e | Limit APC [n] Level | 0x011F |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 7.16 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Load Controller |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1988 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[1] | limitPeriodEndDateTime | The value in this field shall be the end date-time of the APC [1] Limit Period if Auxiliary Controller [1] is an APC; otherwise it shall have no meaning. The Device shall, before updating this DLMS attribute, check that the limitPeriodEndDateTime is greater than the corresponding limitPeriodStartDateTime and is no more than 24 hours greater than the corresponding limitPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 1 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1983 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[1] | limitPeriodStartDateTime | The value in this field shall be the start date-time of the APC [1] Limit Period if Auxiliary Controller [1] is an APC; otherwise it shall have no meaning. This field shall always be present where the 'controllerNumber' specified in the Command is 1 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1989 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[2] | limitPeriodEndDateTime | The value in this field shall be the end date-time of the APC [2] Limit Period if Auxiliary Controller [2] is an APC; otherwise it shall have no meaning. The Device shall, before updating this DLMS attribute, check that the limitPeriodEndDateTime is greater than the corresponding limitPeriodStartDateTime and is no more than 24 hours greater than the corresponding limitPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 2 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1984 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[2] | limitPeriodStartDateTime | The value in this field shall be the start date-time of the APC [2] Limit Period if Auxiliary Controller [2] is an APC; otherwise it shall have no meaning. This field shall always be present where the 'controllerNumber' specified in the Command is 2 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1990 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[3] | limitPeriodEndDateTime | The value in this field shall be the end date-time of the APC [3] Limit Period if Auxiliary Controller [3] is an APC; otherwise it shall have no meaning. The Device shall, before updating this DLMS attribute, check that the limitPeriodEndDateTime is greater than the corresponding limitPeriodStartDateTime and is no more than 24 hours greater than the corresponding limitPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 3 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1985 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[3] | limitPeriodStartDateTime | The value in this field shall be the start date-time of the APC [3] Limit Period if Auxiliary Controller [3] is an APC; otherwise it shall have no meaning. This field shall always be present where the 'controllerNumber' specified in the Command is 3 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1991 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[4] | limitPeriodEndDateTime | The value in this field shall be the end date-time of the APC [4] Limit Period if Auxiliary Controller [4] is an APC; otherwise it shall have no meaning. The Device shall, before updating this DLMS attribute, check that the limitPeriodEndDateTime is greater than the corresponding limitPeriodStartDateTime and is no more than 24 hours greater than the corresponding limitPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 4 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1986 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[4] | limitPeriodStartDateTime | The value in this field shall be the start date-time of the APC [4] Limit Period if Auxiliary Controller [4] is an APC; otherwise it shall have no meaning. This field shall always be present where the 'controllerNumber' specified in the Command is 4 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1992 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[5] | limitPeriodEndDateTime | The value in this field shall be the end date-time of the APC [5] Limit Period if Auxiliary Controller [5] is an APC; otherwise it shall have no meaning. The Device shall, before updating this DLMS attribute, check that the limitPeriodEndDateTime is greater than the corresponding limitPeriodStartDateTime and is no more than 24 hours greater than the corresponding limitPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 5 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1987 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[5] | limitPeriodStartDateTime | The value in this field shall be the start date-time of the APC [5] Limit Period if Auxiliary Controller [5] is an APC; otherwise it shall have no meaning. This field shall always be present where the 'controllerNumber' specified in the Command is 5 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1993 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[n] | controllerNumberAndCommandedState | See GBCS Section 7.3.6.1 |
Method | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x011F |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1983 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[1]: limitPeriodStartDateTime | 1 | 0-0:94.44.117.3 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1988 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[1]: limitPeriodEndDateTime | 1 | 0-0:94.44.117.4 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1984 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[2]: limitPeriodStartDateTime | 1 | 0-0:94.44.118.3 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1989 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[2]: limitPeriodEndDateTime | 1 | 0-0:94.44.118.4 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1985 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[3]: limitPeriodStartDateTime | 1 | 0-0:94.44.119.3 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1990 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[3]: limitPeriodEndDateTime | 1 | 0-0:94.44.119.4 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1986 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[4]: limitPeriodStartDateTime | 1 | 0-0:94.44.120.3 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1991 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[4]: limitPeriodEndDateTime | 1 | 0-0:94.44.120.4 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1987 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[5]: limitPeriodStartDateTime | 1 | 0-0:94.44.121.3 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1992 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[5]: limitPeriodEndDateTime | 1 | 0-0:94.44.121.4 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1993 |
SMETS 5.29.1.1 / 9.5.2.16 |
AuxiliaryProportionalController[n]: controllerNumberAndCommandedState | 9 | 0-0:10.0.107.255 | M | 1 | data | long-unsigned | - |
This Use Case is for reading the (prepayment) daily read log on the Smart Meter. The read request relates to retrieving data from a prepayment meter.
| Use Case | Title | Message Code |
|---|---|---|
| ECS21b | Read Electricity (Prepayment) Daily Read Log | 0x0034 |
| GCS16b | Read GSME Daily Read log(s) (prepayment) | 0x0096 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.14 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 539 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | logEntries[1..31].logEntry.accumulatedDebtRegisterValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 540 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | logEntries[1..31].logEntry.emergencyCreditBalanceValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 541 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | logEntries[1..31].logEntry.meterBalanceValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 542 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | logEntries[1..31].logEntry.paymentDebtRegisterValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 543 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | logEntries[1..31].logEntry.timeDebtRegisters1Value | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 544 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | logEntries[1..31].logEntry.timeDebtRegisters2Value | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 610 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | logEntries[1..31].logEntry.timestamp | The UTC date-time at which the corresponding log entry was taken |
Operational data | DATE-TIME |
| 1494 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 1523 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 1529 |
SMETS 4.6.5.14 SMETS 5.7.5.26 |
PrepaymentDailyReadLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x0034 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 610 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: logEntries[1..31].logEntry.timestamp | 7 | 0-0:98.1.8.255 | A | 2 | buffer:buffer[1..31].entry_prepaymentReadLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 540 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: logEntries[1..31].logEntry.emergencyCreditBalanceValue | 7 | 0-0:98.1.8.255 | A | 2 | buffer:buffer[1..31].entry_prepaymentReadLogEntry.emergencyCreditBalanceValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 541 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: logEntries[1..31].logEntry.meterBalanceValue | 7 | 0-0:98.1.8.255 | A | 2 | buffer:buffer[1..31].entry_prepaymentReadLogEntry.meterBalanceValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 542 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: logEntries[1..31].logEntry.paymentDebtRegisterValue | 7 | 0-0:98.1.8.255 | A | 2 | buffer:buffer[1..31].entry_prepaymentReadLogEntry.paymentDebtRegisterValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 543 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: logEntries[1..31].logEntry.timeDebtRegisters1Value | 7 | 0-0:98.1.8.255 | A | 2 | buffer:buffer[1..31].entry_prepaymentReadLogEntry.timeDebtRegisters1Value | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 544 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: logEntries[1..31].logEntry.timeDebtRegisters2Value | 7 | 0-0:98.1.8.255 | A | 2 | buffer:buffer[1..31].entry_prepaymentReadLogEntry.timeDebtRegisters2Value | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 539 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: logEntries[1..31].logEntry.accumulatedDebtRegisterValue | 7 | 0-0:98.1.8.255 | A | 2 | buffer:buffer[1..31].entry_prepaymentReadLogEntry.accumulatedDebtRegisterValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1494 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: readLog | 30 | 0-0:43.2.6.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1523 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: methodInput: fromDateTime | 30 | 0-0:43.2.6.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1529 |
SMETS 5.7.5.26 |
PrepaymentDailyReadLog: methodInput: toDateTime | 30 | 0-0:43.2.6.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | GPF (primary and for any Remote Party with access rights); GSME (Supplier only) |
|---|---|
| Message Code | 0x0096 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1494 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: method: readLog | -- |
Snapshot Cause = 0x00000001 (General) |
Prepayment: 0x0705 | Get Prepay Snapshot: 0x07 | -- |
| 1523 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: methodInput: fromDateTime | -- |
Earliest Start Time |
|||
| 1529 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: methodInput: toDateTime | -- |
Latest End Time |
|||
| 610 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: logEntries[1..31].logEntry.timestamp | -- | -- | Prepayment: 0x0705 | (Response): | Publish Prepay Snapshot: 0x01 |
| 539 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: logEntries[1..31].logEntry.accumulatedDebtRegisterValue | -- | -- | |||
| 540 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: logEntries[1..31].logEntry.emergencyCreditBalanceValue | -- | -- | |||
| 541 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: logEntries[1..31].logEntry.meterBalanceValue | -- | -- | |||
| 542 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: logEntries[1..31].logEntry.paymentDebtRegisterValue | -- | -- | |||
| 543 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: logEntries[1..31].logEntry.timeDebtRegisters1Value | -- | -- | |||
| 544 | SMETS 4.6.5.14 | PrepaymentDailyReadLog: logEntries[1..31].logEntry.timeDebtRegisters2Value | -- | -- |
| Encrypted attributes - see section 8 |
This Use Case is for reading Auxiliary Controller Configuration Data, where those terms have their SMETS meaning.
| Use Case | Title | Message Code |
|---|---|---|
| ECS61d | Read Auxiliary Controller Configuration Data | 0x011C |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 7.14 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
| Load Controller |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1773 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[1] | Description | The description for Auxiliary Controller referred to by n = 1 |
Configuration data | OCTET-STRING |
| 1774 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[2] | Description | The description for Auxiliary Controller referred to by n = 2 |
Configuration data | OCTET-STRING |
| 1775 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[3] | Description | The description for Auxiliary Controller referred to by n = 3 |
Configuration data | OCTET-STRING |
| 1776 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[4] | Description | The description for Auxiliary Controller referred to by n = 4 |
Configuration data | OCTET-STRING |
| 1777 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[5] | Description | The description for Auxiliary Controller referred to by n = 5 |
Configuration data | OCTET-STRING |
| 1819 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays) | date[0..20].current | This is the date (or set of dates if wildcards are used) of the corresponding special day |
Configuration data | DATE WITH WILDCARDS |
| 1821 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays) | dayIdentifier[0..20].current | This is a number used in calendar entries that require execution on this special day. |
Configuration data | INTEGER |
| 767 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | currentEntries[0..120].beginDate | The earliest date on which this entry in entries will take effect |
Configuration data | DATE |
| 769 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | currentEntries[0..120].endDate | The last date on which this entry in entries will take effect |
Configuration data | DATE |
| 727 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | currentEntries[0..120].execSpecdays[0..20] | Each boolean determines whether this entry executes on this day |
Configuration data | Series of BOOLEANS |
| 729 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | currentEntries[0..120].execWeekdays[0..7] | Each boolean determines whether this entry executes on this day |
Configuration data | Series of BOOLEANS |
| 747 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | currentEntries[0..120].scriptSelector | See the Blue Book and section 7.3.6.1 of the GBCS |
Configuration data | INTEGER |
| 760 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | currentEntries[0..120].switchTime | The time during the day at which the action is triggered |
Configuration data | TIME NO WILDCARDS |
| Target | ESME |
|---|---|
| Message Code | 0x011C |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1773 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[1]: Description | 1 | 0-0:94.44.0.11 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1774 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[2]: Description | 1 | 0-0:94.44.0.12 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1775 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[3]: Description | 1 | 0-0:94.44.0.13 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1776 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[4]: Description | 1 | 0-0:94.44.0.14 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1777 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[5]: Description | 1 | 0-0:94.44.0.15 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1823 |
(DLMS) |
AuxiliaryControllerCalendar(SpecialDays): index[0..20].current | 11 | 0-0:11.0.3.255 | A | 2 | entries:entries[0..20].spec_day_entry.index | long-unsigned | - | |
| 1819 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays): date[0..20].current | 11 | 0-0:11.0.3.255 | A | 2 | entries:entries[0..20].spec_day_entry.specialday_date | octet-string(5) | - | Formatted as date (octet-string(5)) according to 4.1.6.1 of the Blue Book |
| 1821 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays): dayIdentifier[0..20].current | 11 | 0-0:11.0.3.255 | A | 2 | entries:entries[0..20].spec_day_entry.day_id | unsigned | - | |
| 745 |
(DLMS) |
AuxiliaryControllerCalendar: currentEntries[0..120].index | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.index | long-unsigned | - | |
| 739 |
(DLMS) |
AuxiliaryControllerCalendar: currentEntries[0..120].enable | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.enable | boolean | ||0x01 | |
| 779 |
(DLMS) |
AuxiliaryControllerCalendar: currentEntries[0..120].scriptLN | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.script_logical_name | octet-string(6) | ||0x00000A0067FF | |
| 747 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: currentEntries[0..120].scriptSelector | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.script_selector | long-unsigned | - | |
| 760 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: currentEntries[0..120].switchTime | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.switch_time | octet-string(4) | - | |
| 749 |
(DLMS) |
AuxiliaryControllerCalendar: currentEntries[0..120].validityWindow | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.validity_window | long-unsigned | ||0xFFFF | |
| 729 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: currentEntries[0..120].execWeekdays[0..7] | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.exec_weekdays | bit-string(7) | - | |
| 727 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: currentEntries[0..120].execSpecdays[0..20] | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.exec_specdays | bit-string(20) | The length of this bit-string is variable and must align to the number of special days specified in the associated special days object. The length shown is the maximum number of such special days. |
|
| 767 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: currentEntries[0..120].beginDate | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.begin_date | octet-string(5) | - | |
| 769 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: currentEntries[0..120].endDate | 10 | 0-0:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.end_date | octet-string(5) | - |
This Use Case is for reading the Auxiliary Controller Event Log.
| Use Case | Title | Message Code |
|---|---|---|
| ECS35g | Read Auxiliary Controller Event Log | 0x00FD |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.13 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Load Controller |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1828 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog | logEntries[1..100].logEntry.HANCommandID | 0x00000000, if this entry relates to an ALCS or APC. For entries related to an HCALCS, an identifier, allocated by the sending Device, for the Command / Response between the sending Device and HC ALCS |
Operational data | INTEGER |
| 1827 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog | logEntries[1..100].logEntry.outcome | 0x00 (Outcome not known), 0x01 (Success), 0x02 (Failure). 'Outcome not known' shall only be used where this entry relates to a Command being sent to an HCALCS (and so the sending Device cannot know the outcome) |
Operational data | ENUMERATION |
| 565 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog | logEntries[1..100].logEntry.switchNumberAndAction | See GBCS Section 7.3.6.1 and Section 18.1.1.1 |
Operational data | Two INTEGERs |
| 603 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog | logEntries[1..100].logEntry.timestamp | The UTC date- time stamp of this entry |
Operational data | INTEGER |
| 580 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 634 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 655 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x00FD |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 580 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog: method: readLog | 7 | 0-17:99.98.2.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 634 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog: methodInput: fromDateTime | 7 | 0-17:99.98.2.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 655 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog: methodInput: toDateTime | 7 | 0-17:99.98.2.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 603 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog: logEntries[1..100].logEntry.timestamp | 7 | 0-17:99.98.2.255 | A | 2 | buffer:buffer[1..100].entry_auxiliaryControllerLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 565 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog: logEntries[1..100].logEntry.switchNumberAndAction | 7 | 0-17:99.98.2.255 | A | 2 | buffer:buffer[1..100].entry_auxiliaryControllerLogEntry.switchNumberAndAction | long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1827 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog: logEntries[1..100].logEntry.outcome | 7 | 0-17:99.98.2.255 | A | 2 | buffer:buffer[1..100].entry_auxiliaryControllerLogEntry.outcome | enum | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1828 |
SMETS 5.7.5.6 / 9.6.3.1 |
AuxiliaryControllerEventLog: logEntries[1..100].logEntry.HANCommandID | 7 | 0-17:99.98.2.255 | A | 2 | buffer:buffer[1..100].entry_auxiliaryControllerLogEntry.hANCommandID | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
This Use Case is for reading Auxiliary Controller Operational Data, where those terms have their SMETS meaning.
| Use Case | Title | Message Code |
|---|---|---|
| ECS61e | Read Auxiliary Controller Operational Data | 0x011D |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 7.15 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
| Load Controller |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 938 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[1] | stateAndAssociatedInformation | See GBCS Section 7.2.9.2 |
Operational data | OCTET-STRING |
| 1830 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[1] | typeAndIdentifier | The value returned shall be determined by the type of Auxiliary Controller the Device has associated with Auxiliary Controller [1]: 1. The empty string if there is no associated Auxiliary Controller; 2. 0xFF if there is an associated APC; 3. 0x0000000000000000 if there is an associated ALCS; and 4. the HCALCS Entity Identifier, as stored in the Device Log entry for this HCALCS, if there is an associated HCALCS. Note that an HCALCS's Entity Identifier can never be 0x0000000000000000 or 0xFF or the empty string, because it is an EUI-64 identifier. |
Operational data | OCTET-STRING |
| 939 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[2] | stateAndAssociatedInformation | See GBCS Section 7.2.9.2 |
Operational data | OCTET-STRING |
| 1831 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[2] | typeAndIdentifier | The value returned shall be determined by the type of Auxiliary Controller the Device has associated with Auxiliary Controller [2]: 1. The empty string if there is no associated Auxiliary Controller; 2. 0xFF if there is an associated APC; 3. 0x0000000000000000 if there is an associated ALCS; and 4. the HCALCS Entity Identifier, as stored in the Device Log entry for this HCALCS, if there is an associated HCALCS. Note that an HCALCS's Entity Identifier can never be 0x0000000000000000 or 0xFF or the empty string, because it is an EUI-64 identifier. |
Operational data | OCTET-STRING |
| 940 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[3] | stateAndAssociatedInformation | See GBCS Section 7.2.9.2 |
Operational data | OCTET-STRING |
| 1832 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[3] | typeAndIdentifier | The value returned shall be determined by the type of Auxiliary Controller the Device has associated with Auxiliary Controller [3]: 1. The empty string if there is no associated Auxiliary Controller; 2. 0xFF if there is an associated APC; 3. 0x0000000000000000 if there is an associated ALCS; and 4. the HCALCS Entity Identifier, as stored in the Device Log entry for this HCALCS, if there is an associated HCALCS. Note that an HCALCS's Entity Identifier can never be 0x0000000000000000 or 0xFF or the empty string, because it is an EUI-64 identifier. |
Operational data | OCTET-STRING |
| 941 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[4] | stateAndAssociatedInformation | See GBCS Section 7.2.9.2 |
Operational data | OCTET-STRING |
| 1833 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[4] | typeAndIdentifier | The value returned shall be determined by the type of Auxiliary Controller the Device has associated with Auxiliary Controller [4]: 1. The empty string if there is no associated Auxiliary Controller; 2. 0xFF if there is an associated APC; 3. 0x0000000000000000 if there is an associated ALCS; and 4. the HCALCS Entity Identifier, as stored in the Device Log entry for this HCALCS, if there is an associated HCALCS. Note that an HCALCS's Entity Identifier can never be 0x0000000000000000 or 0xFF or the empty string, because it is an EUI-64 identifier. |
Operational data | OCTET-STRING |
| 942 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[5] | stateAndAssociatedInformation | See GBCS Section 7.2.9.2 |
Operational data | OCTET-STRING |
| 1834 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[5] | typeAndIdentifier | The value returned shall be determined by the type of Auxiliary Controller the Device has associated with Auxiliary Controller [5]: 1. The empty string if there is no associated Auxiliary Controller; 2. 0xFF if there is an associated APC; 3. 0x0000000000000000 if there is an associated ALCS; and 4. the HCALCS Entity Identifier, as stored in the Device Log entry for this HCALCS, if there is an associated HCALCS. Note that an HCALCS's Entity Identifier can never be 0x0000000000000000 or 0xFF or the empty string, because it is an EUI-64 identifier. |
Operational data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x011D |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1830 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[1]: typeAndIdentifier | 1 | 0-0:94.44.0.21 | A | 2 | value | octet-string(8) | - | |
| 1831 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[2]: typeAndIdentifier | 1 | 0-0:94.44.0.22 | A | 2 | value | octet-string(8) | - | |
| 1832 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[3]: typeAndIdentifier | 1 | 0-0:94.44.0.23 | A | 2 | value | octet-string(8) | - | |
| 1833 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[4]: typeAndIdentifier | 1 | 0-0:94.44.0.24 | A | 2 | value | octet-string(8) | - | |
| 1834 |
SMETS 5.7.5.38 / 9.6.3.7 |
AuxiliaryController[5]: typeAndIdentifier | 1 | 0-0:94.44.0.25 | A | 2 | value | octet-string(8) | - | |
| 938 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[1]: stateAndAssociatedInformation | 1 | 0-0:94.44.0.31 | A | 2 | value | utf8-string(72000) | - | To fit within a maximum of 63 GBT Messages each containing 1,149 octets. |
| 939 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[2]: stateAndAssociatedInformation | 1 | 0-0:94.44.0.32 | A | 2 | value | utf8-string(72000) | - | To fit within a maximum of 63 GBT Messages each containing 1,149 octets. |
| 940 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[3]: stateAndAssociatedInformation | 1 | 0-0:94.44.0.33 | A | 2 | value | utf8-string(72000) | - | To fit within a maximum of 63 GBT Messages each containing 1,149 octets. |
| 941 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[4]: stateAndAssociatedInformation | 1 | 0-0:94.44.0.34 | A | 2 | value | utf8-string(72000) | - | To fit within a maximum of 63 GBT Messages each containing 1,149 octets. |
| 942 |
SMETS 5.7.5.37 / 9.6.3.6 |
AuxiliaryController[5]: stateAndAssociatedInformation | 1 | 0-0:94.44.0.35 | A | 2 | value | utf8-string(72000) | - | To fit within a maximum of 63 GBT Messages each containing 1,149 octets. |
This Use Case is to allow a Supplier to obtain a data set stored in the Billing Data Log on the device on an ad-hoc basis for a specified date range. This Use Case returns all log entries between the two dates specified.
| Use Case | Title | Message Code |
|---|---|---|
| ECS20c | Read ESME Billing Data Log (billing calendar triggered exc export) | 0x0030 |
| GCS15c | Read GSME Billing Data Log (billing calendar triggered) | 0x0076 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.4 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1874 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.accumulatedDebtRegisterValue | the register value recorded |
Operational data | INTEGER |
| 520 |
SMETS 4.6.5.3; CHTS 4.5.2 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.activeImportRegisterValue/consumption | the register value recorded |
Operational data | INTEGER |
| 1477 |
SMETS 4.6.5.3; CHTS 4.5.2 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.Block[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 1875 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.emergencyCreditBalanceValue | the register value recorded |
Operational data | INTEGER |
| 1876 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.meterBalanceValue | the register value recorded |
Operational data | INTEGER |
| 1877 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.paymentDebtRegisterValue | the register value recorded |
Operational data | INTEGER |
| 1800 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.secondaryActiveImportRegisterValue/consumption | the register value recorded |
Operational data | INTEGER |
| 1801 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.secondaryTariffTOU[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 1478 |
SMETS 4.6.5.3; CHTS 4.5.2 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 525 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..48].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 527 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block1.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 529 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block2.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 531 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block3.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 533 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block4.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 1878 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.timeDebtRegisters1Value | the register value recorded |
Operational data | INTEGER |
| 1879 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.timeDebtRegisters2Value | the register value recorded |
Operational data | INTEGER |
| 607 |
SMETS 4.6.5.3; CHTS 4.5.2 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | logEntries[1..12].logEntry.timestamp | The UTC date-time at which the corresponding snapshot was taken |
Operational data | DATE-TIME |
| 1490 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 1519 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 1525 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x0030 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 607 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timestamp | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 520 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.activeImportRegisterValue/consumption | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.activeImportRegisterValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1800 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.secondaryActiveImportRegisterValue/consumption | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.secondaryActiveImportRegisterValue | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 525 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..48].RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOURegisterValues[1..48].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1801 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.secondaryTariffTOU[1..4].RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.secondaryTariffTOURegisterValues[1..4].value | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 527 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block1.RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOUBlock1RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 529 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block2.RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOUBlock2RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 531 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block3.RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOUBlock3RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 533 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block4.RegisterMatrixValue | 7 | 0-0:98.1.0.255 | A | 2 | buffer:buffer[1..12].entry_registerReadLogEntry.tariffTOUBlock4RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1880 |
(DLMS) |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timestamp | 7 | 0-0:98.1.1.255 | A | 2 | buffer:buffer[1..12].entry_prepaymentReadLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1875 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.emergencyCreditBalanceValue | 7 | 0-0:98.1.1.255 | A | 2 | buffer:buffer[1..12].entry_prepaymentReadLogEntry.emergencyCreditBalanceValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1876 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.meterBalanceValue | 7 | 0-0:98.1.1.255 | A | 2 | buffer:buffer[1..12].entry_prepaymentReadLogEntry.meterBalanceValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1877 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.paymentDebtRegisterValue | 7 | 0-0:98.1.1.255 | A | 2 | buffer:buffer[1..12].entry_prepaymentReadLogEntry.paymentDebtRegisterValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1878 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timeDebtRegisters1Value | 7 | 0-0:98.1.1.255 | A | 2 | buffer:buffer[1..12].entry_prepaymentReadLogEntry.timeDebtRegisters1Value | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1879 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timeDebtRegisters2Value | 7 | 0-0:98.1.1.255 | A | 2 | buffer:buffer[1..12].entry_prepaymentReadLogEntry.timeDebtRegisters2Value | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1874 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.accumulatedDebtRegisterValue | 7 | 0-0:98.1.1.255 | A | 2 | buffer:buffer[1..12].entry_prepaymentReadLogEntry.accumulatedDebtRegisterValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1490 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): readLog | 30 | 0-0:43.2.2.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1519 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): methodInput: fromDateTime | 30 | 0-0:43.2.2.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1525 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(BillingCalendarTriggeredExcExport): methodInput: toDateTime | 30 | 0-0:43.2.2.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | GPF (primary and for any Remote Party with access rights); GSME (Supplier only) |
|---|---|
| Message Code | 0x0076 |
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1490 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): method: readLog | -- |
Snapshot Cause: 0x00000002 (End of Billing Period) |
Metering: 0x0702 | GetSnapshot: 0x06 | -- |
| 1519 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): methodInput: fromDateTime | -- |
Earliest Start Time (this must have the same value as the other fromDateTime in this Use Case) |
|||
| 1525 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): methodInput: toDateTime | -- |
Latest End Time (this must have the same value as the other toDateTime in this Use Case) |
|||
| 520 | SMETS 4.6.5.3; CHTS 4.5.2 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.activeImportRegisterValue/consumption | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
Metering: 0x0702 | (Response/pushed): | Publish Snapshot: 0x06 |
| 1477 | SMETS 4.6.5.3; CHTS 4.5.2 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.Block[1..4].RegisterMatrixValue | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
|||
| 1478 | SMETS 4.6.5.3; CHTS 4.5.2 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.tariffTOU[1..4].RegisterMatrixValue | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
|||
| 607 | SMETS 4.6.5.3; CHTS 4.5.2 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timestamp | -- | -- | |||
| 1871 | (GBZ) | BillingDataLog(BillingCalendarTriggeredExcExport): method: readLog | -- |
Snapshot Cause: 0x00000002 (End of Billing Period) |
Prepayment: 0x0705 | Get Prepay Snapshot: 0x07 | -- |
| 1872 | (GBZ) | BillingDataLog(BillingCalendarTriggeredExcExport): methodInput: fromDateTime | -- |
Earliest Start Time (this must have the same value as the other fromDateTime in this Use Case) |
|||
| 1873 | (GBZ) | BillingDataLog(BillingCalendarTriggeredExcExport): methodInput: toDateTime | -- |
Latest End Time (this must have the same value as the other toDateTime in this Use Case) |
|||
| 1874 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.accumulatedDebtRegisterValue | -- | -- | Prepayment: 0x0705 | (Response): | Publish Prepay Snapshot: 0x01 |
| 1875 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.emergencyCreditBalanceValue | -- | -- | |||
| 1876 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.meterBalanceValue | -- | -- | |||
| 1877 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.paymentDebtRegisterValue | -- | -- | |||
| 1878 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timeDebtRegisters1Value | -- | -- | |||
| 1879 | SMETS 4.6.5.3 | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timeDebtRegisters2Value | -- | -- | |||
| 1880 | (GBZ) | BillingDataLog(BillingCalendarTriggeredExcExport): logEntries[1..12].logEntry.timestamp | -- | -- |
| Encrypted attributes - see section 8 |
This Use Case is to allow a Supplier to obtain a data set stored in the Billing Data Log on the device on an ad-hoc basis for a specified date range.
| Use Case | Title | Message Code |
|---|---|---|
| ECS20b | Read ESME Billing Data Log (change of mode / tariff triggered exc export) | 0x002F |
| GCS15b | Read GSME Billing Data Log (change of mode / tariff triggered) | 0x00C3 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.4 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 519 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.accumulatedDebtRegisterValue | the register value recorded |
Operational data | INTEGER |
| 521 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.activeImportRegisterValue/consumption | the register value recorded |
Operational data | INTEGER |
| 1838 |
SMETS 4.6.5.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.Block[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 522 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.emergencyCreditBalanceValue | the register value recorded |
Operational data | INTEGER |
| 523 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.meterBalanceValue | the register value recorded |
Operational data | INTEGER |
| 524 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.paymentDebtRegisterValue | the register value recorded |
Operational data | INTEGER |
| 1802 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.secondaryActiveImportRegisterValue/consumption | the register value recorded |
Operational data | INTEGER |
| 1803 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.secondaryTariffTOU[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 1839 |
SMETS 4.6.5.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.tariffTOU[1..4].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 526 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.tariffTOU[1..48].RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 528 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block1.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 530 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block2.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 532 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block3.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 534 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.tariffTOU[1..8].Block4.RegisterMatrixValue | the register value recorded |
Operational data | INTEGER |
| 535 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.timeDebtRegisters1Value | the register value recorded |
Operational data | INTEGER |
| 536 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.timeDebtRegisters2Value | the register value recorded |
Operational data | INTEGER |
| 608 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.timestamp | The UTC date-time at which the corresponding snapshot was taken |
Operational data | DATE-TIME |
| 1837 |
SMETS 4.6.5.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | logEntries[1..12].logEntry.timestampGasConsumption | The UTC date-time at which the corresponding snapshot was taken |
Operational data | DATE-TIME |
| 1491 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 1520 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 1526 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x002F |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 608 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.timestamp | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 521 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.activeImportRegisterValue/consumption | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.activeImportRegisterValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1802 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.secondaryActiveImportRegisterValue/consumption | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.secondaryActiveImportRegisterValue | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 526 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.tariffTOU[1..48].RegisterMatrixValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.tariffTOURegisterValues[1..48].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1803 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.secondaryTariffTOU[1..4].RegisterMatrixValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.secondaryTariffTOURegisterValues[1..4].value | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 528 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block1.RegisterMatrixValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.tariffTOUBlock1RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 530 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block2.RegisterMatrixValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.tariffTOUBlock2RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 532 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block3.RegisterMatrixValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.tariffTOUBlock3RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 534 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.tariffTOU[1..8].Block4.RegisterMatrixValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.tariffTOUBlock4RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 522 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.emergencyCreditBalanceValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.emergencyCreditBalanceValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 523 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.meterBalanceValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.meterBalanceValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 524 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.paymentDebtRegisterValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.paymentDebtRegisterValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 535 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.timeDebtRegisters1Value | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.timeDebtRegisters1Value | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 536 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.timeDebtRegisters2Value | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.timeDebtRegisters2Value | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 519 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.accumulatedDebtRegisterValue | 7 | 0-0:98.1.2.255 | A | 2 | buffer:buffer[1..12].entry_billingCalendarOnSetModeOrTariffLogEntry.accumulatedDebtRegisterValue | double-long | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1491 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): readLog | 30 | 0-0:43.2.3.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1520 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): methodInput: fromDateTime | 30 | 0-0:43.2.3.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1526 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): methodInput: toDateTime | 30 | 0-0:43.2.3.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | GPF (primary and for any Remote Party with access rights); GSME (Supplier only) |
|---|---|
| Message Code | 0x00C3 |
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1491 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): method: readLog | -- |
Snapshot Cause = 0x00006008 (Change of Meter Mode | Change of Supplier | Tariff Information) |
Prepayment: 0x0705 | Get Prepay Snapshot: 0x07 | -- |
| 1520 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): methodInput: fromDateTime | -- |
Earliest Start Time (this must have the same value as the other fromDateTime in this Use Case) |
|||
| 1526 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): methodInput: toDateTime | -- |
Latest End Time (this must have the same value as the other toDateTime in this Use Case) |
|||
| 519 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.accumulatedDebtRegisterValue | -- | -- | Prepayment: 0x0705 | (Response): | Publish Prepay Snapshot: 0x01 |
| 522 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.emergencyCreditBalanceValue | -- | -- | |||
| 523 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.meterBalanceValue | -- | -- | |||
| 524 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.paymentDebtRegisterValue | -- | -- | |||
| 535 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.timeDebtRegisters1Value | -- | -- | |||
| 536 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.timeDebtRegisters2Value | -- | -- | |||
| 608 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.timestamp | -- | -- | |||
| 1840 | (GBZ) | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): method: readLogGasConsumption | -- |
Snapshot Cause = 0x00006008 (Change of Meter Mode | Change of Supplier | Tariff Information) |
Metering: 0x0702 | GetSnapshot: 0x06 | -- |
| 1841 | (GBZ) | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): methodInput: fromDateTimeGasConsumption | -- |
Earliest Start Time (this must have the same value as the other fromDateTime in this Use Case) |
|||
| 1842 | (GBZ) | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): methodInput: toDateTimeGasConsumption | -- |
Latest End Time (this must have the same value as the other toDateTime in this Use Case) |
|||
| 521 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.activeImportRegisterValue/consumption | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
Metering: 0x0702 | (Response): | Publish Snapshot: 0x06 |
| 1837 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.timestampGasConsumption | -- | -- | |||
| 1838 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.Block[1..4].RegisterMatrixValue | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
|||
| 1839 | SMETS 4.6.5.3 | BillingDataLog(SetPaymentModeOrTariffTriggeredFinancialExcExport): logEntries[1..12].logEntry.tariffTOU[1..4].RegisterMatrixValue | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
| Encrypted attributes - see section 8 |
This Use Case is to allow a Supplier to obtain a data set stored in the Billing Data Log for the Device on an ad-hoc basis for a specified date range.
| Use Case | Title | Message Code |
|---|---|---|
| ECS20a | Read ESME Billing Data Log (payment based debt payments) | 0x002E |
| GCS15d | Read GSME Billing Data Log (payment-based debt payments) | 0x00C4 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.4 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 517 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment) | logEntries[1..10].logEntry.amount | Amount of debt recovered as part of the Credit Added |
Operational data | INTEGER |
| 592 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment) | logEntries[1..10].logEntry.timestamp | timestamp of recovery |
Operational data | DATE-TIME |
| 574 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 628 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 649 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x002E |
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 574 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment): method: readLog | 7 | 0-0:98.1.4.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 628 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment): methodInput: fromDateTime | 7 | 0-0:98.1.4.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 649 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment): methodInput: toDateTime | 7 | 0-0:98.1.4.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 592 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment): logEntries[1..10].logEntry.timestamp | 7 | 0-0:98.1.4.255 | A | 2 | buffer:buffer[1..10].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 517 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPaymentBasedDebtRepayment): logEntries[1..10].logEntry.amount | 7 | 0-0:98.1.4.255 | A | 2 | buffer:buffer[1..10].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x00C4 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 574 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPaymentBasedDebtRepayment): method: readLog | -- | -- | Prepayment: 0x0705 | Get Debt Repayment Log: 0x0A | -- |
| 628 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPaymentBasedDebtRepayment): methodInput: fromDateTime | -- |
From Date Time |
|||
| 649 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPaymentBasedDebtRepayment): methodInput: toDateTime | -- |
Latest End Time Set to 0xFFFFFFFE to retrieve all entries |
|||
| 517 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPaymentBasedDebtRepayment): logEntries[1..10].logEntry.amount | -- | -- | Prepayment: 0x0705 | (Response): | Publish Debt Log: 0x06 |
| 592 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPaymentBasedDebtRepayment): logEntries[1..10].logEntry.timestamp | -- | -- |
This Use Case is to allow a Supplier to obtain a data set stored in the Billing Data Log for the Device on an ad-hoc basis for a specified date range.
| Use Case | Title | Message Code |
|---|---|---|
| ECS20d | Read ESME Billing Data Log (prepayment credits) | 0x00C9 |
| GCS15e | Read GSME Billing Data Log (prepayment credits) | 0x00C5 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.4 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 558 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits) | logEntries[1..5].logEntry.amount | amount of credit |
Operational data | INTEGER |
| 618 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits) | logEntries[1..5].logEntry.timestamp | timestamp of its application |
Operational data | DATE-TIME |
| 575 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 629 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 650 |
SMETS 4.6.5.3 SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x00C9 |
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 575 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits): method: readLog | 7 | 0-0:98.1.5.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 629 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits): methodInput: fromDateTime | 7 | 0-0:98.1.5.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 650 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits): methodInput: toDateTime | 7 | 0-0:98.1.5.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 618 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits): logEntries[1..5].logEntry.timestamp | 7 | 0-0:98.1.5.255 | A | 2 | buffer:buffer[1..5].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 558 |
SMETS 5.7.5.10 / 5.13.2.3 |
BillingDataLog(mostrecentPrepaymentCredits): logEntries[1..5].logEntry.amount | 7 | 0-0:98.1.5.255 | A | 2 | buffer:buffer[1..5].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x00C5 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 575 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPrepaymentCredits): method: readLog | -- | -- | Prepayment: 0x0705 | Get Top Up Log: 0x08 | -- |
| 629 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPrepaymentCredits): methodInput: fromDateTime | -- |
From Date Time |
|||
| 650 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPrepaymentCredits): methodInput: toDateTime | -- |
Latest End Time Set to 0xFFFFFFFE to retrieve all entries |
|||
| 558 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPrepaymentCredits): logEntries[1..5].logEntry.amount | -- | -- | Prepayment: 0x0705 | (Response): | Publish Top Up Log: 0x05 |
| 618 | SMETS 4.6.5.3 | BillingDataLog(mostrecentPrepaymentCredits): logEntries[1..5].logEntry.timestamp | -- | -- |
This Use Case is for reading the boost button data from the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS61c | Read Boost Function Data | 0x005E |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 7.11 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 12 |
SMETS 5.26.1.1 / 9.14.1.1 |
BoostFunctionAvailability | value | TRUE if a Boost Function, with its SMETS meaning, is present. FALSE otherwise. |
Constant data | BOOLEAN |
| 13 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[1] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [1], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 14 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[2] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [2], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 15 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[3] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [3], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 16 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[4] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [4], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 17 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[5] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [5], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 3 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog | logEntries[1..25].logEntry.boostEnd | The end of the Boost Period, with its SMETS meaning, in UTC. |
Operational data | DATE-TIME |
| 4 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog | logEntries[1..25].logEntry.boostStart | The start of the Boost Period, with its SMETS meaning, in UTC |
Operational data | DATE-TIME |
| 2 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog | method: readLog | The Response shall contain all of the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 5 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, the Response shall contain all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, the Response shall contain all entries between fromDateTime and toDateTime inclusive. |
Method Input | DATE-TIME |
| 6 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, the Response shall contain all entries from the oldest in the log to 'toDateTime'. If not the End of Time, the Response shall contain all entries between fromDateTime and toDateTime inclusive. |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x005E |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 12 |
SMETS 5.26.1.1 / 9.14.1.1 |
BoostFunctionAvailability: value | 1 | 0-0:94.44.7.255 | A | 2 | value | boolean | 0x00 if absent or 0x01 if present |
|
| 2 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog: method: readLog | 7 | 0-0:99.98.20.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 5 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog: methodInput: fromDateTime | 7 | 0-0:99.98.20.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | See GBCS Section 9.1.5 |
| 6 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog: methodInput: toDateTime | 7 | 0-0:99.98.20.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | See GBCS Section 9.1.5 |
| 4 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog: logEntries[1..25].logEntry.boostStart | 7 | 0-0:99.98.20.255 | A | 2 | buffer:buffer[1..25].entry_boostFunctionLogEntry.boost_start | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 3 |
SMETS 5.26.3.1 / 9.14.3.1 |
BoostFunctionEventLog: logEntries[1..25].logEntry.boostEnd | 7 | 0-0:99.98.20.255 | A | 2 | buffer:buffer[1..25].entry_boostFunctionLogEntry.boost_end | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 13 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[1]: value | 1 | 0-0:94.44.6.1 | A | 2 | value | boolean | - | |
| 14 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[2]: value | 1 | 0-0:94.44.6.2 | A | 2 | value | boolean | - | |
| 15 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[3]: value | 1 | 0-0:94.44.6.3 | A | 2 | value | boolean | - | |
| 16 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[4]: value | 1 | 0-0:94.44.6.4 | A | 2 | value | boolean | - | |
| 17 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[5]: value | 1 | 0-0:94.44.6.5 | A | 2 | value | boolean | - |
This Use Case provides details of the list of Devices currently in the Communication Hub's whitelist.
The 'whitelist' is called the CHF Device Log in CHTS.
This Use Case also provides that date-time at which each Device on the HAN was last communicated with by the Communications Hub.
For each Device operating at Sub GHz frequencies, the Use Case provides an indication of the signal strength for the Communications Link.
Note, that the whitelist may not include the GPF's details, and so those details may not be present in the Response.
| Use Case | Title | Message Code |
|---|---|---|
| CCS06 | Read CHF device log and check HAN communications | 0x010F |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 8.9 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 990 |
CHTS 4.6.3.2 |
CHFCommunicationsStore | logEntries[0..16].logentry.lastCommsTimestamp | The UTC date and time at which the Communications Hub last communicated with the Device with the corresponding entry in DeviceLog(CHF).logEntries[0..16] |
Operational data | DATE-TIME |
| 1929 |
CHTS 4.6.3.14 |
CHFCommunicationsStore | logEntries[0..16].logentry.subGHzLinkQuality | If the Device is operating on Sub GHz, an indication of the Communications Link quality for that Device. Otherwise an indicator that it is operating on 2.4GHz. See GBCS Section 10.6.2.1 for the meaning of the integer. |
Operational data | INTEGER |
| 991 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | logEntries[0..16].logentry.entityIdentifier | The list of Entity Identifiers for Devices that are 'whitelisted' on the HAN |
Operational data | OCTET-STRING |
| Target | CHF |
|---|---|
| Message Code | 0x010F |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 991 |
CHTS 4.6.2.1 |
DeviceLog(CHF): logEntries[0..16].logentry.entityIdentifier | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.mac_address | octet-string(8) | - | See Blue Book for a full description |
| 986 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails1 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.status | bit-string(8) | - | See Blue Book for a full description |
| 987 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails2 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.maxRSSI | integer | - | See Blue Book for a full description |
| 1929 |
CHTS 4.6.3.14 |
CHFCommunicationsStore: logEntries[0..16].logentry.subGHzLinkQuality | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.averageRSSI | integer | - | See Blue Book for a full description |
| 989 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails4 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.minRSSI | integer | - | See Blue Book for a full description |
| 995 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails5 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.maxLQI | unsigned | - | See Blue Book for a full description |
| 996 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails6 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.averageLQI | unsigned | - | See Blue Book for a full description |
| 997 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails7 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.minLQI | unsigned | - | See Blue Book for a full description |
| 990 |
CHTS 4.6.3.2 |
CHFCommunicationsStore: logEntries[0..16].logentry.lastCommsTimestamp | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.last_communication_date-time | octet-string(12) | - | See Blue Book for a full description |
| 998 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails8 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.number_of_hops | unsigned | - | See Blue Book for a full description |
| 999 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails9 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.transmission_failures | unsigned | - | See Blue Book for a full description |
| 992 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails10 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.transmission_successes | unsigned | - | See Blue Book for a full description |
| 993 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails11 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.application_version | unsigned | - | See Blue Book for a full description |
| 994 |
CHTS DLMS |
DeviceLog(CHF) - data returned in, but not required by the Use Case: logEntries[0..16].logentry.extradetails12 | 104 | 0-0:30.3.0.255 | A | 4 | active_devices:active_devices[0..16].active_device.stack_version | unsigned | - | See Blue Book for a full description |
This Use Case is for reading the CHF Device Log and the CHF Historic Device Log, including the hash of the security credentials associated with each Device ID (so the hash of the TC Link Key where such a TC Link Key has been established; an empty string otherwise).
| Use Case | Title | Message Code |
|---|---|---|
| CCS07 | Read CHF Device Logs | 0x00FE |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 8.9 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1971 |
CHTS 4.5.1.5 |
DeviceLog(CHF) | readCHFDeviceLog | Reads the CHF Device Log |
Method | Method |
| 1969 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | methodOutput: devices[0..16].device.deviceIdentifier | The device identifiers for each of the Devices in the CHF Device Log. |
Method Output | OCTET-STRING |
| 1968 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | methodOutput: devices[0..16].device.securityDetails | The hash of the security credentials for each of the Devices in the CHF Device Log. Where a TC Link Key between the CH and the Device with this Device ID has been established, this field shall contain a Hash of that TC Link Key. Otherwise this field shall contain an empty string. |
Method Output | OCTET-STRING |
| 1970 | DeviceLog(CHF) | methodOutput: hanIdentifier | The identifier for the HAN. |
Method Output | OCTET-STRING | |
| 1976 |
CHTS 4.5.1.7 |
HistoricDeviceLog(CHF) | readHistoricCHFDeviceLog | Reads the CHF Historic Device Log |
Method | Method |
| 1974 |
CHTS 4.6.3.15 |
HistoricDeviceLog(CHF) | methodOutput: devices[0..16].device.deviceIdentifier | The device identifiers for each of the Devices in the CHF Historic Device Log. |
Method Output | OCTET-STRING |
| 1973 |
CHTS 4.6.3.15 |
HistoricDeviceLog(CHF) | methodOutput: devices[0..16].device.securityDetails | The hash of the security credentials for each of the Devices in the CHF Historic Device Log. Where a TC Link Key between the CH and the Device with this Device ID had been established previously, this field shall contain a Hash of that TC Link Key. Otherwise this field shall contain an empty string. |
Method Output | OCTET-STRING |
| 1975 | HistoricDeviceLog(CHF) | methodOutput: hanIdentifier | The identifier for the HAN. |
Method Output | OCTET-STRING |
| Target | CHF |
|---|---|
| Message Code | 0x00FE |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1971 |
CHTS 4.5.1.5 |
DeviceLog(CHF): readCHFDeviceLog | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN | null (contrary to COSEM) | - | |
| 1967 |
CHTS DLMS |
DeviceLog(CHF): methodOutput: readDateTime | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN.date-time | octet-string(12) | - | Return parameter of backup_PAN method. This date-time is formatted as per 4.1.6.1 of the Blue Book |
| 1970 | DeviceLog(CHF): methodOutput: hanIdentifier | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN.extended_PAN_ID | octet-string(8) | - | ||
| 1969 |
CHTS 4.6.2.1 |
DeviceLog(CHF): methodOutput: devices[0..16].device.deviceIdentifier | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN.devices_to_backup[0..16].device_to_backup.MAC_address | octet-string(8) | - | |
| 1968 |
CHTS 4.6.2.1 |
DeviceLog(CHF): methodOutput: devices[0..16].device.securityDetails | 104 | 0-0:30.3.0.255 | M | 4 | backup_PAN:backup_PAN.devices_to_backup[0..16].device_to_backup.hashed_TC_link_key | octet-string(16) | - | |
| 1976 |
CHTS 4.5.1.7 |
HistoricDeviceLog(CHF): readHistoricCHFDeviceLog | 104 | 0-0:30.3.1.255 | M | 4 | backup_PAN:backup_PAN | null (contrary to COSEM) | - | |
| 1972 |
CHTS DLMS |
HistoricDeviceLog(CHF): methodOutput: readDateTime | 104 | 0-0:30.3.1.255 | M | 4 | backup_PAN:backup_PAN.date-time | octet-string(12) | - | Return parameter of backup_PAN method. This date-time is formatted as per 4.1.6.1 of the Blue Book |
| 1975 | HistoricDeviceLog(CHF): methodOutput: hanIdentifier | 104 | 0-0:30.3.1.255 | M | 4 | backup_PAN:backup_PAN.extended_PAN_ID | octet-string(8) | - | ||
| 1974 |
CHTS 4.6.3.15 |
HistoricDeviceLog(CHF): methodOutput: devices[0..16].device.deviceIdentifier | 104 | 0-0:30.3.1.255 | M | 4 | backup_PAN:backup_PAN.devices_to_backup[0..16].device_to_backup.MAC_address | octet-string(8) | - | |
| 1973 |
CHTS 4.6.3.15 |
HistoricDeviceLog(CHF): methodOutput: devices[0..16].device.securityDetails | 104 | 0-0:30.3.1.255 | M | 4 | backup_PAN:backup_PAN.devices_to_backup[0..16].device_to_backup.hashed_TC_link_key | octet-string(16) | - |
This Use Case is for reading the Event Log on the CHF only.
| Use Case | Title | Message Code |
|---|---|---|
| ECS35c | Read CHF Event Log | 0x0093 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.13 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 587 |
CHTS 4.6.3.3 |
EventLog(CHF) | logEntries[1..100].logEntry.logCode | The Alert / Log Code corresponding to this event (as defined in GBCS) |
Operational data | INTEGER |
| 662 |
CHTS 4.6.3.3 |
EventLog(CHF) | logEntries[1..100].logEntry.otherInformation | Where required by the alert code: other information relating to this alert. See Alert/Log Codes section of the GBCS which details when this is required |
Operational data | OCTET-STRING |
| 601 |
CHTS 4.6.3.3 |
EventLog(CHF) | logEntries[1..100].logEntry.timestamp | The UTC date- time stamp of this entry |
Operational data | DATE-TIME |
| 578 |
CHTS 4.6.3.3 |
EventLog(CHF) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 632 |
CHTS 4.6.3.3 |
EventLog(CHF) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 653 |
CHTS 4.6.3.3 |
EventLog(CHF) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | CHF |
|---|---|
| Message Code | 0x0093 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 578 |
CHTS 4.6.3.3 |
EventLog(CHF): method: readLog | 7 | 0-0:99.98.0.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 632 |
CHTS 4.6.3.3 |
EventLog(CHF): methodInput: fromDateTime | 7 | 0-0:99.98.0.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 653 |
CHTS 4.6.3.3 |
EventLog(CHF): methodInput: toDateTime | 7 | 0-0:99.98.0.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 601 |
CHTS 4.6.3.3 |
EventLog(CHF): logEntries[1..100].logEntry.timestamp | 7 | 0-0:99.98.0.255 | A | 2 | buffer:buffer[1..100].entry_eventLogEntry8.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 587 |
CHTS 4.6.3.3 |
EventLog(CHF): logEntries[1..100].logEntry.logCode | 7 | 0-0:99.98.0.255 | A | 2 | buffer:buffer[1..100].entry_eventLogEntry8.logCode | long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 662 |
CHTS 4.6.3.3 |
EventLog(CHF): logEntries[1..100].logEntry.otherInformation | 7 | 0-0:99.98.0.255 | A | 2 | buffer:buffer[1..100].entry_eventLogEntry8.otherInformation | octet-string(8) | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
This Use Case is for reading the Security Log on the CHF.
| Use Case | Title | Message Code |
|---|---|---|
| ECS35d | Read CHF Security Log | 0x0094 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.13 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 589 |
CHTS 4.6.3.5 |
SecurityLog(CHF) | logEntries[1..100].logEntry.logCode | The Alert / Log Code corresponding to this event (as defined in GBCS) |
Operational data | INTEGER |
| 604 |
CHTS 4.6.3.5 |
SecurityLog(CHF) | logEntries[1..100].logEntry.timestamp | The UTC date- time stamp of this entry |
Operational data | DATE-TIME |
| 584 |
CHTS 4.6.3.5 |
SecurityLog(CHF) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 638 |
CHTS 4.6.3.5 |
SecurityLog(CHF) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 659 |
CHTS 4.6.3.5 |
SecurityLog(CHF) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | CHF |
|---|---|
| Message Code | 0x0094 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 584 |
CHTS 4.6.3.5 |
SecurityLog(CHF): method: readLog | 7 | 0-0:99.98.1.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 638 |
CHTS 4.6.3.5 |
SecurityLog(CHF): methodInput: fromDateTime | 7 | 0-0:99.98.1.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 659 |
CHTS 4.6.3.5 |
SecurityLog(CHF): methodInput: toDateTime | 7 | 0-0:99.98.1.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 604 |
CHTS 4.6.3.5 |
SecurityLog(CHF): logEntries[1..100].logEntry.timestamp | 7 | 0-0:99.98.1.255 | A | 2 | buffer:buffer[1..100].entry_securityLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 589 |
CHTS 4.6.3.5 |
SecurityLog(CHF): logEntries[1..100].logEntry.logCode | 7 | 0-0:99.98.1.255 | A | 2 | buffer:buffer[1..100].entry_securityLogEntry.logCode | long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
A request to the CHF to read the Sub GHz Channel Log. See GBCS 10.6.2.1 for the specific meaning of each of the values in a log entry.
| Use Case | Title | Message Code |
|---|---|---|
| DBCH02 | Read CHF Sub GHz Channel Log | 0x010B |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.32 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1927 |
CHTS 4.6.3.13 |
SubGHzChannelLog | logEntries[0..100].logEntry.logCode | The Alert / Log Code corresponding to this event (as defined in GBCS). For this log, all entries will have the same code. |
Operational data | INTEGER |
| 1928 |
CHTS 4.6.3.13 |
SubGHzChannelLog | logEntries[0..100].logEntry.otherInformation | Specifies the Sub GHz Channel that the CH began operating on at this date-time. See GBCS 10.6.2.1 for the specific meaning of each part of the value returned. |
Operational data | OCTET-STRING |
| 1926 |
CHTS 4.6.3.13 |
SubGHzChannelLog | logEntries[0..100].logEntry.timestamp | The UTC date-time stamp at which this event happened, according to the CH Date and Time |
Operational data | DATE-TIME |
| 1923 |
CHTS 4.6.3.13 |
SubGHzChannelLog | method: readLog | The Response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 1924 |
CHTS 4.6.3.13 |
SubGHzChannelLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, the Response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, the Response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 1925 |
CHTS 4.6.3.13 |
SubGHzChannelLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, the Response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, the Response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | CHF in a Dual Band CH only |
|---|---|
| Message Code | 0x010B |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1923 |
CHTS 4.6.3.13 |
SubGHzChannelLog: method: readLog | 7 | 0-0:94.44.10.3 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 1924 |
CHTS 4.6.3.13 |
SubGHzChannelLog: methodInput: fromDateTime | 7 | 0-0:94.44.10.3 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 1925 |
CHTS 4.6.3.13 |
SubGHzChannelLog: methodInput: toDateTime | 7 | 0-0:94.44.10.3 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 1926 |
CHTS 4.6.3.13 |
SubGHzChannelLog: logEntries[0..100].logEntry.timestamp | 7 | 0-0:94.44.10.3 | A | 2 | buffer:buffer[0..100].entry_eventLogEntry8.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1927 |
CHTS 4.6.3.13 |
SubGHzChannelLog: logEntries[0..100].logEntry.logCode | 7 | 0-0:94.44.10.3 | A | 2 | buffer:buffer[0..100].entry_eventLogEntry8.logCode | long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1928 |
CHTS 4.6.3.13 |
SubGHzChannelLog: logEntries[0..100].logEntry.otherInformation | 7 | 0-0:94.44.10.3 | A | 2 | buffer:buffer[0..100].entry_eventLogEntry8.otherInformation | octet-string(8) | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
A request to the CHF to read the Sub GHz Channel the CH is currently operating on. See GBCS 10.6.2.1 for the specific meaning of each part of the value returned.
| Use Case | Title | Message Code |
|---|---|---|
| DBCH01 | Read CHF Sub GHz Channel | 0x010A |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.31 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1922 |
CHTS 4.6.3.12 |
OperatingSubGHzChannel | value | See GBCS 10.6.2.1. |
Operational data |
| Target | CHF in a Dual Band CH only |
|---|---|
| Message Code | 0x010A |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1922 |
CHTS 4.6.3.12 |
OperatingSubGHzChannel: value | 1 | 0-0:94.44.10.2 | A | 2 | value | bit-string(32) | - |
A request to the CHF to read the Sub GHz Configuration values. See GBCS 10.6.2.3 for the specific meaning of each of the values.
| Use Case | Title | Message Code |
|---|---|---|
| DBCH03 | Read CHF Sub GHz Configuration | 0x010C |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.30 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1915 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | channelNoisierTheshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1914 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | channelQuieterThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1913 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | gSMECurfew | See GBCS 10.6.2.3. |
Configuration data | |
| 1911 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | limited-CriticalDutyCycleThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1919 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHFailurePercentage | See GBCS 10.6.2.3. |
Configuration data | |
| 1918 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHNoiseMeasurementPeriod | See GBCS 10.6.2.3. |
Configuration data | |
| 1920 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHRetryPercentage | See GBCS 10.6.2.3. |
Configuration data | |
| 1912 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | maximumSubGHzChannelChangesPerWeek | See GBCS 10.6.2.3. |
Configuration data | |
| 1916 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | nonGSMEPoorCommunicationsPercentageThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1917 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | nonGSMEPoorCommunicationsThirtyMinutePeriodsMeasurementPeriod | See GBCS 10.6.2.3. |
Configuration data | |
| 1910 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | normal-LimitedDutyCycleThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1905 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page28Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1906 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page29Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1907 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page30Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1908 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page31Mask | See GBCS 10.6.2.3. |
Configuration data |
| Target | CHF in a Dual Band CH only |
|---|---|
| Message Code | 0x010C |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1905 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page28Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page28Mask | bit-string(32) | - | |
| 1906 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page29Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page29Mask | bit-string(32) | - | |
| 1907 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page30Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page30Mask | bit-string(32) | - | |
| 1908 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page31Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page31Mask | bit-string(32) | - | |
| 1910 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: normal-LimitedDutyCycleThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.normalLimitedDutyCycleThreshold | long-unsigned | - | |
| 1911 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: limited-CriticalDutyCycleThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.limitedCriticalDutyCycleThreshold | long-unsigned | - | |
| 1912 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: maximumSubGHzChannelChangesPerWeek | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.channelChangesPerWeek | unsigned | - | |
| 1913 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: gSMECurfew | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.gsmeCurfew | long-unsigned | - | |
| 1914 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: channelQuieterThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.quieterDecibelsLimit | unsigned | - | |
| 1915 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: channelNoisierTheshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.noisierDecibelsLimit | unsigned | - | |
| 1916 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: nonGSMEPoorCommunicationsPercentageThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.nonGsmePoorCommsPercentage | long-unsigned | - | |
| 1917 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: nonGSMEPoorCommunicationsThirtyMinutePeriodsMeasurementPeriod | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.nonGsmeMeasurementPeriods | unsigned | - | |
| 1918 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHNoiseMeasurementPeriod | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChNoiseMeasurementPeriod | long-unsigned | - | |
| 1919 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHFailurePercentage | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChFailurePercentage | long-unsigned | - | |
| 1920 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHRetryPercentage | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChRetryPercentage | long-unsigned | - |
This Use Case is for reading the Device information Configuration Data on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26c | Read ESME Configuration Data Device Information (randomisation) | 0x003D |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 65 |
SMETS 5.7.5.28 / 9.6.3.4 |
RandomisedOffset | value | RandomisedOffsetNumber.value * RandomisedOffsetLimit * (10 to the power -4) rounded to the nearest integer number of seconds |
Operational data | INTEGER |
| 66 |
SMETS 5.7.4.33 / 9.6.2.6 |
RandomisedOffsetLimit | value | Integer between 0 and 1799 |
Configuration data | INTEGER |
| 67 |
SMETS 5.7.1.5 / 9.6.1.4 |
RandomisedOffsetNumber | value | Integer between 1 and 10,000 randomly set at manufacture |
Constant data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x003D |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 65 |
SMETS 5.7.5.28 / 9.6.3.4 |
RandomisedOffset: value | 1 | 0-0:94.44.0.0 | A | 2 | value | long-unsigned | - | |
| 67 |
SMETS 5.7.1.5 / 9.6.1.4 |
RandomisedOffsetNumber: value | 1 | 0-0:94.44.0.2 | A | 2 | value | long-unsigned | - | |
| 66 |
SMETS 5.7.4.33 / 9.6.2.6 |
RandomisedOffsetLimit: value | 1 | 0-0:94.44.0.1 | A | 2 | value | long-unsigned | - |
This Use Case is for reading the billing calendar configuration.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26l | Read ESME Configuration Data Device Information (Billing Calendar - all periodicities) | 0x00D9 |
| GCS21k | Read GSME Configuration Data Device Information (BillingCalendar - all periodicities) | 0x00DA |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1965 |
SMETS 4.6.4.2 |
BillingCalendar | startDateTimeAndAnyPeriodicity | The date-time of the first billing calendar snapshot and the periodicity of following ones after that |
Operational data | DATE-TIME and Periodicity |
| 1963 |
SMETS 4.6.4.2 SMETS 5.7.4.7 |
BillingCalendar | startDateTimeAndLongerPeriodicity | The date-time of the first billing calendar snapshot and the periodicity of following ones after that (where periodicity can be daily, weekly, monthly, quarterly, six monthly or yearly if being set, or all periodicities if being read). A start date-time of 29th, 30th or 31st of month should not be used. |
Configuration data | DATE-TIME and Periodicity |
| Target | ESME |
|---|---|
| Message Code | 0x00D9 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1963 |
SMETS 5.7.4.7 |
BillingCalendar: startDateTimeAndLongerPeriodicity | 22 | 0-0:15.0.0.255 | A | 4 | execution_time:execution_time[1..4].execution_time_date | EXCEPTIONAL | - | See Section 18.2.1 of the GBCS for encoding of this field |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x00DA |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1965 | SMETS 4.6.4.2 | BillingCalendar: startDateTimeAndAnyPeriodicity | -- | -- | Price: 0x0700 | GetBillingPeriod: 0x0B | PublishBillingPeriod: 0x09 |
This Use Case is for reading the Communication Hub's Manufacturer Identifier and Model Type. Note that, in common with all other Responses, the Device's Entity Identifier is also returned, with it being part of the Grouping Header.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26n | Read CHF Configuration Data Device Information (CH identity and type) | 0x00FA |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1961 |
CHTS 4.6.1.2 |
CHManufacturerIdentifier | value | The value shall be fixed at manufacture to be a 4 octet utf-8 encoded, hexadecimal representation of the Manufacturer ID allocated by the ZigBee Alliance. The value equates to the corresponding DUIS Read Inventory DeviceManufacturer data item. |
Constant data | OCTET-STRING |
| 1962 |
CHTS 4.6.1.3 |
ModelType(CommsHub) | value | The value shall be fixed at manufacture to be the 8 octet concatenation (value of Image Type) || (value of OTA Hardware Version), and so shall be fixed to the corresponding DUIS Read Inventory DeviceModel data item value for this Device. The (value of Image Type) shall be a 4 octet utf-8 encoded, hexadecimal representation of the 16 bit unsigned integer equating to the Image Type parameter in the OTA cluster. The (value of OTA Hardware Version) shall be a 4 octet utf-8 encoded, hexadecimal representation of the 16 bit unsigned integer equating to the value of the Hardware Version parameter in the OTA cluster. |
Constant data | OCTET-STRING |
| Target | CHF |
|---|---|
| Message Code | 0x00FA |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1962 |
CHTS 4.6.1.3 |
ModelType(CommsHub): value | 1 | 0-0:96.1.4.255 | A | 2 | value | octet-string(8) | - | |
| 1961 |
CHTS 4.6.1.2 |
CHManufacturerIdentifier: value | 1 | 0-0:96.1.6.255 | A | 2 | value | octet-string(4) | - |
This Use Case is for reading general Configuration Data.
| Use Case | Title | Message Code |
|---|---|---|
| GCS21a | Read Gas Configuration Data Device Information | 0x007B |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1740 |
SMETS 4.6.4.3 |
CalorificValue | value | The amount of energy released when a known volume of gas is completely combusted under specified conditions, measured in Megajoules per cubic metre (MJ/m3) |
Operational data | INTEGER |
| 1741 |
SMETS 4.6.4.5 |
ConversionFactor | value | Divisor to convert gas energy to kWh |
Operational data | INTEGER |
| 1870 |
SMETS 4.6.4.33 |
UncontrolledGasFlowRate | measurementPeriod | Period over which the flow is measured, in seconds |
Configuration data | INTEGER |
| 1869 |
SMETS 4.6.4.33 |
UncontrolledGasFlowRate | stabilisationPeriod | Time given for flow to stabilise, in tenths of a second |
Configuration data | INTEGER |
| 1754 |
SMETS 4.6.4.33 |
UncontrolledGasFlowRate | value | The threshold value |
Operational data | INTEGER |
| Target | GSME |
|---|---|
| Message Code | 0x007B |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1740 | SMETS 4.6.4.3 | CalorificValue: value | UINT32 | Commodity: CalorificValue: 0x0304 | Price: 0x0700 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1710 | (GBZ) | CalorificValue: unit | ENUM8 | Commodity: CalorificValueUnit: 0x0305 | |||
| 1558 | (GBZ) | CalorificValue: scale | BITMAP8 (NIBBLES) | Commodity: Calorific Value Trailing Digit: 0x0306 | |||
| 1741 | SMETS 4.6.4.5 | ConversionFactor: value | UINT32 | Commodity: ConversionFactor: 0x0302 | |||
| 1559 | (GBZ) | ConversionFactor: scale | BITMAP8 (NIBBLES) | Commodity: ConversionFactorTrailingDigit: 0x0303 | |||
| 1754 | SMETS 4.6.4.33 | UncontrolledGasFlowRate: value | UINT16 | Supply Control: Uncontrolled Flow Threshold: 0x0B10 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1738 | (GBZ) | UncontrolledGasFlowRate: unit | ENUM8 | Supply Control: Uncontrolled Flow Threshold Unit of Measure: 0x0B11 | |||
| 1666 | (GBZ) | UncontrolledGasFlowRate: scaleMultiplier | UINT16 | Supply Control: Uncontrolled Flow Multiplier: 0x0B12 | |||
| 1665 | (GBZ) | UncontrolledGasFlowRate: scaleDivisor | UINT16 | Supply Control: Uncontrolled Flow Divisor: 0x0B13 | |||
| 1869 | SMETS 4.6.4.33 | UncontrolledGasFlowRate: stabilisationPeriod | UINT8 | Supply Control: Flow Stabilisation Period: 0x0B14 | |||
| 1870 | SMETS 4.6.4.33 | UncontrolledGasFlowRate: measurementPeriod | UINT16 | Supply Control: Flow Measurement Period: 0x0B15 |
This Use Case is for reading the configured instantaneous power thresholds.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26f | Read ESME Configuration Data Device Information (instantaneous power thresholds) | 0x0040 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 862 |
SMETS 5.7.4.24 |
LowMediumPowerThreshold | threshold | The value of the Threshold between Low and Medium power |
Configuration data | INTEGER |
| 863 |
SMETS 5.7.4.29 |
MediumHighPowerThreshold | threshold | The value of the Threshold between Medium and High power |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x0040 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 862 |
SMETS 5.7.4.24 |
LowMediumPowerThreshold: threshold | 21 | 0-0:16.0.0.255 | A | 2 | thresholds:thresholds[1of2..2].threshold | double-long-unsigned | - | First entry in the array of 2 entries |
| 863 |
SMETS 5.7.4.29 |
MediumHighPowerThreshold: threshold | 21 | 0-0:16.0.0.255 | A | 2 | thresholds:thresholds[2of2..2].threshold | double-long-unsigned | - | Second entry in the array of 2 entries |
This Use Case is for reading the payment mode configuration.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26j | Read ESME Configuration Data Device Information (Payment Mode) | 0x00BE |
| GCS21j | Read GSME Configuration Data Device Information (Payment Mode) | 0x00BF |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1018 |
SMETS 4.6.4.21 SMETS 5.7.4.31 |
PaymentMode | value.PaymentMode | Credit(TRUE),Prepayment(FALSE) |
Configuration data | BOOLEAN |
| 1024 |
SMETS 4.6.4.21 / 4.6.4.27 / 4.6.4.28 SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode | value | See SMETS |
Configuration data | BOOLEAN (three) |
| Target | ESME |
|---|---|
| Message Code | 0x00BE |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1018 |
SMETS 5.7.4.31 |
PaymentMode: value.PaymentMode | 111 | 0-0:19.0.0.255 | A | 2 | account_mode_and_status:account_mode_and_status.payment_mode | enum | - | |
| 1019 |
(DLMS) |
PaymentMode: value.Status | 111 | 0-0:19.0.0.255 | A | 2 | account_mode_and_status:account_mode_and_status.account_status | enum | 2 |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x00BF |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1018 | SMETS 4.6.4.21 | PaymentMode: value.PaymentMode | BITMAP16 | Prepayment Information: Payment Control Configuration: 0x0000 | Prepayment: 0x0705 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1024 | SMETS 4.6.4.21 / 4.6.4.27 / 4.6.4.28 | SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: value | BITMAP16 | Prepayment Information: Payment Control Configuration: 0x0000 |
This Use Case is for reading the Smart Meter's Manufacturer Identifier , Model Type and Supply Tamper State. For GSME, Supply Depletion State is also returned. Note that, in common with all other Responses, the Device's Entity Identifier is also returned, with it being part of the Grouping Header.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26m | Read ESME Configuration Data Device Information (identity, type and supply tamper state) | 0x00F9 |
| GCS21m | Read GSME Configuration Data Device Information (identity, type and supply tamper / depletion state) | 0x00FB |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1956 |
SMETS 4.6.1.2 SMETS 5.7.1.2 / 9.6.1.2 |
ManufacturerIdentifier | value | The value shall be fixed at manufacture to be a 4 octet utf-8 encoded, hexadecimal representation of the Manufacturer ID allocated by the ZigBee Alliance and so shall be equivalent to the 16 bit unsigned integer used by Devices in the Manufacturer Code parameter in relation to the OTA cluster. The value equates to the corresponding DUIS Read Inventory DeviceManufacturer data item. |
Constant data | OCTET-STRING |
| 1958 |
SMETS 5.7.1.4 |
MeterVariant | value | Set at manufacture. The value set shall be the single utf-8 octet that reflects what the meter is from the values 'A' (meaning Single Element Electricity Metering Equipment), 'B' (meaning Twin Element Electricity Metering Equipment) or 'C' (meaning Polyphase Electricity Metering Equipment). |
Constant data | OCTET-STRING |
| 1957 |
SMETS 4.6.1.3 SMETS 5.7.1.3 / 9.6.1.3 |
ModelType(SmartMeter) | value | The value shall be fixed at manufacture to be the 8 octet concatenation (value of Image Type) || (value of OTA Hardware Version), which equates to the corresponding DUIS Read Inventory DeviceModel data item.. The (value of Image Type) shall be a 4 octet utf-8 encoded, hexadecimal representation of the 16 bit unsigned integer used by Devices in the value of the Image Type parameter in relation to the OTA cluster. The (value of OTA Hardware Version) shall be a 4 octet utf-8 encoded, hexadecimal representation of the 16 bit unsigned integer used by Devices in the value of the Hardware Version parameter in relation to the OTA cluster. |
Constant data | OCTET-STRING |
| 1959 |
SMETS 4.6.4.25 |
SupplyDepletionState | value | Locked(TRUE), Unchanged(FALSE) |
Operational data | BOOLEAN |
| 1960 |
SMETS 4.6.4.26 SMETS 5.7.4.44 |
SupplyTamperState | value | Locked(TRUE), Unchanged(FALSE) |
Configuration data | BOOLEAN |
| Target | ESME |
|---|---|
| Message Code | 0x00F9 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1958 |
SMETS 5.7.1.4 |
MeterVariant: value | 1 | 0-0:96.1.2.255 | A | 2 | value | octet-string(1) | - | |
| 1957 |
SMETS 5.7.1.3 / 9.6.1.3 |
ModelType(SmartMeter): value | 1 | 0-0:96.1.4.255 | A | 2 | value | octet-string(8) | - | |
| 1956 |
SMETS 5.7.1.2 / 9.6.1.2 |
ManufacturerIdentifier: value | 1 | 0-0:96.1.6.255 | A | 2 | value | octet-string(4) | - | |
| 1960 |
SMETS 5.7.4.44 |
SupplyTamperState: value | 1 | 0-0:94.44.0.4 | A | 2 | value | boolean | - |
| Target | GSME |
|---|---|
| Message Code | 0x00FB |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1956 | SMETS 4.6.1.2 | ManufacturerIdentifier: value | CHARSTRING[n] | BasicDeviceInformation: ManufacturerName: 0x0004 | Basic: 0x0000 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1957 | SMETS 4.6.1.3 | ModelType(SmartMeter): value | CHARSTRING[n] | BasicDeviceInformation: ModelIdentifier: 0x0005 | |||
| 1960 | SMETS 4.6.4.26 | SupplyTamperState: value | ENUM8 | Supply Limit: SupplyTamperState: 0x0607 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1959 | SMETS 4.6.4.25 | SupplyDepletionState: value | ENUM8 | Supply Limit: SupplyDepletionState: 0x0608 |
This Use Case is for reading prepayment Configuration Data.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26a | Read ESME Configuration Data Prepayment | 0x003B |
| GCS21b | Read GSME Configuration Data Prepayment | 0x00B5 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.13 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1756 |
SMETS 4.6.4.8 |
DebtRecoveryperPayment | percentage(ZSE Reading) | Use in the ZSE read use case. Integer representing percentage of each payment taken to recover debt. This is a number between 0 and 10,000 ( so, for example, 3000 represents 30% ) |
Operational data | INTEGER |
| 1151 |
SMETS 4.6.4.8 SMETS 5.7.4.11 |
DebtRecoveryperPayment | valueCurrent | Integer representing percentage of each payment taken to recover debt. This is a number between 0 and 10,000 ( so, for example, 3000 represents 30% ) |
Configuration data | INTEGER |
| 1035 |
SMETS 4.6.4.10 SMETS 5.7.4.13 |
DebtRecoveryRateCap | amountCurrent | The amount of the cap |
Configuration data | INTEGER |
| 1036 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap | periodCurrent | The time period over which the DebtRecoveryRateCap will be applied. The ZSE specification fixes this at 1 week and so it is not a parameter in the command to the GSME / response from it. The DLMS COSEM value is fixed at 604800 seconds (1 week) in alignment with the ZSE constraint. Thus, 1 week shall mean a 7 day by 24 hour period prior to the point at which any calculation is undertaken using the Debt Recovery Rate Cap. |
Configuration data | INTEGER |
| 1093 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[1] | amountCurrent | charge per periodCurrent |
Configuration data | INTEGER |
| 1145 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[1] | periodCurrent | Period over which amountCurrent is to be recovered. The valid periods are hour (3600 seconds), day (86,400 seconds) |
Configuration data | INTEGER |
| 1668 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[1] | scalerCurrent | -5 for Gas; variable for Electricity (power of 10 to apply when interpreting the amountCurrent) |
Configuration data | INTEGER |
| 1094 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[2] | amountCurrent | charge per periodCurrent |
Configuration data | INTEGER |
| 1146 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[2] | periodCurrent | Period over which amountCurrent is to be recovered. The valid periods are hour (3600 seconds), day (86,400 seconds) |
Configuration data | INTEGER |
| 1669 |
SMETS 4.6.4.9 SMETS 5.7.4.12 |
DebtRecoveryRates[2] | scalerCurrent | -5 for Gas; variable for Electricity (power of 10 to apply when interpreting the amountCurrent) |
Configuration data | INTEGER |
| 864 |
SMETS 4.6.4.12 SMETS 5.7.4.15 |
DisablementThreshold(MeterBalance) | thresholdCurrent | Threshold value |
Configuration data | INTEGER |
| 1042 |
SMETS 4.6.4.13 SMETS 5.7.4.16 |
EmergencyCreditLimit | amountCurrent | maximum amount that could be made available |
Configuration data | INTEGER |
| 1043 |
SMETS 4.6.4.14 SMETS 5.7.4.17 |
EmergencyCreditThreshold | thresholdCurrent | Threshold value (of meter balance ) at which emergency credit becomes available and can be selected |
Configuration data | INTEGER |
| 1034 |
SMETS 4.6.4.16 SMETS 5.7.4.23 |
LowCreditThreshold | thresholdCurrent | threshold in currency units |
Configuration data | INTEGER |
| 1695 |
SMETS 4.6.4.20 SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays) | date[0..20].current | This is the date (or set of dates if wildcards are used) of the corresponding special day |
Configuration data | DATE WITH WILDCARDS |
| 1697 |
SMETS 4.6.4.20 SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays) | dayIdentifier[0..20].current | This is a number used in calendar entries that require execution on this special day. |
Configuration data | INTEGER |
| 1461 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentDayIdentifiers[1..5] | The trigger points in the calendar, specified in terms of dayIdentifier and time within that day |
Operational data | INTEGER |
| 1881 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentDayIdentifiers[1..5].Time[1..3].actions | Defines whether, at the associated start time, a non-disablement period starts or ends (so Enabled or Not Enabled) |
Configuration data | INTEGER |
| 1462 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentDayIdentifiers[1..5].Time[1..3].startTime | The trigger points in the calendar, specified in terms of dayIdentifier and time within that day. 'nextDayIdentifiers[1..5].Time[1].startTime' must always be midnight UTC to align to ZSE constraints |
Operational data | TIME NO WILDCARDS |
| 1464 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentSeasons[1..3].startDate | This is the date on which the season starts. [the season will end the day the next season starts] |
Operational data | DATE WITH WILDCARDS |
| 1465 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentSeasons[1..3].WeekIdentifier | The name used to refer to the week structure used in this season |
Operational data | OCTET-STRING |
| 1466 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentWeeks[1..2].days[1].Identifier | dayIdentifier for Monday |
Operational data | INTEGER |
| 1467 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentWeeks[1..2].days[2].Identifier | dayIdentifier for Tuesday |
Operational data | INTEGER |
| 1468 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentWeeks[1..2].days[3].Identifier | dayIdentifier for Wednesday |
Operational data | INTEGER |
| 1469 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentWeeks[1..2].days[4].Identifier | dayIdentifier for Thursday |
Operational data | INTEGER |
| 1470 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentWeeks[1..2].days[5].Identifier | dayIdentifier for Friday |
Operational data | INTEGER |
| 1471 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentWeeks[1..2].days[6].Identifier | dayIdentifier for Saturday |
Operational data | INTEGER |
| 1472 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentWeeks[1..2].days[7].Identifier | dayIdentifier for Sunday |
Operational data | INTEGER |
| 1473 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | currentWeeks[1..2].weekIdentifier | The name given to a particular week structure |
Operational data | OCTET-STRING |
| 771 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].beginDate | The earliest date on which this entry in entries will take effect |
Configuration data | DATE-TIME no wildcards |
| 773 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].endDate | The last date on which this entry in entries will take effect |
Configuration data | DATE-TIME no wildcards |
| 731 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].execSpecdays[0..20] | Each boolean determines whether this entry executes on this day |
Configuration data | Series of BOOLEANS |
| 733 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].execWeekdays[1..7] | Each boolean determines whether this entry executes on this day |
Configuration data | Series of BOOLEANS |
| 752 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].scriptRef | See the Blue Book and section 7.3.7 of the GBCS |
Configuration data | INTEGER |
| 763 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].time | The time during the day at which the action is triggered |
Configuration data | TIME NO WILDCARDS |
| 1167 |
SMETS 4.6.4.17 SMETS 5.7.4.25 |
PrepaymentCredit(MaximumCreditThreshold) | valueCurrent | The largest value of any one credit |
Configuration data | INTEGER |
| 1168 |
SMETS 4.6.4.18 SMETS 5.7.4.27 |
PrepaymentCredit(MaxMeterBalance) | valueCurrent | The largest value that a credit could take MeterBalance.value to and still be accepted |
Configuration data | INTEGER |
| 1024 |
SMETS 4.6.4.21 / 4.6.4.27 / 4.6.4.28 SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode | value | See SMETS |
Configuration data | BOOLEAN (three) |
| Target | ESME |
|---|---|
| Message Code | 0x003B |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1058 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.commodityScale | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1668 |
SMETS 5.7.4.12 |
DebtRecoveryRates[1]: scalerCurrent | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.price_scale | integer | - | |
| 1076 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.classID | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.class_id | long-unsigned | 0 | |
| 1088 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.LN | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1052 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.attribute_index | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.attribute_index | integer | 0 | |
| 1082 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.index | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1093 |
SMETS 5.7.4.12 |
DebtRecoveryRates[1]: amountCurrent | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1816 |
(DLMS) |
Non-DisablementCalendar(SpecialDays): index[0..20].current | 11 | 0-0:11.0.2.255 | A | 2 | entries:entries[0..20].spec_day_entry.index | long-unsigned | - | |
| 1695 |
SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays): date[0..20].current | 11 | 0-0:11.0.2.255 | A | 2 | entries:entries[0..20].spec_day_entry.specialday_date | octet-string(5) | - | Formatted as date (octet-string(5)) according to 4.1.6.1 of the Blue Book |
| 1697 |
SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays): dayIdentifier[0..20].current | 11 | 0-0:11.0.2.255 | A | 2 | entries:entries[0..20].spec_day_entry.day_id | unsigned | - | |
| 1145 |
SMETS 5.7.4.12 |
DebtRecoveryRates[1]: periodCurrent | 113 | 0-0:19.20.1.255 | A | 8 | period | double-long-unsigned | - | |
| 1944 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.commodityScale | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1954 |
(DLMS) |
DebtRecoveryRates[1]: scalerCurrent | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.price_scale | integer | - | |
| 1946 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.classID | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.class_id | long-unsigned | 0 | |
| 1950 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.LN | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1942 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.attribute_index | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.attribute_index | integer | 0 | |
| 1948 |
(DLMS) |
DebtRecoveryRates[1]: valueCurrent.index | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1952 |
(DLMS) |
DebtRecoveryRates[1]: amountCurrent | 113 | 0-0:19.20.1.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1059 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.commodityScale | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1669 |
SMETS 5.7.4.12 |
DebtRecoveryRates[2]: scalerCurrent | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.price_scale | integer | - | |
| 1077 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.classID | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.class_id | long-unsigned | 0 | |
| 1089 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.LN | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1053 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.attribute_index | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.attribute_index | integer | 0 | |
| 1083 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.index | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1094 |
SMETS 5.7.4.12 |
DebtRecoveryRates[2]: amountCurrent | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1146 |
SMETS 5.7.4.12 |
DebtRecoveryRates[2]: periodCurrent | 113 | 0-0:19.20.2.255 | A | 8 | period | double-long-unsigned | - | |
| 1945 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.commodityScale | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1955 |
(DLMS) |
DebtRecoveryRates[2]: scalerCurrent | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.price_scale | integer | - | |
| 1947 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.classID | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.class_id | long-unsigned | 0 | |
| 1951 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.LN | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1943 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.attribute_index | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.attribute_index | integer | 0 | |
| 1949 |
(DLMS) |
DebtRecoveryRates[2]: valueCurrent.index | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1953 |
(DLMS) |
DebtRecoveryRates[2]: amountCurrent | 113 | 0-0:19.20.2.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1151 |
SMETS 5.7.4.11 |
DebtRecoveryperPayment: valueCurrent | 113 | 0-0:19.20.3.255 | A | 13 | proportion | long-unsigned | ||
| 1167 |
SMETS 5.7.4.25 |
PrepaymentCredit(MaximumCreditThreshold): valueCurrent | 9000 | 0-0:94.44.2.10 | A | 2 | value_active | double-long | - | |
| 864 |
SMETS 5.7.4.15 |
DisablementThreshold(MeterBalance): thresholdCurrent | 21 | 0-0:16.0.1.255 | A | 2 | thresholds:thresholds[1..1].threshold | double-long | - | The single entry in the array |
| 1168 |
SMETS 5.7.4.27 |
PrepaymentCredit(MaxMeterBalance): valueCurrent | 9000 | 0-0:94.44.2.20 | A | 2 | value_active | double-long | - | |
| 1034 |
SMETS 5.7.4.23 |
LowCreditThreshold: thresholdCurrent | 111 | 0-0:19.0.0.255 | A | 16 | low_credit_threshold | double-long | - | threshold (in millipence) |
| 1035 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap: amountCurrent | 111 | 0-0:19.0.0.255 | A | 18 | max_provision | long-unsigned | - | The ESME shall interpret this value as having an associated scalar of zero, so meaning it represents a value in whole currency units. |
| 1036 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap: periodCurrent | 111 | 0-0:19.0.0.255 | A | 19 | max_provision_period | double-long | - | |
| 1042 |
SMETS 5.7.4.16 |
EmergencyCreditLimit: amountCurrent | 112 | 0-0:19.10.1.255 | A | 9 | preset_credit_amount | double-long | - | |
| 1043 |
SMETS 5.7.4.17 |
EmergencyCreditThreshold: thresholdCurrent | 112 | 0-0:19.10.1.255 | A | 10 | credit_available_threshold | double-long | - | threshold (in millipence) |
| 751 |
(DLMS) |
Non-DisablementCalendar: entries[1..22].Index | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.index | long-unsigned | - | |
| 741 |
(DLMS) |
Non-DisablementCalendar: entries[1..22].enable | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.enable | boolean | ||0x01 | |
| 781 |
(DLMS) |
Non-DisablementCalendar: entries[1..22].scriptTable | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.script_logical_name | octet-string(6) | ||0x00000A006AFF | |
| 752 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].scriptRef | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.script_selector | long-unsigned | - | |
| 763 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].time | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.switch_time | octet-string(4) | - | |
| 759 |
(DLMS) |
Non-DisablementCalendar: entries[1..22].validityWindow | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.validity_window | long-unsigned | ||0xFFFF | |
| 733 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].execWeekdays[1..7] | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.exec_weekdays | bit-string(7) | - | |
| 731 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].execSpecdays[0..20] | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.exec_specdays | bit-string(20) | - | The length of this bit-string is variable and must align to the number of special days specified in the associated special days object. The length shown is the maximum number of such special days. |
| 771 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].beginDate | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.begin_date | octet-string(5) | - | |
| 773 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].endDate | 10 | 0-0:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.end_date | octet-string(5) | - | |
| 1024 |
SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: value | 111 | 0-0:19.0.0.255 | A | 11 | credit_charge_configuration:credit_charge_configuration | EXCEPTIONAL | - | See GBCS Section 18.2.1 for details of the 5 values that are allowed and how these map to the value of each of SuspendDebtDisabled, SuspendDebtEmergency and Payment Mode |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x00B5 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1668 | SMETS 4.6.4.9 | DebtRecoveryRates[1]: scalerCurrent | BITMAP8 (NIBBLES) | Tariff Information: Price Trailing Digit: 0x0617 | Price: 0x0700 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1669 | SMETS 4.6.4.9 | DebtRecoveryRates[2]: scalerCurrent | BITMAP8 (NIBBLES) | Tariff Information: Price Trailing Digit: 0x0617 | |||
| 1756 | SMETS 4.6.4.8 | DebtRecoveryperPayment: percentage(ZSE Reading) | UINT16 | Debt: DebtRecoveryTopUpPercentage#3: 0x0239 | Prepayment: 0x0705 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1035 | SMETS 4.6.4.10 | DebtRecoveryRateCap: amountCurrent | INT32 | Prepayment Information: OverallDebtCap: 0x0006 | |||
| 1093 | SMETS 4.6.4.9 | DebtRecoveryRates[1]: amountCurrent | UINT32 | Debt: DebtRecovery Amount#1: 0x0217 | |||
| 1145 | SMETS 4.6.4.9 | DebtRecoveryRates[1]: periodCurrent | ENUM8 | Debt: DebtRecoveryFrequency#1: 0x0216 | |||
| 1094 | SMETS 4.6.4.9 | DebtRecoveryRates[2]: amountCurrent | UINT32 | Debt: DebtRecovery Amount#2: 0x0227 | |||
| 1146 | SMETS 4.6.4.9 | DebtRecoveryRates[2]: periodCurrent | ENUM8 | Debt: DebtRecoveryFrequency#2: 0x0226 | |||
| 864 | SMETS 4.6.4.12 | DisablementThreshold(MeterBalance): thresholdCurrent | INT32 | Prepayment Information: CutOffValue: 0x0040 | |||
| 1042 | SMETS 4.6.4.13 | EmergencyCreditLimit: amountCurrent | UINT32 | Prepayment Information: EmergencyCreditLimit: 0x0010 | |||
| 1043 | SMETS 4.6.4.14 | EmergencyCreditThreshold: thresholdCurrent | UINT32 | Prepayment Information: EmergencyCreditThreshold: 0x0011 | |||
| 1034 | SMETS 4.6.4.16 | LowCreditThreshold: thresholdCurrent | UINT32 | Prepayment Information: LowCreditWarning: 0x0031 | |||
| 1167 | SMETS 4.6.4.17 | PrepaymentCredit(MaximumCreditThreshold): valueCurrent | UINT32 | Prepayment Information: MaxCreditPerTopUp: 0x0022 | |||
| 1168 | SMETS 4.6.4.18 | PrepaymentCredit(MaxMeterBalance): valueCurrent | UINT32 | Prepayment Information: MaxCreditLimit: 0x0021 | |||
| 1461 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentDayIdentifiers[1..5] | -- | -- | Calendar: 0x0707 | GetDayProfiles: 0x01 | PublishDayProfile: 0x01 |
| 1462 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentDayIdentifiers[1..5].Time[1..3].startTime | -- | -- | |||
| 1881 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentDayIdentifiers[1..5].Time[1..3].actions | -- | -- | |||
| 1473 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentWeeks[1..2].weekIdentifier | -- | -- | Calendar: 0x0707 | GetWeekProfiles: 0x02 | PublishWeekProfile: 0x02 |
| 1466 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentWeeks[1..2].days[1].Identifier | -- | -- | |||
| 1467 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentWeeks[1..2].days[2].Identifier | -- | -- | |||
| 1468 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentWeeks[1..2].days[3].Identifier | -- | -- | |||
| 1469 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentWeeks[1..2].days[4].Identifier | -- | -- | |||
| 1470 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentWeeks[1..2].days[5].Identifier | -- | -- | |||
| 1471 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentWeeks[1..2].days[6].Identifier | -- | -- | |||
| 1472 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentWeeks[1..2].days[7].Identifier | -- | -- | |||
| 1464 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentSeasons[1..3].startDate | -- | -- | Calendar: 0x0707 | GetSeasons: 0x03 | PublishSeasons: 0x03 |
| 1465 | SMETS 4.6.4.20 | Non-DisablementCalendar: currentSeasons[1..3].WeekIdentifier | -- | -- | |||
| 1697 | SMETS 4.6.4.20 | Non-DisablementCalendar(SpecialDays): dayIdentifier[0..20].current | -- | -- | Calendar: 0x0707 | GetSpecialDays: 0x04 | PublishSpecialDays: 0x04 |
| 1695 | SMETS 4.6.4.20 | Non-DisablementCalendar(SpecialDays): date[0..20].current | -- | -- |
This Use Case is for reading the Voltage Configuration Data on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26k | Read ESME Configuration Voltage Data - 3 phase | 0x00C6 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 30 |
SMETS 5.7.4.4 |
(Phase[1])AverageRMSOverVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 31 |
SMETS 5.7.4.5 |
(Phase[1])AverageRMSUnderVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 32 |
SMETS 5.19.1.1 |
(Phase[2])AverageRMSOverVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 33 |
SMETS 5.19.1.2 |
(Phase[2])AverageRMSUnderVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 34 |
SMETS 5.19.1.1 |
(Phase[3])AverageRMSOverVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 35 |
SMETS 5.19.1.2 |
(Phase[3])AverageRMSUnderVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 969 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod | period | The period for which the RMS Voltage must stay above the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 960 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 970 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod | period | The period for which the RMS Voltage must stay below the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 961 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 971 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod | period | The period for which the RMS Voltage must stay below the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 962 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 972 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod | period | The period for which the RMS Voltage must stay above the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 963 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00C6 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 960 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold: threshold | 71 | 0-0:17.0.1.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 969 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod: period | 71 | 0-0:17.0.1.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 961 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold: threshold | 71 | 0-0:17.0.2.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 970 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod: period | 71 | 0-0:17.0.2.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 962 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold: threshold | 71 | 0-0:17.0.3.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 971 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod: period | 71 | 0-0:17.0.3.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 963 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold: threshold | 71 | 0-0:17.0.4.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 972 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod: period | 71 | 0-0:17.0.4.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 30 |
SMETS 5.7.4.4 |
(Phase[1])AverageRMSOverVoltageThreshold: value | 1 | 1-0:32.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 31 |
SMETS 5.7.4.5 |
(Phase[1])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:32.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 33 |
SMETS 5.19.1.2 |
(Phase[2])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:52.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 32 |
SMETS 5.19.1.1 |
(Phase[2])AverageRMSOverVoltageThreshold: value | 1 | 1-0:52.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 35 |
SMETS 5.19.1.2 |
(Phase[3])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:72.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 34 |
SMETS 5.19.1.1 |
(Phase[3])AverageRMSOverVoltageThreshold: value | 1 | 1-0:72.35.0.4 | A | 2 | value | double-long-unsigned | - |
This Use Case is for reading the Voltage Configuration Data on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS26b | Read ESME Configuration Voltage Data | 0x003C |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 30 |
SMETS 5.7.4.4 |
(Phase[1])AverageRMSOverVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 31 |
SMETS 5.7.4.5 |
(Phase[1])AverageRMSUnderVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 969 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod | period | The period for which the RMS Voltage must stay above the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 960 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 970 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod | period | The period for which the RMS Voltage must stay below the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 961 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 971 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod | period | The period for which the RMS Voltage must stay below the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 962 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 972 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod | period | The period for which the RMS Voltage must stay above the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 963 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x003C |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 960 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold: threshold | 71 | 0-0:17.0.1.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 969 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod: period | 71 | 0-0:17.0.1.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 961 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold: threshold | 71 | 0-0:17.0.2.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 970 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod: period | 71 | 0-0:17.0.2.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 962 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold: threshold | 71 | 0-0:17.0.3.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 971 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod: period | 71 | 0-0:17.0.3.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 963 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold: threshold | 71 | 0-0:17.0.4.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 972 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod: period | 71 | 0-0:17.0.4.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 30 |
SMETS 5.7.4.4 |
(Phase[1])AverageRMSOverVoltageThreshold: value | 1 | 1-0:32.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 31 |
SMETS 5.7.4.5 |
(Phase[1])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:32.31.0.4 | A | 2 | value | double-long-unsigned | - |
This Use Case is for reading the Daily Consumption Log.
| Use Case | Title | Message Code |
|---|---|---|
| ECS66 | Read ESME Daily Consumption Log | 0x0060 |
| GCS61 | Read gas Daily Consumption Log | 0x00A0 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.17 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 619 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog | logEntries[1..731].logEntry.timestamp | Timestamp of the entry |
Operational data | DATE-TIME |
| 559 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog | logEntries[1..731].logEntry.value | Consumption for that day |
Operational data | INTEGER |
| 932 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog | Method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | method |
| 1797 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 1798 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x0060 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 619 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog: logEntries[1..731].logEntry.timestamp | 7 | 0-0:99.1.3.255 | A | 2 | buffer:buffer[1..731].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 559 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog: logEntries[1..731].logEntry.value | 7 | 0-0:99.1.3.255 | A | 2 | buffer:buffer[1..731].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 932 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog: Method: readLog | 30 | 0-0:43.2.4.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1797 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog: methodInput: fromDateTime | 30 | 0-0:43.2.4.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1798 |
SMETS 5.7.5.14 CHTS 4.6.3.7 |
DailyConsumptionLog: methodInput: toDateTime | 30 | 0-0:43.2.4.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | GPF |
|---|---|
| Message Code | 0x00A0 |
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
The SME will automatically collect daily consumption data continuously, and will return data in a GetSampledDataResponse command when requested by a GetSampledData command with a Sample ID = 0.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 932 | SMETS | DailyConsumptionLog: Method: readLog | -- |
SampleID = 0x0001 (Daily Consumption Log) |
Metering: 0x0702 | GetSampledData: 0x08 | -- |
| 1797 | SMETS | DailyConsumptionLog: methodInput: fromDateTime | -- |
EarliestSampleTime |
|||
| 1798 | SMETS | DailyConsumptionLog: methodInput: toDateTime | -- |
NumberOfSamples (calculated as {{toDateTime-fromDateTime}/(1 day)}) |
|||
| 559 | SMETS | DailyConsumptionLog: logEntries[1..731].logEntry.value | -- | -- | Metering: 0x0702 | (Response): | GetSampledDataResponse: 0x07 |
| 619 | SMETS | DailyConsumptionLog: logEntries[1..731].logEntry.timestamp | -- | -- |
| Encrypted attributes - see section 8 |
This Use Case is for reading the daily read log on the Smart Meter excluding export.
| Use Case | Title | Message Code |
|---|---|---|
| ECS21a | Read Electricity Daily Read Log (exc export) | 0x0033 |
| GCS16a | Read GSME Daily Read log(s) | 0x0077 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.6 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 546 |
SMETS 4.6.5.7 SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.activeImportRegisterValue/consumption | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 1804 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.secondaryActiveImportRegisterValue/consumption | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 1805 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.secondaryTariffTOU[1..4].RegisterMatrixValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 1782 |
SMETS 4.6.5.7 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.tariffBlockCounterMatrix[1..4].CounterMatrixValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 547 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.tariffTOU[1..48].RegisterMatrixValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 548 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.tariffTOU[1..8].Block1.RegisterMatrixValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 549 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.tariffTOU[1..8].Block2.RegisterMatrixValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 550 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.tariffTOU[1..8].Block3.RegisterMatrixValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 551 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.tariffTOU[1..8].Block4.RegisterMatrixValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 1781 |
SMETS 4.6.5.7 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.tariffTOURegisterMatrix[1..4].RegisterMatrixValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 611 |
SMETS 4.6.5.7 SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | logEntries[1..31].logEntry.timestamp | The UTC date-time at which the corresponding log entry was taken |
Operational data | DATE-TIME |
| 1493 |
SMETS 4.6.5.7 SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 1522 |
SMETS 4.6.5.7 SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 1528 |
SMETS 4.6.5.7 SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x0033 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 611 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.timestamp | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 546 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.activeImportRegisterValue/consumption | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.activeImportRegisterValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1804 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.secondaryActiveImportRegisterValue/consumption | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.secondaryActiveImportRegisterValue | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 547 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.tariffTOU[1..48].RegisterMatrixValue | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.tariffTOURegisterValues[1..48].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1805 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.secondaryTariffTOU[1..4].RegisterMatrixValue | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.secondaryTariffTOURegisterValues[1..4].value | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 548 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.tariffTOU[1..8].Block1.RegisterMatrixValue | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.tariffTOUBlock1RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 549 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.tariffTOU[1..8].Block2.RegisterMatrixValue | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.tariffTOUBlock2RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 550 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.tariffTOU[1..8].Block3.RegisterMatrixValue | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.tariffTOUBlock3RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 551 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): logEntries[1..31].logEntry.tariffTOU[1..8].Block4.RegisterMatrixValue | 7 | 0-0:98.1.9.255 | A | 2 | buffer:buffer[1..31].entry_registerReadLogEntry.tariffTOUBlock4RegisterValues[1..8].value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 1493 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): readLog | 30 | 0-0:43.2.5.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1522 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): methodInput: fromDateTime | 30 | 0-0:43.2.5.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 1528 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(excExport): methodInput: toDateTime | 30 | 0-0:43.2.5.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | GPF (primary and for any Remote Party with access rights); GSME (Supplier only) |
|---|---|
| Message Code | 0x0077 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1493 | SMETS 4.6.5.7 | DailyReadLog(excExport): method: readLog | -- |
Snapshot Cause: 0x00000001 (General) |
Metering: 0x0702 | GetSnapshot: 0x06 | -- |
| 1522 | SMETS 4.6.5.7 | DailyReadLog(excExport): methodInput: fromDateTime | -- |
Earliest Start Time |
|||
| 1528 | SMETS 4.6.5.7 | DailyReadLog(excExport): methodInput: toDateTime | -- |
Latest End Time |
|||
| 546 | SMETS 4.6.5.7 | DailyReadLog(excExport): logEntries[1..31].logEntry.activeImportRegisterValue/consumption | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
Metering: 0x0702 | (Response): | Publish Snapshot: 0x06 |
| 1781 | SMETS 4.6.5.7 | DailyReadLog(excExport): logEntries[1..31].logEntry.tariffTOURegisterMatrix[1..4].RegisterMatrixValue | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
|||
| 1782 | SMETS 4.6.5.7 | DailyReadLog(excExport): logEntries[1..31].logEntry.tariffBlockCounterMatrix[1..4].CounterMatrixValue | -- |
SnapshotPayloadType: 6 (Block Tier Information Set Delivered (No Billing)) |
|||
| 611 | SMETS 4.6.5.7 | DailyReadLog(excExport): logEntries[1..31].logEntry.timestamp | -- | -- |
| Encrypted attributes - see section 8 |
This Use Case is for reading the Event Log on the Device
| Use Case | Title | Message Code |
|---|---|---|
| CS10a | Read ZigBee Device Event Log | 0x0014 |
| ECS35a | Read ESME Event Log | 0x0048 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.13 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 588 |
SMETS 4.6.5.9 SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF) | logEntries[1..100].logEntry.logCode | The Alert / Log Code corresponding to this event (as defined in GBCS) |
Operational data | INTEGER |
| 594 |
SMETS 4.6.5.9 SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF) | logEntries[1..100].logEntry.otherInformation | Where required by the alert code: other information relating to this alert. See Alert/Log Codes section of the GBCS which details when this is required |
Operational data | OCTET-STRING |
| 602 |
SMETS 4.6.5.9 SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF) | logEntries[1..100].logEntry.timestamp | The UTC date- time stamp of this entry |
Operational data | DATE-TIME |
| 579 |
SMETS 4.6.5.9 SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 633 |
SMETS 4.6.5.9 SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 654 |
SMETS 4.6.5.9 SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x0048 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 579 |
SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF): method: readLog | 7 | 0-0:99.98.0.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 633 |
SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF): methodInput: fromDateTime | 7 | 0-0:99.98.0.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 654 |
SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF): methodInput: toDateTime | 7 | 0-0:99.98.0.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 602 |
SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF): logEntries[1..100].logEntry.timestamp | 7 | 0-0:99.98.0.255 | A | 2 | buffer:buffer[1..100].entry_eventLogEntry8.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 588 |
SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF): logEntries[1..100].logEntry.logCode | 7 | 0-0:99.98.0.255 | A | 2 | buffer:buffer[1..100].entry_eventLogEntry8.logCode | long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 594 |
SMETS 5.7.5.16 / 9.5.2.4 CHTS 4.6.3.8 |
EventLog(incGPF): logEntries[1..100].logEntry.otherInformation | 7 | 0-0:99.98.0.255 | A | 2 | buffer:buffer[1..100].entry_eventLogEntry8.otherInformation | octet-string(8) | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| Target | ZigBee Device |
|---|---|
| Message Code | 0x0014 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 579 | SMETS 4.6.5.9 | EventLog(incGPF): method: readLog | -- |
Event Control / Log ID: where Log ID is 0x3 (Device's own General Event Log) or 0x6 (GSME Proxy Log copy of GSME Event Log - GPF only) |
Events: 0x0709 | Get Event Log: 0x00 | -- |
| 633 | SMETS 4.6.5.9 | EventLog(incGPF): methodInput: fromDateTime | -- |
Start Time |
|||
| 654 | SMETS 4.6.5.9 | EventLog(incGPF): methodInput: toDateTime | -- |
End Time |
|||
| 588 | SMETS 4.6.5.9 | EventLog(incGPF): logEntries[1..100].logEntry.logCode | -- | Log Payload: refer to ZigBee standard: | Events: 0x0709 | (Response): | Publish Event Log: 0x01 |
| 602 | SMETS 4.6.5.9 | EventLog(incGPF): logEntries[1..100].logEntry.timestamp | -- | Log Payload: refer to ZigBee standard: | |||
| 594 | SMETS 4.6.5.9 | EventLog(incGPF): logEntries[1..100].logEntry.otherInformation | -- | Log Payload: refer to ZigBee standard: |
This Use Case provides a means to identify which Devices in the HAN a Device is communicating with.
Refer to section 13.7.4 of GBCS for processing requirements.
| Use Case | Title | Message Code |
|---|---|---|
| CS07 | Read Device Join Details | 0x0013 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | N/A |
| Service Reference | 8.9 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| See GBCS |
This Use Case is for reading the Security Log on the Device
| Use Case | Title | Message Code |
|---|---|---|
| CS10b | Read ZigBee Device Security Log | 0x00A1 |
| ECS35b | Read ESME Security Log | 0x0049 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.13 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 590 |
SMETS 4.6.5.17 SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF) | logEntries[1..100].logEntry.logCode | The Alert / Log Code corresponding to this event (as defined in GBCS) |
Operational data | INTEGER |
| 605 |
SMETS 4.6.5.17 SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF) | logEntries[1..100].logEntry.timestamp | The UTC date- time stamp of this entry |
Operational data | DATE-TIME |
| 585 |
SMETS 4.6.5.17 SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 639 |
SMETS 4.6.5.17 SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 660 |
SMETS 4.6.5.17 SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x0049 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 585 |
SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF): method: readLog | 7 | 0-0:99.98.1.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 639 |
SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF): methodInput: fromDateTime | 7 | 0-0:99.98.1.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 660 |
SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF): methodInput: toDateTime | 7 | 0-0:99.98.1.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 605 |
SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF): logEntries[1..100].logEntry.timestamp | 7 | 0-0:99.98.1.255 | A | 2 | buffer:buffer[1..100].entry_securityLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 590 |
SMETS 5.7.5.31 / 9.6.3.5 CHTS 4.6.3.11 |
SecurityLog(notCHF): logEntries[1..100].logEntry.logCode | 7 | 0-0:99.98.1.255 | A | 2 | buffer:buffer[1..100].entry_securityLogEntry.logCode | long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| Target | ZigBee Device |
|---|---|
| Message Code | 0x00A1 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 585 | SMETS 4.6.5.17 | SecurityLog(notCHF): method: readLog | -- |
Event Control / Log ID: where Log ID is 0x4 (Device's own Security Event Log) or 0x7 (GSME Proxy Log copy of GSME Security Log - GPF only) |
Events: 0x0709 | Get Event Log: 0x00 | -- |
| 639 | SMETS 4.6.5.17 | SecurityLog(notCHF): methodInput: fromDateTime | -- |
Start Time |
|||
| 660 | SMETS 4.6.5.17 | SecurityLog(notCHF): methodInput: toDateTime | -- |
End Time |
|||
| 590 | SMETS 4.6.5.17 | SecurityLog(notCHF): logEntries[1..100].logEntry.logCode | -- | -- | Events: 0x0709 | (Response): | Publish Event Log: 0x01 |
| 605 | SMETS 4.6.5.17 | SecurityLog(notCHF): logEntries[1..100].logEntry.timestamp | -- | -- |
This Use Case is for reading the daily read log on the ESME for export. The read request relates to retrieving data from a credit meter.
| Use Case | Title | Message Code |
|---|---|---|
| ECS21c | Read Electricity Daily Read Log (export only) | 0x0035 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.6 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 545 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export) | logEntries[1..31].logEntry.activeExportRegisterValue | the billing log entry recorded at that date-time |
Operational data | INTEGER |
| 612 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export) | logEntries[1..31].logEntry.timestamp | The UTC date-time at which the corresponding log entry was taken |
Operational data | DATE-TIME |
| 577 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 631 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 652 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x0035 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 577 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export): method: readLog | 7 | 0-0:98.1.10.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 631 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export): methodInput: fromDateTime | 7 | 0-0:98.1.10.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 652 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export): methodInput: toDateTime | 7 | 0-0:98.1.10.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 612 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export): logEntries[1..31].logEntry.timestamp | 7 | 0-0:98.1.10.255 | A | 2 | buffer:buffer[1..31].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 545 |
SMETS 5.7.5.13 / 5.13.2.4 |
DailyReadLog(export): logEntries[1..31].logEntry.activeExportRegisterValue | 7 | 0-0:98.1.10.255 | A | 2 | buffer:buffer[1..31].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
This Use Case is for reading the TOU Register Matrix.
| Use Case | Title | Message Code |
|---|---|---|
| ECS17d | Read ESME Energy Register (TOU) | 0x0029 |
| GCS13c | Read GSME Register (TOU) | 0x00B6 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.1 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 28 |
SMETS 5.7.5.34 |
TariffTOURegisterCollection | TOUPrimaryRegister[1..48].value | Wh |
Operational data | INTEGER |
| 38 |
SMETS 5.13.2.10 |
TariffTOURegisterCollection | TOUSecondRegister[1..4].value | Wh |
Operational data | INTEGER |
| 1370 |
SMETS 4.6.5.20 |
TariffTOURegisterMatrix[1..4] | value | Accumulated consumption for each TOU rate register |
Operational data | INTEGER |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x0029 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 28 |
SMETS 5.7.5.34 |
TariffTOURegisterCollection: TOUPrimaryRegister[1..48].value | 1 | 0-0:94.44.34.1 | A | 2 | value:TOU_register_collection.TOU_primary_registers[1..48].value | double-long-unsigned | - | part of TOU_register_collection ::= structure { TOU_primary_registers array value; TOU_secondary_registers array value; } value: double-long-unsigned; |
| 38 |
SMETS 5.13.2.10 |
TariffTOURegisterCollection: TOUSecondRegister[1..4].value | 1 | 0-0:94.44.34.1 | A | 2 | value:TOU_register_collection.TOU_secondary_registers[1..4].value | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | part of TOU_register_collection ::= structure { TOU_primary_registers array value; TOU_secondary_registers array value; } value: double-long-unsigned; |
| 1813 |
(DLMS) |
TariffTOURegisterCollection: read | 30 | 0-0:43.2.9.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | GPF (primary and for any Remote Party with access rights); GSME (Supplier only) |
|---|---|
| Message Code | 0x00B6 |
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1370 | SMETS 4.6.5.20 | TariffTOURegisterMatrix[1..4]: value | UINT48 | TOU Information: CurrentTierNSummationDelivered: 0x0100, 0x0102, 0x0104, 0x0106 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1366 | (GBZ) | TariffTOURegisterMatrix[1..4]: unit | ENUM8 | Formatting: UnitofMeasure: 0x0300 | |||
| 1357 | (GBZ) | TariffTOURegisterMatrix[1..4]: scale | UINT24 | Formatting: Multiplier: 0x0301 | |||
| 1835 | (GBZ) | TariffTOURegisterMatrix[1..4]: scale | UINT24 | Formatting: Divisor: 0x0302 |
| Encrypted attributes - see section 8 |
This Use Case is for reading the TOU with Block Register Matrix.
| Use Case | Title | Message Code |
|---|---|---|
| ECS17e | Read ESME Energy Register (TOU with Blocks) | 0x002A |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.1 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 29 |
SMETS 5.7.5.35 |
TariffBlockTOURegisterCollection | TariffBlock[1..4]RegisterBlockCounterMatrixTOU[1..16].value | The response returned will be a 1 by 64 matrix where entries [1..8] are Register Matrix values for block 1, [9..16] are Block Counters for block 1, entries [17..24] are Register Matrix values for block 2, [25..32] are Block Counters for block 2, entries [33..40] are Register Matrix values for block 3, [41..48] are Block Counters for block 3, entries [49..56] are Register Matrix values for block 4, [57..64] are Block Counters for block 4. |
Operational data | INTEGER |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x002A |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 29 |
SMETS 5.7.5.35 |
TariffBlockTOURegisterCollection: TariffBlock[1..4]RegisterBlockCounterMatrixTOU[1..16].value | 1 | 0-0:94.44.34.2 | A | 2 | value:Block_TOU_register_collection.Block_primary_registers[1..64].value | double-long-unsigned | - | Block_TOU_register_collection ::= structure { Block_primary_registers array value } value: double-long-unsigned; |
| 1814 |
(DLMS) |
TariffBlockTOURegisterCollection: read | 30 | 0-0:43.2.10.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
This Use Case is for reading export energy registers.
| Use Case | Title | Message Code |
|---|---|---|
| ECS17a | Read ESME Energy Registers (Export Energy) | 0x0026 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 362 |
SMETS 5.7.5.2 |
ActiveExportRegister | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Constant data | INTEGER |
| 233 |
SMETS 5.7.5.2 |
ActiveExportRegister | unit | Wh |
Constant data | ENUMERATION |
| 100 |
SMETS 5.7.5.2 |
ActiveExportRegister | value | The active energy exported, as measured by the measuring element |
Operational data | INTEGER |
| 365 |
SMETS 5.7.5.29 |
ReactiveExportRegister | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Constant data | INTEGER |
| 236 |
SMETS 5.7.5.29 |
ReactiveExportRegister | unit | VARh |
Constant data | ENUMERATION |
| 103 |
SMETS 5.7.5.29 |
ReactiveExportRegister | value | Operational data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x0026 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 100 |
SMETS 5.7.5.2 |
ActiveExportRegister: value | 3 | 1-0:2.8.0.255 | A | 2 | value | double-long-unsigned | - | |
| 362 |
SMETS 5.7.5.2 |
ActiveExportRegister: scale | 3 | 1-0:2.8.0.255 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 233 |
SMETS 5.7.5.2 |
ActiveExportRegister: unit | 3 | 1-0:2.8.0.255 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 30 | |
| 103 |
SMETS 5.7.5.29 |
ReactiveExportRegister: value | 3 | 1-0:4.8.0.255 | A | 2 | value | double-long-unsigned | - | |
| 365 |
SMETS 5.7.5.29 |
ReactiveExportRegister: scale | 3 | 1-0:4.8.0.255 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 236 |
SMETS 5.7.5.29 |
ReactiveExportRegister: unit | 3 | 1-0:4.8.0.255 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 32 |
This Use Case is for reading the power registers on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS17c | Read ESME Energy Registers (Power) | 0x0028 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.16 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 43 |
SMETS 5.7.5.4 / 5.13.2.1 / 5.13.2.5 |
PowerImportCollection | ActivePowerImport.scaler | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 40 |
SMETS 5.7.5.4 / 5.13.2.1 / 5.13.2.5 |
PowerImportCollection | ActivePowerImport.unit | W |
Operational data | ENUMERATION |
| 25 |
SMETS 5.7.5.4 / 5.13.2.1 / 5.13.2.5 |
PowerImportCollection | ActivePowerImport.value | This is the total active Power from all elements on the meter |
Operational data | INTEGER |
| 26 |
SMETS 5.7.5.4 / 5.13.2.1 / 5.13.2.5 |
PowerImportCollection | PrimaryActivePowerImport.value | This is the total active Power from the first element on the meter |
Operational data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x0028 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 25 |
SMETS 5.7.5.4 / 5.13.2.1 / 5.13.2.5 |
PowerImportCollection: ActivePowerImport.value | 1 | 0-0:94.44.34.20 | A | 2 | value:power_import_collection.active_power_import_value | double-long-unsigned | - | part of power_import_collection ::= structure { active_power_import_value double-long-unsigned; # value of {3,1.0:1.7.0.255,2} active_power_scal_unit_type structure { # value of {3,1.0:1.7.0.255,3} active_power_import_scaler integer; active_power_import_unit enum } primary_active_power_import_value double-long-unsigned # value of {3,1.10:1.7.0.255,2} } |
| 43 |
SMETS 5.7.5.4 / 5.13.2.1 / 5.13.2.5 |
PowerImportCollection: ActivePowerImport.scaler | 1 | 0-0:94.44.34.20 | A | 2 | value:power_import_collection.active_power_scal_unit_type.active_power_import_scaler | integer | 0 | part of power_import_collection ::= structure { active_power_import_value double-long-unsigned; # value of {3,1.0:1.7.0.255,2} active_power_scal_unit_type structure { # value of {3,1.0:1.7.0.255,3} active_power_import_scaler integer; active_power_import_unit enum } primary_active_power_import_value double-long-unsigned # value of {3,1.10:1.7.0.255,2} } |
| 40 |
SMETS 5.7.5.4 / 5.13.2.1 / 5.13.2.5 |
PowerImportCollection: ActivePowerImport.unit | 1 | 0-0:94.44.34.20 | A | 2 | value:power_import_collection.active_power_scal_unit_type.active_power_import_unit | enum | 27 | part of power_import_collection ::= structure { active_power_import_value double-long-unsigned; # value of {3,1.0:1.7.0.255,2} active_power_scal_unit_type structure { # value of {3,1.0:1.7.0.255,3} active_power_import_scaler integer; active_power_import_unit enum } primary_active_power_import_value double-long-unsigned # value of {3,1.10:1.7.0.255,2} } |
| 26 |
SMETS 5.7.5.4 / 5.13.2.1 / 5.13.2.5 |
PowerImportCollection: PrimaryActivePowerImport.value | 1 | 0-0:94.44.34.20 | A | 2 | value:power_import_collection.primary_active_power_import_value | double-long-unsigned | - | part of power_import_collection ::= structure { active_power_import_value double-long-unsigned; # value of {3,1.0:1.7.0.255,2} active_power_scal_unit_type structure { # value of {3,1.0:1.7.0.255,3} active_power_import_scaler integer; active_power_import_unit enum } primary_active_power_import_value double-long-unsigned # value of {3,1.10:1.7.0.255,2} } |
This Use Case is for reading the Power Event Log on the Device
| Use Case | Title | Message Code |
|---|---|---|
| ECS35e | Read ESME Power Event Log | 0x00B9 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.13 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 591 |
SMETS 5.7.5.25 |
PowerEventLog | logEntries[1..100].logEntry.logCode | The Alert / Log Code corresponding to this event (as defined in GBCS) |
Operational data | INTEGER |
| 595 |
SMETS 5.7.5.25 |
PowerEventLog | logEntries[1..100].logEntry.otherInformation | Where required by the alert code: other information relating to this alert. See Alert/Log Codes section of the GBCS which details when this is required |
Operational data | INTEGER |
| 606 |
SMETS 5.7.5.25 |
PowerEventLog | logEntries[1..100].logEntry.timestamp | The UTC date- time stamp of this entry |
Operational data | DATE-TIME |
| 586 |
SMETS 5.7.5.25 |
PowerEventLog | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 640 |
SMETS 5.7.5.25 |
PowerEventLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 661 |
SMETS 5.7.5.25 |
PowerEventLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x00B9 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 586 |
SMETS 5.7.5.25 |
PowerEventLog: method: readLog | 7 | 0-0:99.98.4.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 640 |
SMETS 5.7.5.25 |
PowerEventLog: methodInput: fromDateTime | 7 | 0-0:99.98.4.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 661 |
SMETS 5.7.5.25 |
PowerEventLog: methodInput: toDateTime | 7 | 0-0:99.98.4.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 606 |
SMETS 5.7.5.25 |
PowerEventLog: logEntries[1..100].logEntry.timestamp | 7 | 0-0:99.98.4.255 | A | 2 | buffer:buffer[1..100].entry_powerLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 591 |
SMETS 5.7.5.25 |
PowerEventLog: logEntries[1..100].logEntry.logCode | 7 | 0-0:99.98.4.255 | A | 2 | buffer:buffer[1..100].entry_powerLogEntry.logCode | long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 595 |
SMETS 5.7.5.25 |
PowerEventLog: logEntries[1..100].logEntry.otherInformation | 7 | 0-0:99.98.4.255 | A | 2 | buffer:buffer[1..100].entry_powerLogEntry.otherInformation | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
This Use Case is for reading the Firmware Version on the Device.
| Use Case | Title | Message Code |
|---|---|---|
| ECS52 | Read ESME/SAPC/Comms Hub Firmware Version | 0x0059 |
| GCS38 | Read GSME Firmware Version | 0x0084 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 11.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 85 |
SMETS 4.6.5.10; CHTS 4.6.3.9 SMETS 5.7.5.17 / 9.6.3.3; CHTS 4.6.3.4 |
FirmwareVersion | value | The Device's now current firmware version. The value shall be four octets in length and shall correspond to the File Version field in the ZSE OTA Header structure. |
Operational data | OCTET-STRING |
| Target | CHF; ESME |
|---|---|
| Message Code | 0x0059 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 85 |
SMETS 5.7.5.17 / 9.6.3.3; CHTS 4.6.3.4 |
FirmwareVersion: value | 1 | 0-0:0.2.1.255 | A | 2 | value | octet-string(4) | - |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x0084 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 85 | SMETS 4.6.5.10; CHTS 4.6.3.9 | FirmwareVersion: value | OCTETSTRING[n] | Meter Status: CurrentMeterID: 0x0206 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
This Use Case is for reading the gas network sampling data log.
| Use Case | Title | Message Code |
|---|---|---|
| GCS18 | Read Gas Network Data Log | 0x0079 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.10 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1481 |
SMETS 4.6.5.12 |
NetworkDataLog | logEntry[1..41].timestamp | Log of consumption data taken at 6-minute intervals over a 4-hour period: timestamps |
Operational data | DATE-TIME |
| 1356 |
SMETS 4.6.5.12 |
NetworkDataLog | logEntry[1..41].value | Log of consumption data taken at 6-minute intervals over a 4-hour period: values |
Operational data | INTEGER |
| 1391 |
SMETS 4.6.5.12 |
NetworkDataLog | method:readLog | Method to read the Network Data Log |
Method | Method |
| 1400 |
SMETS 4.6.5.12 |
NetworkDataLog | methodInput: samples | Number of samples requested |
Method Input | INTEGER |
| Sensitive |
| Target | GSME |
|---|---|
| Message Code | 0x0079 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1391 | SMETS 4.6.5.12 | NetworkDataLog: method:readLog | -- |
SampleID = 0x0002 (Network Data Log) |
Metering: 0x0702 | GetSampledData: 0x08 | -- |
| 1403 | (GBZ) | NetworkDataLog: methodInput: time | -- |
EarliestSampleTime |
|||
| 1400 | SMETS 4.6.5.12 | NetworkDataLog: methodInput: samples | -- |
NumberOfSamples |
|||
| 1356 | SMETS 4.6.5.12 | NetworkDataLog: logEntry[1..41].value | -- | -- | Metering: 0x0702 | (Response): | GetSampledDataResponse: 0x07 |
| 1481 | SMETS 4.6.5.12 | NetworkDataLog: logEntry[1..41].timestamp | -- | -- |
| Encrypted attributes - see section 8 |
This Use Case is for reading the GSME block counters.
| Use Case | Title | Message Code |
|---|---|---|
| GCS13b | Read GSME Block Counters | 0x00B8 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.1 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1378 |
SMETS 4.6.5.19 |
TariffBlockCounter[1..4] | divisor | Divisor component of scale to apply when interpreting the value attribute |
Operational data | INTEGER |
| 1379 |
SMETS 4.6.5.19 |
TariffBlockCounter[1..4] | multiplier | Multiplier component of scale to apply when interpreting the value attribute |
Operational data | INTEGER |
| 1380 |
SMETS 4.6.5.19 |
TariffBlockCounter[1..4] | unit | m3 |
Operational data | ENUMERATION |
| 1377 |
SMETS 4.6.5.19 |
TariffBlockCounter[1..4] | value | Accumulated consumption within each block |
Operational data | ENUMERATION |
| Sensitive |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x00B8 |
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1377 | SMETS 4.6.5.19 | TariffBlockCounter[1..4]: value | UINT48 | Block Information (Delivered): CurrentNoTierBlockNSummationDelivered: 0x0700-0x0703 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1380 | SMETS 4.6.5.19 | TariffBlockCounter[1..4]: unit | ENUM8 | Formatting: UnitofMeasure: 0x0300 | |||
| 1379 | SMETS 4.6.5.19 | TariffBlockCounter[1..4]: multiplier | UINT24 | Formatting: Multiplier: 0x0301 | |||
| 1378 | SMETS 4.6.5.19 | TariffBlockCounter[1..4]: divisor | UINT24 | Formatting: Divisor: 0x0302 |
| Encrypted attributes - see section 8 |
This Use Case is for reading the half hourly consumption values.
| Use Case | Title | Message Code |
|---|---|---|
| ECS22b | Read Electricity Half Hour Profile Data (active import) | 0x0037 |
| GCS17 | Read GSME Profile Data Log | 0x0078 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.8 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | Yes |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 537 |
SMETS 4.6.5.15 SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod) | logEntries[1..19056].logEntry.primaryValue | The total active energy imported in this 30 minute period (if a twin element meter, this is for the primary element; if on a polyphase meter, it is cumulative across the phases) |
Operational data | INTEGER |
| 538 |
SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod) | logEntries[1..19056].logEntry.secondaryValue | The total active energy imported in this 30 minute period on the secondary element |
Operational data | INTEGER |
| 609 |
SMETS 4.6.5.15 SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod) | logEntries[1..19056].logEntry.timestamp | The date-time stamp at the end of the period to which the value relates |
Operational data | DATE-TIME |
| 581 |
SMETS 4.6.5.15 SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod) | readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 635 |
SMETS 4.6.5.15 SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 656 |
SMETS 4.6.5.15 SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x0037 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 609 |
SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod): logEntries[1..19056].logEntry.timestamp | 7 | 0-0:99.1.0.255 | A | 2 | buffer:buffer[1..19056].entry_activeImportLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 537 |
SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod): logEntries[1..19056].logEntry.primaryValue | 7 | 0-0:99.1.0.255 | A | 2 | buffer:buffer[1..19056].entry_activeImportLogEntry.primaryValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 538 |
SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod): logEntries[1..19056].logEntry.secondaryValue | 7 | 0-0:99.1.0.255 | A | 2 | buffer:buffer[1..19056].entry_activeImportLogEntry.secondaryValue | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 581 |
SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod): readLog | 30 | 0-0:43.2.7.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 635 |
SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod): methodInput: fromDateTime | 30 | 0-0:43.2.7.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 656 |
SMETS 5.7.5.27 / 5.13.2.7 CHTS 4.6.3.10 |
ProfileDataLog(ActiveEnergyImportedInPeriod): methodInput: toDateTime | 30 | 0-0:43.2.7.255 | M | 1 | get_protected_attributes | octet-string(12) | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | GPF (primary and for any Remote Party with access rights); GSME (Supplier only) |
|---|---|
| Message Code | 0x0078 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
The GSME will automatically collect consumption profile data continuously and will return data in a GetSampledDataResponse command when requested by a GetSampledData command with a Sample ID = 1.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 581 | SMETS 4.6.5.15 | ProfileDataLog(ActiveEnergyImportedInPeriod): method: readLog | -- |
SampleID = 0x0001 (Profile Data Log) |
Metering: 0x0702 | GetSampledData: 0x08 | -- |
| 635 | SMETS 4.6.5.15 | ProfileDataLog(ActiveEnergyImportedInPeriod): methodInput: fromDateTime | -- |
EarliestSampleTime |
|||
| 656 | SMETS 4.6.5.15 | ProfileDataLog(ActiveEnergyImportedInPeriod): methodInput: toDateTime | -- |
NumberOfSamples (calculated as {{toDateTime-fromDateTime}/30'}) |
|||
| 537 | SMETS 4.6.5.15 | ProfileDataLog(ActiveEnergyImportedInPeriod): logEntries[1..19056].logEntry.primaryValue | -- | -- | Metering: 0x0702 | (Response): | GetSampledDataResponse: 0x07 |
| 609 | SMETS 4.6.5.15 | ProfileDataLog(ActiveEnergyImportedInPeriod): logEntries[1..19056].logEntry.timestamp | -- | -- |
| Encrypted attributes - see section 8 |
This Use Case is for reading the half hourly electricity values on the ESME for export.
| Use Case | Title | Message Code |
|---|---|---|
| ECS22a | Read Electricity Half Hour Profile Data (export) | 0x0036 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.8 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | Yes |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 555 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export) | logEntries[1..4464].logEntry.activeEnergyExportedValue | The total active energy exported in this 30 minute period (if a twin element meter, this is for the primary element; if on a polyphase meter, it is cumulative across the phases) |
Operational data | INTEGER |
| 556 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export) | logEntries[1..4464].logEntry.reactiveEnergyExportedValue | The total reactive energy exported in this 30 minute period (if a twin element meter, this is for the primary element; if on a polyphase meter, it is cumulative across the phases) |
Operational data | INTEGER |
| 616 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export) | logEntries[1..4464].logEntry.timestamp | The date-time stamp at the end of the period to which the value relates |
Operational data | DATE-TIME |
| 582 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 636 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 657 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x0036 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 582 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export): method: readLog | 7 | 0-0:99.1.1.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 636 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export): methodInput: fromDateTime | 7 | 0-0:99.1.1.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 657 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export): methodInput: toDateTime | 7 | 0-0:99.1.1.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 616 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export): logEntries[1..4464].logEntry.timestamp | 7 | 0-0:99.1.1.255 | A | 2 | buffer:buffer[1..4464].entry_twoDlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 555 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export): logEntries[1..4464].logEntry.activeEnergyExportedValue | 7 | 0-0:99.1.1.255 | A | 2 | buffer:buffer[1..4464].entry_twoDlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 556 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(Export): logEntries[1..4464].logEntry.reactiveEnergyExportedValue | 7 | 0-0:99.1.1.255 | A | 2 | buffer:buffer[1..4464].entry_twoDlValueLogEntry.dlValue2 | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
This Use Case is for reading the half hourly electricity values on the ESME for reactive import.
| Use Case | Title | Message Code |
|---|---|---|
| ECS22c | Read Electricity Half Hour Profile Data (reactive import) | 0x0038 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.8 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | Yes |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 557 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport) | logEntries[1..4464].logEntry.reactiveEnergyImportedValue | The total reactive energy imported in this 30 minute period (if a twin element meter, this is across the primary and secondary element; if on a polyphase meter, it is cumulative across the phases) |
Operational data | INTEGER |
| 617 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport) | logEntries[1..4464].logEntry.timestamp | The date-time stamp at the end of the period to which the value relates |
Operational data | DATE-TIME |
| 583 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport) | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 637 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport) | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 658 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport) | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x0038 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 583 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport): method: readLog | 7 | 0-0:99.1.2.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 637 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport): methodInput: fromDateTime | 7 | 0-0:99.1.2.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 658 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport): methodInput: toDateTime | 7 | 0-0:99.1.2.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 617 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport): logEntries[1..4464].logEntry.timestamp | 7 | 0-0:99.1.2.255 | A | 2 | buffer:buffer[1..4464].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 557 |
SMETS 5.7.5.27 / 5.13.2.7 |
ProfileDataLog(ReactiveImport): logEntries[1..4464].logEntry.reactiveEnergyImportedValue | 7 | 0-0:99.1.2.255 | A | 2 | buffer:buffer[1..4464].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
This Use Case is for reading the ESME import energy registers / GSME consumption registers.
| Use Case | Title | Message Code |
|---|---|---|
| ECS17b | Read ESME Energy Registers (Import Energy) | 0x0027 |
| GCS13a | Read GSME Consumption Register | 0x0074 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.1 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1373 |
SMETS 4.6.5.4 |
ConsumptionRegister | divisor | Divisor component of scale to apply when interpreting the value attribute |
Operational data | INTEGER |
| 1374 |
SMETS 4.6.5.4 |
ConsumptionRegister | multiplier | Multiplier component of scale to apply when interpreting the value attribute |
Operational data | INTEGER |
| 1376 |
SMETS 4.6.5.4 |
ConsumptionRegister | unit | m3 |
Operational data | INTEGER |
| 1375 |
SMETS 4.6.5.4 |
ConsumptionRegister | value | The total energy imported |
Operational data | INTEGER |
| 42 |
SMETS 5.7.5.3 |
ImportRegisterCollection | active.scale | 0 (power of 10 to apply when interpreting the value attribute) |
Constant data | INTEGER |
| 39 |
SMETS 5.7.5.3 |
ImportRegisterCollection | active.unit | Wh |
Constant data | ENUMERATION |
| 21 |
SMETS 5.7.5.3 |
ImportRegisterCollection | active.value | The active energy imported, as measured by the measuring element(s) |
Operational data | INTEGER |
| 44 |
SMETS 5.7.5.30 |
ImportRegisterCollection | reactive.scale | 0 (power of 10 to apply when interpreting the value attribute) |
Constant data | INTEGER |
| 41 |
SMETS 5.7.5.30 |
ImportRegisterCollection | reactive.unit | VARh |
Constant data | ENUMERATION |
| 27 |
SMETS 5.7.5.30 |
ImportRegisterCollection | reactive.value | The reactive energy imported, as measured by the measuring element |
Operational data | INTEGER |
| 37 |
SMETS 5.13.2.11 |
ImportRegisterCollection | secondary.value | The active energy imported, as measured by the secondary measuring element |
Operational data | INTEGER |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x0027 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 24 |
(DLMS) |
ImportRegisterCollection: read | 30 | 0-0:43.2.8.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| 21 |
SMETS 5.7.5.3 |
ImportRegisterCollection: active.value | 1 | 0-0:94.44.34.10 | A | 2 | value:import_register_collection.active_import_value | double-long-unsigned | - | import_register_collection ::= structure { active_import_value double_long_unsigned; active_scal_unit_type structure { active_import_scaler integer; active_import_unit enum } reactive_import_value double-long-unsigned; reactive_scal_unit_type structure { reactive_import_scaler integer; reactive_import_unit enum } second_active_import_value OPTIONAL double-long-unsigned } |
| 42 |
SMETS 5.7.5.3 |
ImportRegisterCollection: active.scale | 1 | 0-0:94.44.34.10 | A | 2 | value:import_register_collection.active_scal_unit_type.active_import_scaler | integer | 0 | part of import_register_collection ::= structure { active_import_value double_long_unsigned; active_power_scal_unit_type structure { active_import_scaler integer; active_import_unit enum } reactive_import_value double-long-unsigned; reactive_power_scal_unit_type structure { reactive_import_scaler integer; reactive_import_unit enum } second_active_import_value OPTIONAL double-long-unsigned } |
| 39 |
SMETS 5.7.5.3 |
ImportRegisterCollection: active.unit | 1 | 0-0:94.44.34.10 | A | 2 | value:import_register_collection.active_scal_unit_type.active_import_unit | enum | 30 | part of import_register_collection ::= structure { active_import_value double_long_unsigned; active_scal_unit_type structure { active_import_scaler integer; active_import_unit enum } reactive_import_value double-long-unsigned; reactive_scal_unit_type structure { reactive_import_scaler integer; reactive_import_unit enum } second_active_import_value OPTIONAL double-long-unsigned } |
| 27 |
SMETS 5.7.5.30 |
ImportRegisterCollection: reactive.value | 1 | 0-0:94.44.34.10 | A | 2 | value:import_register_collection.reactive_import_value | double-long-unsigned | - | part of import_register_collection ::= structure { active_import_value double_long_unsigned; active_scal_unit_type structure { active_import_scaler integer; active_import_unit enum } reactive_import_value double-long-unsigned; reactive_scal_unit_type structure { reactive_import_scaler integer; reactive_import_unit enum } second_active_import_value OPTIONAL double-long-unsigned } |
| 44 |
SMETS 5.7.5.30 |
ImportRegisterCollection: reactive.scale | 1 | 0-0:94.44.34.10 | A | 2 | value:import_register_collection.reactive_scal_unit_type.reactive_import_scaler | integer | 0 | part of import_register_collection ::= structure { active_import_value double_long_unsigned; active_scal_unit_type structure { active_import_scaler integer; active_import_unit enum } reactive_import_value double-long-unsigned; reactive_scal_unit_type structure { reactive_import_scaler integer; reactive_import_unit enum } second_active_import_value OPTIONAL double-long-unsigned } |
| 41 |
SMETS 5.7.5.30 |
ImportRegisterCollection: reactive.unit | 1 | 0-0:94.44.34.10 | A | 2 | value:import_register_collection.reactive_scal_unit_type.reactive_import_unit | enum | 32 | part of import_register_collection ::= structure { active_import_value double_long_unsigned; active_power_scal_unit_type structure { active_import_scaler integer; active_import_unit enum } reactive_import_value double-long-unsigned; reactive_power_scal_unit_type structure { reactive_import_scaler integer; reactive_import_unit enum } second_active_import_value OPTIONAL double-long-unsigned } |
| 37 |
SMETS 5.13.2.11 |
ImportRegisterCollection: secondary.value | 1 | 0-0:94.44.34.10 | A | 2 | value:import_register_collection.second_active_import_value | double-long-unsigned[[TWIN_ELEMENT_ESME_ONLY]] | - | part of import_register_collection ::= structure { active_import_value double_long_unsigned; active_scal_unit_type structure { active_import_scaler integer; active_import_unit enum } reactive_import_value double-long-unsigned; reactive_scal_unit_type structure { reactive_import_scaler integer; reactive_import_unit enum } second_active_import_value OPTIONAL double-long-unsigned } |
| Encrypted attributes - see section 8 |
| Target | GPF (primary and for any Remote Party with access rights); GSME (Supplier only) |
|---|---|
| Message Code | 0x0074 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1375 | SMETS 4.6.5.4 | ConsumptionRegister: value | UINT48 | Reading Information: CurrentSummationDelivered: 0x0000 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1376 | SMETS 4.6.5.4 | ConsumptionRegister: unit | ENUM8 | Formatting: UnitofMeasure: 0x0300 | |||
| 1374 | SMETS 4.6.5.4 | ConsumptionRegister: multiplier | UINT24 | Formatting: Multiplier: 0x0301 | |||
| 1373 | SMETS 4.6.5.4 | ConsumptionRegister: divisor | UINT24 | Formatting: Divisor: 0x0302 |
| Encrypted attributes - see section 8 |
This Use Case is for reading the Load Limit configuration and operational data on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS27 | Read ESME Load Limit Data | 0x0042 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.15 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 364 |
SMETS 5.7.5.18 |
LoadLimitCounter | scale | The count of load limit events since last reset |
Operational data | INTEGER |
| 235 |
SMETS 5.7.5.18 |
LoadLimitCounter | unit | The count of load limit events since last reset |
Operational data | ENUMERATION |
| 102 |
SMETS 5.7.5.18 |
LoadLimitCounter | value | The count of load limit events since last reset |
Operational data | INTEGER |
| 973 |
SMETS 5.7.4.19 |
LoadLimitPeriod(Timer) | valueCurrent | Integer determining how long Active Import Power needs to exceed threshold before Load Limiting action |
Configuration data | INTEGER |
| 964 |
SMETS 5.7.4.20 |
LoadLimitPowerThreshold | thresholdCurrent | Configuration data | INTEGER | |
| 974 |
SMETS 5.7.4.21 |
LoadLimitRestorationPeriod(Timer) | valueCurrent | Integer (seconds) |
Configuration data | INTEGER |
| 1166 |
SMETS 5.7.4.22 |
LoadLimitSupplyState | valueCurrent | Disable(TRUE), Unchanged(FALSE) |
Configuration data | BOOLEAN |
| Target | ESME |
|---|---|
| Message Code | 0x0042 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1166 |
SMETS 5.7.4.22 |
LoadLimitSupplyState: valueCurrent | 9000 | 0-0:94.44.0.3 | A | 2 | value_active | boolean | - | |
| 102 |
SMETS 5.7.5.18 |
LoadLimitCounter: value | 3 | 0-0:94.44.42.255 | A | 2 | value | double-long-unsigned | - | |
| 364 |
SMETS 5.7.5.18 |
LoadLimitCounter: scale | 3 | 0-0:94.44.42.255 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 235 |
SMETS 5.7.5.18 |
LoadLimitCounter: unit | 3 | 0-0:94.44.42.255 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 964 |
SMETS 5.7.4.20 |
LoadLimitPowerThreshold: thresholdCurrent | 71 | 0-0:17.0.0.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 973 |
SMETS 5.7.4.19 |
LoadLimitPeriod(Timer): valueCurrent | 71 | 0-0:17.0.0.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 974 |
SMETS 5.7.4.21 |
LoadLimitRestorationPeriod(Timer): valueCurrent | 71 | 0-0:17.0.0.255 | A | 7 | min_under_threshold_duration | double-long-unsigned | - |
This Use Case is for reading the Export Maximum Demand registers on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS18a | Read Maximum Demand Registers (export) | 0x002B |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.12 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1826 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue | dateTimeOfLastReset | UTC date time at which the MaximumDemandActiveEnergyExportValue.reset method was last used |
Operational data | DATE-TIME no wildcards |
| 512 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue | dateTimeStamp | Date time stamp of that highest value |
Operational data | DATE-TIME |
| 509 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 506 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue | unit | W |
Constant data | ENUMERATION |
| 503 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue | value | Highest value since last reset |
Operational data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x002B |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1826 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue: dateTimeOfLastReset | 1 | 0-0:94.44.5.2 | A | 2 | value | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 503 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue: value | 4 | 1-0:2.6.0.255 | A | 2 | value | double-long-unsigned | - | |
| 509 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue: scale | 4 | 1-0:2.6.0.255 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 506 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue: unit | 4 | 1-0:2.6.0.255 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 27 | |
| 512 |
SMETS 5.7.5.21 |
MaximumDemandActivePowerExportValue: dateTimeStamp | 4 | 1-0:2.6.0.255 | A | 5 | capture_time | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
This Use Case is for reading the Import Maximum Demand registers on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS18b | Read Maximum Demand Registers (import) | 0x002C |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.12 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 74 |
SMETS 5.7.5.20 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue | dateTimeOfLastReset | UTC date time at which the MaximumDemand(ConfigurableTime)ActiveEnergyImportValue.reset method was last used |
Operational data | DATE-TIME no wildcards |
| 511 |
SMETS 5.7.5.21 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue | dateTimeStamp | Date time stamp of that highest value |
Operational data | DATE-TIME |
| 508 |
SMETS 5.7.5.21 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Constant data | INTEGER |
| 505 |
SMETS 5.7.5.21 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue | unit | W |
Constant data | ENUMERATION |
| 502 |
SMETS 5.7.5.20 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue | value | Highest value since last reset |
Operational data | INTEGER |
| 1825 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue | dateTimeOfLastReset | UTC date time at which the MaximumDemandActiveEnergyImportValue.reset method was last used |
Operational data | DATE-TIME no wildcards |
| 513 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue | dateTimeStamp | Date time stamp of that highest value |
Operational data | DATE-TIME |
| 510 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 507 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue | unit | W |
Constant data | ENUMERATION |
| 504 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue | value | Highest value since last reset |
Operational data | INTEGER |
| 748 |
SMETS 5.7.4.26 |
MaximumDemandConfigurableTimePeriod | currentEntries[1..2].scriptSelector | Determines whether the associated switchTime is the start or the end time of the MaximumDemandConfigurableTimePeriod. scriptSelector has the value of 1 where it relates to the start time and 2 where it relates to the end time. |
Configuration data | INTEGER |
| 761 |
SMETS 5.7.4.26 |
MaximumDemandConfigurableTimePeriod | currentEntries[1..2].switchTime | The time during the day at which the action is triggered |
Configuration data | TIME NO WILDCARDS |
| Target | ESME |
|---|---|
| Message Code | 0x002C |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 74 |
SMETS 5.7.5.20 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue: dateTimeOfLastReset | 1 | 0-0:94.44.5.0 | A | 2 | value | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1825 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue: dateTimeOfLastReset | 1 | 0-0:94.44.5.1 | A | 2 | value | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 504 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue: value | 4 | 1-0:1.6.0.255 | A | 2 | value | double-long-unsigned | - | |
| 510 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue: scale | 4 | 1-0:1.6.0.255 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 507 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue: unit | 4 | 1-0:1.6.0.255 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 27 | |
| 513 |
SMETS 5.7.5.19 |
MaximumDemandActiveEnergyImportValue: dateTimeStamp | 4 | 1-0:1.6.0.255 | A | 5 | capture_time | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 502 |
SMETS 5.7.5.20 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue: value | 4 | 1-0:1.6.1.255 | A | 2 | value | double-long-unsigned | - | |
| 508 |
SMETS 5.7.5.21 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue: scale | 4 | 1-0:1.6.1.255 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 505 |
SMETS 5.7.5.21 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue: unit | 4 | 1-0:1.6.1.255 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 27 | |
| 511 |
SMETS 5.7.5.21 |
MaximumDemand(ConfigurableTime)ActivePowerImportValue: dateTimeStamp | 4 | 1-0:1.6.1.255 | A | 5 | capture_time | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 746 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].index | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.index | long-unsigned | - | |
| 740 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].enable | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.enable | boolean | ||0x01 | |
| 780 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].scriptLN | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.script_logical_name | octet-string(6) | ||0x00000A8064FF | |
| 748 |
SMETS 5.7.4.26 |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].scriptSelector | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.script_selector | long-unsigned | - | |
| 761 |
SMETS 5.7.4.26 |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].switchTime | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.switch_time | octet-string(4) | - | |
| 750 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].validityWindow | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.validity_window | long-unsigned | ||0xFFFF | |
| 730 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].execWeekdays[1..7] | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.exec_weekdays | bit-string(7) | ||0b11111110 (bit padding is on the least significant bit) | |
| 728 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].execSpecdays[0..0] | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.exec_specdays | bit-string(0) | ||0x | |
| 768 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].beginDate | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.begin_date | octet-string(5) | ||0x000001FFFF | |
| 770 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].endDate | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.end_date | octet-string(5) | ||0xFFFFFFFFFF |
This Use Case is for reading the meter balance(s).
| Use Case | Title | Message Code |
|---|---|---|
| ECS82 | Read Meter Balance for ESME | 0x0069 |
| GCS60 | Read Meter Balance for GSME | 0x008D |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.18 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1022 |
SMETS 4.6.5.11 SMETS 5.7.5.22 |
MeterBalance | value | For ESME: if positive, credit available; if negative, money due For GSME: if positive, money due; cannot be negative |
Operational data | INTEGER |
| 1041 |
SMETS 4.6.5.11 |
MeterBalance | valuePrepaymentMode | For GSME: if positive, credit available; if negative, money due |
Operational data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x0069 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1022 |
SMETS 5.7.5.22 |
MeterBalance: value | 112 | 0-0:19.10.0.255 | A | 2 | current_credit_amount | double-long | - |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x008D |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1022 | SMETS 4.6.5.11 | MeterBalance: value | UINT32 | Meter Billing: BillToDateDelivered: 0x0A00 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1041 | SMETS 4.6.5.11 | MeterBalance: valuePrepaymentMode | INT32 | Prepayment Information: Credit Remaining: 0x0001 | Prepayment: 0x0705 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
This Use Case is for reading the MPAN/MPRN value of the Smart Meter. An MPAN/MPRN shall be a utf-8 encoded string.
| Use Case | Title | Message Code |
|---|---|---|
| ECS40 | Read MPAN Value on the ESME | 0x004E |
| GCS46 | Read MPRN on the GSME | 0x0089 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 76 |
SMETS 5.7.4.28 |
MeterPointAdministrationNumber(combinedMPANS) | value | Primary and secondary MPAN. |
Configuration data | OCTET-STRING |
| 77 |
SMETS 5.7.4.28 |
MeterPointAdministrationNumber(ExportMPAN) | value | The MPAN associated with Export Consumption |
Configuration data | OCTET-STRING |
| 1747 |
SMETS 4.6.4.19 |
MeterPointReferenceNumber | value | The MPRN associated with the gas consumption |
Operational data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x004E |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 76 |
SMETS 5.7.4.28 |
MeterPointAdministrationNumber(combinedMPANS): value | 1 | 0-0:94.44.34.11 | A | 2 | value | octet-string(26) | - | The first 13 bytes represent primary MPAN and, where present on the ESME, the second 13 bytes represents secondary MPAN. Writing a string longer than 13 bytes to a single element meter shall result in an error. |
| 77 |
SMETS 5.7.4.28 |
MeterPointAdministrationNumber(ExportMPAN): value | 1 | 1-0:0.0.2.255 | A | 2 | value | octet-string(13) | - | OCTET-STRING(13) |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x0089 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1747 | SMETS 4.6.4.19 | MeterPointReferenceNumber: value | OCTETSTRING[n] | Formatting: SiteID: 0x0307 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
This Use Case is for reading the currently configured, non critical alert and event behaviours that are relevant to Network Operators.
| Use Case | Title | Message Code |
|---|---|---|
| ECS25r2 | Read non-critical event and alert behaviours - ESME- Network Operator | 0x00EF |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1939 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Network Operator | settingsForWANAlerting | The BIT STRING shall be 256 bits in length. The ESME shall have this BIT STRING set to reflect the current configuration according to the following: - 0b0 shall mean WAN alerting 'turned off' and 0b1 shall mean 'turned on' - the BIT STRING shall be numbered according to LSB = 0 - the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Event / Alert Code which is the concatenation 0x80 || n. |
Configuration data | BIT-STRING |
| 1938 |
SMETS 5.7.4.51 |
Events Configuration Settings - Network Operator | settingForLogging | The BIT STRING shall be 256 bits in length. The ESME shall have this BIT STRING set to reflect the current configuration according to the following: - 0b0 shall mean logging 'turned off' and 0b1 shall mean 'turned on' - the BIT STRING shall be numbered according to LSB = 0 - the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Event / Alert Code which is the concatenation 0x80 || n. |
Configuration data | BIT-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x00EF |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1939 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Network Operator: settingsForWANAlerting | 1 | 0-33:97.98.15.255 | A | 2 | value | bit-string(256) | - | |
| 1938 |
SMETS 5.7.4.51 |
Events Configuration Settings - Network Operator: settingForLogging | 1 | 0-33:97.98.18.255 | A | 2 | value | bit-string(256) | - |
This Use Case is for reading the currently configured, non critical alert and event behaviours that are relevant to Suppliers.
For the GSME use case, the following shall apply:
- GBCS non-critical events/alerts use the Event / Alert code range starting 0x81. As per ZSE Table D-174, this equates to a Device Management Cluster Attribute Set within the range that is 'Reserved for non-ZigBee Event Configuration'
- In line with Device Management Cluster Attribute Sets, the value 0x81FF shall be interpreted by the GSME as the EventGroupID for Event / Alert Codes that start 0x81;
- GSME shall therefore, in response to the GetEventConfiguration command in GCS20r (which has an Event ID set to 0x81FF), provide, in the Report Event Configuration command in the Response, configuration details of all Event / Alert Codes starting 0x81 which GBCS Table 16.2 mandates a GSME to support and any non-mandated ones which the GSME does support.
| Use Case | Title | Message Code |
|---|---|---|
| ECS25r1 | Read non-critical event and alert behaviours - ESME- Supplier | 0x00EE |
| GCS20r | Read non-critical event and alert behaviours - GSME- Supplier | 0x00F1 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.2 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1935 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Supplier | settingsForHANDeviceSharing | The BIT STRING shall be 256 bits in length. The ESME shall have this BIT STRING set to reflect the current configuration according to the following: - 0b0 shall mean HAN Device sharing 'turned off' and 0b1 shall mean 'turned on' - the BIT STRING shall be numbered according to LSB = 0 - the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Event / Alert Code which is the concatenation 0x81 || n. |
Configuration data | BIT-STRING |
| 1934 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Supplier | settingsForWANAlerting | The BIT STRING shall be 256 bits in length. The ESME shall have this BIT STRING set to reflect the current configuration according to the following: - 0b0 shall mean WAN Alerting 'turned off' and 0b1 shall mean 'turned on' - the BIT STRING shall be numbered according to LSB = 0 - the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Event / Alert Code which is the concatenation 0x81 || n. |
Configuration data | BIT-STRING |
| 1940 |
SMETS 4.6.4.1 / 4.6.4.34 |
Events and Alerts Configuration Settings | method: getSettings | The response to this method contains the Events and Alerts Configuration Settings. |
Method | Method |
| 1941 |
SMETS 4.6.4.1 / 4.6.4.34 |
Events and Alerts Configuration Settings | settings | A list of Event / Alert Codes and, for each, a BIT STRING defining the current configuration settings |
Configuration data | Series of Event / Alert Codes and BIT-STRINGs |
| 1937 |
SMETS 5.7.4.51 |
Events Configuration Settings - Supplier | settingForLogging | The BIT STRING shall be 256 bits in length. The ESME shall have this BIT STRING set to reflect the current configuration according to the following: - 0b0 shall mean logging 'turned off' and 0b1 shall mean 'turned on' - the BIT STRING shall be numbered according to LSB = 0 - the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Event / Alert Code which is the concatenation 0x81 || n. |
Configuration data | BIT-STRING |
| 1936 |
SMETS 5.7.4.51 |
Events Configuration Settings - Supplier | settingsForAlarms | The BIT STRING shall be 256 bits in length. The ESME shall have this BIT STRING set to reflect the current configuration according to the following: - 0b0 shall mean Alarm 'turned off' and 0b1 shall mean 'turned on' - the BIT STRING shall be numbered according to LSB = 0 - the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Event / Alert Code which is the concatenation 0x81 || n. |
Configuration data | BIT-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x00EE |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1934 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Supplier: settingsForWANAlerting | 1 | 0-30:97.98.15.255 | A | 2 | value | bit-string(256) | - | |
| 1935 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Supplier: settingsForHANDeviceSharing | 1 | 0-30:97.98.16.255 | A | 2 | value | bit-string(256) | - | |
| 1936 |
SMETS 5.7.4.51 |
Events Configuration Settings - Supplier: settingsForAlarms | 1 | 0-30:97.98.17.255 | A | 2 | value | bit-string(256) | - | |
| 1937 |
SMETS 5.7.4.51 |
Events Configuration Settings - Supplier: settingForLogging | 1 | 0-30:97.98.18.255 | A | 2 | value | bit-string(256) | - |
| Target | GSME |
|---|---|
| Message Code | 0x00F1 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1940 | SMETS 4.6.4.1 / 4.6.4.34 | Events and Alerts Configuration Settings: method: getSettings | -- |
Event ID |
Device Management: 0x0708 | GetEventConfiguration: 0x05 | |
| 1941 | SMETS 4.6.4.1 / 4.6.4.34 | Events and Alerts Configuration Settings: settings | -- |
Event Configuration Payload |
Device Management: 0x0708 | (Response): | Report Event Configuration: 0x04 |
This Use Case is for reading the Smart Meter prepayment registers.
| Use Case | Title | Message Code |
|---|---|---|
| ECS19 | Read ESME Prepayment Registers | 0x002D |
| GCS14 | Read GSME Prepayment Register(s) | 0x0075 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.3 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1039 |
SMETS 4.6.5.1 |
AccumulatedDebtRegister | value | Debt accumulated on the meter for time based charges (standing charge and time based debt recovery) but only used whilst EmergencyCredit is in use, and where SuspendDebtEmergency.value = TRUE |
Operational data | INTEGER |
| 1040 |
SMETS 4.6.5.8 |
EmergencyCreditBalance | value | amount of emergency credit remaining |
Operational data | INTEGER |
| 1041 |
SMETS 4.6.5.11 |
MeterBalance | valuePrepaymentMode | For GSME: if positive, credit available; if negative, money due |
Operational data | INTEGER |
| 1148 |
SMETS 4.6.5.13 |
PaymentDebtRegister | value | The remaining payment-based debt to be recovered |
Operational data | INTEGER |
| 1809 |
SMETS 5.7.5.1 |
PrepaymentBalanceCollection | AccumulatedDebtRegister | See SMETS requirements |
Operational data | INTEGER |
| 1808 |
SMETS 5.7.5.15 |
PrepaymentBalanceCollection | EmergencyCreditBalance | See SMETS requirements |
Operational data | INTEGER |
| 1807 |
SMETS 5.7.5.22 |
PrepaymentBalanceCollection | MeterBalance | See SMETS requirements |
Operational data | INTEGER |
| 1812 |
SMETS 5.7.5.23 |
PrepaymentBalanceCollection | PaymentDebtBalance | See SMETS requirements |
Operational data | INTEGER |
| 1810 |
SMETS 5.7.5.36 |
PrepaymentBalanceCollection | TimeDebt1Balance | See SMETS requirements |
Operational data | INTEGER |
| 1811 |
SMETS 5.7.5.36 |
PrepaymentBalanceCollection | TimeDebt2Balance | See SMETS requirements |
Operational data | INTEGER |
| 1736 |
SMETS 4.6.5.21 |
TimeDebtRegisters[1] | unit | Currency units (as determined by CurrencyUnits.value) |
Operational data | ENUMERATION |
| 1149 |
SMETS 4.6.5.21 |
TimeDebtRegisters[1] | value | Amount remaining to be recovered through time based debt recovery using DebtRecoveryRate[1..2] |
Operational data | INTEGER |
| 1737 |
SMETS 4.6.5.21 |
TimeDebtRegisters[2] | unit | Currency units (as determined by CurrencyUnits.value) |
Operational data | ENUMERATION |
| 1150 |
SMETS 4.6.5.21 |
TimeDebtRegisters[2] | value | Amount remaining to be recovered through time based debt recovery using DebtRecoveryRate[1..2] |
Operational data | INTEGER |
| Sensitive |
| Target | ESME |
|---|---|
| Message Code | 0x002D |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1807 |
SMETS 5.7.5.22 |
PrepaymentBalanceCollection: MeterBalance | 1 | 0-0:94.44.34.30 | A | 2 | value:prepayment_balance_collection.meter_balance | double-long | - | part of prepayment_balance_collection ::= structure { meter_balance double_long; // contains the value of {112,0-0:19.10.0.255,2,0,0,<null>} emergency_credit_balance double_long; // contains the value of {112,0-0:19.10.1.255,2,0,0,<null>} accumulated_debt_register double_long; // contains the value of {112,0-0:19.10.2.255,2,0,0,<null>} time_debt_1_balance double_long; // contains the value of {113, 0-0:19.2.1.255,12,0,0,<null>} time_debt_2_balance double_long; // contains the value of {113, 0-0:19.2.2.255,12,0,0,<null>} payment_debt_balance double_long // contains the value of {113, 0-0:19.2.3.255,12,0,0,<null>} } // explanatory elements in {} are structured as {class_id,logical_name,attribute_id,data_index,restriction_index} |
| 1808 |
SMETS 5.7.5.15 |
PrepaymentBalanceCollection: EmergencyCreditBalance | 1 | 0-0:94.44.34.30 | A | 2 | value:prepayment_balance_collection.emergency_credit_balance | double-long | - | part of prepayment_balance_collection ::= structure { meter_balance double_long; // contains the value of {112,0-0:19.10.0.255,2,0,0,<null>} emergency_credit_balance double_long; // contains the value of {112,0-0:19.10.1.255,2,0,0,<null>} accumulated_debt_register double_long; // contains the value of {112,0-0:19.10.2.255,2,0,0,<null>} time_debt_1_balance double_long; // contains the value of {113, 0-0:19.2.1.255,12,0,0,<null>} time_debt_2_balance double_long; // contains the value of {113, 0-0:19.2.2.255,12,0,0,<null>} payment_debt_balance double_long // contains the value of {113, 0-0:19.2.3.255,12,0,0,<null>} } // explanatory elements in {} are structured as {class_id,logical_name,attribute_id,data_index,restriction_index} |
| 1809 |
SMETS 5.7.5.1 |
PrepaymentBalanceCollection: AccumulatedDebtRegister | 1 | 0-0:94.44.34.30 | A | 2 | value:prepayment_balance_collection.accumulated_debt_register | double-long | - | part of prepayment_balance_collection ::= structure { meter_balance double_long; // contains the value of {112,0-0:19.10.0.255,2,0,0,<null>} emergency_credit_balance double_long; // contains the value of {112,0-0:19.10.1.255,2,0,0,<null>} accumulated_debt_register double_long; // contains the value of {112,0-0:19.10.2.255,2,0,0,<null>} time_debt_1_balance double_long; // contains the value of {113, 0-0:19.2.1.255,12,0,0,<null>} time_debt_2_balance double_long; // contains the value of {113, 0-0:19.2.2.255,12,0,0,<null>} payment_debt_balance double_long // contains the value of {113, 0-0:19.2.3.255,12,0,0,<null>} } // explanatory elements in {} are structured as {class_id,logical_name,attribute_id,data_index,restriction_index} |
| 1810 |
SMETS 5.7.5.36 |
PrepaymentBalanceCollection: TimeDebt1Balance | 1 | 0-0:94.44.34.30 | A | 2 | value:prepayment_balance_collection.time_debt_1_balance | double-long | - | part of prepayment_balance_collection ::= structure { meter_balance double_long; // contains the value of {112,0-0:19.10.0.255,2,0,0,<null>} emergency_credit_balance double_long; // contains the value of {112,0-0:19.10.1.255,2,0,0,<null>} accumulated_debt_register double_long; // contains the value of {112,0-0:19.10.2.255,2,0,0,<null>} time_debt_1_balance double_long; // contains the value of {113, 0-0:19.2.1.255,12,0,0,<null>} time_debt_2_balance double_long; // contains the value of {113, 0-0:19.2.2.255,12,0,0,<null>} payment_debt_balance double_long // contains the value of {113, 0-0:19.2.3.255,12,0,0,<null>} } // explanatory elements in {} are structured as {class_id,logical_name,attribute_id,data_index,restriction_index} |
| 1811 |
SMETS 5.7.5.36 |
PrepaymentBalanceCollection: TimeDebt2Balance | 1 | 0-0:94.44.34.30 | A | 2 | value:prepayment_balance_collection.time_debt_2_balance | double-long | - | part of prepayment_balance_collection ::= structure { meter_balance double_long; // contains the value of {112,0-0:19.10.0.255,2,0,0,<null>} emergency_credit_balance double_long; // contains the value of {112,0-0:19.10.1.255,2,0,0,<null>} accumulated_debt_register double_long; // contains the value of {112,0-0:19.10.2.255,2,0,0,<null>} time_debt_1_balance double_long; // contains the value of {113, 0-0:19.2.1.255,12,0,0,<null>} time_debt_2_balance double_long; // contains the value of {113, 0-0:19.2.2.255,12,0,0,<null>} payment_debt_balance double_long // contains the value of {113, 0-0:19.2.3.255,12,0,0,<null>} } // explanatory elements in {} are structured as {class_id,logical_name,attribute_id,data_index,restriction_index} |
| 1812 |
SMETS 5.7.5.23 |
PrepaymentBalanceCollection: PaymentDebtBalance | 1 | 0-0:94.44.34.30 | A | 2 | value:prepayment_balance_collection.payment_debt_balance | double-long | - | part of prepayment_balance_collection ::= structure { meter_balance double_long; // contains the value of {112,0-0:19.10.0.255,2,0,0,<null>} emergency_credit_balance double_long; // contains the value of {112,0-0:19.10.1.255,2,0,0,<null>} accumulated_debt_register double_long; // contains the value of {112,0-0:19.10.2.255,2,0,0,<null>} time_debt_1_balance double_long; // contains the value of {113, 0-0:19.2.1.255,12,0,0,<null>} time_debt_2_balance double_long; // contains the value of {113, 0-0:19.2.2.255,12,0,0,<null>} payment_debt_balance double_long // contains the value of {113, 0-0:19.2.3.255,12,0,0,<null>} } // explanatory elements in {} are structured as {class_id,logical_name,attribute_id,data_index,restriction_index} |
| 934 |
(DLMS) |
PrepaymentBalanceCollection: read | 30 | 0-0:43.2.1.255 | M | 1 | get_protected_attributes | structure | - | See section 8.5 for population of the input / output structure for this method's invocation |
| Encrypted attributes - see section 8 |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x0075 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1556 | (GBZ) | AccumulatedDebtRegister: scale | BITMAP8 (NIBBLES) | Tariff Information: Price Trailing Digit: 0x0617 | Price: 0x0700 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1708 | (GBZ) | AccumulatedDebtRegister: unit | UINT16 | Tariff Information: Currency: 0x0616 | |||
| 1566 | (GBZ) | EmergencyCreditBalance: scale | BITMAP8 (NIBBLES) | Tariff Information: Price Trailing Digit: 0x0617 | |||
| 1717 | (GBZ) | EmergencyCreditBalance: unit | UINT16 | Tariff Information: Currency: 0x0616 | |||
| 1725 | (GBZ) | MeterBalance: unit | UINT16 | Tariff Information: Currency: 0x0616 | |||
| 1570 | (GBZ) | PaymentDebtRegister: scale | BITMAP8 (NIBBLES) | Tariff Information: Price Trailing Digit: 0x0617 | |||
| 1726 | (GBZ) | PaymentDebtRegister: unit | UINT16 | Tariff Information: Currency: 0x0616 | |||
| 1575 | (GBZ) | TimeDebtRegisters[1]: scale | BITMAP8 (NIBBLES) | Tariff Information: Price Trailing Digit: 0x0617 | |||
| 1736 | SMETS 4.6.5.21 | TimeDebtRegisters[1]: unit | UINT16 | Tariff Information: Currency: 0x0616 | |||
| 1576 | (GBZ) | TimeDebtRegisters[2]: scale | BITMAP8 (NIBBLES) | Tariff Information: Price Trailing Digit: 0x0617 | |||
| 1737 | SMETS 4.6.5.21 | TimeDebtRegisters[2]: unit | UINT16 | Tariff Information: Currency: 0x0616 | |||
| 1039 | SMETS 4.6.5.1 | AccumulatedDebtRegister: value | INT32 | Prepayment Information: Accumulated Debt: 0x0005 | Prepayment: 0x0705 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1040 | SMETS 4.6.5.8 | EmergencyCreditBalance: value | INT32 | Prepayment Information: EmergencyCreditRemaining: 0x0002 | |||
| 1041 | SMETS 4.6.5.11 | MeterBalance: valuePrepaymentMode | INT32 | Prepayment Information: Credit Remaining: 0x0001 | |||
| 1148 | SMETS 4.6.5.13 | PaymentDebtRegister: value | UINT32 | Debt: DebtAmount#3: 0x0231 | |||
| 1149 | SMETS 4.6.5.21 | TimeDebtRegisters[1]: value | UINT32 | Debt: DebtAmount#1: 0x0211 | |||
| 1150 | SMETS 4.6.5.21 | TimeDebtRegisters[2]: value | UINT32 | Debt: DebtAmount#2: 0x0221 |
| Encrypted attributes - see section 8 |
This Use Case is for reading the status of the Load Switch/Valve in the Smart Meter.
| Use Case | Title | Message Code |
|---|---|---|
| ECS45 | Read Status of Load Switch in the ESME | 0x0052 |
| GCS33 | Read GSME Valve Status | 0x0082 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 7.4 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1751 |
SMETS 4.6.5.16 |
RemainingBatteryCapacity | value | Remaining battery life in days |
Operational data | INTEGER |
| 943 |
SMETS 4.6.5.18 SMETS 5.7.5.32 |
SupplyState | value.output_state | Enabled, Disabled or Armed |
Operational data | ENUMERATION |
| Target | ESME |
|---|---|
| Message Code | 0x0052 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 943 |
SMETS 5.7.5.32 |
SupplyState: value.output_state | 70 | 0-0:96.3.10.255 | A | 3 | control_state | enum | - | Enabled = 1 (Connected), Disabled = 0 (Disconnected), Armed = 2 (Ready_for_reconnection) |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x0082 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1751 | SMETS 4.6.5.16 | RemainingBatteryCapacity: value | UINT16 | Meter Status: RemainingBatteryLifeinDays: 0x0205 | Metering: 0x0702 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 943 | SMETS 4.6.5.18 | SupplyState: value.output_state | ENUM8 | Reading Information: SupplyStatus : 0x0014 |
This Use Case is for reading the second element tariff configuration
| Use Case | Title | Message Code |
|---|---|---|
| ECS24b | Read ESME Tariff Data - second element | 0x00BD |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.11 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | Yes |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 370 |
SMETS 5.13.2.9 |
SecondaryActiveTariffPrice | scale | power of 10 to apply when interpreting the value attribute |
Operational data | INTEGER |
| 492 |
SMETS 5.13.2.9 |
SecondaryActiveTariffPrice | unit | Currency units (as determined by CurrencyUnits.value) per kWh |
Operational data | ENUMERATION |
| 108 |
SMETS 5.13.2.9 |
SecondaryActiveTariffPrice | value | Number representing the price in currency units per kWh consumed |
Operational data | INTEGER |
| 1066 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | valueCurrent.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Operational data | INTEGER |
| 1072 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | valueCurrent[1..4].charge_per_unit | charge per unit |
Operational data | INTEGER |
| 1085 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | valueCurrent[1..4].index | reference for the price entry |
Operational data | OCTET-STRING |
| 786 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement)(SpecialDays) | date[0..50].current | This is the date (or set of dates if wildcards are used) of the corresponding special day |
Operational data | DATE WITH WILDCARDS |
| 794 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement)(SpecialDays) | dayIdentifier[0..50].current | This is a number used in calendar entries that require execution on this special day |
Operational data | INTEGER |
| 826 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentDayIdentifiers[1..16] | The trigger points in the calendar, specified in terms of the dayIdentifier and time within that day |
Operational data | INTEGER |
| 820 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentDayIdentifiers[1..16].Time[1..48].actions | Identifies which rate to use at this startTime |
Operational data | INTEGER |
| 822 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentDayIdentifiers[1..16].Time[1..48].startTime | The trigger points in the calendar, specified in terms of the dayIdentifier and time within that day |
Operational data | TIME NO WILDCARDS |
| 802 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentSeasons[1..4].Name | This is a name given to the season e.g. ("winter") |
Operational data | OCTET-STRING |
| 798 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentSeasons[1..4].startDate | This is the date on which the season starts. [the season will end the day the next season starts] |
Operational data | DATE WITH WILDCARDS |
| 800 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentSeasons[1..4].WeekIdentifier | The name used to refer to the week structure used in this season |
Operational data | OCTET-STRING |
| 806 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentWeeks[1..4].days[1].Identifier | dayIdentifier for Monday |
Operational data | INTEGER |
| 808 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentWeeks[1..4].days[2].Identifier | dayIdentifier for Tuesday |
Operational data | INTEGER |
| 812 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentWeeks[1..4].days[4].Identifier | dayIdentifier for Thursday |
Operational data | INTEGER |
| 814 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentWeeks[1..4].days[5].Identifier | dayIdentifier for Friday |
Operational data | INTEGER |
| 816 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentWeeks[1..4].days[6].Identifier | dayIdentifier for Saturday |
Operational data | INTEGER |
| 818 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentWeeks[1..4].days[7].Identifier | dayIdentifier for Sunday |
Operational data | INTEGER |
| 804 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentWeeks[1..4].weekIdentifier | The name given to a particular week structure |
Operational data | OCTET-STRING |
| 810 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | currentWeeks[1..4}.days[3].Identifier | dayIdentifier for Wednesday |
Operational data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00BD |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1060 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueCurrent.commodityScale | 113 | 0-0:19.20.5.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.commodity_scale | integer | - | |
| 1066 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: valueCurrent.price_scale | 113 | 0-0:19.20.5.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.price_scale | integer | - | |
| 1078 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueCurrent.classID | 113 | 0-0:19.20.5.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.class_id | long-unsigned | 3 | |
| 1090 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueCurrent.LN | 113 | 0-0:19.20.5.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.logical_name | octet-string(6) | ||0x0114010800FF | |
| 1054 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueCurrent.attribute_index | 113 | 0-0:19.20.5.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.attribute_index | integer | 2 | |
| 1085 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: valueCurrent[1..4].index | 113 | 0-0:19.20.5.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..4].charge_table_element.index | octet-string(1) | - | |
| 1072 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: valueCurrent[1..4].charge_per_unit | 113 | 0-0:19.20.5.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..4].charge_table_element.charge_per_unit | long | - | |
| 108 |
SMETS 5.13.2.9 |
SecondaryActiveTariffPrice: value | 3 | 0-0:94.44.1.8 | A | 2 | value | double-long-unsigned | - | |
| 370 |
SMETS 5.13.2.9 |
SecondaryActiveTariffPrice: scale | 3 | 0-0:94.44.1.8 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | -5 | |
| 492 |
SMETS 5.13.2.9 |
SecondaryActiveTariffPrice: unit | 3 | 0-0:94.44.1.8 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 254 | DLMS Blue Book has no corresponding unit, so set to 254 = "other unit" |
| 790 |
(DLMS) |
TariffSwitchingTable(SecondaryElement)(SpecialDays): index[0..50].current | 11 | 0-0:11.0.1.255 | A | 2 | entries:entries[0..50].spec_day_entry.index | long-unsigned | - | |
| 786 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement)(SpecialDays): date[0..50].current | 11 | 0-0:11.0.1.255 | A | 2 | entries:entries[0..50].spec_day_entry.specialday_date | octet-string(5) | - | Formatted as date (octet-string(5)) according to 4.1.6.1 of the Blue Book |
| 794 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement)(SpecialDays): dayIdentifier[0..50].current | 11 | 0-0:11.0.1.255 | A | 2 | entries:entries[0..50].spec_day_entry.day_id | unsigned | - | |
| 802 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentSeasons[1..4].Name | 20 | 0-0:13.0.1.255 | A | 3 | season_profile_active:season_profile_active[1..4].season.season_profile_name | octet-string(8) | - | OCTET-STRING(8) |
| 798 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentSeasons[1..4].startDate | 20 | 0-0:13.0.1.255 | A | 3 | season_profile_active:season_profile_active[1..4].season.season_start | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 800 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentSeasons[1..4].WeekIdentifier | 20 | 0-0:13.0.1.255 | A | 3 | season_profile_active:season_profile_active[1..4].season.week_name | octet-string(4) | - | OCTET-STRING(4) |
| 804 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentWeeks[1..4].weekIdentifier | 20 | 0-0:13.0.1.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.week_profile_name | octet-string(4) | - | OCTET-STRING(4) |
| 806 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentWeeks[1..4].days[1].Identifier | 20 | 0-0:13.0.1.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.monday | unsigned | - | |
| 808 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentWeeks[1..4].days[2].Identifier | 20 | 0-0:13.0.1.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.tuesday | unsigned | - | |
| 810 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentWeeks[1..4}.days[3].Identifier | 20 | 0-0:13.0.1.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.wednesday | unsigned | - | |
| 812 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentWeeks[1..4].days[4].Identifier | 20 | 0-0:13.0.1.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.thursday | unsigned | - | |
| 814 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentWeeks[1..4].days[5].Identifier | 20 | 0-0:13.0.1.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.friday | unsigned | - | |
| 816 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentWeeks[1..4].days[6].Identifier | 20 | 0-0:13.0.1.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.saturday | unsigned | - | |
| 818 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentWeeks[1..4].days[7].Identifier | 20 | 0-0:13.0.1.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.sunday | unsigned | - | |
| 826 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentDayIdentifiers[1..16] | 20 | 0-0:13.0.1.255 | A | 5 | day_profile_table_active:day_profile_table_active[1..16].day_profile.day_id | unsigned | - | |
| 822 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentDayIdentifiers[1..16].Time[1..48].startTime | 20 | 0-0:13.0.1.255 | A | 5 | day_profile_table_active:day_profile_table_active[1..16].day_profile.day_schedule[1..48].day_profile_action.start_time | octet-string(4) | - | Formatted as time (octet-string(4))according to 4.1.6.1 of the Blue Book |
| 824 |
(DLMS) |
TariffSwitchingTable(SecondaryElement): currentDayIdentifiers[1..16].Time[1..48].actionsObject | 20 | 0-0:13.0.1.255 | A | 5 | day_profile_table_active:day_profile_table_active[1..16].day_profile.day_schedule[1..48].day_profile_action.script_logical_name | octet-string(6) | '0-0:10.0.100.255||0x00000A0064FF | |
| 820 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): currentDayIdentifiers[1..16].Time[1..48].actions | 20 | 0-0:13.0.1.255 | A | 5 | day_profile_table_active:day_profile_table_active[1..16].day_profile.day_schedule[1..48].day_profile_action.script_selector | long-unsigned | - | See section 7.3.7 of the GBCS |
This Use Case is for reading the tariff configuration and operational data.
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.11 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | Yes |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 361 |
SMETS 4.6.5.2 SMETS 5.7.5.5 / 5.13.2.6 |
(Primary)ActiveTariffPrice | scale | power of 10 to apply when interpreting the value attribute |
Operational data | INTEGER |
| 232 |
SMETS 4.6.5.2 SMETS 5.7.5.5 / 5.13.2.6 |
(Primary)ActiveTariffPrice | unit | Currency units (as determined by CurrencyUnits.value) per unit of energy |
Operational data | ENUMERATION |
| 99 |
SMETS 4.6.5.2 SMETS 5.7.5.5 / 5.13.2.6 |
(Primary)ActiveTariffPrice | value | Number representing the price in currency units of energy consumed |
Operational data | INTEGER |
| 19 |
SMETS 4.6.4.6 SMETS 5.7.4.9 |
CurrencyUnit | valueCurrent | GB Pounds(TRUE), ECB Euro (FALSE) |
Configuration data | BOOLEAN |
| 1439 |
SMETS 4.6.4.23 |
StandingCharge | amountCurrent | Charge in currency units per unit time |
Operational data | INTEGER |
| 1073 |
SMETS 5.7.4.42 |
StandingCharge | valueCurrent.charge_per_unit | charge per unit |
Configuration data | INTEGER |
| 1079 |
SMETS 5.7.4.42 |
StandingCharge | valueCurrent.classID | class ID of the Commodity Reference Object |
Configuration data | INTEGER |
| 1067 |
SMETS 5.7.4.42 |
StandingCharge | valueCurrent.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Configuration data | INTEGER |
| 1674 |
SMETS 4.6.4.32 |
TariffBlockPriceMatrixTOU | scalerCurrent | -5 (Power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 1068 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU | valueCurrent.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Configuration data | INTEGER |
| 1445 |
SMETS 4.6.4.29 |
TariffBlockPriceMatrixTOU | valueCurrent[1..4] | The current set of prices in currency units per kWh |
Operational data | INTEGER |
| 1074 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU | valueCurrent[1..80].charge_per_unit | charge per unit |
Configuration data | INTEGER |
| 785 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable(SpecialDays) | date[0..n].current | This is the date (or set of dates if wildcards are used) of the corresponding special day. n is 20 for GSME and 50 for ESME |
Configuration data | DATE WITH WILDCARDS |
| 793 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable(SpecialDays) | dayIdentifier[0..n].current | This is a number used in calendar entries that require execution on this special day. n is 20 for GSME and 50 for ESME |
Configuration data | INTEGER |
| 825 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentDayIdentifiers[1..m] | The trigger points in the calendar, specified in terms of the dayIdentifier and time within that day m = 4 for GSME, 16 for ESME |
Configuration data | INTEGER |
| 819 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentDayIdentifiers[1..m].Time[1..n].actions | Identifies which rate to use at this startTime (m= 4 and n = 1 for GSME, m = 16 and n = 48 for ESME). |
Configuration data | INTEGER |
| 821 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentDayIdentifiers[1..m].Time[1..n].startTime | The trigger points in the calendar, specified in terms of the dayIdentifier and time within that day |
Configuration data | TIME NO WILDCARDS |
| 801 |
SMETS 5.7.4.48 |
TariffSwitchingTable | currentSeasons[1..4].Name | This is a name given to the season e.g. ("winter"). |
Configuration data | OCTET-STRING |
| 797 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentSeasons[1..n].startDate | This is the date on which the season starts. [the season will end the day the next season starts] |
Configuration data | DATE WITH WILDCARDS |
| 799 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentSeasons[1..n].WeekIdentifier | The name used to refer to the week structure used in this season |
Configuration data | OCTET-STRING |
| 805 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentWeeks[1..n].days[1].Identifier | dayIdentifier for Monday |
Configuration data | INTEGER |
| 807 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentWeeks[1..n].days[2].Identifier | dayIdentifier for Tuesday |
Configuration data | INTEGER |
| 809 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentWeeks[1..n].days[3].Identifier | dayIdentifier for Wednesday |
Configuration data | INTEGER |
| 811 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentWeeks[1..n].days[4].Identifier | dayIdentifier for Thursday |
Configuration data | INTEGER |
| 813 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentWeeks[1..n].days[5].Identifier | dayIdentifier for Friday |
Configuration data | INTEGER |
| 815 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentWeeks[1..n].days[6].Identifier | dayIdentifier for Saturday |
Configuration data | INTEGER |
| 817 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentWeeks[1..n].days[7].Identifier | dayIdentifier for Sunday |
Configuration data | INTEGER |
| 803 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | currentWeeks[1..n].weekIdentifier | The name given to a particular week structure. GSME supports 2 week structures, ESME supports 4 week structures. |
Configuration data | OCTET-STRING |
| 1363 |
SMETS 4.6.4.31 |
TariffThresholdMatrix[1..3] | thresholdCurrent | The value of the thresholds to switch between tariff blocks |
Operational data | INTEGER |
| 865 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[1] | thresholdCurrent[1..3] | Threshold to trigger recording against higher block |
Configuration data | INTEGER[1..3] |
| 866 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[2] | thresholdCurrent[1..3] | Threshold to trigger recording against higher block |
Configuration data | INTEGER[1..3] |
| 867 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[3] | thresholdCurrent[1..3] | Threshold to trigger recording against higher block |
Configuration data | INTEGER[1..3] |
| 868 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[4] | thresholdCurrent[1..3] | Threshold to trigger recording against higher block |
Configuration data | INTEGER[1..3] |
| 869 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[5] | thresholdCurrent[1..3] | Threshold to trigger recording against higher block |
Configuration data | INTEGER[1..3] |
| 870 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[6] | thresholdCurrent[1..3] | Threshold to trigger recording against higher block |
Configuration data | INTEGER[1..3] |
| 871 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[7] | thresholdCurrent[1..3] | Threshold to trigger recording against higher block |
Configuration data | INTEGER[1..3] |
| 872 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[8] | thresholdCurrent[1..3] | Threshold to trigger recording against higher block |
Configuration data | INTEGER[1..3] |
| Target | ESME |
|---|---|
| Message Code | 0x003A |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 99 |
SMETS 5.7.5.5 / 5.13.2.6 |
(Primary)ActiveTariffPrice: value | 3 | 0-0:94.44.1.7 | A | 2 | value | double-long-unsigned | - | |
| 361 |
SMETS 5.7.5.5 / 5.13.2.6 |
(Primary)ActiveTariffPrice: scale | 3 | 0-0:94.44.1.7 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | -5 | |
| 232 |
SMETS 5.7.5.5 / 5.13.2.6 |
(Primary)ActiveTariffPrice: unit | 3 | 0-0:94.44.1.7 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 254 | |
| 801 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentSeasons[1..4].Name | 20 | 0-0:13.0.0.255 | A | 3 | season_profile_active:season_profile_active[1..4].season.season_profile_name | octet-string(8) | - | OCTET-STRING(8) |
| 797 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentSeasons[1..n].startDate | 20 | 0-0:13.0.0.255 | A | 3 | season_profile_active:season_profile_active[1..4].season.season_start | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 799 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentSeasons[1..n].WeekIdentifier | 20 | 0-0:13.0.0.255 | A | 3 | season_profile_active:season_profile_active[1..4].season.week_name | octet-string(4) | - | OCTET-STRING(4) |
| 803 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentWeeks[1..n].weekIdentifier | 20 | 0-0:13.0.0.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.week_profile_name | octet-string(4) | - | OCTET-STRING(4) |
| 805 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentWeeks[1..n].days[1].Identifier | 20 | 0-0:13.0.0.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.monday | unsigned | - | |
| 807 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentWeeks[1..n].days[2].Identifier | 20 | 0-0:13.0.0.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.tuesday | unsigned | - | |
| 809 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentWeeks[1..n].days[3].Identifier | 20 | 0-0:13.0.0.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.wednesday | unsigned | - | |
| 811 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentWeeks[1..n].days[4].Identifier | 20 | 0-0:13.0.0.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.thursday | unsigned | - | |
| 813 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentWeeks[1..n].days[5].Identifier | 20 | 0-0:13.0.0.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.friday | unsigned | - | |
| 815 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentWeeks[1..n].days[6].Identifier | 20 | 0-0:13.0.0.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.saturday | unsigned | - | |
| 817 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentWeeks[1..n].days[7].Identifier | 20 | 0-0:13.0.0.255 | A | 4 | week_profile_table_active:week_profile_table_active[1..4].week_profile.sunday | unsigned | - | |
| 825 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentDayIdentifiers[1..m] | 20 | 0-0:13.0.0.255 | A | 5 | day_profile_table_active:day_profile_table_active[1..16].day_profile.day_id | unsigned | - | |
| 821 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentDayIdentifiers[1..m].Time[1..n].startTime | 20 | 0-0:13.0.0.255 | A | 5 | day_profile_table_active:day_profile_table_active[1..16].day_profile.day_schedule[1..48].day_profile_action.start_time | octet-string(4) | - | Formatted as time (octet-string(4))according to 4.1.6.1 of the Blue Book |
| 823 |
(DLMS) |
TariffSwitchingTable: currentDayIdentifiers[1..m].Time[1..n].actionsObject | 20 | 0-0:13.0.0.255 | A | 5 | day_profile_table_active:day_profile_table_active[1..16].day_profile.day_schedule[1..48].day_profile_action.script_logical_name | octet-string(6) | '0-0:10.0.100.255||0x00000A0064FF | |
| 819 |
SMETS 5.7.4.48 |
TariffSwitchingTable: currentDayIdentifiers[1..m].Time[1..n].actions | 20 | 0-0:13.0.0.255 | A | 5 | day_profile_table_active:day_profile_table_active[1..16].day_profile.day_schedule[1..48].day_profile_action.script_selector | long-unsigned | - | See section 7.3.7 of the GBCS |
| 789 |
(DLMS) |
TariffSwitchingTable(SpecialDays): index[0..50].current | 11 | 0-0:11.0.0.255 | A | 2 | entries:entries[0..50].spec_day_entry.index | long-unsigned | - | |
| 785 |
SMETS 5.7.4.48 |
TariffSwitchingTable(SpecialDays): date[0..n].current | 11 | 0-0:11.0.0.255 | A | 2 | entries:entries[0..50].spec_day_entry.specialday_date | octet-string(5) | - | Formatted as date (octet-string(5)) according to 4.1.6.1 of the Blue Book |
| 793 |
SMETS 5.7.4.48 |
TariffSwitchingTable(SpecialDays): dayIdentifier[0..n].current | 11 | 0-0:11.0.0.255 | A | 2 | entries:entries[0..50].spec_day_entry.day_id | unsigned | - | |
| 865 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[1]: thresholdCurrent[1..3] | 21 | 0-0:16.0.11.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 866 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[2]: thresholdCurrent[1..3] | 21 | 0-0:16.0.12.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 867 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[3]: thresholdCurrent[1..3] | 21 | 0-0:16.0.13.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 868 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[4]: thresholdCurrent[1..3] | 21 | 0-0:16.0.14.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 869 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[5]: thresholdCurrent[1..3] | 21 | 0-0:16.0.15.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 870 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[6]: thresholdCurrent[1..3] | 21 | 0-0:16.0.16.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 871 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[7]: thresholdCurrent[1..3] | 21 | 0-0:16.0.17.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 872 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[8]: thresholdCurrent[1..3] | 21 | 0-0:16.0.18.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 19 |
SMETS 5.7.4.9 |
CurrencyUnit: valueCurrent | 9000 | 0-0:94.44.2.0 | A | 2 | value_active | boolean | - | GB Pounds(TRUE), ECB Euro (FALSE) |
| 1061 |
(DLMS) |
StandingCharge: valueCurrent.commodityScale | 113 | 0-0:19.20.4.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1067 |
SMETS 5.7.4.42 |
StandingCharge: valueCurrent.price_scale | 113 | 0-0:19.20.4.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.price_scale | integer | - | |
| 1079 |
SMETS 5.7.4.42 |
StandingCharge: valueCurrent.classID | 113 | 0-0:19.20.4.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.class_id | long-unsigned | 0 | |
| 1091 |
(DLMS) |
StandingCharge: valueCurrent.LN | 113 | 0-0:19.20.4.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1055 |
(DLMS) |
StandingCharge: valueCurrent.attribute_index | 113 | 0-0:19.20.4.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.attribute_index | integer | 0 | |
| 1084 |
(DLMS) |
StandingCharge: valueCurrent.index | 113 | 0-0:19.20.4.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1073 |
SMETS 5.7.4.42 |
StandingCharge: valueCurrent.charge_per_unit | 113 | 0-0:19.20.4.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1062 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueCurrent.commodityScale | 113 | 0-0:19.20.0.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.commodity_scale | integer | - | |
| 1068 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU: valueCurrent.price_scale | 113 | 0-0:19.20.0.255 | A | 5 | unit_charge_active:unit_charge_active.charge_per_unit_scaling.price_scale | integer | - | |
| 1080 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueCurrent.classID | 113 | 0-0:19.20.0.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.class_id | long-unsigned | 3 | |
| 1092 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueCurrent.LN | 113 | 0-0:19.20.0.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.logical_name | octet-string(6) | ||0x0100010800FF | |
| 1056 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueCurrent.attribute_index | 113 | 0-0:19.20.0.255 | A | 5 | unit_charge_active:unit_charge_active.commodity_reference.attribute_index | integer | 2 | |
| 1086 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueCurrent.index | 113 | 0-0:19.20.0.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..80].charge_table_element.index | octet-string(1) | - | |
| 1074 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU: valueCurrent[1..80].charge_per_unit | 113 | 0-0:19.20.0.255 | A | 5 | unit_charge_active:unit_charge_active.charge_table[1..80].charge_table_element.charge_per_unit | long | - |
| Target | GPF (primary); GSME |
|---|---|
| Message Code | 0x009F |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 19 | SMETS 4.6.4.6 | CurrencyUnit: valueCurrent | UINT16 | Tariff Information: Currency: 0x0616 | Price: 0x0700 | Read Attributes: 0x00 | Read Attributes Response: 0x01 |
| 1674 | SMETS 4.6.4.32 | TariffBlockPriceMatrixTOU: scalerCurrent | BITMAP8 (NIBBLES) | Tariff Information: Price Trailing Digit: 0x0617 | |||
| 1363 | SMETS 4.6.4.31 | TariffThresholdMatrix[1..3]: thresholdCurrent | UINT48 | Block Threshold: BlockNThreshold: 0x0100-0x0102 | |||
| 1445 | SMETS 4.6.4.29 | TariffBlockPriceMatrixTOU: valueCurrent[1..4] | UINT32 | Block Price Information: NoTierBlockNPrice: 0x0400, 0x0401, 0x0402, 0x0403, 0x0410, 0x0420, 0x0430, 0x0440 | |||
| 1365 | (GBZ) | TariffThresholdMatrix[1..3]: unit | ENUM8 | Tariff Information: UnitofMeasure: 0x0615 | |||
| 1359 | (GBZ) | TariffThresholdMatrix[1..3]: scalerCurrentMultiplier | UINT24 | Block Period: ThresholdMultiplier: 0x0202 | |||
| 1358 | (GBZ) | TariffThresholdMatrix[1..3]: scalerCurrentDivisor | UINT24 | Block Period: ThresholdDivisor: 0x0203 | |||
| 1439 | SMETS 4.6.4.23 | StandingCharge: amountCurrent | UINT32 | Commodity: Standing Charge : 0x0301 | |||
| 819 | SMETS 4.6.4.30 | TariffSwitchingTable: currentDayIdentifiers[1..m].Time[1..n].actions | -- | -- | Calendar: 0x0707 | GetDayProfiles: 0x01 | PublishDayProfile: 0x01 |
| 825 | SMETS 4.6.4.30 | TariffSwitchingTable: currentDayIdentifiers[1..m] | -- | -- | |||
| 821 | SMETS 4.6.4.30 | TariffSwitchingTable: currentDayIdentifiers[1..m].Time[1..n].startTime | -- | -- | |||
| 803 | SMETS 4.6.4.30 | TariffSwitchingTable: currentWeeks[1..n].weekIdentifier | -- | -- | Calendar: 0x0707 | GetWeekProfiles: 0x02 | PublishWeekProfile: 0x02 |
| 805 | SMETS 4.6.4.30 | TariffSwitchingTable: currentWeeks[1..n].days[1].Identifier | -- | -- | |||
| 807 | SMETS 4.6.4.30 | TariffSwitchingTable: currentWeeks[1..n].days[2].Identifier | -- | -- | |||
| 809 | SMETS 4.6.4.30 | TariffSwitchingTable: currentWeeks[1..n].days[3].Identifier | -- | -- | |||
| 811 | SMETS 4.6.4.30 | TariffSwitchingTable: currentWeeks[1..n].days[4].Identifier | -- | -- | |||
| 813 | SMETS 4.6.4.30 | TariffSwitchingTable: currentWeeks[1..n].days[5].Identifier | -- | -- | |||
| 815 | SMETS 4.6.4.30 | TariffSwitchingTable: currentWeeks[1..n].days[6].Identifier | -- | -- | |||
| 817 | SMETS 4.6.4.30 | TariffSwitchingTable: currentWeeks[1..n].days[7].Identifier | -- | -- | |||
| 797 | SMETS 4.6.4.30 | TariffSwitchingTable: currentSeasons[1..n].startDate | -- | -- | Calendar: 0x0707 | GetSeasons: 0x03 | PublishSeasons: 0x03 |
| 799 | SMETS 4.6.4.30 | TariffSwitchingTable: currentSeasons[1..n].WeekIdentifier | -- | -- | |||
| 793 | SMETS 4.6.4.30 | TariffSwitchingTable(SpecialDays): dayIdentifier[0..n].current | -- | -- | Calendar: 0x0707 | GetSpecialDays: 0x04 | PublishSpecialDays: 0x04 |
| 785 | SMETS 4.6.4.30 | TariffSwitchingTable(SpecialDays): date[0..n].current | -- | -- | |||
| 99 | SMETS 4.6.5.2 | (Primary)ActiveTariffPrice: value | -- | Price: 0x0700 | Get Current Price: 0x00 | Publish Price: 0x00 | |
| 232 | SMETS 4.6.5.2 | (Primary)ActiveTariffPrice: unit | -- | ||||
| 361 | SMETS 4.6.5.2 | (Primary)ActiveTariffPrice: scale | -- |
This Use Case is for reading the voltage operational data on 3 phase ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS23b | Read Voltage Operational Data -3 Phase | 0x00BC |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.10 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 355 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 226 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter | unit | No units |
Operational data | ENUMERATION |
| 93 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter | value | The count since last reset |
Operational data | INTEGER |
| 356 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 227 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter | unit | No units |
Operational data | ENUMERATION |
| 94 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter | value | The count since last reset |
Operational data | INTEGER |
| 613 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | logEntries[1..4320].logEntry.timestamp | The date-time at the end of the corresponding measurement period |
Operational data | DATE-TIME |
| 552 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | logEntries[1..4320].logEntry.value | The Average RMS Value measured (so implied unit is Volts) |
Operational data | INTEGER |
| 663 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | measurementPeriod | The time in seconds between each capture in this object. This shall be the same as the period over which the average RMS is averaged |
Configuration data | INTEGER |
| 566 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 620 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 641 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 357 |
SMETS 5.19.2.1 |
(Phase[2])AverageRMSOverVoltageCounter | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 228 |
SMETS 5.19.2.1 |
(Phase[2])AverageRMSOverVoltageCounter | unit | No units |
Operational data | ENUMERATION |
| 95 |
SMETS 5.19.2.1 |
(Phase[2])AverageRMSOverVoltageCounter | value | The count since last reset |
Operational data | INTEGER |
| 358 |
SMETS 5.19.2.2 |
(Phase[2])AverageRMSUnderVoltageCounter | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 229 |
SMETS 5.19.2.2 |
(Phase[2])AverageRMSUnderVoltageCounter | unit | No units |
Operational data | ENUMERATION |
| 96 |
SMETS 5.19.2.2 |
(Phase[2])AverageRMSUnderVoltageCounter | value | The count since last reset |
Operational data | INTEGER |
| 614 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog | logEntries[1..4320].logEntry.timestamp | The date-time at the end of the corresponding measurement period |
Operational data | DATE-TIME |
| 553 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog | logEntries[1..4320].logEntry.value | The Average RMS Value measured (so implied unit is Volts) |
Operational data | INTEGER |
| 664 |
SMETS 5.19.1.3 |
(Phase[2])AverageRMSVoltageProfileDataLog | measurementPeriod | The time in seconds between each capture in this object. This shall be the same as the period over which the average RMS is averaged |
Configuration data | INTEGER |
| 567 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 621 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 642 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 359 |
SMETS 5.19.2.1 |
(Phase[3])AverageRMSOverVoltageCounter | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 230 |
SMETS 5.19.2.1 |
(Phase[3])AverageRMSOverVoltageCounter | unit | No units |
Operational data | ENUMERATION |
| 97 |
SMETS 5.19.2.1 |
(Phase[3])AverageRMSOverVoltageCounter | value | The count since last reset |
Operational data | INTEGER |
| 360 |
SMETS 5.19.2.2 |
(Phase[3])AverageRMSUnderVoltageCounter | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 231 |
SMETS 5.19.2.2 |
(Phase[3])AverageRMSUnderVoltageCounter | unit | No units |
Operational data | ENUMERATION |
| 98 |
SMETS 5.19.2.2 |
(Phase[3])AverageRMSUnderVoltageCounter | value | The count since last reset |
Operational data | INTEGER |
| 615 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog | logEntries[1..4320].logEntry.timestamp | The date-time at the end of the corresponding measurement period |
Operational data | DATE-TIME |
| 554 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog | logEntries[1..4320].logEntry.value | The Average RMS Value measured (so implied unit is Volts) |
Operational data | INTEGER |
| 665 |
SMETS 5.19.1.3 |
(Phase[3])AverageRMSVoltageProfileDataLog | measurementPeriod | The time in seconds between each capture in this object. This shall be the same as the period over which the average RMS is averaged |
Configuration data | INTEGER |
| 568 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 622 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 643 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x00BC |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 94 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter: value | 3 | 1-0:32.32.0.4 | A | 2 | value | double-long-unsigned | - | |
| 356 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter: scale | 3 | 1-0:32.32.0.4 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 227 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter: unit | 3 | 1-0:32.32.0.4 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 93 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter: value | 3 | 1-0:32.36.0.4 | A | 2 | value | double-long-unsigned | - | |
| 355 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter: scale | 3 | 1-0:32.36.0.4 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 226 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter: unit | 3 | 1-0:32.36.0.4 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 566 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: method: readLog | 7 | 1-0:32.24.0.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 620 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: methodInput: fromDateTime | 7 | 1-0:32.24.0.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 641 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: methodInput: toDateTime | 7 | 1-0:32.24.0.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 613 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: logEntries[1..4320].logEntry.timestamp | 7 | 1-0:32.24.0.255 | A | 2 | buffer:buffer[1..4320].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 552 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: logEntries[1..4320].logEntry.value | 7 | 1-0:32.24.0.255 | A | 2 | buffer:buffer[1..4320].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 663 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: measurementPeriod | 7 | 1-0:32.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 96 |
SMETS 5.19.2.2 |
(Phase[2])AverageRMSUnderVoltageCounter: value | 3 | 1-0:52.32.0.4 | A | 2 | value | double-long-unsigned | - | |
| 358 |
SMETS 5.19.2.2 |
(Phase[2])AverageRMSUnderVoltageCounter: scale | 3 | 1-0:52.32.0.4 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 229 |
SMETS 5.19.2.2 |
(Phase[2])AverageRMSUnderVoltageCounter: unit | 3 | 1-0:52.32.0.4 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 95 |
SMETS 5.19.2.1 |
(Phase[2])AverageRMSOverVoltageCounter: value | 3 | 1-0:52.36.0.4 | A | 2 | value | double-long-unsigned | - | |
| 357 |
SMETS 5.19.2.1 |
(Phase[2])AverageRMSOverVoltageCounter: scale | 3 | 1-0:52.36.0.4 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 228 |
SMETS 5.19.2.1 |
(Phase[2])AverageRMSOverVoltageCounter: unit | 3 | 1-0:52.36.0.4 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 567 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog: method: readLog | 7 | 1-0:52.24.0.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 621 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog: methodInput: fromDateTime | 7 | 1-0:52.24.0.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 642 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog: methodInput: toDateTime | 7 | 1-0:52.24.0.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 614 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog: logEntries[1..4320].logEntry.timestamp | 7 | 1-0:52.24.0.255 | A | 2 | buffer:buffer[1..4320].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 553 |
SMETS 5.19.2.3 |
(Phase[2])AverageRMSVoltageProfileDataLog: logEntries[1..4320].logEntry.value | 7 | 1-0:52.24.0.255 | A | 2 | buffer:buffer[1..4320].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 664 |
SMETS 5.19.1.3 |
(Phase[2])AverageRMSVoltageProfileDataLog: measurementPeriod | 7 | 1-0:52.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 98 |
SMETS 5.19.2.2 |
(Phase[3])AverageRMSUnderVoltageCounter: value | 3 | 1-0:72.32.0.4 | A | 2 | value | double-long-unsigned | - | |
| 360 |
SMETS 5.19.2.2 |
(Phase[3])AverageRMSUnderVoltageCounter: scale | 3 | 1-0:72.32.0.4 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 231 |
SMETS 5.19.2.2 |
(Phase[3])AverageRMSUnderVoltageCounter: unit | 3 | 1-0:72.32.0.4 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 97 |
SMETS 5.19.2.1 |
(Phase[3])AverageRMSOverVoltageCounter: value | 3 | 1-0:72.36.0.4 | A | 2 | value | double-long-unsigned | - | |
| 359 |
SMETS 5.19.2.1 |
(Phase[3])AverageRMSOverVoltageCounter: scale | 3 | 1-0:72.36.0.4 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 230 |
SMETS 5.19.2.1 |
(Phase[3])AverageRMSOverVoltageCounter: unit | 3 | 1-0:72.36.0.4 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 568 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog: method: readLog | 7 | 1-0:72.24.0.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 622 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog: methodInput: fromDateTime | 7 | 1-0:72.24.0.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 643 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog: methodInput: toDateTime | 7 | 1-0:72.24.0.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 615 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog: logEntries[1..4320].logEntry.timestamp | 7 | 1-0:72.24.0.255 | A | 2 | buffer:buffer[1..4320].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 554 |
SMETS 5.19.2.3 |
(Phase[3])AverageRMSVoltageProfileDataLog: logEntries[1..4320].logEntry.value | 7 | 1-0:72.24.0.255 | A | 2 | buffer:buffer[1..4320].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 665 |
SMETS 5.19.1.3 |
(Phase[3])AverageRMSVoltageProfileDataLog: measurementPeriod | 7 | 1-0:72.24.0.255 | A | 4 | capture_period | double-long-unsigned | - |
This Use Case is for reading the voltage operational data on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS23 | Read Voltage Operational Data | 0x0039 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 4.10 |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
| Network Operator |
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 355 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 226 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter | unit | No units |
Operational data | ENUMERATION |
| 93 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter | value | The count since last reset |
Operational data | INTEGER |
| 356 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter | scale | 0 (power of 10 to apply when interpreting the value attribute) |
Operational data | INTEGER |
| 227 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter | unit | No units |
Operational data | ENUMERATION |
| 94 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter | value | The count since last reset |
Operational data | INTEGER |
| 613 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | logEntries[1..4320].logEntry.timestamp | The date-time at the end of the corresponding measurement period |
Operational data | DATE-TIME |
| 552 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | logEntries[1..4320].logEntry.value | The Average RMS Value measured (so implied unit is Volts) |
Operational data | INTEGER |
| 663 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | measurementPeriod | The time in seconds between each capture in this object. This shall be the same as the period over which the average RMS is averaged |
Configuration data | INTEGER |
| 566 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | method: readLog | The response contains all the log entries between fromDateTime and toDateTime inclusive |
Method | Method |
| 620 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | methodInput: fromDateTime | If the Start of Time as per GBCS section 9.1.6, response contains all entries from the oldest in the log to 'toDateTime'. If not the Start of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| 641 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | methodInput: toDateTime | If the End of Time as per GBCS section 9.1.6, response contains all entries from 'fromDateTime' in the log to the newest. If not the End of Time, response contains all entries between fromDateTime and toDateTime inclusive |
Method Input | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x0039 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 94 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter: value | 3 | 1-0:32.32.0.4 | A | 2 | value | double-long-unsigned | - | |
| 356 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter: scale | 3 | 1-0:32.32.0.4 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 227 |
SMETS 5.7.5.8 / 5.19.2.2 |
(Phase[1])AverageRMSUnderVoltageCounter: unit | 3 | 1-0:32.32.0.4 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 93 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter: value | 3 | 1-0:32.36.0.4 | A | 2 | value | double-long-unsigned | - | |
| 355 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter: scale | 3 | 1-0:32.36.0.4 | A | 3 | scaler_unit:scal_unit_type.scaler | integer | 0 | |
| 226 |
SMETS 5.7.5.7 / 5.19.2.1 |
(Phase[1])AverageRMSOverVoltageCounter: unit | 3 | 1-0:32.36.0.4 | A | 3 | scaler_unit:scal_unit_type.unit | enum | 255 | |
| 566 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: method: readLog | 7 | 1-0:32.24.0.255 | A | 2 | see notes column | integer | - | All access to attribute 2 shall be via selective access. In such access access_parameters.selected_values shall be an empty array and access-selector shall take the value 1. |
| 620 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: methodInput: fromDateTime | 7 | 1-0:32.24.0.255 | A | 2 | buffer:range_descriptor.from_value | double-long-unsigned | - | see section 9.1.5 |
| 641 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: methodInput: toDateTime | 7 | 1-0:32.24.0.255 | A | 2 | buffer:range_descriptor.to_value | double-long-unsigned | - | see section 9.1.5 |
| 613 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: logEntries[1..4320].logEntry.timestamp | 7 | 1-0:32.24.0.255 | A | 2 | buffer:buffer[1..4320].entry_dlValueLogEntry.timestamp | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 552 |
SMETS 5.7.5.9 / 5.19.2.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: logEntries[1..4320].logEntry.value | 7 | 1-0:32.24.0.255 | A | 2 | buffer:buffer[1..4320].entry_dlValueLogEntry.dlValue | double-long-unsigned | - | see section 18.2.1 for definition of the named structure in each entry of buffer for this OBIS code |
| 663 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: measurementPeriod | 7 | 1-0:32.24.0.255 | A | 4 | capture_period | double-long-unsigned | - |
This Use Case is for remotely closing the Load Switch on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS42 | Remotely Close the Load Switch on the ESME | 0x004F |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 7.1 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 693 |
SMETS 5.6.3.12 |
SupplyState | enable | This enables supply if the conditions required in SMETS are met. |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x004F |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 693 |
SMETS 5.6.3.12 |
SupplyState: enable | 9 | 0-0:10.0.106.255 | M | 1 | execute:data | long-unsigned | ||0x0033 | Script 51 = remote Supply Enable |
This Use Case is for remotely opening the Load Switch on the ESME / closing the Valve on the GSME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS43 | Remotely Open the Load Switch on the ESME | 0x0050 |
| GCS32 | Remotely close the valve in the GSME | 0x0081 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 7.2 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 944 |
SMETS 4.5.3.10 SMETS 5.6.3.11 |
SupplyState | disable | this disables the supply. |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x0050 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 944 |
SMETS 5.6.3.11 |
SupplyState: disable | 9 | 0-0:10.0.106.255 | M | 1 | execute:data | long-unsigned | ||0x0034 | Script 52 = Remote Supply Disable |
| Target | GSME |
|---|---|
| Message Code | 0x0081 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 944 | SMETS 4.5.3.10 | SupplyState: disable | ENUM8 | Proposed Supply Status (after Implementation) 0 = Close valve |
Metering: 0x0702 |
This Use Case removes a Device from the 'whitelist' on the Communications Hub.
The 'whitelist' is called the CHF Device Log in CHTS.
If a Device is not on this whitelist, it cannot communicate over the HAN.Where the CHF has established a TC Link Key with the Device specified in the Command, it shall, having authenticated the Command, record that TC Link Key and associated Device Entity Identifier in the CHF Historic Device Log. The CHF shall do this before removing the Device's details from the CHF Device Log, unless the Device specified in the Command is of Device Type HHT. If the Device ID is already in the CHF Historic Device Log, the CHF shall update that record with the TC Link Key for it in the CHF Device Log. If there are already 15 entries in the CHF Historic Device Log, the CHF shall overwrite the oldest entry in that log with the details of this mostly recently removed Device. For clarity, a GPF does not establish a TC Link Key with the CHF, so could never be recorded in the CHF Historic Device Log.
| Use Case | Title | Message Code |
|---|---|---|
| CCS02 | Remove device from CHF device log | 0x0002 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 8.11 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1005 |
CHTS 4.5.1.9 |
DeviceLog(CHF) | removeEntry | Remove the entry from the Device Log identified in entryToBeRemoved |
Method | Method |
| Target | CHF |
|---|---|
| Message Code | 0x0002 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1005 |
CHTS 4.5.1.9 |
DeviceLog(CHF): removeEntry | 104 | 0-0:30.3.0.255 | M | 2 | unregister_device | octet-string(8) | - | This is the Entity Identifier in an octet-string(8) as allocated at manufacture |
A request to the CHF to invoke a Sub GHz Channel Scan. See GBCS 10.6.2.3 for the actions the CHF is required to take whenever the corresponding DLMS COSEM attribute is set.
| Use Case | Title | Message Code |
|---|---|---|
| DBCH05 | Request CHF Sub GHz Channel Scan | 0x010E |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.29 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1921 |
CHTS 4.5.1.12 |
CHFSubGHzChannelScan | request | A request to the CHF to invoke a Sub GHz Channel Scan. See GBCS 10.6.2.3 for the actions the CHF is required to take whenever the corresponding DLMS COSEM attribute is set. |
Method |
| Target | CHF in a Dual Band CH only |
|---|---|
| Message Code | 0x010E |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1921 |
CHTS 4.5.1.12 |
CHFSubGHzChannelScan: request | 1 | 0-0:94.44.10.1 | A | 2 | value | unsigned | ||0x00 |
This Use Case is solely to allocate a Message Code to be recorded in the recipient Device's Event Log when an authenticated ZSE Get Scheduled Events command is received.
| Use Case | Title | Message Code |
|---|---|---|
| HECS01 | Request Control of HCALCS [n] | 0x0119 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | HAN Only Message |
| Message Type | ZSE specified |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | N/A |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| (none) |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|
| Target | |
|---|---|
| Message Code | 0x0119 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|
This Use Case is solely to allocate a Message Code to be recorded in the ESME Event Log when an authenticated ZSE Local Change Supply command is received by the ESME. For clarity and in line with SMETS, such commands can only be successful when they are to enable supply and so the Proposed Supply Status parameter has a value 0x02 meaning 'Supply ON'.
| Use Case | Title | Message Code |
|---|---|---|
| PECS03 | Request to Enable ESME Supply from PPMID | 0x0118 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | HAN Only Message |
| Message Type | ZSE specified |
| Capable of Future Dated Invocation | N/A |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | N/A |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| (none) |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|
| Target | |
|---|---|
| Message Code | 0x0118 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|
This Use Case is for resetting the Maximum Demand Registers on the ESME.
This Use Case should also be used once the Maximum Demand Configurable Time Period has been set to a new value by the DCC Service User (Network Operator) as per Use Case ECS37 (Set Maximum Demand Configurable Time Period).
| Use Case | Title | Message Code |
|---|---|---|
| ECS57 | Reset ESME Maximum Demand Registers | 0x005A |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.18 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 514 |
SMETS 5.6.3.28 |
MaximumDemand(ConfigurableTime)ActiveEnergyImportValue | reset | As per SMETS, reset the register to zero, and set the time of last reset value to the current time |
Method | Method |
| 515 |
SMETS 5.6.3.27 |
MaximumDemandActiveEnergyExportValue | reset | As per SMETS, reset the register to zero, and set the time of last reset value to the current time |
Method | Method |
| 516 |
SMETS 5.6.3.26 |
MaximumDemandActiveEnergyImportValue | reset | As per SMETS, reset the register to zero, and set the time of last reset value to the current time |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x005A |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 516 |
SMETS 5.6.3.26 |
MaximumDemandActiveEnergyImportValue: reset | 4 | 1-0:1.6.0.255 | M | 1 | reset | integer[[OPTIONAL]] | 0 | |
| 514 |
SMETS 5.6.3.28 |
MaximumDemand(ConfigurableTime)ActiveEnergyImportValue: reset | 4 | 1-0:1.6.1.255 | M | 1 | reset | integer[[OPTIONAL]] | 0 | |
| 515 |
SMETS 5.6.3.27 |
MaximumDemandActiveEnergyExportValue: reset | 4 | 1-0:2.6.0.255 | M | 1 | reset | integer[[OPTIONAL]] | 0 |
This Use Case is for resetting the voltage counters.
| Use Case | Title | Message Code |
|---|---|---|
| ECS29e | Reset RMS Voltage Counters on ESME | 0x00D3 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.27 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1899 |
SMETS 5.6.3.22 / 5.18.1.1 |
(Phase[1])AverageRMSOverVoltageCounter | reset | Reset (Phase[1])AverageRMSOverVoltageCounter |
Method | Method |
| 1900 |
SMETS 5.6.3.23 / 5.18.1.2 |
(Phase[1])AverageRMSUnderVoltageCounter | reset | Reset (Phase[1])AverageRMSUnderVoltageCounter |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x00D3 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1900 |
SMETS 5.6.3.23 / 5.18.1.2 |
(Phase[1])AverageRMSUnderVoltageCounter: reset | 3 | 1-0:32.32.0.4 | M | 1 | reset | integer | 0 | |
| 1899 |
SMETS 5.6.3.22 / 5.18.1.1 |
(Phase[1])AverageRMSOverVoltageCounter: reset | 3 | 1-0:32.36.0.4 | M | 1 | reset | integer | 0 |
This Use Case is for resetting the voltage counters.
| Use Case | Title | Message Code |
|---|---|---|
| ECS29f | Reset RMS Voltage Counters on polyphase ESME | 0x00D4 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.27 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1899 |
SMETS 5.6.3.22 / 5.18.1.1 |
(Phase[1])AverageRMSOverVoltageCounter | reset | Reset (Phase[1])AverageRMSOverVoltageCounter |
Method | Method |
| 1900 |
SMETS 5.6.3.23 / 5.18.1.2 |
(Phase[1])AverageRMSUnderVoltageCounter | reset | Reset (Phase[1])AverageRMSUnderVoltageCounter |
Method | Method |
| 1901 |
SMETS 5.18.1.1 |
(Phase[2])AverageRMSOverVoltageCounter | reset | Reset (Phase[2])AverageRMSOverVoltageCounter |
Method | Method |
| 1902 |
SMETS 5.18.1.2 |
(Phase[2])AverageRMSUnderVoltageCounter | reset | Reset (Phase[2])AverageRMSUnderVoltageCounter |
Method | Method |
| 1903 |
SMETS 5.18.1.1 |
(Phase[3])AverageRMSOverVoltageCounter | reset | Reset (Phase[3])AverageRMSOverVoltageCounter |
Method | Method |
| 1904 |
SMETS 5.18.1.2 |
(Phase[3])AverageRMSUnderVoltageCounter | reset | Reset (Phase[3])AverageRMSUnderVoltageCounter |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x00D4 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1900 |
SMETS 5.6.3.23 / 5.18.1.2 |
(Phase[1])AverageRMSUnderVoltageCounter: reset | 3 | 1-0:32.32.0.4 | M | 1 | reset | integer | 0 | |
| 1899 |
SMETS 5.6.3.22 / 5.18.1.1 |
(Phase[1])AverageRMSOverVoltageCounter: reset | 3 | 1-0:32.36.0.4 | M | 1 | reset | integer | 0 | |
| 1902 |
SMETS 5.18.1.2 |
(Phase[2])AverageRMSUnderVoltageCounter: reset | 3 | 1-0:52.32.0.4 | M | 1 | reset | integer | 0 | |
| 1901 |
SMETS 5.18.1.1 |
(Phase[2])AverageRMSOverVoltageCounter: reset | 3 | 1-0:52.36.0.4 | M | 1 | reset | integer | 0 | |
| 1904 |
SMETS 5.18.1.2 |
(Phase[3])AverageRMSUnderVoltageCounter: reset | 3 | 1-0:72.32.0.4 | M | 1 | reset | integer | 0 | |
| 1903 |
SMETS 5.18.1.1 |
(Phase[3])AverageRMSOverVoltageCounter: reset | 3 | 1-0:72.36.0.4 | M | 1 | reset | integer | 0 |
This Use Case is for resetting the tariff block counter matrix on the ESME.
This Use Case has the effect of resetting the consumer's block consumption back to zero, such that their consumption will go back to being charged at the first block rate.
The ESME automatically resets its tariff block counters at the end of the block period/billing period.
Therefore, this Use Case should be avoided in favour of forcing an end of billing period, which will reset the block counter and provide a set of register reads at the time of reset.
| Use Case | Title | Message Code |
|---|---|---|
| ECS05 | Reset Tariff Block Counter Matrix | 0x001D |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 1.7 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 694 |
SMETS 5.7.5.33 |
TariffBlock[1to4]CounterMatrixTOU[1to8] | reset | sets TariffBlock[x]CounterMatrixTOU[y].value to zero on all TariffBlock[1..4]CounterMatrixTOU[1..8] registers |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x001D |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 694 |
SMETS 5.7.5.33 |
TariffBlock[1to4]CounterMatrixTOU[1to8]: reset | 9 | 0-0:10.0.100.255 | M | 1 | execute:data | long-unsigned | ||0x0063 | data shall have the value of 99 which refers to script_identifier of 99 |
This Use Case is for restoring the CHF Device Log. Refer to section 18.2. Subject to successful execution, the Communications Hub shall form a network with an Extended PAN ID set to the value (restore_PAN:restore_PAN.extended_PAN_ID) in the received Command.
| Use Case | Title | Message Code |
|---|---|---|
| CCS03 | Restore CHF Device Log | 0x0003 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 8.12 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1017 |
CHTS 4.5.1.11 |
DeviceLog(CHF) | restoreCHFDeviceLog | Restores a previously backed up CHF Device Log using the details in logDetails |
Method | Method |
| 1015 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | methodInput: logDetails.device[1..16].deviceidentifier | The device identifiers for the devices on the HAN used in the restoreCHFDeviceLog method |
Method Input | OCTET-STRING |
| 1014 |
CHTS 4.6.2.1 |
DeviceLog(CHF) | methodInput: logDetails.device[1..16].securityDetails | The security details used in the restoreCHFDeviceLog method |
Method Input | OCTET-STRING |
| 1016 | DeviceLog(CHF) | methodInput: logDetails.hanIdentifier | The identifier for the HAN used in the restoreCHFDeviceLog method |
Method Input | OCTET-STRING |
| Target | CHF |
|---|---|
| Message Code | 0x0003 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1017 |
CHTS 4.5.1.11 |
DeviceLog(CHF): restoreCHFDeviceLog | 104 | 0-0:30.3.0.255 | M | 5 | restore_PAN:restore_PAN | - | ||
| 1016 | DeviceLog(CHF): methodInput: logDetails.hanIdentifier | 104 | 0-0:30.3.0.255 | M | 5 | restore_PAN:restore_PAN.extended_PAN_ID | octet-string(8) | - | Input parameter for restore_PAN method. |
|
| 1015 |
CHTS 4.6.2.1 |
DeviceLog(CHF): methodInput: logDetails.device[1..16].deviceidentifier | 104 | 0-0:30.3.0.255 | M | 5 | restore_PAN:restore_PAN.devices_to_restore[1..16].device_to_restore.MAC_address | octet-string(8) | - | Input parameter for restore_PAN method. This is the Entity Identifier in an octet-string(8) as allocated at . Note that there will be a variable number of entries in the array devices_to_restore. |
| 1014 |
CHTS 4.6.2.1 |
DeviceLog(CHF): methodInput: logDetails.device[1..16].securityDetails | 104 | 0-0:30.3.0.255 | M | 5 | restore_PAN:restore_PAN.devices_to_restore[1..16].device_to_restore.hashed_TC_link_key | octet-string(16) | - | Input parameter for restore_PAN method. . Note that there will be a variable number of entries in the array devices_to_restore. |
This Use Case is for sending a Customer Identification Number (CIN) to the Smart Meter.
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 9.1 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 82 |
SMETS 4.6.4.7 SMETS 5.7.4.10 |
CustomerIdentificationNumber | value | A number for display on the Device's UI |
Configuration data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x0058 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 82 |
SMETS 5.7.4.10 |
CustomerIdentificationNumber: value | 1 | 0-3:96.13.1.255 | A | 2 | value | octet-string(4) | - | OCTET-STRING(4) |
| Target | GSME |
|---|---|
| Message Code | 0x0083 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 82 | SMETS 4.6.4.7 | CustomerIdentificationNumber: value | OCTETSTRING[n] | CustomerID Number n = 1 - 4 |
Device Management: 0x0708 |
This Use Case is for sending a Consumer message to the Smart Meter.
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 3.1 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1398 |
SMETS 4.6.4.24 SMETS 5.7.4.43 |
SupplierMessage | value | Message contents for display |
Configuration data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x0021 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1398 |
SMETS 5.7.4.43 |
SupplierMessage: value | 1 | 0-2:96.13.1.255 | A | 2 | value | octet-string(116) | - | OCTET-STRING(116) |
| Target | GSME |
|---|---|
| GPF Gas ESI Tap-Off | Yes |
| Message Code | 0x0071 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1398 | SMETS 4.6.4.24 | SupplierMessage: value | CHARSTRING[n] | Message n = 1 - 116 |
Messaging: 0x0703 |
This Use case is for setting which of the 5 Auxiliary Controller[n] are controlled by the Boost Function, where those terms have their SMETS meanings.
| Use Case | Title | Message Code |
|---|---|---|
| ECS62 | Set ALCS/APC and Boost Function Association | 0x005F |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 7.9, 7.10 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 13 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[1] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [1], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 14 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[2] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [2], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 15 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[3] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [3], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 16 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[4] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [4], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| 17 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[5] | value | TRUE meaning the Boost Function is to control Auxiliary Controller [5], where those terms have their SMETS meanings. FALSE otherwise. |
Configuration data | BOOLEAN |
| Target | ESME |
|---|---|
| Message Code | 0x005F |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 13 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[1]: value | 1 | 0-0:94.44.6.1 | A | 2 | value | boolean | - | |
| 14 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[2]: value | 1 | 0-0:94.44.6.2 | A | 2 | value | boolean | - | |
| 15 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[3]: value | 1 | 0-0:94.44.6.3 | A | 2 | value | boolean | - | |
| 16 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[4]: value | 1 | 0-0:94.44.6.4 | A | 2 | value | boolean | - | |
| 17 |
SMETS 5.26.2.1 / 9.14.2.1 |
BoostFunctionControl[5]: value | 1 | 0-0:94.44.6.5 | A | 2 | value | boolean | - |
This Use Case is for configuring Alert behaviours - ESME - Network Operator.
| Use Case | Title | Message Code |
|---|---|---|
| ECS25b | Set Alert Behaviours - ESME - Network Operator | 0x00B0 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.22 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 9 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - DNO | Bit string | Both BIT STRINGS shall be 256 bits in length. The first bit string ('Mask') shall detail which alerts are to be changed. A value of 0b0 shall mean 'do not change' and 0b1 shall mean 'change'. The second bit string ('Actions') shall, for the alerts set by the Mask as requiring change, specify the value each is to be changed to. In Actions, 0b0 shall mean 'turn off' and 0b1 shall mean 'turn on'. Both bit strings shall be numbered according to LSB = 0. The mapping to Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Alert Code which is the concatenation 0x80 || n. The value set on the ESME shall be the concatenation Mask || Actions, so a 512 bit length bit string |
Configuration data | Two BIT-STRINGs |
| Target | ESME |
|---|---|
| Message Code | 0x00B0 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 9 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - DNO: Bit string | 1 | 0-33:97.98.11.255 | A | 2 | value | bit-string(512) | - | Both BIT STRINGS shall be 256 bits in length. The first bit string ('Mask') shall detail which alerts are to be changed. A value of 0b0 shall mean 'do not change' and 0b1 shall mean 'change'. The second bit string ('Actions') shall, for the alerts set by the Mask as requiring change, specify the value each is to be changed to. In Actions, 0b0 shall mean 'turn off' and 0b1 shall mean 'turn on'. Both bit strings shall be numbered according to LSB = 0. The mapping to Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Alert Code which is the concatenation 0x80 || n. The value set on the ESME shall be the concatenation Mask || Actions, so a 512 bit length bit string |
This Use Case is for configuring Alert behaviours - Supplier. Note that critical events / alerts, so including those relating to security, cannot be configured in this Use Case, and so events logged in the Security Log cannot be configured.
| Use Case | Title | Message Code |
|---|---|---|
| ECS25a | Set Alert Behaviours - ESME - Supplier | 0x00AC |
| GCS20 | Set Alert Behaviours - GSME | 0x00AD |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.22 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 8 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Supplier | Bit string | Both BIT STRINGS shall be 256 bits in length. The first bit string ('Mask') shall detail which alerts are to be changed. A value of 0b0 shall mean 'do not change' and 0b1 shall mean 'change'. The second bit string ('Actions') shall, for the alerts set by the Mask as requiring change, specify the value each is to be changed to. In Actions, 0b0 shall mean 'turn off' and 0b1 shall mean 'turn on'. Both bit strings shall be numbered according to LSB = 0. The mapping to Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Alert Code which is the concatenation 0x81 || n. The value set on the ESME shall be the concatenation Mask || Actions, so a 512 bit length bit string |
Configuration data | Two BIT-STRINGs |
| 1487 |
SMETS 4.6.4.1 |
Alerts Configuration Settings | configure | Settings to control whether to generate and send an Alert for events. |
Configuration data | Method |
| 1518 |
SMETS 4.6.4.1 |
Alerts Configuration Settings | methodInput: eventList | List of events to update |
Method Input | STRUCTURE |
| 1530 |
SMETS 4.6.4.1 |
Alerts Configuration Settings | methodInput: value | Value to apply to all events in eventList |
Method Input | BIT-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x00AC |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 8 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Supplier: Bit string | 1 | 0-30:97.98.11.255 | A | 2 | value | bit-string(512) | - | Both BIT STRINGS shall be 256 bits in length. The first bit string ('Mask') shall detail which alerts are to be changed. A value of 0b0 shall mean 'do not change' and 0b1 shall mean 'change'. The second bit string ('Actions') shall, for the alerts set by the Mask as requiring change, specify the value each is to be changed to. In Actions, 0b0 shall mean 'turn off' and 0b1 shall mean 'turn on'. Both bit strings shall be numbered according to LSB = 0. The mapping to Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Alert Code which is the concatenation 0x81 || n. The value set on the ESME shall be the concatenation Mask || Actions, so a 512 bit length bit string |
| Target | GSME |
|---|---|
| Message Code | 0x00AD |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1487 | SMETS 4.6.4.1 | Alerts Configuration Settings: configure | ENUM8 | Configuration Control 0x00 = Apply by List
Command will need to be applied
multiple times for each eventList
with a different value
(Event Configuration) |
Device Management: 0x0708 | SetEventConfiguration : 0x04 | ZCL Default Response : 0x0B |
| 1518 | SMETS 4.6.4.1 | Alerts Configuration Settings: methodInput: eventList | Refer to ZigBee standard | Event Configuration Payload Refer to ZigBee standard |
|||
| 1530 | SMETS 4.6.4.1 | Alerts Configuration Settings: methodInput: value | BITMAP8 | Event Configuration Refer to ZigBee standard |
This Use Case is for setting the commanded state of one of the Auxiliary Controllers.
| Use Case | Title | Message Code |
|---|---|---|
| ECS47a | Set Auxiliary Controller [n] State | 0x011E |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 7.13 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 60 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[1] | settingPeriodEndDateTime | The value in this field shall be the end date-time of the APC [1] Setting Period, ALCS[1] Setting Period or HCALCS[1] Setting Period, depending on whether Auxiliary Controller [1] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. The Device shall, before updating this DLMS attribute, check that the settingPeriodEndDateTime is greater than the corresponding settingPeriodStartDateTime and is no more than 24 hours greater than the corresponding settingPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 1 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 50 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[1] | settingPeriodStartDateTime | The value in this field shall be the start date-time of the APC [1] Setting Period, ALCS[1] Setting Period or HCALCS[1] Setting Period, depending on whether Auxiliary Controller [1] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. This field shall always be present where the 'controllerNumber' specified in the Command is 1 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 61 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[2] | settingPeriodEndDateTime | The value in this field shall be the end date-time of the APC [2] Setting Period, ALCS[2] Setting Period or HCALCS[2] Setting Period, depending on whether Auxiliary Controller [2] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. The Device shall, before updating this DLMS attribute, check that the settingPeriodEndDateTime is greater than the corresponding settingPeriodStartDateTime and is no more than 24 hours greater than the corresponding settingPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 2 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 51 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[2] | settingPeriodStartDateTime | The value in this field shall be the start date-time of the APC [2] Setting Period, ALCS[2] Setting Period or HCALCS[2] Setting Period, depending on whether Auxiliary Controller [2] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. This field shall always be present where the 'controllerNumber' specified in the Command is 2 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 62 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[3] | settingPeriodEndDateTime | The value in this field shall be the end date-time of the APC [3] Setting Period, ALCS[3] Setting Period or HCALCS[3] Setting Period, depending on whether Auxiliary Controller [3] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. The Device shall, before updating this DLMS attribute, check that the settingPeriodEndDateTime is greater than the corresponding settingPeriodStartDateTime and is no more than 24 hours greater than the corresponding settingPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 3 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 52 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[3] | settingPeriodStartDateTime | The value in this field shall be the start date-time of the APC [3] Setting Period, ALCS[3] Setting Period or HCALCS[3] Setting Period, depending on whether Auxiliary Controller [3] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. This field shall always be present where the 'controllerNumber' specified in the Command is 3 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 63 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[4] | settingPeriodEndDateTime | The value in this field shall be the end date-time of the APC [4] Setting Period, ALCS[4] Setting Period or HCALCS[4] Setting Period, depending on whether Auxiliary Controller [4] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. The Device shall, before updating this DLMS attribute, check that the settingPeriodEndDateTime is greater than the corresponding settingPeriodStartDateTime and is no more than 24 hours greater than the corresponding settingPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 4 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 53 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[4] | settingPeriodStartDateTime | The value in this field shall be the start date-time of the APC [4] Setting Period, ALCS[4] Setting Period or HCALCS[4] Setting Period, depending on whether Auxiliary Controller [4] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. This field shall always be present where the 'controllerNumber' specified in the Command is 4 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 64 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[5] | settingPeriodEndDateTime | The value in this field shall be the end date-time of the APC [5] Setting Period, ALCS[5] Setting Period or HCALCS[5] Setting Period, depending on whether Auxiliary Controller [5] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. The Device shall, before updating this DLMS attribute, check that the settingPeriodEndDateTime is greater than the corresponding settingPeriodStartDateTime and is no more than 24 hours greater than the corresponding settingPeriodStartDateTime. If this check fails, the Device shall not update this DLMS attribute, and shall, in the Response, return corresponding Data-Access-Result / Action-Result values of other-reason for this and subsequent DLMS instructions in the Command. This field shall always be present where the 'controllerNumber' specified in the Command is 5 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 54 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[5] | settingPeriodStartDateTime | The value in this field shall be the start date-time of the APC [5] Setting Period, ALCS[5] Setting Period or HCALCS[5] Setting Period, depending on whether Auxiliary Controller [5] is an APC, ALCS or HCALCS. It shall have no meaning if there is currently no such associated Auxiliary Controller. This field shall always be present where the 'controllerNumber' specified in the Command is 5 and shall never be present otherwise. |
Configuration data | DATE-TIME |
| 1829 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[n] | controllerNumberAndCommandedState | See GBCS Section 7.3.6.1 |
Method | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x011E |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 50 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[1]: settingPeriodStartDateTime | 1 | 0-0:94.44.117.1 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 60 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[1]: settingPeriodEndDateTime | 1 | 0-0:94.44.117.2 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 51 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[2]: settingPeriodStartDateTime | 1 | 0-0:94.44.118.1 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 61 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[2]: settingPeriodEndDateTime | 1 | 0-0:94.44.118.2 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 52 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[3]: settingPeriodStartDateTime | 1 | 0-0:94.44.119.1 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 62 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[3]: settingPeriodEndDateTime | 1 | 0-0:94.44.119.2 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 53 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[4]: settingPeriodStartDateTime | 1 | 0-0:94.44.120.1 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 63 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[4]: settingPeriodEndDateTime | 1 | 0-0:94.44.120.2 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 54 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[5]: settingPeriodStartDateTime | 1 | 0-0:94.44.121.1 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 64 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[5]: settingPeriodEndDateTime | 1 | 0-0:94.44.121.2 | A | 2 | value | octet-string(12)[[OPTIONAL]] | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1829 |
SMETS 5.6.3.33 / 5.22.2.4 / 5.29.1.2 / 9.5.2.14 / 9.5.2.17 / 9.10.2.1 |
AuxiliaryController[n]: controllerNumberAndCommandedState | 9 | 0-0:10.0.103.255 | M | 1 | data | long-unsigned | - | See GBCS Section 7.3.6 |
This Use Case is for setting the Auxiliary Controller Calendar.
| Use Case | Title | Message Code |
|---|---|---|
| ECS46d | Set Auxiliary Controller Calendar | 0x011A |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 6.14.3 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1818 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1820 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays) | date[0..20].next | This is the date (or set of dates if wildcards are used) of the corresponding special day. |
Configuration Data | DATE WITH WILDCARDS |
| 1822 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays) | dayIdentifier[0..20].next | This is a number used in calendar entries that require execution on this special day. |
Configuration Data | INTEGER |
| 1201 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 775 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | nextEntries[0..120].beginDate | The earliest date on which this entry in entries will take effect |
Configuration data | DATE |
| 777 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | nextEntries[0..120].endDate | The last date on which this entry in entries will take effect |
Configuration data | DATE |
| 735 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | nextEntries[0..120].execSpecdays[0..20] | Each boolean determines whether this entry executes on this day |
Configuration data | Series of BOOLEANS |
| 737 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | nextEntries[0..120].execWeekdays[0..7] | Each boolean determines whether this entry executes on this day |
Configuration data | Series of BOOLEANS |
| 756 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | nextEntries[0..120].scriptSelector | See the Blue Book and section 7.3.6.1 of the GBCS |
Configuration data | INTEGER |
| 765 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar | nextEntries[0..120].switchTime | The time during the day at which the action is triggered |
Configuration data | TIME NO WILDCARDS |
| Target | ESME |
|---|---|
| Message Code | 0x011A |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1824 |
(DLMS) |
AuxiliaryControllerCalendar(SpecialDays): index[0..20].next | 11 | 0-1:11.0.3.255 | A | 2 | entries:entries[0..20].spec_day_entry.index | long-unsigned | - | Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 1820 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays): date[0..20].next | 11 | 0-1:11.0.3.255 | A | 2 | entries:entries[0..20].spec_day_entry.specialday_date | octet-string(5) | - | Formatted as date (octet-string(5)) according to 4.1.6.1 of the Blue Book. Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 1822 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays): dayIdentifier[0..20].next | 11 | 0-1:11.0.3.255 | A | 2 | entries:entries[0..20].spec_day_entry.day_id | unsigned | - | Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 754 |
(DLMS) |
AuxiliaryControllerCalendar: nextEntries[0..120].index | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.index | long-unsigned | - | |
| 743 |
(DLMS) |
AuxiliaryControllerCalendar: nextEntries[0..120].enable | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.enable | boolean | ||0x01 | |
| 783 |
(DLMS) |
AuxiliaryControllerCalendar: nextEntries[0..120].scriptLN | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.script_logical_name | octet-string(6) | ||0x00000A0067FF | |
| 756 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: nextEntries[0..120].scriptSelector | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.script_selector | long-unsigned | - | |
| 765 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: nextEntries[0..120].switchTime | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.switch_time | octet-string(4) | - | |
| 758 |
(DLMS) |
AuxiliaryControllerCalendar: nextEntries[0..120].validityWindow | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.validity_window | long-unsigned | ||0xFFFF | |
| 737 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: nextEntries[0..120].execWeekdays[0..7] | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.exec_weekdays | bit-string(7) | - | |
| 735 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: nextEntries[0..120].execSpecdays[0..20] | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.exec_specdays | bit-string(20) | The length of this bit-string is variable and must align to the number of special days specified in the associated special days object. The length shown is the maximum number of such special days. |
|
| 775 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: nextEntries[0..120].beginDate | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.begin_date | octet-string(5) | - | |
| 777 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: nextEntries[0..120].endDate | 10 | 0-1:12.0.2.255 | A | 2 | entries:entries[0..120].schedule_table_entry.end_date | octet-string(5) | - | |
| 1201 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar: activateNextDateTime | 9000 | 0-0:94.44.128.26 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book. |
| 1818 |
SMETS 5.7.4.2 / 9.6.2.1 |
AuxiliaryControllerCalendar(SpecialDays): activateNextDateTime | 9000 | 0-0:94.44.128.35 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
This Use Case is for configuring the Auxiliary Controller Descriptions.
| Use Case | Title | Message Code |
|---|---|---|
| ECS46a | Set Auxiliary Controller Descriptions | 0x0053 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.14 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1773 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[1] | Description | The description for Auxiliary Controller referred to by n = 1 |
Configuration data | OCTET-STRING |
| 1774 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[2] | Description | The description for Auxiliary Controller referred to by n = 2 |
Configuration data | OCTET-STRING |
| 1775 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[3] | Description | The description for Auxiliary Controller referred to by n = 3 |
Configuration data | OCTET-STRING |
| 1776 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[4] | Description | The description for Auxiliary Controller referred to by n = 4 |
Configuration data | OCTET-STRING |
| 1777 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[5] | Description | The description for Auxiliary Controller referred to by n = 5 |
Configuration data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x0053 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1773 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[1]: Description | 1 | 0-0:94.44.0.11 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1774 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[2]: Description | 1 | 0-0:94.44.0.12 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1775 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[3]: Description | 1 | 0-0:94.44.0.13 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1776 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[4]: Description | 1 | 0-0:94.44.0.14 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - | |
| 1777 |
SMETS 5.7.4.3 / 9.6.2.2 |
AuxiliaryController[5]: Description | 1 | 0-0:94.44.0.15 | A | 2 | value | visible-string(22)[[OPTIONAL]] | - |
This Use Case is for setting/configuring the Billing Calendar on the Smart Meter, where the periodicity can be daily, weekly, monthly, quarterly, six monthly or yearly .
| Use Case | Title | Message Code |
|---|---|---|
| ECS30a | Set Billing Calendar on the ESME - all periodicities | 0x00D7 |
| GCS25a | Set Billing Calendar on the GSME - all periodicities | 0x00D8 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.8 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1963 |
SMETS 4.6.4.2 SMETS 5.7.4.7 |
BillingCalendar | startDateTimeAndLongerPeriodicity | The date-time of the first billing calendar snapshot and the periodicity of following ones after that (where periodicity can be daily, weekly, monthly, quarterly, six monthly or yearly if being set, or all periodicities if being read). A start date-time of 29th, 30th or 31st of month should not be used. |
Configuration data | DATE-TIME and Periodicity |
| Target | ESME |
|---|---|
| Message Code | 0x00D7 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1963 |
SMETS 5.7.4.7 |
BillingCalendar: startDateTimeAndLongerPeriodicity | 22 | 0-0:15.0.0.255 | A | 4 | execution_time:execution_time[1..4].execution_time_date | EXCEPTIONAL | - | See Section 18.2.1 of the GBCS for encoding of this field |
| Target | GSME |
|---|---|
| GPF Gas ESI Tap-Off | Yes |
| Message Code | 0x00D8 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1963 | SMETS 4.6.4.2 | BillingCalendar: startDateTimeAndLongerPeriodicity | -- | Billing Period Start Time: The date-time of the first billing calendar snapshot. Billing Period Duration and Duration Type: in combination these allow for periodicity of daily, weekly, monthly, quarterly, six monthly or yearly. |
Price: 0x0700 | ||
| 1964 | (GBZ) | BillingCalendar: blockResolutionPeriod | -- | Block Period Start Time, Block Period Duration Type and Block Period Duration shall have the same values as Billing Period Start Time, Billing Period Duration Type and Billing Period Duration respectively |
Price: 0x0700 |
This Use Case is only retained as a CH requirement in relation to the Tapping Off Mechanism. CHs are required to process any Commands and Responses received in line with the 'Tapping Off Requirements' for GSME Billing Calendar settings
| Use Case | Title | Message Code |
|---|---|---|
| GCS25 | Set Billing Calendar on the GSME | 0x007E |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.8 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| (none) |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 919 |
SMETS 4.6.4.2 |
BillingCalendar | startDateTimeAndPeriodicity | The date-time of the first billing calendar snapshot and the periodicity of following ones after that (where periodicity can be 1=daily; 2=weekly and 3=monthly). Monthly periodicity and a start date-time of 29th, 30th or 31st of month should not be used. |
Configuration data | DATE-TIME |
| Target | None |
|---|---|
| GPF Gas ESI Tap-Off | Yes |
| Message Code | 0x007E |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 919 | SMETS 4.6.4.2 | BillingCalendar: startDateTimeAndPeriodicity | -- | Billing Period Start Time: The date-time of the first billing calendar snapshot. Billing Period Duration Type: the Periodicity where 1 = Days, 2 = Weeks, 3 = Months |
Price: 0x0700 | ||
| 1705 | (GBZ) | BillingCalendar: blockResolutionPeriod | -- | Block Period Start Time: The date-time of the first billing calendar snapshot. Block Period Duration Type: the Periodicity where 1 = Days, 2 = Weeks, 3 = Months |
Price: 0x0700 |
This Use Case is for setting a date for a Change of Tenancy on the Device and restricting access to data based on this date.
The date in the Command may be in the future or in the past, and the Command will be executed on receipt.
Once set, the date is used by the Smart Meter to restrict the householder's access to the following information:
- Profile data log;
- Cumulative and Historical Value Store;
- Daily Read Log;
- Prepayment Daily Read Log;
- Billing Data Log; and
- Daily Consumption Log.
| Use Case | Title | Message Code |
|---|---|---|
| ECS12 | Set Change of Tenancy date on ESME | 0x0022 |
| GCS09 | Set Change of Tenancy date on GPF | 0x0072 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 3.2 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 75 |
SMETS NA; CHTS 4.5.4.10 SMETS 5.6.3.31 |
restrictDataDateTime | value | the date-time from which the data is restricted |
Configuration data | DATE-TIME no wildcards |
| Target | ESME |
|---|---|
| Message Code | 0x0022 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 75 |
SMETS 5.6.3.31 |
restrictDataDateTime: value | 1 | 0-0:94.44.3.2 | A | 2 | value | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| Target | GPF |
|---|---|
| Message Code | 0x0072 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 75 | SMETS NA; CHTS 4.5.4.10 | restrictDataDateTime: value | UTCTime | Implementation Date/Time UTC Time |
Device Management: 0x0708 | Publish Change of Tenancy : 0x00 | ZCL Default Response : 0x0B |
| 1766 | (GBZ) | restrictDataDateTime: valueProviderChangeControlNext | BITMAP32 | Proposed Tenancy Change Control 0x00000200 = Clear IHD Data - Consumer |
|||
| 1768 | (GBZ) | restrictDataDateTime: valueTariffTypeNext | BITMAP8 (NIBBLES) | Tariff Type 0 = Delivered Tariff |
A request to the CHF to set the Sub GHz Configuration values. See GBCS 10.6.2.3 for the specific processing requirements the CHF is required to carry out on receipt of such a Command.
| Use Case | Title | Message Code |
|---|---|---|
| DBCH04 | Set CHF Sub GHz Configuration | 0x010D |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.28 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1915 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | channelNoisierTheshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1914 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | channelQuieterThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1913 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | gSMECurfew | See GBCS 10.6.2.3. |
Configuration data | |
| 1911 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | limited-CriticalDutyCycleThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1919 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHFailurePercentage | See GBCS 10.6.2.3. |
Configuration data | |
| 1918 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHNoiseMeasurementPeriod | See GBCS 10.6.2.3. |
Configuration data | |
| 1920 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHRetryPercentage | See GBCS 10.6.2.3. |
Configuration data | |
| 1912 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | maximumSubGHzChannelChangesPerWeek | See GBCS 10.6.2.3. |
Configuration data | |
| 1916 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | nonGSMEPoorCommunicationsPercentageThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1917 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | nonGSMEPoorCommunicationsThirtyMinutePeriodsMeasurementPeriod | See GBCS 10.6.2.3. |
Configuration data | |
| 1910 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | normal-LimitedDutyCycleThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1905 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page28Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1906 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page29Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1907 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page30Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1908 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page31Mask | See GBCS 10.6.2.3. |
Configuration data |
| Target | CHF in a Dual Band CH only |
|---|---|
| Message Code | 0x010D |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1905 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page28Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page28Mask | bit-string(32) | - | |
| 1906 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page29Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page29Mask | bit-string(32) | - | |
| 1907 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page30Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page30Mask | bit-string(32) | - | |
| 1908 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page31Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page31Mask | bit-string(32) | - | |
| 1910 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: normal-LimitedDutyCycleThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.normalLimitedDutyCycleThreshold | long-unsigned | - | |
| 1911 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: limited-CriticalDutyCycleThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.limitedCriticalDutyCycleThreshold | long-unsigned | - | |
| 1912 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: maximumSubGHzChannelChangesPerWeek | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.channelChangesPerWeek | unsigned | - | |
| 1913 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: gSMECurfew | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.gsmeCurfew | long-unsigned | - | |
| 1914 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: channelQuieterThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.quieterDecibelsLimit | unsigned | - | |
| 1915 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: channelNoisierTheshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.noisierDecibelsLimit | unsigned | - | |
| 1916 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: nonGSMEPoorCommunicationsPercentageThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.nonGsmePoorCommsPercentage | long-unsigned | - | |
| 1917 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: nonGSMEPoorCommunicationsThirtyMinutePeriodsMeasurementPeriod | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.nonGsmeMeasurementPeriods | unsigned | - | |
| 1918 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHNoiseMeasurementPeriod | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChNoiseMeasurementPeriod | long-unsigned | - | |
| 1919 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHFailurePercentage | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChFailurePercentage | long-unsigned | - | |
| 1920 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHRetryPercentage | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChRetryPercentage | long-unsigned | - |
This Use Case is for setting the clock.
Refer to section 9.1.
| Use Case | Title | Message Code |
|---|---|---|
| ECS70 | Set Clock on ESME | 0x0062 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.11, 8.1 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 681 |
SMETS 5.6.3.32 / 9.5.2.13 |
Time | setTime | To align UTC time (processing detail as per GBCS) |
Method | Method |
| 685 |
SMETS 4.5.3.20 SMETS 5.6.3.32 / 9.5.2.13 |
Time | setValidTimeRange | To set the date-time range in which the ESME shall adjust its time to the Comms Hub time if the Comms Hub time is within the date-time range |
Method | Method |
| 683 |
SMETS 4.5.3.20 SMETS 5.6.3.32 / 9.5.2.13 |
Time | methodInput: timeRangeEnd | date-time of the end of the range, as an input parameter to Time.setValidTimeRange |
Method Input | DATE-TIME |
| 684 |
SMETS 4.5.3.20 SMETS 5.6.3.32 / 9.5.2.13 |
Time | methodInput: timeRangeStart | date-time of the start of the range, as an input parameter to Time.setValidTimeRange |
Method Input | DATE-TIME |
| 676 |
SMETS 4.5.3.20 SMETS 5.5.1 / 9.4.1 |
Time | methodOutput: status | May be one of three values: Invalid, Unreliable, Reliable |
Operational data | ENUMERATION |
| 675 |
SMETS 4.5.3.20 SMETS 5.5.1 / 9.4.1 CHTS 4.6.3.1 |
Time | methodOutput: value | The UTC date time |
Operational data | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x0062 |
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 678 |
(DLMS) |
Time: clockBase | 8 | 0-0:1.0.0.255 | A | 9 | clock_base | enum | 5 | See GBCS |
| 685 |
SMETS 5.6.3.32 / 9.5.2.13 |
Time: setValidTimeRange | 8 | 0-0:1.0.0.255 | M | 5 | preset_adjusting_time | - | See GBCS |
|
| 682 |
(DLMS) |
Time: methodInput: presetTime | 8 | 0-0:1.0.0.255 | M | 5 | preset_adjusting_time:preset_adjusting_time.preset_time | octet-string(12) | ||0xFFFFFFFFFFFFFFFFFF8000FF | data input structure for this method: preset_adjusting_time ::= structure { preset_time: octet-string, validity_interval_start: octet-string, validity_interval_end: octet-string } |
| 683 |
SMETS 5.6.3.32 / 9.5.2.13 |
Time: methodInput: timeRangeEnd | 8 | 0-0:1.0.0.255 | M | 5 | preset_adjusting_time:preset_adjusting_time.validity_interval_end | octet-string(12) | - | |
| 684 |
SMETS 5.6.3.32 / 9.5.2.13 |
Time: methodInput: timeRangeStart | 8 | 0-0:1.0.0.255 | M | 5 | preset_adjusting_time:preset_adjusting_time.validity_interval_start | octet-string(12) | - | |
| 681 |
SMETS 5.6.3.32 / 9.5.2.13 |
Time: setTime | 8 | 0-0:1.0.0.255 | M | 4 | adjust_to_preset_time | integer | 0 | See GBCS |
| 675 |
SMETS 5.5.1 / 9.4.1 CHTS 4.6.3.1 |
Time: methodOutput: value | 8 | 0-0:1.0.0.255 | A | 2 | time | octet-string(12) | - | The octet-string contains data that defines both Local Time and UTC Time within the same 12 octet string |
| 676 |
SMETS 5.5.1 / 9.4.1 |
Time: methodOutput: status | 8 | 0-0:1.0.0.255 | A | 4 | status | unsigned | - | See GBCS |
This Use Case is for setting the Conversion Value and Conversion Factors on a gas meter.
| Use Case | Title | Message Code |
|---|---|---|
| GCS23 | Set CV and Conversion Factor Value(s) on the GSME | 0x007C |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.6 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1371 |
SMETS 4.6.4.3 |
CalorificValue | valueNext | The amount of energy released when a known volume of gas is completely combusted under specified conditions |
Configuration data | INTEGER |
| 1372 |
SMETS 4.6.4.5 |
ConversionFactor | valueNext | The yet to be activated value |
Configuration data | INTEGER |
| Target | GSME |
|---|---|
| GPF Gas ESI Tap-Off | Yes |
| Message Code | 0x007C |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1372 | SMETS 4.6.4.5 | ConversionFactor: valueNext | UINT32 | Conversion Factor 0 - 0xFFFFFFFF |
Price: 0x0700 | PublishConversionFactor : 0x02 | ZCL Default Response : 0x0B |
| 1685 | (GBZ) | ConversionFactor: ScalerNext | BITMAP8 (NIBBLES) | Conversion Factor Trailing Digit 0x50 - MS nibble = digits to right of decimal point |
|||
| 1371 | SMETS 4.6.4.3 | CalorificValue: valueNext | UINT32 | Calorific Value 0 - 0xFFFFFFFF |
Price: 0x0700 | PublishCalorificValue : 0x03 | ZCL Default Response : 0x0B |
| 1367 | (GBZ) | CalorificValue: unitNext | ENUM8 | Calorific Value Unit 0x01 (MJ/m3) |
|||
| 1360 | (GBZ) | CalorificValue: ScalerNext | BITMAP8 (NIBBLES) | Calorific Value Trailing Digit 0x10 - MS nibble = digits to right of decimal point |
This Use Case is for configuring Event behaviours for audible alarms - Supplier.
| Use Case | Title | Message Code |
|---|---|---|
| ECS25a2 | Set Event Behaviours - ESME audible alarm - Supplier | 0x00EB |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.22 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1931 |
SMETS 5.7.4.51 |
Events Configuration Settings - Supplier | maskAndActionsForAlarms | Both BIT STRINGS shall be 256 bits in length. The first bits string ('Mask') shall detail which events / alerts are to be changed. A value of 0b0 shall mean 'do not change' and 0b1 shall mean 'change'. The second bit string ('Actions') shall, for the events / alerts set by the Mask to be changed, specify the value each is to be changed to. In Actions, 0b0 shall mean 'turn off' and 0b1 shall mean 'turn on'. Both bit strings shall be numbered according to LSB = 0, the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Alert Code which is the concatenation 0x81 || n. The bit string in the corresponding read object shall be updated in line with Mask and Actions. The value set on the ESME shall be the concatenation Mask || Actions, so a 512 bit length bit string'. |
Configuration data | Two BIT-STRINGs |
| Target | ESME |
|---|---|
| Message Code | 0x00EB |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1931 |
SMETS 5.7.4.51 |
Events Configuration Settings - Supplier: maskAndActionsForAlarms | 1 | 0-30:97.98.13.255 | A | 2 | value | bit-string(512) | - |
This Use Case is for configuring Event behaviours for whether an event is logged or not - Network Operator.
| Use Case | Title | Message Code |
|---|---|---|
| ECS25b3 | Set Event Behaviours - ESME logging - Network Operator | 0x00ED |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.22 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1933 |
SMETS 5.7.4.51 |
Events Configuration Settings - Network Operator | maskAndActionsForLogging | Both BIT STRINGS shall be 256 bits in length. The first bits string ('Mask') shall detail which events / alerts are to be changed. A value of 0b0 shall mean 'do not change' and 0b1 shall mean 'change'. The second bit string ('Actions') shall, for the events / alerts set by the Mask to be changed, specify the value each is to be changed to. In Actions, 0b0 shall mean 'turn off' and 0b1 shall mean 'turn on'. Both bit strings shall be numbered according to LSB = 0, the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Alert Code which is the concatenation 0x80|| n. The bit string in the corresponding read object shall be updated in line with Mask and Actions. The value set on the ESME shall be the concatenation Mask || Actions, so a 512 bit length bit string'. |
Configuration data | Two BIT-STRINGs |
| Target | ESME |
|---|---|
| Message Code | 0x00ED |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1933 |
SMETS 5.7.4.51 |
Events Configuration Settings - Network Operator: maskAndActionsForLogging | 1 | 0-33:97.98.14.255 | A | 2 | value | bit-string(512) | - |
This Use Case is for configuring Event behaviours for whether an event is logged or not - Supplier.
| Use Case | Title | Message Code |
|---|---|---|
| ECS25a3 | Set Event Behaviours - ESME logging - Supplier | 0x00EC |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.22 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1932 |
SMETS 5.7.4.51 |
Events Configuration Settings - Supplier | maskAndActionsForLogging | Both BIT STRINGS shall be 256 bits in length. The first bits string ('Mask') shall detail which events / alerts are to be changed. A value of 0b0 shall mean 'do not change' and 0b1 shall mean 'change'. The second bit string ('Actions') shall, for the events / alerts set by the Mask to be changed, specify the value each is to be changed to. In Actions, 0b0 shall mean 'turn off' and 0b1 shall mean 'turn on'. Both bit strings shall be numbered according to LSB = 0, the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Alert Code which is the concatenation 0x81 || n. The bit string in the corresponding read object shall be updated in line with Mask and Actions. The value set on the ESME shall be the concatenation Mask || Actions, so a 512 bit length bit string'. |
Configuration data | Two BIT-STRINGs |
| Target | ESME |
|---|---|
| Message Code | 0x00EC |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1932 |
SMETS 5.7.4.51 |
Events Configuration Settings - Supplier: maskAndActionsForLogging | 1 | 0-30:97.98.14.255 | A | 2 | value | bit-string(512) | - |
This Use Case is for configuring Event behaviours for notifying events to HAN devices - Supplier.
| Use Case | Title | Message Code |
|---|---|---|
| ECS25a1 | Set Event Behaviours - ESME to HAN Device - Supplier | 0x00EA |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.22 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1930 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Supplier | maskAndActionsForHANDeviceSharing | Both BIT STRINGS shall be 256 bits in length. The first bits string ('Mask') shall detail which events / alerts are to be changed. A value of 0b0 shall mean 'do not change' and 0b1 shall mean 'change'. The second bit string ('Actions') shall, for the events / alerts set by the Mask to be changed, specify the value each is to be changed to. In Actions, 0b0 shall mean 'turn off' and 0b1 shall mean 'turn on'. Both bit strings shall be numbered according to LSB = 0, the mapping to Event / Alert Code of a particular bit in position n, where n is in hexadecimal, shall be to the Alert Code which is the concatenation 0x81 || n. The bit string in the corresponding read object shall be updated in line with Mask and Actions. The value set on the ESME shall be the concatenation Mask || Actions, so a 512 bit length bit string'. |
Configuration data | Two BIT-STRINGs |
| Target | ESME |
|---|---|
| Message Code | 0x00EA |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1930 |
SMETS 5.7.4.1 |
Alerts Configuration Settings - Supplier: maskAndActionsForHANDeviceSharing | 1 | 0-30:97.98.12.255 | A | 2 | value | bit-string(512) | - |
This Use Case is for setting the Export MPAN value on the ESME by the Consumer's export Supplier (who is unknown to the ESME). Setting of Import MPAN on the ESME by the Consumer's Import Supplier is covered by Use Case ECS39a. An MPAN/MPRN shall be a utf-8 encoded string.
| Use Case | Title | Message Code |
|---|---|---|
| ECS39b | Set Export MPAN Value on the ESME | 0x004D |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.20 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 77 |
SMETS 5.7.4.28 |
MeterPointAdministrationNumber(ExportMPAN) | value | The MPAN associated with Export Consumption |
Configuration data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x004D |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 77 |
SMETS 5.7.4.28 |
MeterPointAdministrationNumber(ExportMPAN): value | 1 | 1-0:0.0.2.255 | A | 2 | value | octet-string(13) | - | OCTET-STRING(13) |
This Use Case is for setting the configurations for the instantaneous power threshold on the ESME.
These settings determine the ambient signals (green/amber/red) or other indicators present on the IHD as consumer energy usage changes throughout the day.
| Use Case | Title | Message Code |
|---|---|---|
| ECS34 | Set Instantaneous Power Threshold Configuration | 0x0047 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 6.12 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 862 |
SMETS 5.7.4.24 |
LowMediumPowerThreshold | threshold | The value of the Threshold between Low and Medium power |
Configuration data | INTEGER |
| 863 |
SMETS 5.7.4.29 |
MediumHighPowerThreshold | threshold | The value of the Threshold between Medium and High power |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x0047 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 862 |
SMETS 5.7.4.24 |
LowMediumPowerThreshold: threshold | 21 | 0-0:16.0.0.255 | A | 2 | thresholds:thresholds[1of2..2].threshold | double-long-unsigned | - | First entry in the array of 2 entries |
| 863 |
SMETS 5.7.4.29 |
MediumHighPowerThreshold: threshold | 21 | 0-0:16.0.0.255 | A | 2 | thresholds:thresholds[2of2..2].threshold | double-long-unsigned | - | Second entry in the array of 2 entries |
This Use Case is for resetting the Load Limit Counter (to zero) on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS28b | Set Load Limit Configuration Counter Reset | 0x0044 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.4 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 500 |
SMETS 5.6.3.25 |
LoadLimitCounter | reset | Set LoadLimitCounter.value to zero |
Method | Method |
| Target | ESME |
|---|---|
| Message Code | 0x0044 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 500 |
SMETS 5.6.3.25 |
LoadLimitCounter: reset | 3 | 0-0:94.44.42.255 | M | 1 | reset | integer | 0 |
This Use Case is for setting the Load Limit general configurations on the ESME.
The general configurations set by this Use Case cover the Load Limit Power Threshold, Load Limit Period, Load Limit Restoration Period and Load Limit Supply State.
| Use Case | Title | Message Code |
|---|---|---|
| ECS28a | Set Load Limit Configurations - General Settings | 0x0043 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 6.4 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1217 |
SMETS 5.7.4.19 |
LoadLimitPeriod(Timer) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1193 |
SMETS 5.7.4.19 |
LoadLimitPeriod(Timer) | valueNext | The yet to be activated value |
Configuration data | INTEGER |
| 1218 |
SMETS 5.7.4.20 |
LoadLimitPowerThreshold | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1192 |
SMETS 5.7.4.20 |
LoadLimitPowerThreshold | thresholdNext | The yet to be activated value |
Configuration data | INTEGER |
| 1219 |
SMETS 5.7.4.21 |
LoadLimitRestorationPeriod(Timer) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1194 |
SMETS 5.7.4.21 |
LoadLimitRestorationPeriod(Timer) | valueNext | The yet to be activated value |
Configuration data | INTEGER |
| 1220 |
SMETS 5.7.4.22 |
LoadLimitSupplyState | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1180 |
SMETS 5.7.4.22 |
LoadLimitSupplyState | valueNext | Disable(TRUE), Unchanged(FALSE) |
Configuration data | BOOLEAN |
| Target | ESME |
|---|---|
| Message Code | 0x0043 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1180 |
SMETS 5.7.4.22 |
LoadLimitSupplyState: valueNext | 9000 | 0-0:94.44.0.3 | A | 4 | value_passive | boolean | - | |
| 1192 |
SMETS 5.7.4.20 |
LoadLimitPowerThreshold: thresholdNext | 9000 | 0-0:94.44.128.7 | A | 4 | value_passive | double-long-unsigned | - | |
| 1193 |
SMETS 5.7.4.19 |
LoadLimitPeriod(Timer): valueNext | 9000 | 0-0:94.44.128.6 | A | 4 | value_passive | double-long-unsigned | - | |
| 1194 |
SMETS 5.7.4.21 |
LoadLimitRestorationPeriod(Timer): valueNext | 9000 | 0-0:94.44.128.8 | A | 4 | value_passive | double-long-unsigned | - | |
| 1220 |
SMETS 5.7.4.22 |
LoadLimitSupplyState: activateNextDateTime | 9000 | 0-0:94.44.0.3 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1218 |
SMETS 5.7.4.20 |
LoadLimitPowerThreshold: activateNextDateTime | 9000 | 0-0:94.44.128.7 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1217 |
SMETS 5.7.4.19 |
LoadLimitPeriod(Timer): activateNextDateTime | 9000 | 0-0:94.44.128.6 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1219 |
SMETS 5.7.4.21 |
LoadLimitRestorationPeriod(Timer): activateNextDateTime | 9000 | 0-0:94.44.128.8 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
This Use Case is for setting the Maximum Demand Configurable Time Period on the ESME.
Once the Maximum Demand Configurable Time Period has been set to a new value, the DCC Service User (Network Operator) will need to reset the Maximum Demand registers (via Use Case ECS57 (Reset Maximum Demand Registers)).
| Use Case | Title | Message Code |
|---|---|---|
| ECS37 | Set Maximum Demand Configurable Time Period | 0x004A |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.18 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 748 |
SMETS 5.7.4.26 |
MaximumDemandConfigurableTimePeriod | currentEntries[1..2].scriptSelector | Determines whether the associated switchTime is the start or the end time of the MaximumDemandConfigurableTimePeriod. scriptSelector has the value of 1 where it relates to the start time and 2 where it relates to the end time. |
Configuration data | INTEGER |
| 761 |
SMETS 5.7.4.26 |
MaximumDemandConfigurableTimePeriod | currentEntries[1..2].switchTime | The time during the day at which the action is triggered |
Configuration data | TIME NO WILDCARDS |
| Target | ESME |
|---|---|
| Message Code | 0x004A |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 746 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].index | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.index | long-unsigned | - | |
| 740 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].enable | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.enable | boolean | ||0x01 | |
| 780 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].scriptLN | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.script_logical_name | octet-string(6) | ||0x00000A8064FF | |
| 748 |
SMETS 5.7.4.26 |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].scriptSelector | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.script_selector | long-unsigned | - | |
| 761 |
SMETS 5.7.4.26 |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].switchTime | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.switch_time | octet-string(4) | - | |
| 750 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].validityWindow | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.validity_window | long-unsigned | ||0xFFFF | |
| 730 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].execWeekdays[1..7] | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.exec_weekdays | bit-string(7) | ||0b11111110 (bit padding is on the least significant bit) | |
| 728 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].execSpecdays[0..0] | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.exec_specdays | bit-string(0) | ||0x | |
| 768 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].beginDate | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.begin_date | octet-string(5) | ||0x000001FFFF | |
| 770 |
(DLMS) |
MaximumDemandConfigurableTimePeriod: currentEntries[1..2].endDate | 10 | 0-0:12.0.0.255 | A | 2 | entries:entries[1..2].schedule_table_entry.end_date | octet-string(5) | ||0xFFFFFFFFFF |
This Use Case is for setting the Import MPAN/MPRN value on the Smart Meter by the Supplier. An MPAN/MPRN shall be a utf-8 encoded string.
| Use Case | Title | Message Code |
|---|---|---|
| ECS39a | Set MPAN Value on the ESME | 0x004C |
| GCS41 | Set MPRN Value on the GSME | 0x0087 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.20 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 76 |
SMETS 5.7.4.28 |
MeterPointAdministrationNumber(combinedMPANS) | value | Primary and secondary MPAN. |
Configuration data | OCTET-STRING |
| 1502 |
SMETS 4.6.4.19 |
MeterPointReferenceNumber | set | Method to set the MPRN associated with gas consumption |
Configuration data | OCTET-STRING |
| 1531 |
SMETS 4.6.4.19 |
MeterPointReferenceNumber | methodInput: value | The MPRN associated with gas consumption |
Method Input | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x004C |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 76 |
SMETS 5.7.4.28 |
MeterPointAdministrationNumber(combinedMPANS): value | 1 | 0-0:94.44.34.11 | A | 2 | value | octet-string(26) | - | The first 13 bytes represent primary MPAN and, where present on the ESME, the second 13 bytes represents secondary MPAN. Writing a string longer than 13 bytes to a single element meter shall result in an error. |
| Target | GSME |
|---|---|
| Message Code | 0x0087 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1502 | SMETS 4.6.4.19 | MeterPointReferenceNumber: set | -- | -- | Device Management: 0x0708 | Update SiteID : 0x03 | ZCL Default Response : 0x0B |
| 1531 | SMETS 4.6.4.19 | MeterPointReferenceNumber: methodInput: value | OCTETSTRING[n] | SiteID n = 1 - 32 |
This Use Case is for converting the Smart Meter from a prepayment to credit mode.
| Use Case | Title | Message Code |
|---|---|---|
| ECS02 | Set ESME Payment Mode to Credit | 0x001A |
| GCS02 | Set GSME Payment Mode to Credit | 0x006C |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 1.6 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1030 |
SMETS 4.5.3.21 SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1025 |
SMETS 4.5.3.21 SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode | valueNext | See SMETS |
Configuration data | BOOLEAN (three) |
| Target | ESME |
|---|---|
| Message Code | 0x001A |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1020 |
(DLMS) |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: valueNext.paymentModePart | 111 | 0-1:19.0.0.255 | A | 2 | account_mode_and_status:account_mode_and_status.payment_mode | enum | ||0x01 (credit) or 0x02 (prepayment) | |
| 1021 |
(DLMS) |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: valueNext.Status | 111 | 0-1:19.0.0.255 | A | 2 | account_mode_and_status:account_mode_and_status.account_status | enum | 1 | |
| 1025 |
SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: valueNext | 111 | 0-1:19.0.0.255 | A | 11 | credit_charge_configuration:credit_charge_configuration | EXCEPTIONAL | See GBCS Section 18.2.1 for details of the 5 values that are allowed and how these map to the valueNext of each of SuspendDebtDisabled, SuspendDebtEmergency and Payment Mode |
|
| 1030 |
SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: activateNextDateTime | 111 | 0-1:19.0.0.255 | A | 13 | account_activation_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| Target | GSME |
|---|---|
| Message Code | 0x006C |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1030 | SMETS 4.5.3.21 | SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: activateNextDateTime | UTCTime | Implementation Date/Time UTC Time
0 = immediate |
Prepayment: 0x0705 | Change Payment Mode : 0x06 | Change Payment Mode Response : 0x02 |
| 726 | (GBZ) | DisablementThreshold(MeterBalance): thresholdNext | INT32 | Cut Off Value Set to 0xFFFFFFFF (do not change) |
|||
| 1025 | SMETS 4.5.3.21 | SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: valueNext | BITMAP16 | Proposed Payment Control Configuration 0b0000110010010100 | 0b0000010010010111 | 0b0000000010010111 | 0b0000110010010111 | 0b0000100010010111 |
This Use Case is for setting the Payment Mode to prepayment
| Use Case | Title | Message Code |
|---|---|---|
| ECS03 | Set ESME Payment Mode to Prepayment | 0x001B |
| GCS03 | Set GSME Payment Mode to Prepayment | 0x006D |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 1.6 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1203 |
SMETS 5.7.4.15 |
DisablementThreshold(MeterBalance) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1190 |
SMETS 4.6.4.12 SMETS 5.7.4.15 |
DisablementThreshold(MeterBalance) | thresholdNext | The yet to be activated threshold |
Configuration data | INTEGER |
| 1030 |
SMETS 4.5.3.21 SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1025 |
SMETS 4.5.3.21 SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode | valueNext | See SMETS |
Configuration data | BOOLEAN (three) |
| Target | ESME |
|---|---|
| Message Code | 0x001B |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1020 |
(DLMS) |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: valueNext.paymentModePart | 111 | 0-1:19.0.0.255 | A | 2 | account_mode_and_status:account_mode_and_status.payment_mode | enum | ||0x01 (credit) or 0x02 (prepayment) | |
| 1021 |
(DLMS) |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: valueNext.Status | 111 | 0-1:19.0.0.255 | A | 2 | account_mode_and_status:account_mode_and_status.account_status | enum | 1 | |
| 1190 |
SMETS 5.7.4.15 |
DisablementThreshold(MeterBalance): thresholdNext | 9000 | 0-0:94.44.128.22 | A | 4 | value_passive | double-long | - | |
| 1025 |
SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: valueNext | 111 | 0-1:19.0.0.255 | A | 11 | credit_charge_configuration:credit_charge_configuration | EXCEPTIONAL | See GBCS Section 18.2.1 for details of the 5 values that are allowed and how these map to the valueNext of each of SuspendDebtDisabled, SuspendDebtEmergency and Payment Mode |
|
| 1203 |
SMETS 5.7.4.15 |
DisablementThreshold(MeterBalance): activateNextDateTime | 9000 | 0-0:94.44.128.22 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1030 |
SMETS 5.7.4.31 / 5.7.4.45 / 5.7.4.46 |
SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: activateNextDateTime | 111 | 0-1:19.0.0.255 | A | 13 | account_activation_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| Target | GSME |
|---|---|
| Message Code | 0x006D |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1030 | SMETS 4.5.3.21 | SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: activateNextDateTime | UTCTime | Implementation Date/Time UTC Time
0 = immediate |
Prepayment: 0x0705 | Change Payment Mode : 0x06 | Change Payment Mode Response : 0x02 |
| 1190 | SMETS 4.6.4.12 | DisablementThreshold(MeterBalance): thresholdNext | INT32 | Cut Off Value -0x7FFFFFFF -
+0x7FFFFFFF
Set to 0xFFFFFFFF to leave the disablement threshold on the meter unchanged |
|||
| 1025 | SMETS 4.5.3.21 | SuspendDebtDisabled / SuspendDebtEmergency / Payment Mode: valueNext | BITMAP16 | Proposed Payment Control Configuration 0b0000110010010100 | 0b0000010010010111 | 0b0000000010010111 | 0b0000110010010111 | 0b0000100010010111 |
This Use Case is for changing the price for second element on the Smart Meter.
| Use Case | Title | Message Code |
|---|---|---|
| ECS01d | Set Price on ESME secondary | 0x00C7 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 1.2 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1140 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1112 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | valueNext.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Configuration data | INTEGER |
| 1118 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | valueNext[1..4].charge_per_unit | charge per unit |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00C7 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1106 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext.commodityScale | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.commodity_scale | integer | 3 | |
| 1112 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: valueNext.price_scale | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.price_scale | integer | - | |
| 1124 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext.classID | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.class_id | long-unsigned | 3 | |
| 1136 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext.LN | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.logical_name | octet-string(6) | ||0x0114010800FF | |
| 1100 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext.attribute_index | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.attribute_index | integer | 2 | |
| 1131 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext[1..4].index | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..4].charge_table_element.index | octet-string(1) | - | |
| 1118 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: valueNext[1..4].charge_per_unit | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..4].charge_table_element.charge_per_unit | long | - | |
| 1140 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: activateNextDateTime | 113 | 0-0:19.20.5.255 | A | 7 | unit_charge_activation_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
This Use Case is for creating a new price on the Smart Meter where the initial condition of the tariff and price is known, and therefore it can be used to update prices.
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 1.2 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 18 |
SMETS 4.6.4.6 SMETS 5.7.4.9 |
CurrencyUnit | valueNext | GB Pounds(TRUE), ECB Euro (FALSE) |
Configuration data | BOOLEAN |
| 1143 |
SMETS 4.6.4.23 SMETS 5.7.4.42 |
StandingCharge | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1442 |
SMETS 4.6.4.23 |
StandingCharge | amountNext | The yet to be activated value |
Configuration data | INTEGER |
| 1551 |
SMETS 4.6.4.23 |
StandingCharge | numberOfBlockThresholdsInUse | Number of block thresholds in use. ZSE requires this as part of the command to set Standing Charge, and so the User needs to provide it. If TOU is in use, the value is 0. |
Configuration data | INTEGER |
| 1119 |
SMETS 5.7.4.42 |
StandingCharge | valueNext.charge_per_unit | charge per unit |
Configuration data | INTEGER |
| 1113 |
SMETS 5.7.4.42 |
StandingCharge | valueNext.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Configuration data | INTEGER |
| 1144 |
SMETS 4.6.4.32 SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1120 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU | valueNext.charge_per_unit[1..80] | charge per unit |
Configuration data | INTEGER |
| 1114 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU | valueNext.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Configuration data | INTEGER |
| 1450 |
SMETS 4.6.4.29 |
TariffBlockPriceMatrixTOU | valueNext[1..4] | The yet to be activated values |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00A2 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1107 |
(DLMS) |
StandingCharge: valueNext.commodityScale | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1113 |
SMETS 5.7.4.42 |
StandingCharge: valueNext.price_scale | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.price_scale | integer | - | |
| 1125 |
(DLMS) |
StandingCharge: valueNext.classID | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.class_id | long-unsigned | 0 | |
| 1137 |
(DLMS) |
StandingCharge: valueNext.LN | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1101 |
(DLMS) |
StandingCharge: valueNext.attribute_index | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.attribute_index | integer | 0 | |
| 1130 |
(DLMS) |
StandingCharge: valueNext.index | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1119 |
SMETS 5.7.4.42 |
StandingCharge: valueNext.charge_per_unit | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1108 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.commodityScale | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.commodity_scale | integer | 3 | |
| 1114 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU: valueNext.price_scale | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.price_scale | integer | - | |
| 1126 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.classID | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.class_id | long-unsigned | 3 | |
| 1138 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.LN | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.logical_name | octet-string(6) | ||0x0100010800FF | |
| 1102 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.attribute_index | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.attribute_index | integer | 2 | |
| 1132 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.index[1..80] | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..80].charge_table_element.index | octet-string(1) | - | |
| 1120 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU: valueNext.charge_per_unit[1..80] | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..80].charge_table_element.charge_per_unit | long | - | |
| 1143 |
SMETS 5.7.4.42 |
StandingCharge: activateNextDateTime | 113 | 0-0:19.20.4.255 | A | 7 | unit_charge_activation_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1144 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU: activateNextDateTime | 113 | 0-0:19.20.0.255 | A | 7 | unit_charge_activation_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| Target | GSME |
|---|---|
| GPF Gas ESI Tap-Off | Yes |
| Message Code | 0x00A3 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1143 | SMETS 4.6.4.23 | StandingCharge: activateNextDateTime | UTCTime | Start Time UTC Time |
Price: 0x0700 | PublishTariffInformation : 0x04 | ZCL Default Response : 0x0B |
| 1442 | SMETS 4.6.4.23 | StandingCharge: amountNext | UINT32 | Standing Charge 0 - 0xFFFFFFFF |
|||
| 1096 | (GBZ) | StandingCharge / TariffTOUPriceMatrix: ScalerNext | BITMAP8 (NIBBLES) | Price Trailing Digit 0x50 - MS nibble = digits to right of decimal point |
|||
| 18 | SMETS 4.6.4.6 | CurrencyUnit: valueNext | UINT16 | Currency 826 (GBP) | 978 (EUR) |
|||
| 1551 | SMETS 4.6.4.23 | StandingCharge: numberOfBlockThresholdsInUse | UINT8 | Number of Block Thresholds in Use 0X00 - 0X03 |
|||
| 1144 | SMETS 4.6.4.32 | TariffBlockPriceMatrixTOU: activateNextDateTime | UTCTime | Start Time UTC Time
Set to 0xFFFFFFFE to cancel |
Price: 0x0700 | PublishPriceMatrix : 0x05 | ZCL Default Response : 0x0B |
| 1450 | SMETS 4.6.4.29 | TariffBlockPriceMatrixTOU: valueNext[1..4] | -- | Refer to ZigBee standard |
This Use Case is for setting the Supply Tamper State configuration on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS81 | Set Supply Tamper State on ESME | 0x0068 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.25 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1960 |
SMETS 4.6.4.26 SMETS 5.7.4.44 |
SupplyTamperState | value | Locked(TRUE), Unchanged(FALSE) |
Configuration data | BOOLEAN |
| Target | ESME |
|---|---|
| Message Code | 0x0068 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1960 |
SMETS 5.7.4.44 |
SupplyTamperState: value | 1 | 0-0:94.44.0.4 | A | 2 | value | boolean | - |
This Use Case is for creating a new tariff for second element on the Smart Meter where the initial condition of the tariff is unknown.
It is also used for updating existing tariffs for second element.
| Use Case | Title | Message Code |
|---|---|---|
| ECS01c | Set Tariff and Price on ESME secondary | 0x00B7 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 1.1 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1140 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1112 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | valueNext.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Configuration data | INTEGER |
| 1118 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix | valueNext[1..4].charge_per_unit | charge per unit |
Configuration data | INTEGER |
| 1225 |
SMETS 5.6.3.35 / 5.13.1.2 |
TariffSwitchingTable(SecondaryElement)(SpecialDays) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 788 |
SMETS 5.7.4.48 |
TariffSwitchingTable(SecondaryElement)(SpecialDays) | date[0..50].next | This is the date (or set of dates if wildcards are used) of the corresponding special day |
Configuration data | DATE WITH WILDCARDS |
| 1778 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement)(SpecialDays) | dayIdentifier[0..50].next | This is a number used in calendar entries that require execution on this special day |
Configuration data | INTEGER |
| 859 |
SMETS 5.6.3.35 / 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 857 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextDayIdentifiers[1..16] | The yet to be activated values to be set at those date times |
Configuration data | INTEGER |
| 853 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextDayIdentifiers[1..16].Time[1..48].startTime | The trigger points in the calendar, specified in terms of the dayIdentifier and time within that day |
Configuration data | TIME NO WILDCARDS |
| 851 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextDayIdentifiers[1..16].Time[1..48].tariff_rate_identifier | Identifies which rate to use at this startTime |
Configuration data | INTEGER |
| 833 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextSeasons[1..4].Name | This is a name given to the season e.g. ("winter") |
Configuration Data | OCTET-STRING |
| 829 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextSeasons[1..4].startDate | This is the date on which the season starts. [the season will end the day the next season starts] |
Configuration Data | DATE WITH WILDCARDS |
| 831 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextSeasons[1..4].WeekIdentifier | The name used to refer to the week structure used in this season |
Configuration Data | OCTET-STRING |
| 837 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextWeeks[1..4].days[1].Identifier | dayIdentifier for Monday |
Configuration Data | INTEGER |
| 839 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextWeeks[1..4].days[2].Identifier | dayIdentifier for Tuesday |
Configuration Data | INTEGER |
| 841 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextWeeks[1..4].days[3].Identifier | dayIdentifier for Wednesday |
Configuration Data | INTEGER |
| 843 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextWeeks[1..4].days[4].Identifier | dayIdentifier for Thursday |
Configuration Data | INTEGER |
| 845 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextWeeks[1..4].days[5].Identifier | dayIdentifier for Friday |
Configuration Data | INTEGER |
| 847 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextWeeks[1..4].days[6].Identifier | dayIdentifier for Saturday |
Configuration Data | INTEGER |
| 849 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextWeeks[1..4].days[7].Identifier | dayIdentifier for Sunday |
Configuration Data | INTEGER |
| 835 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement) | nextWeeks[1..4].weekIdentifier | The name given to a particular week structure |
Configuration Data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x00B7 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1106 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext.commodityScale | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.commodity_scale | integer | 3 | |
| 1112 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: valueNext.price_scale | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.price_scale | integer | - | |
| 1124 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext.classID | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.class_id | long-unsigned | 3 | |
| 1136 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext.LN | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.logical_name | octet-string(6) | ||0x0114010800FF | |
| 1100 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext.attribute_index | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.attribute_index | integer | 2 | |
| 1131 |
(DLMS) |
SecondaryTariffTOUPriceMatrix: valueNext[1..4].index | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..4].charge_table_element.index | octet-string(1) | - | |
| 1118 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: valueNext[1..4].charge_per_unit | 113 | 0-0:19.20.5.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..4].charge_table_element.charge_per_unit | long | - | |
| 833 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextSeasons[1..4].Name | 20 | 0-0:13.0.1.255 | A | 7 | season_profile_passive:season_profile_passive[1..4].season.season_profile_name | octet-string(8) | - | OCTET-STRING(8) |
| 829 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextSeasons[1..4].startDate | 20 | 0-0:13.0.1.255 | A | 7 | season_profile_passive:season_profile_passive[1..4].season.season_start | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 831 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextSeasons[1..4].WeekIdentifier | 20 | 0-0:13.0.1.255 | A | 7 | season_profile_passive:season_profile_passive[1..4].season.week_name | octet-string(4) | - | OCTET-STRING(4) |
| 835 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextWeeks[1..4].weekIdentifier | 20 | 0-0:13.0.1.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.week_profile_name | octet-string(4) | - | OCTET-STRING(4) |
| 837 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextWeeks[1..4].days[1].Identifier | 20 | 0-0:13.0.1.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.monday | unsigned | - | |
| 839 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextWeeks[1..4].days[2].Identifier | 20 | 0-0:13.0.1.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.tuesday | unsigned | - | |
| 841 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextWeeks[1..4].days[3].Identifier | 20 | 0-0:13.0.1.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.wednesday | unsigned | - | |
| 843 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextWeeks[1..4].days[4].Identifier | 20 | 0-0:13.0.1.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.thursday | unsigned | - | |
| 845 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextWeeks[1..4].days[5].Identifier | 20 | 0-0:13.0.1.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.friday | unsigned | - | |
| 847 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextWeeks[1..4].days[6].Identifier | 20 | 0-0:13.0.1.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.saturday | unsigned | - | |
| 849 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextWeeks[1..4].days[7].Identifier | 20 | 0-0:13.0.1.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.sunday | unsigned | - | |
| 857 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextDayIdentifiers[1..16] | 20 | 0-0:13.0.1.255 | A | 9 | day_profile_table_passive:day_profile_table_passive[1..16].day_profile.day_id | unsigned | - | |
| 853 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextDayIdentifiers[1..16].Time[1..48].startTime | 20 | 0-0:13.0.1.255 | A | 9 | day_profile_table_passive:day_profile_table_passive[1..16].day_profile.day_schedule[1..48].day_profile_action.start_time | octet-string(4) | - | Formatted as time (octet-string(4))according to 4.1.6.1 of the Blue Book |
| 855 |
(DLMS) |
TariffSwitchingTable(SecondaryElement): nextDayIdentifiers[1..16].Time[1..48].actionsObject | 20 | 0-0:13.0.1.255 | A | 9 | day_profile_table_passive:day_profile_table_passive[1..16].day_profile.day_schedule[1..48].day_profile_action.script_logical_name | octet-string(6) | '0-0:10.0.100.255||0x00000A0064FF | The OBIS code of the script table containing all TOU tariff scripts |
| 851 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): nextDayIdentifiers[1..16].Time[1..48].tariff_rate_identifier | 20 | 0-0:13.0.1.255 | A | 9 | day_profile_table_passive:day_profile_table_passive[1..16].day_profile.day_schedule[1..48].day_profile_action.script_selector | long-unsigned | - | See section 7.3.7 of the GBCS |
| 1815 |
(DLMS) |
TariffSwitchingTable(SecondaryElement)(SpecialDays): index[0..50].next | 11 | 0-1:11.0.1.255 | A | 2 | entries:entries[0..50].spec_day_entry.index | long-unsigned | - | Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 788 |
SMETS 5.7.4.48 |
TariffSwitchingTable(SecondaryElement)(SpecialDays): date[0..50].next | 11 | 0-1:11.0.1.255 | A | 2 | entries:entries[0..50].spec_day_entry.specialday_date | octet-string(5) | - | Formatted as date (octet-string(5)) according to 4.1.6.1 of the Blue Book. Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 1778 |
SMETS 5.13.1.2 |
TariffSwitchingTable(SecondaryElement)(SpecialDays): dayIdentifier[0..50].next | 11 | 0-1:11.0.1.255 | A | 2 | entries:entries[0..50].spec_day_entry.day_id | unsigned | - | Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 859 |
SMETS 5.6.3.35 / 5.13.1.2 |
TariffSwitchingTable(SecondaryElement): activateNextDateTime | 20 | 0-0:13.0.1.255 | A | 10 | activate_ passive_ calendar_time | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1140 |
SMETS 5.13.1.1 |
SecondaryTariffTOUPriceMatrix: activateNextDateTime | 113 | 0-0:19.20.5.255 | A | 7 | unit_charge_activation_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1225 |
SMETS 5.6.3.35 / 5.13.1.2 |
TariffSwitchingTable(SecondaryElement)(SpecialDays): activateNextDateTime | 9000 | 0-0:94.44.128.30 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
This Use Case is for creating a new tariff on the Smart Meter where the initial condition of the tariff is unknown.
It is also used for updating existing tariffs.
| Use Case | Title | Message Code |
|---|---|---|
| ECS01a | Set Tariff and Price on ESME | 0x0019 |
| GCS01a | Set Tariff and Price on GSME | 0x006B |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 1.1 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1779 |
SMETS 5.7.4.9 |
CurrencyUnit | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME |
| 18 |
SMETS 4.6.4.6 SMETS 5.7.4.9 |
CurrencyUnit | valueNext | GB Pounds(TRUE), ECB Euro (FALSE) |
Configuration data | BOOLEAN |
| 1143 |
SMETS 4.6.4.23 SMETS 5.7.4.42 |
StandingCharge | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1442 |
SMETS 4.6.4.23 |
StandingCharge | amountNext | The yet to be activated value |
Configuration data | INTEGER |
| 1119 |
SMETS 5.7.4.42 |
StandingCharge | valueNext.charge_per_unit | charge per unit |
Configuration data | INTEGER |
| 1113 |
SMETS 5.7.4.42 |
StandingCharge | valueNext.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Configuration data | INTEGER |
| 1144 |
SMETS 4.6.4.32 SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1120 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU | valueNext.charge_per_unit[1..80] | charge per unit |
Configuration data | INTEGER |
| 1114 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU | valueNext.price_scale | power of 10 to apply when interpreting the charge_per_unit value |
Configuration data | INTEGER |
| 1450 |
SMETS 4.6.4.29 |
TariffBlockPriceMatrixTOU | valueNext[1..4] | The yet to be activated values |
Configuration data | INTEGER |
| 1224 |
SMETS 4.5.3.22 SMETS 5.6.3.35 / 5.7.4.49 |
TariffSwitchingTable(SpecialDays) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 687 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable(SpecialDays) | date[0..n].next | This is the date (or set of dates if wildcards are used) of the corresponding special day. n is 20 for GSME and 50 for ESME |
Configuration Data | DATE WITH WILDCARDS |
| 689 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable(SpecialDays) | dayIdentifier[0..n].next | This is a number used in calendar entries that require execution on this special day. n is 20 for GSME and 50 for ESME |
Configuration Data | iNTEGER |
| 858 |
SMETS 4.5.3.22 SMETS 5.6.3.35 / 5.7.4.49 |
TariffSwitchingTable | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 856 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextDayIdentifiers[1..m] | The trigger points in the calendar, specified in terms of the dayIdentifier and time within that day m = 4 for GSME, 16 for ESME |
Configuration data | INTEGER |
| 852 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextDayIdentifiers[1..m].Time[1..n].startTime | The trigger points in the calendar, specified in terms of the dayIdentifier and time within that day. m is 4 for GSME and 16 for ESME. n is 1 for GSME and 48 for ESME |
Configuration data | TIME NO WILDCARDS |
| 850 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextDayIdentifiers[1..m].Time[1..n].tariff_rate_identifier | Identifies which rate to use at this startTime (m= 4 and n = 1 for GSME, m = 16 and n = 48 for ESME). |
Configuration data | INTEGER |
| 832 |
SMETS 5.7.4.48 |
TariffSwitchingTable | nextSeasons[1..n].Name | This is a name given to the season e.g. ("winter"). GSME shall support 3 seasons, ESME shall support 4 seasons |
Configuration Data | OCTET-STRING |
| 828 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextSeasons[1..n].startDate | This is the date on which the season starts. [the season will end the day the next season starts] |
Configuration Data | DATE WITH WILDCARDS |
| 830 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextSeasons[1..n].WeekIdentifier | The name used to refer to the week structure used in this season |
Configuration Data | OCTET-STRING |
| 836 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextWeeks[1..n].days[1].Identifier | dayIdentifier for Monday |
Configuration Data | INTEGER |
| 838 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextWeeks[1..n].days[2].Identifier | dayIdentifier for Tuesday |
Configuration Data | INTEGER |
| 840 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextWeeks[1..n].days[3].Identifier | dayIdentifier for Wednesday |
Configuration Data | INTEGER |
| 842 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextWeeks[1..n].days[4].Identifier | dayIdentifier for Thursday |
Configuration Data | INTEGER |
| 844 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextWeeks[1..n].days[5].Identifier | dayIdentifier for Friday |
Configuration Data | INTEGER |
| 846 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextWeeks[1..n].days[6].Identifier | dayIdentifier for Saturday |
Configuration Data | INTEGER |
| 848 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextWeeks[1..n].days[7].Identifier | dayIdentifier for Sunday |
Configuration Data | INTEGER |
| 834 |
SMETS 4.6.4.30 SMETS 5.7.4.48 |
TariffSwitchingTable | nextWeeks[1..n].weekIdentifier | The name given to a particular week structure. GSME supports 2 week structures, ESME supports 4 week structures. |
Configuration Data | OCTET-STRING |
| 1364 |
SMETS 4.6.4.31 |
TariffThresholdMatrix[1..3] | thresholdNext | The yet to be activated values |
Configuration data | INTEGER |
| 1430 |
SMETS 4.6.4.31 SMETS 5.7.4.49 |
TariffThresholdMatrix | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 880 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[1] | thresholdNext[1..3] | The yet to be activated value |
Configuration data | INTEGER[1..3] |
| 873 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[2] | thresholdNext[1..3] | The yet to be activated value |
Configuration data | INTEGER[1..3] |
| 874 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[3] | thresholdNext[1..3] | The yet to be activated value |
Configuration data | INTEGER[1..3] |
| 875 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[4] | thresholdNext[1..3] | The yet to be activated value |
Configuration data | INTEGER[1..3] |
| 876 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[5] | thresholdNext[1..3] | The yet to be activated value |
Configuration data | INTEGER[1..3] |
| 877 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[6] | thresholdNext[1..3] | The yet to be activated value |
Configuration data | INTEGER[1..3] |
| 878 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[7] | thresholdNext[1..3] | The yet to be activated value |
Configuration data | INTEGER[1..3] |
| 879 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[8] | thresholdNext[1..3] | The yet to be activated value |
Configuration data | INTEGER[1..3] |
| Target | ESME |
|---|---|
| Message Code | 0x0019 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 832 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextSeasons[1..n].Name | 20 | 0-0:13.0.0.255 | A | 7 | season_profile_passive:season_profile_passive[1..4].season.season_profile_name | octet-string(8) | - | OCTET-STRING(8) |
| 828 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextSeasons[1..n].startDate | 20 | 0-0:13.0.0.255 | A | 7 | season_profile_passive:season_profile_passive[1..4].season.season_start | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 830 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextSeasons[1..n].WeekIdentifier | 20 | 0-0:13.0.0.255 | A | 7 | season_profile_passive:season_profile_passive[1..4].season.week_name | octet-string(4) | - | OCTET-STRING(4) |
| 834 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextWeeks[1..n].weekIdentifier | 20 | 0-0:13.0.0.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.week_profile_name | octet-string(4) | - | OCTET-STRING(4) |
| 836 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextWeeks[1..n].days[1].Identifier | 20 | 0-0:13.0.0.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.monday | unsigned | - | |
| 838 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextWeeks[1..n].days[2].Identifier | 20 | 0-0:13.0.0.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.tuesday | unsigned | - | |
| 840 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextWeeks[1..n].days[3].Identifier | 20 | 0-0:13.0.0.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.wednesday | unsigned | - | |
| 842 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextWeeks[1..n].days[4].Identifier | 20 | 0-0:13.0.0.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.thursday | unsigned | - | |
| 844 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextWeeks[1..n].days[5].Identifier | 20 | 0-0:13.0.0.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.friday | unsigned | - | |
| 846 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextWeeks[1..n].days[6].Identifier | 20 | 0-0:13.0.0.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.saturday | unsigned | - | |
| 848 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextWeeks[1..n].days[7].Identifier | 20 | 0-0:13.0.0.255 | A | 8 | week_profile_table_passive:week_profile_table_passive[1..4].week_profile.sunday | unsigned | - | |
| 856 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextDayIdentifiers[1..m] | 20 | 0-0:13.0.0.255 | A | 9 | day_profile_table_passive:day_profile_table_passive[1..16].day_profile.day_id | unsigned | - | |
| 852 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextDayIdentifiers[1..m].Time[1..n].startTime | 20 | 0-0:13.0.0.255 | A | 9 | day_profile_table_passive:day_profile_table_passive[1..16].day_profile.day_schedule[1..48].day_profile_action.start_time | octet-string(4) | - | Formatted as time (octet-string(4))according to 4.1.6.1 of the Blue Book |
| 854 |
(DLMS) |
TariffSwitchingTable: nextDayIdentifiers[1..16].Time[1..48].actionsObject | 20 | 0-0:13.0.0.255 | A | 9 | day_profile_table_passive:day_profile_table_passive[1..16].day_profile.day_schedule[1..48].day_profile_action.script_logical_name | octet-string(6) | '0-0:10.0.100.255||0x00000A0064FF | The OBIS code of the script table containing all TOU tariff scripts |
| 850 |
SMETS 5.7.4.48 |
TariffSwitchingTable: nextDayIdentifiers[1..m].Time[1..n].tariff_rate_identifier | 20 | 0-0:13.0.0.255 | A | 9 | day_profile_table_passive:day_profile_table_passive[1..16].day_profile.day_schedule[1..48].day_profile_action.script_selector | long-unsigned | - | See section 7.3.7 of the GBCS |
| 791 |
(DLMS) |
TariffSwitchingTable(SpecialDays): index[0..50].next | 11 | 0-1:11.0.0.255 | A | 2 | entries:entries[0..50].spec_day_entry.index | long-unsigned | - | Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 687 |
SMETS 5.7.4.48 |
TariffSwitchingTable(SpecialDays): date[0..n].next | 11 | 0-1:11.0.0.255 | A | 2 | entries:entries[0..50].spec_day_entry.specialday_date | octet-string(5) | - | Formatted as date (octet-string(5)) according to 4.1.6.1 of the Blue Book. Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 689 |
SMETS 5.7.4.48 |
TariffSwitchingTable(SpecialDays): dayIdentifier[0..n].next | 11 | 0-1:11.0.0.255 | A | 2 | entries:entries[0..50].spec_day_entry.day_id | unsigned | - | Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 880 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[1]: thresholdNext[1..3] | 21 | 0-0:16.1.11.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 873 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[2]: thresholdNext[1..3] | 21 | 0-0:16.1.12.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 874 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[3]: thresholdNext[1..3] | 21 | 0-0:16.1.13.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 875 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[4]: thresholdNext[1..3] | 21 | 0-0:16.1.14.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 876 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[5]: thresholdNext[1..3] | 21 | 0-0:16.1.15.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 877 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[6]: thresholdNext[1..3] | 21 | 0-0:16.1.16.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 878 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[7]: thresholdNext[1..3] | 21 | 0-0:16.1.17.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 879 |
SMETS 5.7.4.49 |
TariffThresholdMatrixBlocks[1to3]TOU[8]: thresholdNext[1..3] | 21 | 0-0:16.1.18.255 | A | 2 | thresholds:thresholds[1..3].threshold | double-long-unsigned | - | |
| 18 |
SMETS 5.7.4.9 |
CurrencyUnit: valueNext | 9000 | 0-0:94.44.2.0 | A | 4 | value_passive | boolean | - | GB Pounds(TRUE), ECB Euro (FALSE) |
| 1107 |
(DLMS) |
StandingCharge: valueNext.commodityScale | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.commodity_scale | integer | 0 | |
| 1113 |
SMETS 5.7.4.42 |
StandingCharge: valueNext.price_scale | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.price_scale | integer | - | |
| 1125 |
(DLMS) |
StandingCharge: valueNext.classID | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.class_id | long-unsigned | 0 | |
| 1137 |
(DLMS) |
StandingCharge: valueNext.LN | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.logical_name | octet-string(6) | ||0x000000000000 | |
| 1101 |
(DLMS) |
StandingCharge: valueNext.attribute_index | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.attribute_index | integer | 0 | |
| 1130 |
(DLMS) |
StandingCharge: valueNext.index | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..1].charge_table_element.index | octet-string(0) | ||
| 1119 |
SMETS 5.7.4.42 |
StandingCharge: valueNext.charge_per_unit | 113 | 0-0:19.20.4.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..1].charge_table_element.charge_per_unit | long | - | |
| 1108 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.commodityScale | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.commodity_scale | integer | 3 | |
| 1114 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU: valueNext.price_scale | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_per_unit_scaling.price_scale | integer | - | |
| 1126 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.classID | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.class_id | long-unsigned | 3 | |
| 1138 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.LN | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.logical_name | octet-string(6) | ||0x0100010800FF | |
| 1102 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.attribute_index | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.commodity_reference.attribute_index | integer | 2 | |
| 1132 |
(DLMS) |
TariffBlockPriceMatrixTOU: valueNext.index[1..80] | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..80].charge_table_element.index | octet-string(1) | - | |
| 1120 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU: valueNext.charge_per_unit[1..80] | 113 | 0-0:19.20.0.255 | A | 6 | unit_charge_passive:unit_charge_passive.charge_table[1..80].charge_table_element.charge_per_unit | long | - | |
| 858 |
SMETS 5.6.3.35 / 5.7.4.49 |
TariffSwitchingTable: activateNextDateTime | 20 | 0-0:13.0.0.255 | A | 10 | activate_ passive_ calendar_time | octet-string(12) | - | Formatted as date-time (octet-string(12))according to 4.1.6.1 of the Blue Book |
| 1224 |
SMETS 5.6.3.35 / 5.7.4.49 |
TariffSwitchingTable(SpecialDays): activateNextDateTime | 9000 | 0-0:94.44.128.29 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1779 |
SMETS 5.7.4.9 |
CurrencyUnit: activateNextDateTime | 9000 | 0-0:94.44.2.0 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1143 |
SMETS 5.7.4.42 |
StandingCharge: activateNextDateTime | 113 | 0-0:19.20.4.255 | A | 7 | unit_charge_activation_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1144 |
SMETS 5.7.4.47 / 5.7.4.50 |
TariffBlockPriceMatrixTOU: activateNextDateTime | 113 | 0-0:19.20.0.255 | A | 7 | unit_charge_activation_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1430 |
SMETS 5.7.4.49 |
TariffThresholdMatrix: activateNextDateTime | 9000 | 0-0:63.1.1.255 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book. Attribute 2 of this object needs to be fixed and set to {0.0.10.1.14.255,1} |
| Target | GSME |
|---|---|
| GPF Gas ESI Tap-Off | Yes |
| Message Code | 0x006B |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 858 | SMETS 4.5.3.22 | TariffSwitchingTable: activateNextDateTime | UTCTime | Start Time UTC Time
Set to 0xFFFFFFFE to cancel |
Calendar: 0x0707 | PublishCalendar : 0x00 | ZCL Default Response : 0x0B |
| 1352 | (GBZ) | TariffSwitchingTable: calendarType | ENUM8 | Calendar Type 0x00 = Delivered Calendar |
|||
| 856 | SMETS 4.6.4.30 | TariffSwitchingTable: nextDayIdentifiers[1..m] | UINT8 | Day ID 1 - 0xFF |
Calendar: 0x0707 | PublishDayProfile : 0x01 | ZCL Default Response : 0x0B |
| 850 | SMETS 4.6.4.30 | TariffSwitchingTable: nextDayIdentifiers[1..m].Time[1..n].tariff_rate_identifier | STRUCTURE[n] | Day Schedule Entries ENUM8:Price Tier x n |
|||
| 852 | SMETS 4.6.4.30 | TariffSwitchingTable: nextDayIdentifiers[1..m].Time[1..n].startTime | STRUCTURE[n] | Day Schedule Entries For each Day Profile configured with this command, this is an array of Day Schedule Entries containing a single entry. The entry is interpreted as follows:
Start Time (minutes from midnight = 0x0000, UINT16); Price Tier (ENUM8) |
|||
| 834 | SMETS 4.6.4.30 | TariffSwitchingTable: nextWeeks[1..n].weekIdentifier | UINT8 | Week ID 1 - 0xFF |
Calendar: 0x0707 | PublishWeekProfile : 0x02 | ZCL Default Response : 0x0B |
| 836 | SMETS 4.6.4.30 | TariffSwitchingTable: nextWeeks[1..n].days[1].Identifier | UINT8 | Day ID Ref Monday 1 - 0xFF |
|||
| 838 | SMETS 4.6.4.30 | TariffSwitchingTable: nextWeeks[1..n].days[2].Identifier | UINT8 | Day ID Ref Tuesday 1 - 0xFF |
|||
| 840 | SMETS 4.6.4.30 | TariffSwitchingTable: nextWeeks[1..n].days[3].Identifier | UINT8 | Day ID Ref Wednesday 1 - 0xFF |
|||
| 842 | SMETS 4.6.4.30 | TariffSwitchingTable: nextWeeks[1..n].days[4].Identifier | UINT8 | Day ID Ref Thursday 1 - 0xFF |
|||
| 844 | SMETS 4.6.4.30 | TariffSwitchingTable: nextWeeks[1..n].days[5].Identifier | UINT8 | Day ID Ref Friday 1 - 0xFF |
|||
| 846 | SMETS 4.6.4.30 | TariffSwitchingTable: nextWeeks[1..n].days[6].Identifier | UINT8 | Day ID Ref Saturday 1 - 0xFF |
|||
| 848 | SMETS 4.6.4.30 | TariffSwitchingTable: nextWeeks[1..n].days[7].Identifier | UINT8 | Day ID Ref Sunday 1 - 0xFF |
|||
| 828 | SMETS 4.6.4.30 | TariffSwitchingTable: nextSeasons[1..n].startDate | STRUCTURE[n] | Season Entry Date:Season Start Date x n |
Calendar: 0x0707 | PublishSeasons : 0x03 | ZCL Default Response : 0x0B |
| 830 | SMETS 4.6.4.30 | TariffSwitchingTable: nextSeasons[1..n].WeekIdentifier | STRUCTURE[n] | Season Entry UINT8:Week ID Ref x n |
|||
| 1224 | SMETS 4.5.3.22 | TariffSwitchingTable(SpecialDays): activateNextDateTime | UTCTime | Start Time UTC Time |
Calendar: 0x0707 | PublishSpecialDays : 0x04 | ZCL Default Response : 0x0B |
| 1354 | (GBZ) | TariffSwitchingTable(SpecialDays): calendarTypeSpecialDays | ENUM8 | Calendar Type 0 = Delivered Calendar |
|||
| 687 | SMETS 4.6.4.30 | TariffSwitchingTable(SpecialDays): date[0..n].next | STRUCTURE[n] | SpecialDayEntry Date: Special Day Date x n |
|||
| 689 | SMETS 4.6.4.30 | TariffSwitchingTable(SpecialDays): dayIdentifier[0..n].next | STRUCTURE[n] | SpecialDayEntry UINT8:Day ID Ref x n |
|||
| 1143 | SMETS 4.6.4.23 | StandingCharge: activateNextDateTime | UTCTime | Start Time UTC Time |
Price: 0x0700 | PublishTariffInformation : 0x04 | ZCL Default Response : 0x0B |
| 1442 | SMETS 4.6.4.23 | StandingCharge: amountNext | UINT32 | Standing Charge 0 - 0xFFFFFFFF |
|||
| 1096 | (GBZ) | StandingCharge / TariffTOUPriceMatrix: ScalerNext | BITMAP8 (NIBBLES) | Price Trailing Digit 0x50 - MS nibble = digits to right of decimal point |
|||
| 1361 | (GBZ) | TariffThresholdMatrix[1..3]: ScalerNextDivisor | UINT24 | Block Threshold Divisor 0x0003E8 = 1000 |
|||
| 1362 | (GBZ) | TariffThresholdMatrix[1..3]: ScalerNextMultiplier | UINT24 | Block Threshold Multiplier 0x000001 |
|||
| 1405 | (GBZ) | TariffThresholdMatrix[1..3]: unit | ENUM8 | Unit of Measure 0x00 = kWh |
|||
| 18 | SMETS 4.6.4.6 | CurrencyUnit: valueNext | UINT16 | Currency 826 (GBP) | 978 (EUR) |
|||
| 1430 | SMETS 4.6.4.31 | TariffThresholdMatrix: activateNextDateTime | UTCTime | Start Time UTC Time
Set to 0xFFFFFFFE to cancel |
Price: 0x0700 | PublishBlockThresholds : 0x06 | ZCL Default Response : 0x0B |
| 1364 | SMETS 4.6.4.31 | TariffThresholdMatrix[1..3]: thresholdNext | STRUCTURE | Block Threshold Sub-payload UINT48:Block Threshold[1..3] |
|||
| 1144 | SMETS 4.6.4.32 | TariffBlockPriceMatrixTOU: activateNextDateTime | UTCTime | Start Time UTC Time
Set to 0xFFFFFFFE to cancel |
Price: 0x0700 | PublishPriceMatrix : 0x05 | ZCL Default Response : 0x0B |
| 1450 | SMETS 4.6.4.29 | TariffBlockPriceMatrixTOU: valueNext[1..4] | -- | Refer to ZigBee standard |
This Use Case is for setting the uncontrolled gas flow threshold on a GSME.
| Use Case | Title | Message Code |
|---|---|---|
| GCS24a | Set Uncontrolled Gas Flow Rate at greater resolution and Supply Tamper State on the GSME | 0x00FC |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.7 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1524 |
SMETS 4.6.4.25 |
SupplyDepletionState | methodInput: state | Set to Locked or Unchanged |
Method Input | ENUMERATION |
| 1401 |
SMETS 4.6.4.26 |
SupplyTamperState | methodInput: state | Set to Locked or Unchanged |
Method Input | ENUMERATION |
| 1868 |
SMETS 4.6.4.33 |
UncontrolledGasFlowRate | methodInput: measurementPeriod | Period over which the flow is measured, in seconds |
Method Input | INTEGER |
| 1867 |
SMETS 4.6.4.33 |
UncontrolledGasFlowRate | methodInput: stabilisationPeriod | Time given for flow to stabilise, in tenths of a second |
Method Input | INTEGER |
| 1402 |
SMETS 4.6.4.33 |
UncontrolledGasFlowRate | methodInput: threshold | The value to set |
Method Input | INTEGER |
| Target | GSME |
|---|---|
| Message Code | 0x00FC |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1402 | SMETS 4.6.4.33 | UncontrolledGasFlowRate: methodInput: threshold | UINT16 | Uncontrolled Flow Threshold 0 - 0xFFFF |
Metering: 0x0702 | SetUncontrolledFlowThreshold : 0x0E | ZCL Default Response : 0x0B |
| 1397 | (GBZ) | UncontrolledGasFlowRate: methodInput: adjustmentScaleMultiplier | UINT16 | Multiplier 0x0001 |
|||
| 1396 | (GBZ) | UncontrolledGasFlowRate: methodInput: adjustmentScaleDivisor | UINT16 | Divisor 0x2710 |
|||
| 1867 | SMETS 4.6.4.33 | UncontrolledGasFlowRate: methodInput: stabilisationPeriod | UINT8 | Stabilisation Period 0 - 0xFF |
|||
| 1868 | SMETS 4.6.4.33 | UncontrolledGasFlowRate: methodInput: measurementPeriod | UINT16 | Measurement Period 0 - 0xFFFF |
|||
| 1524 | SMETS 4.6.4.25 | SupplyDepletionState: methodInput: state | ENUM8 | SupplyDepletion State 0x03 means supply state is UNCHANGED; 0x00 means supply state is LOCKED |
Metering: 0x0702 | SetSupplyStatus : 0x0D | ZCL Default Response : 0x0B |
| 1401 | SMETS 4.6.4.26 | SupplyTamperState: methodInput: state | ENUM8 | SupplyTamperState 0x03 means supply state is UNCHANGED; 0x00 means supply state is LOCKED |
This Use Case is for configuring the voltage thresholds and resetting the counters.
| Use Case | Title | Message Code |
|---|---|---|
| ECS29b | Set Voltage Configurations on ESME - 3ph | 0x00AE |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 494 |
SMETS 5.6.3.22 |
(Phase[1])AverageRMSOverVoltageCounter | reset | set AverageRMSOverVoltageCounter.value to zero |
Method | Method |
| 30 |
SMETS 5.7.4.4 |
(Phase[1])AverageRMSOverVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 495 |
SMETS 5.6.3.23 |
(Phase[1])AverageRMSUnderVoltageCounter | reset | set AverageRMSUnderVoltageCounter.value to zero |
Method | Method |
| 31 |
SMETS 5.7.4.5 |
(Phase[1])AverageRMSUnderVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 663 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | measurementPeriod | The time in seconds between each capture in this object. This shall be the same as the period over which the average RMS is averaged |
Configuration data | INTEGER |
| 496 |
SMETS 5.18.1.1 |
(Phase[2])AverageRMSOverVoltageCounter | reset | set AverageRMSOverVoltageCounter.value to zero |
Method | Method |
| 32 |
SMETS 5.19.1.1 |
(Phase[2])AverageRMSOverVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 497 |
SMETS 5.18.1.2 |
(Phase[2])AverageRMSUnderVoltageCounter | reset | set AverageRMSUnderVoltageCounter.value to zero |
Method | Method |
| 33 |
SMETS 5.19.1.2 |
(Phase[2])AverageRMSUnderVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 664 |
SMETS 5.19.1.3 |
(Phase[2])AverageRMSVoltageProfileDataLog | measurementPeriod | The time in seconds between each capture in this object. This shall be the same as the period over which the average RMS is averaged |
Configuration data | INTEGER |
| 498 |
SMETS 5.18.1.1 |
(Phase[3])AverageRMSOverVoltageCounter | reset | set AverageRMSOverVoltageCounter.value to zero |
Method | Method |
| 34 |
SMETS 5.19.1.1 |
(Phase[3])AverageRMSOverVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 499 |
SMETS 5.18.1.2 |
(Phase[3])AverageRMSUnderVoltageCounter | reset | set AverageRMSUnderVoltageCounter.value to zero |
Method | Method |
| 35 |
SMETS 5.19.1.2 |
(Phase[3])AverageRMSUnderVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 665 |
SMETS 5.19.1.3 |
(Phase[3])AverageRMSVoltageProfileDataLog | measurementPeriod | The time in seconds between each capture in this object. This shall be the same as the period over which the average RMS is averaged |
Configuration data | INTEGER |
| 969 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod | period | The period for which the RMS Voltage must stay above the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 960 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 970 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod | period | The period for which the RMS Voltage must stay below the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 961 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 971 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod | period | The period for which the RMS Voltage must stay below the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 962 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 972 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod | period | The period for which the RMS Voltage must stay above the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 963 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00AE |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 663 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: measurementPeriod | 7 | 1-0:32.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 664 |
SMETS 5.19.1.3 |
(Phase[2])AverageRMSVoltageProfileDataLog: measurementPeriod | 7 | 1-0:52.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 665 |
SMETS 5.19.1.3 |
(Phase[3])AverageRMSVoltageProfileDataLog: measurementPeriod | 7 | 1-0:72.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 960 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold: threshold | 71 | 0-0:17.0.1.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 969 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod: period | 71 | 0-0:17.0.1.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 961 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold: threshold | 71 | 0-0:17.0.2.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 970 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod: period | 71 | 0-0:17.0.2.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 962 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold: threshold | 71 | 0-0:17.0.3.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 971 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod: period | 71 | 0-0:17.0.3.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 963 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold: threshold | 71 | 0-0:17.0.4.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 972 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod: period | 71 | 0-0:17.0.4.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 30 |
SMETS 5.7.4.4 |
(Phase[1])AverageRMSOverVoltageThreshold: value | 1 | 1-0:32.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 31 |
SMETS 5.7.4.5 |
(Phase[1])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:32.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 33 |
SMETS 5.19.1.2 |
(Phase[2])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:52.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 32 |
SMETS 5.19.1.1 |
(Phase[2])AverageRMSOverVoltageThreshold: value | 1 | 1-0:52.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 35 |
SMETS 5.19.1.2 |
(Phase[3])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:72.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 34 |
SMETS 5.19.1.1 |
(Phase[3])AverageRMSOverVoltageThreshold: value | 1 | 1-0:72.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 495 |
SMETS 5.6.3.23 |
(Phase[1])AverageRMSUnderVoltageCounter: reset | 3 | 1-0:32.32.0.4 | M | 1 | reset | integer | 0 | |
| 494 |
SMETS 5.6.3.22 |
(Phase[1])AverageRMSOverVoltageCounter: reset | 3 | 1-0:32.36.0.4 | M | 1 | reset | integer | 0 | |
| 497 |
SMETS 5.18.1.2 |
(Phase[2])AverageRMSUnderVoltageCounter: reset | 3 | 1-0:52.32.0.4 | M | 1 | reset | integer | 0 | |
| 496 |
SMETS 5.18.1.1 |
(Phase[2])AverageRMSOverVoltageCounter: reset | 3 | 1-0:52.36.0.4 | M | 1 | reset | integer | 0 | |
| 499 |
SMETS 5.18.1.2 |
(Phase[3])AverageRMSUnderVoltageCounter: reset | 3 | 1-0:72.32.0.4 | M | 1 | reset | integer | 0 | |
| 498 |
SMETS 5.18.1.1 |
(Phase[3])AverageRMSOverVoltageCounter: reset | 3 | 1-0:72.36.0.4 | M | 1 | reset | integer | 0 |
This Use Case is for configuring the voltage thresholds and resetting the counters.
| Use Case | Title | Message Code |
|---|---|---|
| ECS29a | Set Voltage Configurations on ESME | 0x0045 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 494 |
SMETS 5.6.3.22 |
(Phase[1])AverageRMSOverVoltageCounter | reset | set AverageRMSOverVoltageCounter.value to zero |
Method | Method |
| 30 |
SMETS 5.7.4.4 |
(Phase[1])AverageRMSOverVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 495 |
SMETS 5.6.3.23 |
(Phase[1])AverageRMSUnderVoltageCounter | reset | set AverageRMSUnderVoltageCounter.value to zero |
Method | Method |
| 31 |
SMETS 5.7.4.5 |
(Phase[1])AverageRMSUnderVoltageThreshold | value | Value check against at end of each AverageRMSVoltageMeasurementPeriod (not continuously monitored threshold) |
Configuration data | INTEGER |
| 663 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageProfileDataLog | measurementPeriod | The time in seconds between each capture in this object. This shall be the same as the period over which the average RMS is averaged |
Configuration data | INTEGER |
| 969 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod | period | The period for which the RMS Voltage must stay above the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 960 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 970 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod | period | The period for which the RMS Voltage must stay below the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 961 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 971 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod | period | The period for which the RMS Voltage must stay below the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 962 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 972 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod | period | The period for which the RMS Voltage must stay above the threshold, if actionsAtEndOfPeriod are to be triggered. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 963 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold | threshold | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x0045 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 663 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageProfileDataLog: measurementPeriod | 7 | 1-0:32.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 960 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold: threshold | 71 | 0-0:17.0.1.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 969 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod: period | 71 | 0-0:17.0.1.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 961 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold: threshold | 71 | 0-0:17.0.2.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 970 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod: period | 71 | 0-0:17.0.2.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 962 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold: threshold | 71 | 0-0:17.0.3.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 971 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod: period | 71 | 0-0:17.0.3.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 963 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold: threshold | 71 | 0-0:17.0.4.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 972 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod: period | 71 | 0-0:17.0.4.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 30 |
SMETS 5.7.4.4 |
(Phase[1])AverageRMSOverVoltageThreshold: value | 1 | 1-0:32.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 31 |
SMETS 5.7.4.5 |
(Phase[1])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:32.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 495 |
SMETS 5.6.3.23 |
(Phase[1])AverageRMSUnderVoltageCounter: reset | 3 | 1-0:32.32.0.4 | M | 1 | reset | integer | 0 | |
| 494 |
SMETS 5.6.3.22 |
(Phase[1])AverageRMSOverVoltageCounter: reset | 3 | 1-0:32.36.0.4 | M | 1 | reset | integer | 0 |
This Use Case is for configuring the voltage thresholds and periods.
| Use Case | Title | Message Code |
|---|---|---|
| ECS29c | Set Voltage Configurations on ESME without counter reset | 0x00D1 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1893 |
SMETS 5.7.4.4 / 5.19.1.1 |
(Phase[1])AverageRMSOverVoltageThreshold | value | Threshold tested against at end of each AverageRMSVoltageMeasurementPeriod. Note, this is not a continuously monitored threshold. |
Configuration data | INTEGER |
| 1894 |
SMETS 5.7.4.5 / 5.19.1.2 |
(Phase[1])AverageRMSUnderVoltageThreshold | value | Threshold tested against at end of each AverageRMSVoltageMeasurementPeriod. Note, this is not a continuously monitored threshold. |
Configuration data | INTEGER |
| 1882 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageMeasurementPeriod | value | The length of time over which the RMS voltage is averaged. |
Configuration data | INTEGER |
| 1885 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod | value | The duration used to measure an extreme over voltage condition. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 1889 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold | value | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 1886 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod | value | The duration used to measure an extreme under voltage condition. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 1890 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold | value | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 1887 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod | value | The duration used to measure a voltage sag condition. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 1891 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold | value | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 1888 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod | value | The duration used to measure a voltage swell condition. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 1892 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold | value | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00D1 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1894 |
SMETS 5.7.4.5 / 5.19.1.2 |
(Phase[1])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:32.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 1893 |
SMETS 5.7.4.4 / 5.19.1.1 |
(Phase[1])AverageRMSOverVoltageThreshold: value | 1 | 1-0:32.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 1882 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageMeasurementPeriod: value | 7 | 1-0:32.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 1889 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold: value | 71 | 0-0:17.0.1.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 1885 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod: value | 71 | 0-0:17.0.1.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 1890 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold: value | 71 | 0-0:17.0.2.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 1886 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod: value | 71 | 0-0:17.0.2.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 1891 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold: value | 71 | 0-0:17.0.3.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 1887 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod: value | 71 | 0-0:17.0.3.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 1892 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold: value | 71 | 0-0:17.0.4.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 1888 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod: value | 71 | 0-0:17.0.4.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - |
This Use Case is for configuring the voltage thresholds and periods.
| Use Case | Title | Message Code |
|---|---|---|
| ECS29d | Set Voltage Configurations on polyphase ESME without counter reset | 0x00D2 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 6.5 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Network Operator |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1893 |
SMETS 5.7.4.4 / 5.19.1.1 |
(Phase[1])AverageRMSOverVoltageThreshold | value | Threshold tested against at end of each AverageRMSVoltageMeasurementPeriod. Note, this is not a continuously monitored threshold. |
Configuration data | INTEGER |
| 1894 |
SMETS 5.7.4.5 / 5.19.1.2 |
(Phase[1])AverageRMSUnderVoltageThreshold | value | Threshold tested against at end of each AverageRMSVoltageMeasurementPeriod. Note, this is not a continuously monitored threshold. |
Configuration data | INTEGER |
| 1882 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageMeasurementPeriod | value | The length of time over which the RMS voltage is averaged. |
Configuration data | INTEGER |
| 1895 |
SMETS 5.19.1.1 |
(Phase[2])AverageRMSOverVoltageThreshold | value | Threshold tested against at end of each AverageRMSVoltageMeasurementPeriod. Note, this is not a continuously monitored threshold. |
Configuration data | INTEGER |
| 1896 |
SMETS 5.19.1.2 |
(Phase[2])AverageRMSUnderVoltageThreshold | value | Threshold tested against at end of each AverageRMSVoltageMeasurementPeriod. Note, this is not a continuously monitored threshold. |
Configuration data | INTEGER |
| 1883 |
SMETS 5.19.1.3 |
(Phase[2])AverageRMSVoltageMeasurementPeriod | value | The length of time over which the RMS voltage is averaged. |
Configuration data | INTEGER |
| 1897 |
SMETS 5.19.1.1 |
(Phase[3])AverageRMSOverVoltageThreshold | value | Threshold tested against at end of each AverageRMSVoltageMeasurementPeriod. Note, this is not a continuously monitored threshold. |
Configuration data | INTEGER |
| 1898 |
SMETS 5.19.1.2 |
(Phase[3])AverageRMSUnderVoltageThreshold | value | Threshold tested against at end of each AverageRMSVoltageMeasurementPeriod. Note, this is not a continuously monitored threshold. |
Configuration data | INTEGER |
| 1884 |
SMETS 5.19.1.3 |
(Phase[3])AverageRMSVoltageMeasurementPeriod | value | The length of time over which the RMS voltage is averaged. |
Configuration data | INTEGER |
| 1885 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod | value | The duration used to measure an extreme over voltage condition. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 1889 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold | value | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 1886 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod | value | The duration used to measure an extreme under voltage condition. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 1890 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold | value | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 1887 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod | value | The duration used to measure a voltage sag condition. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 1891 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold | value | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| 1888 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod | value | The duration used to measure a voltage swell condition. On a polyphase ESME, this is the value that must be used for all phases |
Configuration data | INTEGER |
| 1892 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold | value | The threshold value. On a polyphase ESME, this is the value that must be used as a threshold on all phases |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00D2 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1894 |
SMETS 5.7.4.5 / 5.19.1.2 |
(Phase[1])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:32.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 1893 |
SMETS 5.7.4.4 / 5.19.1.1 |
(Phase[1])AverageRMSOverVoltageThreshold: value | 1 | 1-0:32.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 1896 |
SMETS 5.19.1.2 |
(Phase[2])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:52.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 1895 |
SMETS 5.19.1.1 |
(Phase[2])AverageRMSOverVoltageThreshold: value | 1 | 1-0:52.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 1898 |
SMETS 5.19.1.2 |
(Phase[3])AverageRMSUnderVoltageThreshold: value | 1 | 1-0:72.31.0.4 | A | 2 | value | double-long-unsigned | - | |
| 1897 |
SMETS 5.19.1.1 |
(Phase[3])AverageRMSOverVoltageThreshold: value | 1 | 1-0:72.35.0.4 | A | 2 | value | double-long-unsigned | - | |
| 1882 |
SMETS 5.7.4.6 / 5.19.1.3 |
(Phase[1])AverageRMSVoltageMeasurementPeriod: value | 7 | 1-0:32.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 1883 |
SMETS 5.19.1.3 |
(Phase[2])AverageRMSVoltageMeasurementPeriod: value | 7 | 1-0:52.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 1884 |
SMETS 5.19.1.3 |
(Phase[3])AverageRMSVoltageMeasurementPeriod: value | 7 | 1-0:72.24.0.255 | A | 4 | capture_period | double-long-unsigned | - | |
| 1889 |
SMETS 5.7.4.35 |
RMSExtremeOverVoltageThreshold: value | 71 | 0-0:17.0.1.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 1885 |
SMETS 5.7.4.34 |
RMSExtremeOverVoltageMeasurementPeriod: value | 71 | 0-0:17.0.1.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 1890 |
SMETS 5.7.4.37 |
RMSExtremeUnderVoltageThreshold: value | 71 | 0-0:17.0.2.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 1886 |
SMETS 5.7.4.36 |
RMSExtremeUnderVoltageMeasurementPeriod: value | 71 | 0-0:17.0.2.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 1891 |
SMETS 5.7.4.40 |
RMSVoltageSagThreshold: value | 71 | 0-0:17.0.3.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 1887 |
SMETS 5.7.4.38 |
RMSVoltageSagMeasurementPeriod: value | 71 | 0-0:17.0.3.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - | |
| 1892 |
SMETS 5.7.4.41 |
RMSVoltageSwellThreshold: value | 71 | 0-0:17.0.4.255 | A | 4 | threshold_normal | double-long-unsigned | - | |
| 1888 |
SMETS 5.7.4.39 |
RMSVoltageSwellMeasurementPeriod: value | 71 | 0-0:17.0.4.255 | A | 6 | min_over_threshold_duration | double-long-unsigned | - |
This Use Case is for instructing the GSME to begin logging network sampling data.
| Use Case | Title | Message Code |
|---|---|---|
| GCS31 | Start Network Data Log on GSME | 0x0080 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 14.1 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Access Control Broker |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1392 |
SMETS 4.5.3.16 |
NetworkDataLog | method:record network data | Method to instruct the GSME to start recording a Network Data Log |
Method | Method |
| Target | GSME |
|---|---|
| Message Code | 0x0080 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1392 | SMETS 4.5.3.16 | NetworkDataLog: method:record network data | -- | -- | Metering: 0x0702 |
Notification that the CHF's Sub GHz Configuration has changed. See GBCS 10.6.2.3 for the specific meaning of each of the values returned in the Use Case specific payload.
| Use Case | Title | Message Code |
|---|---|---|
| DBCH09 | Sub GHz Configuration Changed Sub GHz Alert | 0x0113 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.A.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1915 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | channelNoisierTheshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1914 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | channelQuieterThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1913 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | gSMECurfew | See GBCS 10.6.2.3. |
Configuration data | |
| 1911 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | limited-CriticalDutyCycleThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1919 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHFailurePercentage | See GBCS 10.6.2.3. |
Configuration data | |
| 1918 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHNoiseMeasurementPeriod | See GBCS 10.6.2.3. |
Configuration data | |
| 1920 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | localCHRetryPercentage | See GBCS 10.6.2.3. |
Configuration data | |
| 1912 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | maximumSubGHzChannelChangesPerWeek | See GBCS 10.6.2.3. |
Configuration data | |
| 1916 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | nonGSMEPoorCommunicationsPercentageThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1917 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | nonGSMEPoorCommunicationsThirtyMinutePeriodsMeasurementPeriod | See GBCS 10.6.2.3. |
Configuration data | |
| 1910 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | normal-LimitedDutyCycleThreshold | See GBCS 10.6.2.3. |
Configuration data | |
| 1905 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page28Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1906 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page29Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1907 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page30Mask | See GBCS 10.6.2.3. |
Configuration data | |
| 1908 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings | page31Mask | See GBCS 10.6.2.3. |
Configuration data |
| Target | See GBCS |
|---|---|
| Message Code | 0x0113 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1905 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page28Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page28Mask | bit-string(32) | - | |
| 1906 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page29Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page29Mask | bit-string(32) | - | |
| 1907 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page30Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page30Mask | bit-string(32) | - | |
| 1908 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: page31Mask | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.page31Mask | bit-string(32) | - | |
| 1910 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: normal-LimitedDutyCycleThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.normalLimitedDutyCycleThreshold | long-unsigned | - | |
| 1911 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: limited-CriticalDutyCycleThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.limitedCriticalDutyCycleThreshold | long-unsigned | - | |
| 1912 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: maximumSubGHzChannelChangesPerWeek | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.channelChangesPerWeek | unsigned | - | |
| 1913 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: gSMECurfew | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.gsmeCurfew | long-unsigned | - | |
| 1914 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: channelQuieterThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.quieterDecibelsLimit | unsigned | - | |
| 1915 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: channelNoisierTheshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.noisierDecibelsLimit | unsigned | - | |
| 1916 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: nonGSMEPoorCommunicationsPercentageThreshold | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.nonGsmePoorCommsPercentage | long-unsigned | - | |
| 1917 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: nonGSMEPoorCommunicationsThirtyMinutePeriodsMeasurementPeriod | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.nonGsmeMeasurementPeriods | unsigned | - | |
| 1918 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHNoiseMeasurementPeriod | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChNoiseMeasurementPeriod | long-unsigned | - | |
| 1919 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHFailurePercentage | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChFailurePercentage | long-unsigned | - | |
| 1920 |
CHTS 4.6.2.5 |
SubGHzConfigurationSettings: localCHRetryPercentage | 1 | 0-0:94.44.10.0 | A | 2 | value:subGhzConfig.localChRetryPercentage | long-unsigned | - |
Alert codes: 0x8F35, 0x8F36, 0x8F37, 0x8F38, 0x8F39, 0x8F3A, 0x8F3B, 0x8F3C
Refer to section 7.2.3
| Use Case | Title | Message Code |
|---|---|---|
| ECS80 | Supply Outage Restore Alert from ESME | 0x0067 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.A.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | N/A |
| Service Reference | N/A |
| Read or Update | Read |
| Response Recipient Different than Command Sender? | No |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1771 |
SMETS 5.5.12.6 / 5.17.2.6 |
SupplyOutageRestore | interruptionValue | The date-time at which power was interrupted |
Alert | DATE-TIME |
| 1772 |
SMETS 5.5.12.6 / 5.17.2.6 |
SupplyOutageRestore | restorationValue | The date-time at which power was restored |
Alert | DATE-TIME |
| Target | ESME |
|---|---|
| Message Code | 0x0067 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1771 |
SMETS 5.5.12.6 / 5.17.2.6 |
SupplyOutageRestore: interruptionValue | Not specified | Not specified | A | Not specified | interuption_value | octet-string(12) | - | interuption_value shall be before restoration_value in the alert |
| 1772 |
SMETS 5.5.12.6 / 5.17.2.6 |
SupplyOutageRestore: restorationValue | Not specified | Not specified | A | Not specified | restoration_value | octet-string(12) | - | interuption_value shall be before restoration_value in the alert |
This Use Case is for configuring the prepayment settings on the Smart Meter.
This covers setting up the repayment rates, emergency credit functions, credit warning thresholds, and whether debt is collected when credit is exhausted or emergency credit is in use.
| Use Case | Title | Message Code |
|---|---|---|
| ECS08a | Update Prepayment Configuration on ESME | 0x00DE |
| GCS05 | Update Prepayment Configurations on GSME | 0x006F |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | Yes |
| Protection Against Replay required | Yes |
| Service Reference | 2.1 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1213 |
SMETS 4.6.4.10 SMETS 5.7.4.13 |
DebtRecoveryRateCap | activateAmountNextDateTime | When the 'amountNext' value is to be activated (see GBCS section 9.2.2) |
Configuration data | DATE-TIME no wildcards |
| 1214 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap | activatePeriodNextDateTime | When the 'periodNext' value is to be activated (see GBCS section 9.2.2) |
Configuration data | DATE-TIME no wildcards |
| 1195 |
SMETS 4.6.4.10 SMETS 5.7.4.13 |
DebtRecoveryRateCap | amountNext | The yet to be activated amount of the cap |
Configuration data | INTEGER |
| 1182 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap | periodNext | The yet to be activated time period over which the DebtRecoveryRateCap will be applied. The ZSE specification fixes this at 1 week and so it is not a parameter in the command to the GSME / response from it. The DLMS COSEM value is fixed at 604800 seconds |
Configuration data | INTEGER |
| 1215 |
SMETS 4.6.4.13 SMETS 5.7.4.16 |
EmergencyCreditLimit | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1184 |
SMETS 4.6.4.13 SMETS 5.7.4.16 |
EmergencyCreditLimit | amountNext | The yet to be activated value |
Configuration data | INTEGER |
| 1216 |
SMETS 4.6.4.14 SMETS 5.7.4.17 |
EmergencyCreditThreshold | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1191 |
SMETS 4.6.4.14 SMETS 5.7.4.17 |
EmergencyCreditThreshold | thresholdNext | The yet to be activated value |
Configuration data | INTEGER |
| 1221 |
SMETS 5.7.4.23 |
LowCreditThreshold | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1183 |
SMETS 4.6.4.16 SMETS 5.7.4.23 |
LowCreditThreshold | thresholdNext | The yet to be activated value |
Configuration data | INTEGER |
| 1435 |
SMETS 4.6.4.20 SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1696 |
SMETS 4.6.4.20 SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays) | date[0..20].next | This is the date (or set of dates if wildcards are used) of the corresponding special day. |
Configuration Data | DATE WITH WILDCARDS |
| 1698 |
SMETS 4.6.4.20 SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays) | dayIdentifier[0..20].next | This is a number used in calendar entries that require execution on this special day. |
Configuration Data | INTEGER |
| 1206 |
SMETS 4.6.4.2 SMETS 5.7.4.30 |
Non-DisablementCalendar | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 772 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].beginDateNext | The earliest date on which this entry in entries will take effect |
Configuration data | DATE-TIME no wildcards |
| 774 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].endDateNext | The last date on which this entry in entries will take effect |
Configuration data | DATE-TIME no wildcards |
| 732 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].execSpecdaysNext[0..20] | Each boolean determines whether this entry executes on this day |
Configuration data | Series of BOOLEANS |
| 734 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].execWeekdaysNext[1..7] | Each boolean determines whether this entry executes on this day |
Configuration data | Series of BOOLEANS |
| 753 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].scriptRefNext | See the Blue Book and section 7.3.7 of the GBCS |
Configuration data | INTEGER |
| 764 |
SMETS 5.7.4.30 |
Non-DisablementCalendar | entries[1..22].timeNext | The time during the day at which the action is triggered |
Configuration data | TIME NO WILDCARDS |
| 1537 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextDayIdentifiers[1..5] | The yet to be activated values to be set at those date times |
Configuration data | BOOLEAN |
| 1538 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextDayIdentifiers[1..5].Time[1..3].actions | Defines whether, at the associated start time, a non-disablement period starts or ends (so Enabled or Not Enabled) |
Configuration data | INTEGER |
| 1539 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextDayIdentifiers[1..5].Time[1..3].startTime | The trigger points in the calendar, specified in terms of dayIdentifier and time within that day. 'nextDayIdentifiers[1..5].Time[1].startTime' must always be midnight UTC to align to ZSE constraints |
Configuration data | TIME NO WILDCARDS |
| 1541 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextSeasons[1..3].startDate | This is the date on which the season starts. [the season will end the day the next season starts] |
Configuration Data | DATE WITH WILDCARDS |
| 1542 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextSeasons[1..3].WeekIdentifier | The name used to refer to the week structure used in this season |
Configuration Data | OCTET-STRING |
| 1543 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextWeeks[1..2].days[1].Identifier | dayIdentifier for Monday |
Configuration Data | INTEGER |
| 1544 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextWeeks[1..2].days[2].Identifier | dayIdentifier for Tuesday |
Configuration Data | INTEGER |
| 1545 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextWeeks[1..2].days[3].Identifier | dayIdentifier for Wednesday |
Configuration Data | INTEGER |
| 1546 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextWeeks[1..2].days[4].Identifier | dayIdentifier for Thursday |
Configuration Data | INTEGER |
| 1547 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextWeeks[1..2].days[5].Identifier | dayIdentifier for Friday |
Configuration Data | INTEGER |
| 1548 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextWeeks[1..2].days[6].Identifier | dayIdentifier for Saturday |
Configuration Data | INTEGER |
| 1549 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextWeeks[1..2].days[7].Identifier | dayIdentifier for Sunday |
Configuration Data | INTEGER |
| 1550 |
SMETS 4.6.4.20 |
Non-DisablementCalendar | nextWeeks[1..2].weekIdentifier | The name given to a particular week structure |
Configuration Data | OCTET-STRING |
| 1222 |
SMETS 4.6.4.17 SMETS 5.7.4.25 |
PrepaymentCredit(MaximumCreditThreshold) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1181 |
SMETS 4.6.4.17 SMETS 5.7.4.25 |
PrepaymentCredit(MaximumCreditThreshold) | valueNext | The largest value of any one credit |
Configuration data | INTEGER |
| 1223 |
SMETS 4.6.4.18 SMETS 5.7.4.27 |
PrepaymentCredit(MaxMeterBalance) | activateNextDateTime | If not high values(0xFF), the date-time at which the corresponding 'Next' parameters shall be used to overwrite the corresponding 'Current' attributes |
Configuration data | DATE-TIME no wildcards |
| 1169 |
SMETS 4.6.4.18 SMETS 5.7.4.27 |
PrepaymentCredit(MaxMeterBalance) | valueNext | The largest value that a credit could take MeterBalance.value to and still be accepted |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x00DE |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1817 |
(DLMS) |
Non-DisablementCalendar(SpecialDays): index[0..20].next | 11 | 0-1:11.0.2.255 | A | 2 | entries:entries[0..20].spec_day_entry.index | long-unsigned | - | Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 1696 |
SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays): date[0..20].next | 11 | 0-1:11.0.2.255 | A | 2 | entries:entries[0..20].spec_day_entry.specialday_date | octet-string(5) | - | Formatted as date (octet-string(5)) according to 4.1.6.1 of the Blue Book. Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 1698 |
SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays): dayIdentifier[0..20].next | 11 | 0-1:11.0.2.255 | A | 2 | entries:entries[0..20].spec_day_entry.day_id | unsigned | - | Where there are no special days, this attribute 2 shall be an array of zero entries. |
| 1169 |
SMETS 5.7.4.27 |
PrepaymentCredit(MaxMeterBalance): valueNext | 9000 | 0-0:94.44.2.20 | A | 4 | value_passive | double-long | - | |
| 1181 |
SMETS 5.7.4.25 |
PrepaymentCredit(MaximumCreditThreshold): valueNext | 9000 | 0-0:94.44.2.10 | A | 4 | value_passive | double-long | - | |
| 762 |
(DLMS) |
Non-DisablementCalendar: entries[1..22].IndexNext | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.index | long-unsigned | - | |
| 742 |
(DLMS) |
Non-DisablementCalendar: entries[1..22].enableNext | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.enable | boolean | ||0x01 | |
| 782 |
(DLMS) |
Non-DisablementCalendar: entries[1..22].scriptTableNext | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.script_logical_name | octet-string(6) | ||0x00000A006AFF | |
| 753 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].scriptRefNext | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.script_selector | long-unsigned | - | |
| 764 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].timeNext | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.switch_time | octet-string(4) | - | |
| 1799 |
(DLMS) |
Non-DisablementCalendar: entries[1..22].validityWindowNext | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.validity_window | long-unsigned | ||0xFFFF | |
| 734 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].execWeekdaysNext[1..7] | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.exec_weekdays | bit-string(7) | - | |
| 732 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].execSpecdaysNext[0..20] | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.exec_specdays | bit-string(20) | - | The length of this bit-string is variable and must align to the number of special days specified in the associated special days object. The length shown is the maximum number of such special days. |
| 772 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].beginDateNext | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.begin_date | octet-string(5) | - | |
| 774 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: entries[1..22].endDateNext | 10 | 0-1:12.0.1.255 | A | 2 | entries:entries[1..22].schedule_table_entry.end_date | octet-string(5) | - | |
| 1195 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap: amountNext | 9000 | 0-0:94.44.128.12 | A | 4 | value_passive | long-unsigned | - | The ESME shall interpret this value as having an associated scalar of zero, so meaning it represents a value in whole currency units. |
| 1182 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap: periodNext | 9000 | 0-0:94.44.128.13 | A | 4 | value_passive | double-long | - | |
| 1183 |
SMETS 5.7.4.23 |
LowCreditThreshold: thresholdNext | 9000 | 0-0:94.44.128.9 | A | 4 | value_passive | double-long | - | |
| 1184 |
SMETS 5.7.4.16 |
EmergencyCreditLimit: amountNext | 9000 | 0-0:94.44.128.2 | A | 4 | value_passive | double-long | - | |
| 1435 |
SMETS 5.7.4.30 |
Non-DisablementCalendar(SpecialDays): activateNextDateTime | 9000 | 0-0:94.44.128.31 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1191 |
SMETS 5.7.4.17 |
EmergencyCreditThreshold: thresholdNext | 9000 | 0-0:94.44.128.3 | A | 4 | value_passive | double-long | - | |
| 1223 |
SMETS 5.7.4.27 |
PrepaymentCredit(MaxMeterBalance): activateNextDateTime | 9000 | 0-0:94.44.2.20 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1222 |
SMETS 5.7.4.25 |
PrepaymentCredit(MaximumCreditThreshold): activateNextDateTime | 9000 | 0-0:94.44.2.10 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1213 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap: activateAmountNextDateTime | 9000 | 0-0:94.44.128.12 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1214 |
SMETS 5.7.4.13 |
DebtRecoveryRateCap: activatePeriodNextDateTime | 9000 | 0-0:94.44.128.13 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1221 |
SMETS 5.7.4.23 |
LowCreditThreshold: activateNextDateTime | 9000 | 0-0:94.44.128.9 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1215 |
SMETS 5.7.4.16 |
EmergencyCreditLimit: activateNextDateTime | 9000 | 0-0:94.44.128.2 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1216 |
SMETS 5.7.4.17 |
EmergencyCreditThreshold: activateNextDateTime | 9000 | 0-0:94.44.128.3 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book |
| 1206 |
SMETS 5.7.4.30 |
Non-DisablementCalendar: activateNextDateTime | 9000 | 0-0:94.44.128.28 | A | 6 | activate_passive_value_time | octet-string(12) | - | Time and Date formatted as per section 4.1.6.1. of Blue Book. |
| Target | GSME |
|---|---|
| GPF Gas ESI Tap-Off | Yes |
| Message Code | 0x006F |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
The GPF is required to tap off commands relating to the Non-Disablement Calendar
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1215 | SMETS 4.6.4.13 | EmergencyCreditLimit: activateNextDateTime | UTCTime | Start Time UTC Time
0 = immediate |
Prepayment: 0x0705 | Emergency Credit Setup : 0x03 | ZCL Default Response : 0x0B |
| 1184 | SMETS 4.6.4.13 | EmergencyCreditLimit: amountNext | UINT32 | Emergency Credit Limit 0 - 0xFFFFFFFF |
|||
| 1216 | SMETS 4.6.4.14 | EmergencyCreditThreshold: activateNextDateTime | UTCTime | Start Time UTC Time
0 = immediate |
|||
| 1191 | SMETS 4.6.4.14 | EmergencyCreditThreshold: thresholdNext | UINT32 | Emergency Credit Threshold 0 - 0xFFFFFFFF |
|||
| 1213 | SMETS 4.6.4.10 | DebtRecoveryRateCap: activateAmountNextDateTime | UTCTime | Implementation Date/Time UTC Time
0 = immediate |
Prepayment: 0x0705 | Set Overall Debt Cap : 0x0C | ZCL Default Response : 0x0B |
| 1195 | SMETS 4.6.4.10 | DebtRecoveryRateCap: amountNext | INT32 | Overall Debt Cap -0x7FFFFFFF -
+0x7FFFFFFF |
|||
| 1183 | SMETS 4.6.4.16 | LowCreditThreshold: thresholdNext | UINT32 | Low Credit Warning Level 0 - 0xFFFFFFFF |
Prepayment: 0x0705 | ||
| 1169 | SMETS 4.6.4.18 | PrepaymentCredit(MaxMeterBalance): valueNext | UINT32 | Maximum Credit Level 0 - 0xFFFFFFFF |
Prepayment: 0x0705 | Set Maximum Credit Limit : 0x0B | ZCL Default Response : 0x0B |
| 1222 | SMETS 4.6.4.17 | PrepaymentCredit(MaximumCreditThreshold): activateNextDateTime | UTCTime | Implementation Date/Time UTC Time
0 = immediate |
|||
| 1181 | SMETS 4.6.4.17 | PrepaymentCredit(MaximumCreditThreshold): valueNext | UINT32 | Maximum Credit Per Top Up 0 - 0xFFFFFFFF |
|||
| 1223 | SMETS 4.6.4.18 | PrepaymentCredit(MaxMeterBalance): activateNextDateTime | UTCTime | Implementation Date/Time UTC Time
0 = immediate |
|||
| 1206 | SMETS 4.6.4.2 | Non-DisablementCalendar: activateNextDateTime | UTCTime | Start Time UTC Time
0 = immediate
|
Calendar: 0x0707 | PublishCalendar : 0x00 | ZCL Default Response : 0x0B |
| 1455 | (GBZ) | Non-DisablementCalendar: calendarType | ENUM8 | Calendar Type 3 = Friendly Credit Calendar |
|||
| 1843 | (GBZ) | Non-DisablementCalendar: calendarType | ENUM8 | Calendar Type 0x03 = Friendly Credit Calendar |
|||
| 1537 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextDayIdentifiers[1..5] | UINT8 | Day ID 1 - 0xFF |
Calendar: 0x0707 | PublishDayProfile : 0x01 | ZCL Default Response : 0x0B |
| 1539 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextDayIdentifiers[1..5].Time[1..3].startTime | STRUCTURE[n] | Day Schedule Entries UINT16:Minutes From Midnight x n |
|||
| 1538 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextDayIdentifiers[1..5].Time[1..3].actions | STRUCTURE[n] | Day Schedule Entries BOOLEAN: (1=Non-disablement Active; 0 = Non-disablement inactive) x n |
|||
| 1550 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextWeeks[1..2].weekIdentifier | UINT8 | Week ID 1 - 0xFF |
Calendar: 0x0707 | PublishWeekProfile : 0x02 | ZCL Default Response : 0x0B |
| 1543 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextWeeks[1..2].days[1].Identifier | UINT8 | Day ID Ref Monday 1 - 0xFF |
|||
| 1544 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextWeeks[1..2].days[2].Identifier | UINT8 | Day ID Ref Tuesday 1 - 0xFF |
|||
| 1545 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextWeeks[1..2].days[3].Identifier | UINT8 | Day ID Ref Wednesday 1 - 0xFF |
|||
| 1546 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextWeeks[1..2].days[4].Identifier | UINT8 | Day ID Ref Thursday 1 - 0xFF |
|||
| 1547 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextWeeks[1..2].days[5].Identifier | UINT8 | Day ID Ref Friday 1 - 0xFF |
|||
| 1548 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextWeeks[1..2].days[6].Identifier | UINT8 | Day ID Ref Saturday 1 - 0xFF |
|||
| 1549 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextWeeks[1..2].days[7].Identifier | UINT8 | Day ID Ref Sunday 1 - 0xFF |
|||
| 1541 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextSeasons[1..3].startDate | STRUCTURE[n] | Season Entry Date:Season Start Date x n |
Calendar: 0x0707 | PublishSeasons : 0x03 | ZCL Default Response : 0x0B |
| 1542 | SMETS 4.6.4.20 | Non-DisablementCalendar: nextSeasons[1..3].WeekIdentifier | STRUCTURE[n] | Season Entry UINT8:Week ID Ref x n |
|||
| 1435 | SMETS 4.6.4.20 | Non-DisablementCalendar(SpecialDays): activateNextDateTime | UTCTime | Start Time UTC Time |
Calendar: 0x0707 | PublishSpecialDays : 0x04 | ZCL Default Response : 0x0B |
| 1456 | (GBZ) | Non-DisablementCalendar(SpecialDays): calendarTypeSpecialDays | ENUM8 | Calendar Type 3 = Friendly Credit Calendar |
|||
| 1696 | SMETS 4.6.4.20 | Non-DisablementCalendar(SpecialDays): date[0..20].next | STRUCTURE[n] | SpecialDayEntry Date: Special Day Date x n |
|||
| 1698 | SMETS 4.6.4.20 | Non-DisablementCalendar(SpecialDays): dayIdentifier[0..20].next | STRUCTURE[n] | SpecialDayEntry UINT8:Day ID Ref x n |
This Use Case is for setting the Randomised Offset Limit on the ESME.
| Use Case | Title | Message Code |
|---|---|---|
| ECS38 | Update Randomised Offset Limit | 0x004B |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.C |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | Yes |
| Service Reference | 7.12 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 66 |
SMETS 5.7.4.33 / 9.6.2.6 |
RandomisedOffsetLimit | value | Integer between 0 and 1799 |
Configuration data | INTEGER |
| Target | ESME |
|---|---|
| Message Code | 0x004B |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 66 |
SMETS 5.7.4.33 / 9.6.2.6 |
RandomisedOffsetLimit: value | 1 | 0-0:94.44.0.1 | A | 2 | value | long-unsigned | - |
This Use Case is for writing the Supplier contacts details on the Smart Meter.
| Use Case | Title | Message Code |
|---|---|---|
| ECS16 | Write Supplier Contact Details on ESME | 0x0025 |
| GCS44 | Write Contact Details on GSME | 0x0088 |
| Category | Value |
|---|---|
| Remote Party or HAN Only Message | Remote Party |
| Message Type | SME.C.NC |
| Capable of Future Dated Invocation | No |
| Protection Against Replay required | No |
| Service Reference | 3.4 |
| Read or Update | Update |
| Response Recipient Different than Command Sender? | No |
The following table details the Remote Party Roles that can perform the Use Case on the device. See section 17 of the GBCS for information on the use of this table.
| Remote Party Role |
|---|
| Supplier |
mapping table row # |
ref. | name | attribute/ method |
notes | sub category | data type |
|---|---|---|---|---|---|---|
| 1251 |
SMETS 4.6.4.4 SMETS 5.7.4.8 |
ContactDetails | supplierName | The Supplier name. This is the same value that is updated by UpdateSecurityCredentials on change of Supplier |
Configuration data | OCTET-STRING |
| 1197 |
SMETS 4.6.4.4 SMETS 5.7.4.8 |
ContactDetails | supplierTelephoneNumber | Octet string of the telephone number |
Configuration data | OCTET-STRING |
| Target | ESME |
|---|---|
| Message Code | 0x0025 |
None
The ordering of fields below is according to section 19.2.1.
| mapping table row # |
ref. | name | class | OBIS code | attribute or method? | attribute/ method no. |
attribute/ method name |
DLMS COSEM data types | constant value | notes |
|---|---|---|---|---|---|---|---|---|---|---|
| 1197 |
SMETS 5.7.4.8 |
ContactDetails: supplierTelephoneNumber | 9000 | 0-0:96.13.0.255 | A | 2 | value_active | octet-string(18) | - | |
| 1251 |
SMETS 5.7.4.8 |
ContactDetails: supplierName | 9000 | 0-0:96.13.1.255 | A | 2 | value_active | octet-string(15) | - |
| Target | GSME |
|---|---|
| GPF Gas ESI Tap-Off | Yes |
| Message Code | 0x0088 |
None
Refer to the GBZ Message Template for details on populating additional parameters required by ZCL/ZSE commands.
| mapping table row # |
ref. | name | data type | attribute/ value/ parameter |
cluster: ID | command: ID | response: ID |
|---|---|---|---|---|---|---|---|
| 1251 | SMETS 4.6.4.4 | ContactDetails: supplierName | OCTETSTRING[n] | Proposed Provider Name n = 1 - 15 |
Device Management: 0x0708 | Publish Change of Supplier : 0x01 | ZCL Default Response : 0x0B |
| 1197 | SMETS 4.6.4.4 | ContactDetails: supplierTelephoneNumber | OCTETSTRING[n] | Proposed Provider Contact Details n = 1 - 18 |
|||
| 1767 | (GBZ) | ContactDetails: valueTariffTypeNext | BITMAP8 (NIBBLES) | Tariff Type 0 = Delivered Tariff |
|||
| 1765 | (GBZ) | ContactDetails: valueProviderChangeControlNext | BITMAP32 | Provider Change Control |
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Consumer Top Up | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0019 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Consumer Top Up | 0x04 | 1 |
| ZCL payload | |||
| Originating Device (ENUM8) | Source: 0x00=Energy Service Interface | 0x00 | 1 |
| TopUp Code (OCTETSTRING) | UTRN | * | 21 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Consumer Top Up Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Consumer Top Up Response | 0x03 | 1 |
| ZCL payload | |||
| Result Type (ENUM8) | 0x00 = Accepted; 0x01 = Rejected-Invalid Top Up; 0x02 = Rejected-Duplicate Top Up; 0x03 = Rejected-Error; 0x04 = Rejected-Max Credit Reached; 0x05 = Rejected-Keypad Lock; 0x06 = Rejected-Top Up Value Too Large; 0x10 = Accepted ? Supply Enabled; 0x11 = Accepted ? Supply Disabled; 0x12 = Accepted ? Supply Armed | * | 1 |
| Top Up Value (INT32) | Top up value | * | 4 |
| Source of Top up (ENUM8) | Source: 0x00=Energy Service Interface | 0x00 | 1 |
| Credit Remaining (INT32) | Credit remaining, or 0xFFFFFFFF if credit was not accepted | * | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Get Event Log | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0709 | 2 | |
| Extended Header GBZ Command Length | 0x0011 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Get Event Log | 0x00 | 1 |
| ZCL payload | |||
| Event Control / Log ID (BITMAP8) | 0x13 = General Event Log; 0x16 = GSME Proxy Log copy of GSME Event Log (GPF only) | 0x13 | 0x16 | 1 |
| Event ID (UINT16) | All events | 0x0000 | 2 |
| Start Time (UTCTime) | Earliest log entry datestamp | * | 4 |
| End Time (UTCTime) | Latest log entry datestamp | * | 4 |
| Number of Events (UINT8) | All events | 0x00 | 1 |
| Event Offset (UINT16) | Always read from the beginning | 0x0000 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Publish Event Log (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0709 | 2 | |
| Extended Header GBZ Command Length | 0x0007 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Event Log | 0x01 | 1 |
| ZCL payload | |||
| Total Number of Events (UINT16) | Total number of log entries returned, 1-100 | * | 2 |
| Command Index (UINT8) | Read from the start of the log | 0x00 | 1 |
| Total Commands (UINT8) | Return entire log in a single payload | 0x01 | 1 |
| Log Payload (Refer to ZigBee spec) | The Number of Events / Log Payload Control field shall be set to 0x00 and the recipient shall not use the field. The number of events shall be as detailed in the Log Payload. Other fields shall be populated as per the ZSE specification. For clarity, Event Data fields shall contain 0x00 where there is no associated Event Data. | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0709 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Get Event Log if no events found | 0x00 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Get Event Log | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0709 | 2 | |
| Extended Header GBZ Command Length | 0x0011 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Get Event Log | 0x00 | 1 |
| ZCL payload | |||
| Event Control / Log ID (BITMAP8) | 0x04 = Security Event Log; 0x07 = GSME Proxy Log copy of GSME Security Event Log | 0x04 | 0x07 | 1 |
| Event ID (UINT16) | All events | 0x0000 | 2 |
| Start Time (UTCTime) | Earliest log entry datestamp | * | 4 |
| End Time (UTCTime) | Latest log entry datestamp | * | 4 |
| Number of Events (UINT8) | All events | 0x00 | 1 |
| Event Offset (UINT16) | Always read from the beginning | 0x0000 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Publish Event Log (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0709 | 2 | |
| Extended Header GBZ Command Length | 0x0007 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Event Log | 0x01 | 1 |
| ZCL payload | |||
| Total Number of Events (UINT16) | Total number of log entries returned, 1-100 | * | 2 |
| Command Index (UINT8) | Read from the start of the log | 0x00 | 1 |
| Total Commands (UINT8) | Return entire log in a single payload | 0x01 | 1 |
| Log Payload (Refer to ZigBee spec) | The Number of Events / Log Payload Control field shall be set to 0x00 and the recipient shall not use the field. The number of events shall be as detailed in the Log Payload. Other fields shall be populated as per the ZSE specification. For clarity, Event Data fields shall contain 0x00. | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0709 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Get Event Log if no events found | 0x00 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Clear Event Log Request | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0709 | 2 | |
| Extended Header GBZ Command Length | 0x0004 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Clear Event Log Request | 0x01 | 1 |
| ZCL payload | |||
| Log ID (UINT8) | 0x03 = General Event Log | 0x03 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Clear Event Log Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0709 | 2 | |
| Extended Header GBZ Command Length | 0x0004 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Clear Event Log Response | 0x02 | 1 |
| ZCL payload | |||
| ClearedEventsLogs (BITMAP8) | 0x08 = General Event Log cleared; 0x00 = General Event Log NOT cleared | 0x00 | 0x08 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 7-12 | 1 |
| PublishCalendar | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0019 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishCalendar | 0x00 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCTime) | The activation date-time for this ZSE PublishCalendar command. To reflect the ZSE requirement that 'The Calendar must be replaced as a whole', this ZSE PublishCalendar command and the PublishDayProfile, PublishWeekProfile and PublishSeasons ZSE commands in this Message must all succeed or must all fail. If the activation date-time is in the future, an alert will result from the PublishCalendar ZSE command which will detail whether the Calendar was replaced or not | * | 4 |
| Calendar Type (ENUM8) | 0 = Delivered Calendar | 0x00 | 1 |
| Calendar Time Reference (UINT8) | UTC time | 0x00 | 1 |
| Calendar Name (OCTETSTRING) | Calendar name, 0-length string | 0x00 | 1 |
| Number of Seasons (UINT8) | Number of seasons | * | 1 |
| Number of Week Profiles (UINT8) | Number of week profiles | * | 1 |
| Number of Day Profiles (UINT8) | Number of day profiles | * | 1 |
| PublishDayProfile (1-4 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0014 + total length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishDayProfile | 0x01 | 1 |
| ZCL payload | |||
| A separate PublishDayProfile command for each Day Profile will be sent | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set to same value as the corresponding PublishCalendar command | * | 4 |
| Day ID (UINT8) | Number sequentially, starting from 1 | * | 1 |
| Total Number of Schedule Entries (UINT8) | Number of tariff switches | * | 1 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Calendar Type (ENUM8) | 0 = Delivered Calendar | 0x00 | 1 |
| Day Schedule Entries (Refer to ZigBee spec) | Array of Day Schedule Entries containing a single entry. The entry is interpreted as follows: ; Start Time (minutes from midnight = 0x0000, UINT16); Price Tier (ENUM8) | * | * |
| PublishWeekProfile (1-2 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0017 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishWeekProfile | 0x02 | 1 |
| ZCL payload | |||
| A separate PublishWeekProfile command for each Week Profile will be sent | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set to same value as the corresponding PublishCalendar command | * | 4 |
| Week ID (UINT8) | Number sequentially, starting from 1 | * | 1 |
| Day ID Ref Monday (UINT8) | Day profile to assign to Monday | * | 1 |
| Day ID Ref Tuesday (UINT8) | Day profile to assign to Tuesday | * | 1 |
| Day ID Ref Wednesday (UINT8) | Day profile to assign to Wednesday | * | 1 |
| Day ID Ref Thursday (UINT8) | Day profile to assign to Thursday | * | 1 |
| Day ID Ref Friday (UINT8) | Day profile to assign to Friday | * | 1 |
| Day ID Ref Saturday (UINT8) | Day profile to assign to Saturday | * | 1 |
| Day ID Ref Sunday (UINT8) | Day profile to assign to Sunday | * | 1 |
| PublishSeasons | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0011 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishSeasons | 0x03 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set to same value as the corresponding PublishCalendar command | * | 4 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Season Entry (Refer to ZigBee spec) | Array of up to 3 Season Entry(s). Each entry is interpreted as follows: ; Season Start Date (Date); Week ID Ref (UINT8) | * | * |
| PublishSpecialDays | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0017 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishSpecialDays | 0x04 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set to same value as the corresponding PublishCalendar command | * | 4 |
| Start Time (UTCTime) | Date/time these special days are active; 0 = immediate | * | 4 |
| Calendar Type (ENUM8) | 0 = Delivered Calendar | 0x00 | 1 |
| Total Number of SpecialDays (UINT8) | Number of Special Days | * | 1 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Special Day Entry (Refer to ZigBee spec) | Array of between 0 and 20 Special Day Entry(s). Each entry is interpreted as follows: ; Special Day Date (Date); Day ID Ref (UINT8) | * | * |
| PublishTariffInformation | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0026 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishTariffInformation | 0x04 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Tariff ID (UINT32) | 1 = Tariff Switching Table | 0x00000001 | 4 |
| Start Time (UTCTime) | 0 = now | * | 4 |
| Tariff Type / Charging Scheme (BITMAP8 (NIBBLES)) | Most significant nibble:; 0x0 (TOU Tariff); 0x1 (Block Tariff); Least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 0x10 | 1 |
| Tariff Label (OCTETSTRING) | Label (max = 15), 0-length string | 0x00 | 1 |
| Number of Price Tiers in Use (UINT8) | Number of price tiers in use | * | 1 |
| Number of Block Thresholds in Use (UINT8) | Number of block thresholds in use | * | 1 |
| Unit of Measure (ENUM8) | kWh | 0x00 | 1 |
| Currency (UINT16) | 0x033A = 826 = GBP; 0x03D2 = 978 = Euro | 0x033A | 0x03D2 | 2 |
| Price Trailing Digit (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point. Price is in millipence | 0x50 | 1 |
| Standing Charge (UINT32) | Standing charge | * | 4 |
| TierBlockMode (UINT8) | TOU or Block tariff: set to 0xFF | 0xFF | 1 |
| Block Threshold Multiplier (UINT24) | Multiplier | 0x000001 | 3 |
| Block Threshold Divisor (UINT24) | Divisor = 1000 | 0x0003E8 | 3 |
| PublishBlockThresholds (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0016 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishBlockThresholds | 0x06 | 1 |
| ZCL payload | |||
| This command must be included unless PublishTariffInformation sets Number of Block Thresholds in Use = 0 | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCTime) | 0 = now | * | 4 |
| Issuer Tariff ID (UINT32) | 1 = Tariff Switching Table | 0x00000001 | 4 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Sub-payload Control (BITMAP8) | 0b1=Block thresholds apply to all TOU tiers / block only charging in operation | 0x01 | 1 |
| Block Threshold Sub-payload (Refer to ZigBee spec) | Block Threshold Sub-Payload: ; Tier/NumberOfBlockThresholds (Most significant nibble is 0x0; Least Significant Nibble is number of thresholds so 0x1, 0x2 or 0x3); BlockThreshold N( the value of the Nth threshold); | * | * |
| PublishPriceMatrix | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0016 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishPriceMatrix | 0x05 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCTime) | 0 = now | * | 4 |
| Issuer Tariff ID (UINT32) | 1 = Tariff Switching Table | 0x00000001 | 4 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Sub-payload Control (BITMAP8) | 0b0=Block or Block/TOU; 0b1=TOU | 0x00 | 0x01 | 1 |
| Price Matrix Sub-payload (Refer to ZigBee spec) | Array of PriceMatrix Entries. Each entry is interpreted as follows: ; Tier / Block ID (UINT8); Price (UINT32) | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 7-12 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Publish Calendar | 0x00 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response (1-4 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishDayProfile | 0x01 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response (1-2 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishWeekProfile | 0x02 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishSeasons | 0x03 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishSpecialDays | 0x04 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishTariffInformation | 0x04 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishBlockThresholds | 0x06 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishPriceMatrix | 0x05 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| PublishTariffInformation | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0026 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishTariffInformation | 0x04 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Tariff ID (UINT32) | 1 = Tariff Switching Table | 0x00000001 | 4 |
| Start Time (UTCTime) | 0 = now | * | 4 |
| Tariff Type / Charging Scheme (BITMAP8 (NIBBLES)) | Most significant nibble:; 0x0 (TOU Tariff); 0x1 (Block Tariff); Least significant nibble is 0x0 (Delivered Tariff); | 0x00 | 0x10 | 1 |
| Tariff Label (OCTETSTRING) | Label, 0-length string | 0x00 | 1 |
| Number of Price Tiers in Use (UINT8) | Number of price tiers in use | * | 1 |
| Number of Block Thresholds in Use (UINT8) | Number of block thresholds in use | * | 1 |
| Unit of Measure (ENUM8) | kWh | 0x00 | 1 |
| Currency (UINT16) | 0x033A = 826 = GBP; 0x03D2 = 978 = Euro | 0x033A | 0x03D2 | 2 |
| Price Trailing Digit (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point. Price is in millipence | 0x50 | 1 |
| Standing Charge (UINT32) | Standing charge | * | 4 |
| TierBlockMode (UINT8) | TOU or Block tariff: set to 0xFF | 0xFF | 1 |
| Block Threshold Multiplier (UINT24) | Multiplier | 0x000001 | 3 |
| Block Threshold Divisor (UINT24) | Divisor = 1000 | 0x0003E8 | 3 |
| PublishPriceMatrix | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0016 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishPriceMatrix | 0x05 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCTime) | 0 = now | * | 4 |
| Issuer Tariff ID (UINT32) | 1 = Tariff Switching Table | 0x00000001 | 4 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Sub-payload Control (BITMAP8) | 0b0=Block or Block/TOU; 0b1=TOU | 0x00 | 0x01 | 1 |
| Price Matrix Sub-payload (Refer to ZigBee spec) | Array of PriceMatrix Entries. Each entry is interpreted as follows: ; Tier / Block ID (UINT8); Price (UINT32) | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishTariffInformation | 0x04 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishPriceMatrix | 0x05 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Change Payment Mode | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0015 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Payment Mode | 0x06 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Implementation Date/Time (UTCTime) | 0 = now; 0xFFFFFFFF = cancel | UTC Time; 0 = immediate | 4 |
| Proposed Payment Control Configuration (BITMAP16) | 0b0000110010010100 = Credit mode | 0b0000110010010100 | 2 |
| Cut Off Value (INT32) | Set to 0xFFFFFFFF (do not change) | 0xFFFFFFFF | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Change Payment Mode Response (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Payment Mode Response | 0x02 | 1 |
| ZCL payload | |||
| Friendly Credit (BITMAP8) | 0b0=Friendly credit unavailable; 0b1=Friendly credit available | * | 1 |
| Friendly Credit Calendar ID (UINT32) | 2 = Non-disablement calendar | 0x00000002 | 4 |
| Emergency Credit Limit (UINT32) | Emergency credit limit | * | 4 |
| Emergency Credit Threshold (UINT32) | Emergency credit threshold | * | 4 |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Change Payment Mode if the command did not succeed | 0x06 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Change Payment Mode | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0015 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Payment Mode | 0x06 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Implementation Date/Time (UTCTime) | 0 = now; 0xFFFFFFFF = cancel | UTC Time; 0 = immediate | 4 |
| Proposed Payment Control Configuration (BITMAP16) | The 4 possible values are:; 0b0000010010010111 = Prepayment mode, Suspend Debt Emergency = True, Suspend Debt Disabled = True; 0b0000000010010111 = Prepayment mode, Suspend Debt Emergency = True, Suspend Debt Disabled = False; 0b0000110010010111 = Prepayment mode, Suspend Debt Emergency = False, Suspend Debt Disabled = True; 0b0000100010010111 = Prepayment mode, Suspend Debt Emergency = False, Suspend Debt Disabled = False | 0b0000010010010111 | 0b0000000010010111 | 0b0000110010010111 | 0b0000100010010111 | 2 |
| Cut Off Value (INT32) | Disablement Threshold; Set to 0xFFFFFFFF to leave the disablement threshold on the meter unchanged | * | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Change Payment Mode Response (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Payment Mode Response | 0x02 | 1 |
| ZCL payload | |||
| Friendly Credit (BITMAP8) | 0b0=Friendly credit unavailable; 0b1=Friendly credit available | * | 1 |
| Friendly Credit Calendar ID (UINT32) | 2 = Non-disablement calendar | 0x00000002 | 4 |
| Emergency Credit Limit (UINT32) | Emergency credit limit | * | 4 |
| Emergency Credit Threshold (UINT32) | Emergency credit threshold | * | 4 |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Change Payment Mode if the command did not succeed | 0x06 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 3 | 1 |
| Change Debt | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x001B | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Debt | 0x02 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Debt Label (OCTETSTRING) | Debt label, 0-length string | 0x00 | 1 |
| Debt Amount (INT32) | Incremental change | * | 4 |
| Debt Recovery Method (ENUM8) | 0 if time-based debt | 0x00 | 1 |
| Debt Amount Type (ENUM8) | 1 = Time-based debt (1) Incremental | 0x01 | 1 |
| Debt Recovery Start Time (UINT32) | Set = 0 | 0x00000000 | 4 |
| Debt Recovery Collection Time (UINT16) | Collect debt at midnight | 0x0000 | 2 |
| Debt Recovery Frequency (ENUM8) | 0x00 (Hourly) | 0x01 (Daily) | 0x00 | 0x01 | 1 |
| Debt Recovery Amount (INT32) | Amount to recover at each interval | * | 4 |
| Debt Recovery Balance Percentage (UINT16) | Time-based debt: set to 0 | 0x0000 | 2 |
| Change Debt | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x001B | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Debt | 0x02 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Debt Label (OCTETSTRING) | Debt label, 0-length string | 0x00 | 1 |
| Debt Amount (INT32) | Incremental change | * | 4 |
| Debt Recovery Method (ENUM8) | 0 if time-based debt | 0x00 | 1 |
| Debt Amount Type (ENUM8) | 3 = Time-based debt (2) Incremental | 0x03 | 1 |
| Debt Recovery Start Time (UINT32) | Set = 0 | 0x00000000 | 4 |
| Debt Recovery Collection Time (UINT16) | Collect debt at midnight | 0x0000 | 2 |
| Debt Recovery Frequency (ENUM8) | 0x00 (Hourly) | 0x01 (Daily) | 0x00 | 0x01 | 1 |
| Debt Recovery Amount (INT32) | Amount to recover at each interval | * | 4 |
| Debt Recovery Balance Percentage (UINT16) | Time-based debt: set to 0 | 0x0000 | 2 |
| Change Debt | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x001B | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Debt | 0x02 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Debt Label (OCTETSTRING) | Debt label, 0-length string | 0x00 | 1 |
| Debt Amount (INT32) | Incremental change | * | 4 |
| Debt Recovery Method (ENUM8) | 1 if payment-based debt | 0x01 | 1 |
| Debt Amount Type (ENUM8) | 5 = Payment-based debt Incremental | 0x05 | 1 |
| Debt Recovery Start Time (UINT32) | Set = 0 | 0x00000000 | 4 |
| Debt Recovery Collection Time (UINT16) | Collect debt at midnight | 0x0000 | 2 |
| Debt Recovery Frequency (ENUM8) | Payment Based Debt, set to 0x01 | 0x01 | 1 |
| Debt Recovery Amount (INT32) | Payment-based debt: set to 0 | 0x00000000 | 4 |
| Debt Recovery Balance Percentage (UINT16) | % amount to recover per payment | * | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 3 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Change Debt | 0x02 | 1 |
| Status (ENUM8) | Refer to ZigBee standard. A value of 'INVALID_VALUE' (0x85) will be returned in the event that the Debt Recovery Frequency specified is any other value than 0x00, 0x01, or 0xFF | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Change Debt | 0x02 | 1 |
| Status (ENUM8) | Refer to ZigBee standard. A value of 'INVALID_VALUE' (0x85) will be returned in the event that the Debt Recovery Frequency specified is any other value than 0x00, 0x01, or 0xFF | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Change Debt | 0x02 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 8-14 | 1 |
| Emergency Credit Setup | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0013 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Emergency Credit Setup | 0x03 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCTime) | 0 = now; 0xFFFFFFFF = cancel | * | 4 |
| Emergency Credit Limit (UINT32) | Emergency credit limit | * | 4 |
| Emergency Credit Threshold (UINT32) | Emergency credit threshold | * | 4 |
| Set Overall Debt Cap | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0013 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Set Overall Debt Cap | 0x0C | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Implementation Date/Time (UTCTime) | 0 = now; 0xFFFFFFFF = cancel | * | 4 |
| Overall Debt Cap (INT32) | Overall debt cap | * | 4 |
| Set Low Credit Warning Level | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x10 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x000B | 2 | |
| From Date Time | UTCTime | * | 4 |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Set Low Credit Warning Level | 0x09 | 1 |
| ZCL payload | |||
| Low Credit Warning Level (UINT32) | Low credit warning level | * | 4 |
| Set Maximum Credit Limit | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0017 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Set Maximum Credit Limit | 0x0B | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Implementation Date/Time (UTCTime) | 0 = now; 0xFFFFFFFF = cancel | * | 4 |
| Maximum Credit Level (UINT32) | The maximum meter balance | * | 4 |
| Maximum Credit Per Top Up (UINT32) | The largest value of any one credit | * | 4 |
| PublishCalendar | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0019 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishCalendar | 0x00 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCTime) | The activation date-time for this ZSE PublishCalendar command. To reflect the ZSE requirement that 'The Calendar must be replaced as a whole', this ZSE PublishCalendar command and the PublishDayProfile, PublishWeekProfile and PublishSeasons ZSE commands in this Message must all succeed or must all fail. If the activation date-time is in the future, an alert will result from the PublishCalendar ZSE command which will detail whether the Calendar was replaced or not | * | 4 |
| Calendar Type (ENUM8) | 3 = Friendly Credit Calendar | 0x03 | 1 |
| Calendar Time Reference (UINT8) | UTC time | 0x00 | 1 |
| Calendar Name (OCTETSTRING) | Calendar name, 0-length string | 0x00 | 1 |
| Number of Seasons (UINT8) | Number of seasons | * | 1 |
| Number of Week Profiles (UINT8) | Number of week profiles | * | 1 |
| Number of Day Profiles (UINT8) | Number of day profiles | * | 1 |
| PublishDayProfile (1-5 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0014 + total length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishDayProfile | 0x01 | 1 |
| ZCL payload | |||
| A separate PublishDayProfile command for each Day Profile will be sent | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set to same value as the corresponding PublishCalendar command | * | 4 |
| Day ID (UINT8) | A separate command for each Day Profile will be sent | * | 1 |
| Total Number of Schedule Entries (UINT8) | Total number of ScheduleEntries in this Day Profile | * | 1 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Calendar Type (ENUM8) | 3 = Friendly Credit Calendar | 0x03 | 1 |
| Day Schedule Entries (Refer to ZigBee spec) | Array of Day Schedule Entries. Each entry is interpreted as follows: ; Start Time (minutes from midnight, UINT16); Friendly Credit Enable (BOOLEAN) - 0x01 (Enabled) or 0x00 (not enabled) | * | * |
| PublishWeekProfile (0-2 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0017 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishWeekProfile | 0x02 | 1 |
| ZCL payload | |||
| A separate PublishWeekProfile command for each Week Profile will be sent | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set to same value as the corresponding PublishCalendar command | * | 4 |
| Week ID (UINT8) | A separate command for each Week Profile will be sent | * | 1 |
| Day ID Ref Monday (UINT8) | Reference to Day Profile for Monday | * | 1 |
| Day ID Ref Tuesday (UINT8) | Reference to Day Profile for Tuesday | * | 1 |
| Day ID Ref Wednesday (UINT8) | Reference to Day Profile for Wednesday | * | 1 |
| Day ID Ref Thursday (UINT8) | Reference to Day Profile for Thursday | * | 1 |
| Day ID Ref Friday (UINT8) | Reference to Day Profile for Friday | * | 1 |
| Day ID Ref Saturday (UINT8) | Reference to Day Profile for Saturday | * | 1 |
| Day ID Ref Sunday (UINT8) | Reference to Day Profile for Sunday | * | 1 |
| PublishSeasons | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0011 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishSeasons | 0x03 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set to same value as the corresponding PublishCalendar command | * | 4 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Season Entry (Refer to ZigBee spec) | Array of up to 3 Season Entry(s). Each entry is interpreted as follows: ; Season Start Date (Date); Week ID Ref (UINT8) | * | * |
| PublishSpecialDays | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0017 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishSpecialDays | 0x04 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | Set to same value as the corresponding PublishCalendar command | * | 4 |
| Start Time (UTCTime) | Date/time these special days are active; 0 = immediate | * | 4 |
| Calendar Type (ENUM8) | 3 = Friendly Credit Calendar | 0x03 | 1 |
| Total Number of SpecialDays (UINT8) | Number of Special Days | * | 1 |
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single command | 0x01 | 1 |
| Special Day Entry (Refer to ZigBee spec) | Array of between 0 and 20 Special Day Entry(s). Each entry is interpreted as follows: ; Special Day Date (Date); Day ID Ref (UINT8) | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 8-14 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Emergency Credit Setup | 0x03 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Set Overall Debt Cap | 0x0C | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Set Low Credit Warning Level | 0x09 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Set Maximum Credit Limit | 0x0B | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishCalendar | 0x00 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response (1-5 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishDayProfile | 0x01 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response (0-2 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishWeekProfile | 0x02 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishSeasons | 0x03 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishSpecialDays | 0x04 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Select Available Emergency Credit | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0008 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Select Available Emergency Credit | 0x00 | 1 |
| ZCL payload | |||
| Command Issue Date/ Time (UTCTime) | Date and time command is issued, set = 0 | 0x00000000 | 4 |
| Originating Device (ENUM8) | Source: 0x00=Energy Service Interface | 0x00 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Select Available Emergency Credit | 0x00 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Display Message | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0703 | 2 | |
| Extended Header GBZ Command Length | 0x000E + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Display Message | 0x00 | 1 |
| ZCL payload | |||
| Message ID (UINT32) | Use UTC timestamp of current date and time | * | 4 |
| Message Control (BITMAP8) | Normal transmission only; low importance; no confirmation required | 0x00 | 1 |
| Start Time (UTCtime) | 0 = now | * | 4 |
| Duration In Minutes (UINT16) | Duration in minutes, 0xFFFF = 'until changed' | 0xFFFF | 2 |
| Message (CHARSTRING) | Message, 1-116 characters | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0703 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Display Message | 0x00 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Publish Change of Tenancy | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0014 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Change of Tenancy | 0x00 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Tariff Type (BITMAP8 (NIBBLES)) | Most significant nibble is 0x0 (Reserved) and least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 1 |
| Implementation Date/Time (UTCtime) | Retrospective or in the future | * | 4 |
| Proposed Tenancy Change Control (BITMAP32) | 0x00000200 = Clear IHD Data - Consumer | 0x00000200 | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Publish Change of Tenancy | 0x00 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Request New Password Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x000F | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Request New Password Response | 0x02 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Implementation Date/Time (UTCTime) | Set to 0 to execute immediately | 0x00000000 | 4 |
| Duration in minutes (UINT16) | PIN is valid until changed | 0x0000 | 2 |
| Password Type (ENUM8) | 2 = access to the consumer menu | 0x02 | 1 |
| Password (OCTETSTRING) | Password, 0-length string | 0x00 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Request New Password Response | 0x02 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x000B | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Divisor | 0x0302 | 2 |
| Attribute Identifier (ENUM16) | Multiplier | 0x0301 | 2 |
| Attribute Identifier (ENUM16) | Unit of Measure | 0x0300 | 2 |
| Attribute Identifier (ENUM16) | Reading Information: CurrentSummationDelivered | 0x0000 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0024 + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; disable default response; | 0b00011000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Attribute Identifier (ENUM16) | Divisor | 0x0302 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 24-bit integer | 0x22 | * |
Omitted if unsuccessful Attribute Value (UINT24) | Divisor | * | * |
| Attribute Identifier (ENUM16) | Multiplier | 0x0301 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 24-bit integer | 0x22 | * |
Omitted if unsuccessful Attribute Value (UINT24) | Multiplier | * | * |
| Attribute Identifier (ENUM16) | Unit of Measure | 0x0300 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | m3 | 0x01 | * |
| Attribute Identifier (ENUM16) | Reading Information: CurrentSummationDelivered | 0x0000 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Consumption register | * | * |
| AE MAC | * | 12 | |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0011 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | CurrentNoTierBlock1SummationDelivered | 0x0700 | 2 |
| Attribute Identifier (ENUM16) | CurrentNoTierBlock2SummationDelivered | 0x0701 | 2 |
| Attribute Identifier (ENUM16) | CurrentNoTierBlock3SummationDelivered | 0x0702 | 2 |
| Attribute Identifier (ENUM16) | CurrentNoTierBlock4SummationDelivered | 0x0703 | 2 |
| Attribute Identifier (ENUM16) | Divisor | 0x0302 | 2 |
| Attribute Identifier (ENUM16) | Multiplier | 0x0301 | 2 |
| Attribute Identifier (ENUM16) | Unit of Measure | 0x0300 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x002D + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; disable default response; | 0b00011000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Attribute Identifier (ENUM16) | CurrentNoTierBlock1SummationDelivered | 0x0700 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Tariff Block Counter (1) | * | * |
| Attribute Identifier (ENUM16) | CurrentNoTierBlock2SummationDelivered | 0x0701 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Tariff Block Counter (2) | * | * |
| Attribute Identifier (ENUM16) | CurrentNoTierBlock3SummationDelivered | 0x0702 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Tariff Block Counter (3) | * | * |
| Attribute Identifier (ENUM16) | CurrentNoTierBlock4SummationDelivered | 0x0703 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Tariff Block Counter (4) | * | * |
| Attribute Identifier (ENUM16) | Divisor | 0x0302 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 24-bit integer | 0x22 | * |
Omitted if unsuccessful Attribute Value (UINT24) | Divisor | * | * |
| Attribute Identifier (ENUM16) | Multiplier | 0x0301 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 24-bit integer | 0x22 | * |
Omitted if unsuccessful Attribute Value (UINT24) | Multiplier | * | * |
| Attribute Identifier (ENUM16) | Unit of Measure | 0x0300 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | m3 | 0x01 | * |
| AE MAC | * | 12 | |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0011 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Divisor | 0x0302 | 2 |
| Attribute Identifier (ENUM16) | Multiplier | 0x0301 | 2 |
| Attribute Identifier (ENUM16) | Unit of Measure | 0x0300 | 2 |
| Attribute Identifier (ENUM16) | CurrentTier1SummationDelivered | 0x0100 | 2 |
| Attribute Identifier (ENUM16) | CurrentTier2SummationDelivered | 0x0102 | 2 |
| Attribute Identifier (ENUM16) | CurrentTier3SummationDelivered | 0x0104 | 2 |
| Attribute Identifier (ENUM16) | CurrentTier4SummationDelivered | 0x0106 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x002D + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; disable default response; | 0b00011000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Attribute Identifier (ENUM16) | Divisor | 0x0302 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 24-bit integer | 0x22 | * |
Omitted if unsuccessful Attribute Value (UINT24) | Divisor | * | * |
| Attribute Identifier (ENUM16) | Multiplier | 0x0301 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 24-bit integer | 0x22 | * |
Omitted if unsuccessful Attribute Value (UINT24) | Multiplier | * | * |
| Attribute Identifier (ENUM16) | Unit of Measure | 0x0300 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | m3 | 0x01 | * |
| Attribute Identifier (ENUM16) | CurrentTier1SummationDelivered | 0x0100 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Tariff TOU Register Matrix (1) | * | * |
| Attribute Identifier (ENUM16) | CurrentTier2SummationDelivered | 0x0102 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Tariff TOU Register Matrix (2) | * | * |
| Attribute Identifier (ENUM16) | CurrentTier3SummationDelivered | 0x0104 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Tariff TOU Register Matrix (3) | * | * |
| Attribute Identifier (ENUM16) | CurrentTier4SummationDelivered | 0x0106 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Tariff TOU Register Matrix (4) | * | * |
| AE MAC | * | 12 | |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0007 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Tariff Information: Price Trailing Digit | 0x0617 | 2 |
| Attribute Identifier (ENUM16) | Tariff Information: Currency | 0x0616 | 2 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x000F | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Prepayment Information: Accumulated Debt | 0x0005 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: EmergencyCreditRemaining | 0x0002 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: Credit Remaining | 0x0001 | 2 |
| Attribute Identifier (ENUM16) | Payment-based Debt | 0x0231 | 2 |
| Attribute Identifier (ENUM16) | Time-based Debt (1) | 0x0211 | 2 |
| Attribute Identifier (ENUM16) | Time-based Debt (2) | 0x0221 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0009 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Tariff Information: Price Trailing Digit | 0x0617 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit bitmap | 0x18 | * |
Omitted if unsuccessful Attribute Value (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point | 0x50 | * |
| Attribute Identifier (ENUM16) | Tariff Information: Currency | 0x0616 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 16-bit integer | 0x21 | * |
Omitted if unsuccessful Attribute Value (UINT16) | 0x033A = 826 = GBP; 0x03D2 = 978 = Euro | 0x033A | 0x03D2 | * |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x002A + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Attribute Identifier (ENUM16) | Prepayment Information: Accumulated Debt | 0x0005 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Signed 32-bit integer | 0x2B | * |
Omitted if unsuccessful Attribute Value (INT32) | Accumulated debt | * | * |
| Attribute Identifier (ENUM16) | Prepayment Information: EmergencyCreditRemaining | 0x0002 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Signed 32-bit integer | 0x2B | * |
Omitted if unsuccessful Attribute Value (INT32) | Emergency credit balance | * | * |
| Attribute Identifier (ENUM16) | Prepayment Information: Credit Remaining | 0x0001 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Signed 32-bit integer | 0x2B | * |
Omitted if unsuccessful Attribute Value (INT32) | Meter balance | * | * |
| Attribute Identifier (ENUM16) | Debt Attribute: DebtAmount#3 | 0x0231 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Payment-based Debt | * | * |
| Attribute Identifier (ENUM16) | Debt Attribute: DebtAmount#1 | 0x0211 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Time-based Debt (1) | * | * |
| Attribute Identifier (ENUM16) | Debt Attribute: DebtAmount#2 | 0x0221 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Time-based Debt (2) | * | * |
| AE MAC | * | 12 | |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 24 | 1 |
| Get Prepay Snapshot (12 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Get Prepay Snapshot | 0x07 | 1 |
| ZCL payload | |||
| Earliest Start Time (UTCTime) | Earliest Start Time (this must have the same value as the other fromDateTime in this Use Case) | * | 4 |
| Latest End Time (UTCTime) | Latest End Time (this must have the same value as the other toDateTime in this Use Case) | * | 4 |
| Snapshot Offset (UINT8) | Repeat x12 using this field as an index [0..11] to request 12 snapshots | 0-11 | 1 |
| Snapshot Cause (BITMAP32) | 0x00006008 (Change of Meter Mode | Change of Supplier | Tariff Information) | 0x00006008 | 4 |
| GetSnapshot (12 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSnapshot | 0x06 | 1 |
| ZCL payload | |||
| Earliest Start Time (UTCTime) | Earliest Start Time (this must have the same value as the other fromDateTime in this Use Case) | * | 4 |
| Latest End Time (UTCTime) | Latest End Time (this must have the same value as the other toDateTime in this Use Case) | * | 4 |
| Snapshot Offset (UINT8) | Repeat x12 using this field as an index [0..11] to request 12 snapshots | 0-11 | 1 |
| Snapshot Cause (BITMAP32) | 0x00006008 (Change of Meter Mode | Change of Supplier | Tariff Information) | 0x00006008 | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 24 | 1 |
| Publish Prepay Snapshot (0-12 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x02 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0028 + total length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | * (see GBCS section 7.2.10) | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Prepay Snapshot | 0x01 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Snapshot ID (UINT32) | Generated by device | * | 4 |
| Snapshot Time (UTCTime) | Time when the snapshot was taken | * | 4 |
| Total Snapshots Found (UINT8) | Total number of snapshots found matching the request | * | 1 |
| Command Index (UINT8) | Entire payload returned in 1 command | 0x00 | 1 |
| Total Number of Commands (UINT8) | 0x01 | 1 | |
| Snapshot Cause (BITMAP32) | Refer to ZigBee standard | * | 4 |
| Snapshot Payload Type (ENUM8) | Debt/Credit Status | 0x00 | 1 |
| Snapshot Payload (Refer to ZigBee spec) | The parameters in log entries shall be mapped to SMETS values as follows: ; ZSE Accumulated Debt = SMETS Accumulated Debt Register; ZSE Type 1 Debt Remaining = SMETS Time Debt Registers [1]; ZSE Type 2 Debt Remaining = SMETS Time Debt Registers [2]; ZSE Type 3 Debt Remaining = SMETS Payment Debt Register; ZSE Emergency Credit Remaining = SMETS Emergency Credit Balance; ZSE Credit Remaining = SMETS Meter Balance | * | * |
| AE MAC | * | 12 | |
| Alternate response: the number of these will be such that the total number of responses to GetSnapshot/Get Prepay Snapshot will equal 12 | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Get Prepay Snapshot if no records found | 0x07 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Publish Snapshot (0-12 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x02|0x03(last message) | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0028 + total length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | * (see GBCS section 7.2.10) | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Snapshot | 0x06 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Snapshot ID (UINT32) | Generated by device | * | 4 |
| Snapshot Time (UTCTime) | Time when snapshot was taken | * | 4 |
| Total Snapshots Found (UINT8) | Total number of snapshots found matching the request | * | 1 |
| Command Index (UINT8) | Entire payload returned in 1 command | 0x00 | 1 |
| Total Number of Commands (UINT8) | 0x01 | 1 | |
| Snapshot Cause (BITMAP32) | Refer to ZigBee standard | * | 4 |
| Snapshot Payload Type (ENUM8) | SnapshotPayloadType = 6 | 0x06 | 1 |
| SnapshotSub-Payload (Refer to ZigBee spec) | In the SnapshotSub-Payload: the 'Number of Tiers in Use' shall be set to 0x04; the 'Tier Summation' values shall contain all four register values from the Tariff TOU Register Matrix; the 'Number of Tiers and Block Thresholds in Use' shall be set to 0x14; and the 'Tier Block Summation' values shall contain all four register values from the Tariff Block Counter Matrix | * | * |
| AE MAC | * | 12 | |
| Alternate response: the number of these will be such that the total number of responses to GetSnapshot/Get Prepay Snapshot will equal 12 | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSnapshot if no events found | 0x06 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 24 | 1 |
| GetSnapshot (12 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSnapshot | 0x06 | 1 |
| ZCL payload | |||
| Earliest Start Time (UTCTime) | Earliest Start Time (this must have the same value as the other fromDateTime in this Use Case) | * | 4 |
| Latest End Time (UTCTime) | Latest End Time (this must have the same value as the other toDateTime in this Use Case) | * | 4 |
| Snapshot Offset (UINT8) | Repeat x12 using this field as an index [0..11] to request 12 snapshots | 0-11 | 1 |
| Snapshot Cause (BITMAP32) | 0x00000002 (End of Billing Period) | 0x00000002 | 4 |
| Get Prepay Snapshot (12 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Get Prepay Snapshot | 0x07 | 1 |
| ZCL payload | |||
| Earliest Start Time (UTCTime) | Earliest Start Time (this must have the same value as the other fromDateTime in this Use Case) | * | 4 |
| Latest End Time (UTCTime) | Latest End Time (this must have the same value as the other toDateTime in this Use Case) | * | 4 |
| Snapshot Offset (UINT8) | Repeat x12 using this field as an index [0..11] to request 12 snapshots | 0-11 | 1 |
| Snapshot Cause (BITMAP32) | 0x00000002 (End of Billing Period) | 0x00000002 | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 24 | 1 |
| Publish Snapshot (0-12 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x02 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0028 + total length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | * (see GBCS section 7.2.10) | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Snapshot | 0x06 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Snapshot ID (UINT32) | Generated by device | * | 4 |
| Snapshot Time (UTCTime) | Time when the snapshot was taken | * | 4 |
| Total Snapshots Found (UINT8) | Total number of snapshots found matching the request | * | 1 |
| Command Index (UINT8) | Entire payload returned in 1 command | 0x00 | 1 |
| Total Number of Commands (UINT8) | 0x01 | 1 | |
| Snapshot Cause (BITMAP32) | Refer to ZigBee standard | * | 4 |
| Snapshot Payload Type (ENUM8) | SnapshotPayloadType = 6 | 0x06 | 1 |
| SnapshotSub-Payload (Refer to ZigBee spec) | In the SnapshotSub-Payload: the 'Number of Tiers in Use' shall be set to 0x04; the 'Tier Summation' values shall contain all four register values from the Tariff TOU Register Matrix; the 'Number of Tiers and Block Thresholds in Use' shall be set to 0x14; and the 'Tier Block Summation' values shall contain all four register values from the Tariff Block Counter Matrix | * | * |
| AE MAC | * | 12 | |
| Alternate response: the number of these will be such that the total number of responses to GetSnapshot/Get Prepay Snapshot will equal 12 | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSnapshot if no events found | 0x06 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Publish Prepay Snapshot (0-12 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x02|0x03(last message) | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0028 + total length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | * (see GBCS section 7.2.10) | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Prepay Snapshot | 0x01 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Snapshot ID (UINT32) | Generated by device | * | 4 |
| Snapshot Time (UTCTime) | Time when the snapshot was taken | * | 4 |
| Total Snapshots Found (UINT8) | Total number of snapshots found matching the request | * | 1 |
| Command Index (UINT8) | Entire payload returned in 1 command | 0x00 | 1 |
| Total Number of Commands (UINT8) | 0x01 | 1 | |
| Snapshot Cause (BITMAP32) | Refer to ZigBee standard | * | 4 |
| Snapshot Payload Type (ENUM8) | Debt/Credit Status | 0x00 | 1 |
| Snapshot Payload (Refer to ZigBee spec) | Each log entry is interpreted as follows: ; Accumulated Debt = Accumulated Debt Register; Type 1 Debt Remaining = Time Debt Registers [1]; Type 2 Debt Remaining = Time Debt Registers [2]; Type 3 Debt Remaining = Payment Debt Register; Emergency Credit Remaining = Emergency Credit Balance; Credit Remaining = Meter Balance | * | * |
| AE MAC | * | 12 | |
| Alternate response: the number of these will be such that the total number of responses to GetSnapshot/Get Prepay Snapshot will equal 12 | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Get Prepay Snapshot if no records found | 0x07 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Get Debt Repayment Log | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x11 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| From Date Time | UTCTime | * | 4 |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Get Debt Repayment Log | 0x0A | 1 |
| ZCL payload | |||
| Latest End Time (UTCTime) | Set to 0xFFFFFFFE to retrieve all entries | * | 4 |
| Number of Debts (UINT8) | Maximum of 10 entries | 0x0A | 1 |
| Debt Type (ENUM8) | Payment-based Debt | 0x02 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Publish Debt Log (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x001A + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Debt Log | 0x06 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Command Index (UINT8) | Entire payload returned in 1 command | 0x00 | 1 |
| Total Number of Commands (UINT8) | Entire payload returned in 1 command | 0x01 | 1 |
| Debt Payload (Refer to ZigBee spec) | BillingDataLog(mostrecentPaymentBasedDebtRepayment). Refer to ZigBee standard | * | * |
| AE MAC | * | 12 | |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Get Debt Repayment Log (payment-based debt) if no records found | 0x0A | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Get Top Up Log | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x11 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x000C | 2 | |
| From Date Time | UTCTime | * | 4 |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Get Top Up Log | 0x08 | 1 |
| ZCL payload | |||
| Latest End Time (UTCTime) | Latest End Time (this must have the same value as the other toDateTime in this Use Case) | * | 4 |
| Number of Records (UINT8) | Maximum of 5 entries | 0x05 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Publish Top Up Log (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Top Up Log | 0x05 | 1 |
| ZCL payload | |||
| Command Index (UINT8) | 0x00 | 1 | |
| Total Number of Commands (UINT8) | 0x01 | 1 | |
| Top Up Payload (Refer to ZigBee spec) | BillingDataLog(mostrecentPrepaymentCredits) | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Get Top Up Log if no records found | 0x08 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 31 | 1 |
| GetSnapshot (31 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSnapshot | 0x06 | 1 |
| ZCL payload | |||
| Earliest Start Time (UTCTime) | Earliest start time | * | 4 |
| Latest End Time (UTCTime) | Latest end time | * | 4 |
| Snapshot Offset (UINT8) | Repeat x31 using this field as an index [0..30] to request 31 snapshots | 0-30 | 1 |
| Snapshot Cause (BITMAP32) | 0x00000001 (General) | 0x00000001 | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 31 | 1 |
| Publish Snapshot (0-31 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x02|0x03(last message) | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0028 + total length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | * (see GBCS section 7.2.10) | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Snapshot | 0x06 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Snapshot ID (UINT32) | Generated by device | * | 4 |
| Snapshot Time (UTCTime) | Time when the snapshot was taken | * | 4 |
| Total Snapshots Found (UINT8) | Total number of snapshots found matching the request | * | 1 |
| Command Index (UINT8) | Entire payload returned in 1 command | 0x00 | 1 |
| Total Number of Commands (UINT8) | 0x01 | 1 | |
| Snapshot Cause (BITMAP32) | Refer to ZigBee standard | * | 4 |
| Snapshot Payload Type (ENUM8) | SnapshotPayloadType = 6 | 0x06 | 1 |
| SnapshotSub-Payload (Refer to ZigBee spec) | In the SnapshotSub-Payload: the 'Number of Tiers in Use' shall be set to 0x04; the 'Tier Summation' values shall contain all four register values from the Tariff TOU Register Matrix; the 'Number of Tiers and Block Thresholds in Use' shall be set to 0x14; and the 'Tier Block Summation' values shall contain all four register values from the Tariff Block Counter Matrix | * | * |
| AE MAC | * | 12 | |
| Alternate response: the number of these will be such that the total number of responses to GetSnapshot/Get Prepay Snapshot will equal 31 | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSnapshot if no records found | 0x06 | 1 |
| Status (ENUM8) | NOT_FOUND (no error); Refer to ZigBee standard for error responses | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 31 | 1 |
| Get Prepay Snapshot (31 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Get Prepay Snapshot | 0x07 | 1 |
| ZCL payload | |||
| Earliest Start Time (UTCTime) | Earliest start time | * | 4 |
| Latest End Time (UTCTime) | Latest end time | * | 4 |
| Snapshot Offset (UINT8) | Repeat x31 using this field as an index [0..30] to request 31 snapshots | 0-30 | 1 |
| Snapshot Cause (BITMAP32) | 0x00000001 (General) | 0x00000001 | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 31 | 1 |
| Publish Prepay Snapshot (0-31 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x02|0x03(last message) | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0028 + total length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | * (see GBCS section 7.2.10) | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Prepay Snapshot | 0x01 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Snapshot ID (UINT32) | Generated by device | * | 4 |
| Snapshot Time (UTCTime) | Time when the snapshot was taken | * | 4 |
| Total Snapshots Found (UINT8) | Total number of snapshots found matching the request | * | 1 |
| Command Index (UINT8) | Entire payload returned in 1 command | 0x00 | 1 |
| Total Number of Commands (UINT8) | 0x01 | 1 | |
| Snapshot Cause (BITMAP32) | Refer to ZigBee standard | * | 4 |
| Snapshot Payload Type (ENUM8) | Debt/Credit Status | 0x00 | 1 |
| Snapshot Payload (Refer to ZigBee spec) | PrepaymentDailyReadLog. Each log entry is interpreted as follows: ; Accumulated Debt = Accumulated Debt Register; Type 1 Debt Remaining = Time Debt Registers [1]; Type 2 Debt Remaining = Time Debt Registers [2]; Type 3 Debt Remaining = Payment Debt Register; Emergency Credit Remaining = Emergency Credit Balance; Credit Remaining = Meter Balance | * | * |
| AE MAC | * | 12 | |
| Alternate response: the number of these will be such that the total number of responses to GetSnapshot/Get Prepay Snapshot will equal 31 | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Get Prepay Snapshot if no records found | 0x07 | 1 |
| Status (ENUM8) | NOT_FOUND (no error); Refer to ZigBee standard for error responses | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| GetSampledData | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x000C | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSampledData | 0x08 | 1 |
| ZCL payload | |||
| SampleID (UINT16) | 0 = Profile Data Log | 0x0000 | 2 |
| EarliestSampleTime (UTCTime) | Sample Start Time | * | 4 |
| SampleType (ENUM8) | 0 = Consumption Delivered | 0x00 | 1 |
| NumberOfSamples (UINT16) | 1-19056 | * | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| GetSampledDataResponse | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0023 + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSampledDataResponse | 0x07 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| SampleID (UINT16) | 0 = Profile Data Log | 0x0000 | 2 |
| SampleStartTime (UTCTime) | Sample Start Time | * | 4 |
| SampleType (ENUM8) | 0 = Consumption Delivered | 0x00 | 1 |
| SampleRequestInterval (UINT16) | Time in seconds between samples | 0x0708 | 2 |
| NumberOfSamples (UINT16) | 1-19056 | * | 2 |
| Samples (Refer to ZigBee spec) | Profile Data Log: Array of UINT24 | * | * |
| AE MAC | * | 12 | |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSampledData if no records found | 0x08 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| GetSampledData | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x000C | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSampledData | 0x08 | 1 |
| ZCL payload | |||
| SampleID (UINT16) | 2 = Network Data Log | 0x0002 | 2 |
| EarliestSampleTime (UTCTime) | Date/time of first sampled data to be returned | 0x00000001 | 4 |
| SampleType (ENUM8) | 0 = Consumption Delivered | 0x00 | 1 |
| NumberOfSamples (UINT16) | 4-hours of 6-minute samples inclusive | 41 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| GetSampledDataResponse (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0023 + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSampledDataResponse | 0x07 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| SampleID (UINT16) | 2 = Network Data Log | 0x0002 | 2 |
| SampleStartTime (UTCTime) | Time of first sample returned | * | 4 |
| SampleType (ENUM8) | 0 = Consumption Delivered | 0x00 | 1 |
| SampleRequestInterval (UINT16) | Time in seconds between samples | 0x0168 | 2 |
| NumberOfSamples (UINT16) | Up to 41 samples | 1-41 | 2 |
| Samples (Refer to ZigBee spec) | Network Data Log: Series of intervals as unsigned 24-bit values | * | * |
| AE MAC | * | 12 | |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSampledData if no records found | 0x08 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1-n | 1 |
| SetEventConfiguration (1-n instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x000D + total length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | SetEventConfiguration | 0x04 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Date/Time (UTCTime) | Set to 0 to execute immediately | 0x00000000 | 4 |
| Event Configuration (BITMAP8) | Bits 0-2 shall be set to 0b000 (do not log, if not logging is permitted by GBCS for these Event IDs), or 0b011 (log, if logging is permitted by GBCS for these Event IDs).; Bit 3 to 0b0 (do not alert to WAN, if not alerting is permitted by GBCS for these Event IDs) or 0b1 (alert to WAN, if alerting is permitted by GBCS for these Event IDs); Bit 4 to 0b0 (do not alert to HAN, if not alerting is permitted by GBCS for these Event IDs) or 0b1 (alert to HAN, if alerting is permitted by GBCS for these Event IDs); Bit 5 to 0b0; Bit 6 to 0b0 (do not raise Alarm, if not alarming is permitted by GBCS for these Event IDs) or 0b1 (raise Alarm, if alarming is permitted by GBCS for these Event IDs); Bit 7 to 0b0 | * | 1 |
| Configuration Control (ENUM8) | Apply by List | 0x00 | 1 |
| Event Configuration Payload (Refer to ZigBee spec) | Since Configuration Control is 0x00 ('Apply by List'), this parameter has the 'Apply by List' Sub-Payload structure. The Event ID values shall be the Event / Alert Code values from Section 16 of the GBCS (Column D in the embedded table) | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1-n | 1 |
| Default Response (1-n instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00|0x01(last message) | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to SetEventConfiguration | 0x04 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| GetEventConfiguration | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetEventConfiguration | 0x05 | 1 |
| ZCL payload | |||
| Event ID (UINT16) | To be interpreted as the Event Group ID for all events / alert codes starting 0x81, as supported by the GSME | 0x81FF | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Report Event Configuration | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0005 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Report Event Configuration | 0x04 | 1 |
| ZCL payload | |||
| Command Index (UINT8) | A single command | 0x00 | 1 |
| Total Commands (UINT8) | A single command | 0x01 | 1 |
| Event Configuration Payload (Refer to ZigBee spec) | Shall contain all Event IDs supported by the GSME which start 0x81 and, for each, the corresponding Event Configuration Bitmap. Note: the following text from the ZSE specification for this field shall be disregarded (since it does not appear relevant to this field): 'The log payload is a series of events, in time sequential order. The event payload consists of the logged events and detailed within the event configuration attribute list:' [DN: to raise with ZigBee alliance] | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Commodity: Calorific Value Trailing Digit | 0x0306 | 2 |
| Attribute Identifier (ENUM16) | Commodity: CalorificValueUnit | 0x0305 | 2 |
| Attribute Identifier (ENUM16) | Commodity: CalorificValue | 0x0304 | 2 |
| Attribute Identifier (ENUM16) | Commodity: ConversionFactorTrailingDigit | 0x0303 | 2 |
| Attribute Identifier (ENUM16) | Commodity: ConversionFactor | 0x0302 | 2 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x000F | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Supply Control: Uncontrolled Flow Divisor | 0x0B13 | 2 |
| Attribute Identifier (ENUM16) | Supply Control: Uncontrolled Flow Multiplier | 0x0B12 | 2 |
| Attribute Identifier (ENUM16) | Supply Control: Uncontrolled Flow Threshold Unit of Measure | 0x0B11 | 2 |
| Attribute Identifier (ENUM16) | Supply Control: Uncontrolled Flow Threshold | 0x0B10 | 2 |
| Attribute Identifier (ENUM16) | Supply Control: Flow Stabilisation Period | 0x0B14 | 2 |
| Attribute Identifier (ENUM16) | Supply Control: Flow Measurement Period | 0x0B15 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0012 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Commodity: Calorific Value Trailing Digit | 0x0306 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit bitmap | 0x18 | * |
Omitted if unsuccessful Attribute Value (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point | * | * |
| Attribute Identifier (ENUM16) | Commodity: CalorificValueUnit | 0x0305 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | MJ/m3 | 0x01 | * |
| Attribute Identifier (ENUM16) | Commodity: CalorificValue | 0x0304 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Calorific Value | * | * |
| Attribute Identifier (ENUM16) | Commodity: ConversionFactorTrailingDigit | 0x0303 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit bitmap | 0x18 | * |
Omitted if unsuccessful Attribute Value (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point | * | * |
| Attribute Identifier (ENUM16) | Commodity: ConversionFactor | 0x0302 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Conversion factor | * | * |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0015 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Supply Control: Uncontrolled Flow Divisor | 0x0B13 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 16-bit integer | 0x21 | * |
Omitted if unsuccessful Attribute Value (UINT16) | Divisor | * | * |
| Attribute Identifier (ENUM16) | Supply Control: Uncontrolled Flow Multiplier | 0x0B12 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 16-bit integer | 0x21 | * |
Omitted if unsuccessful Attribute Value (UINT16) | Multiplier | * | * |
| Attribute Identifier (ENUM16) | Supply Control: Uncontrolled Flow Threshold Unit of Measure | 0x0B11 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | m3/h | 0x01 | * |
| Attribute Identifier (ENUM16) | Supply Control: Uncontrolled Flow Threshold | 0x0B10 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 16-bit integer | 0x21 | * |
Omitted if unsuccessful Attribute Value (UINT16) | Uncontrolled Gas Flow Rate | * | * |
| Attribute Identifier (ENUM16) | Supply Control: Flow Stabilisation Period | 0x0B14 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 8-bit integer | 0x20 | * |
Omitted if unsuccessful Attribute Value (UINT8) | Flow Stabilisation Period | * | * |
| Attribute Identifier (ENUM16) | Supply Control: Flow Measurement Period | 0x0B15 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 16-bit integer | 0x21 | * |
Omitted if unsuccessful Attribute Value (UINT16) | Flow Measurement Period | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 6 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x001B | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Debt Attribute: DebtRecoveryTopUpPercentage#3 | 0x0239 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: OverallDebtCap | 0x0006 | 2 |
| Attribute Identifier (ENUM16) | Debt: DebtRecoveryFrequency#1 | 0x0216 | 2 |
| Attribute Identifier (ENUM16) | Debt: DebtRecoveryFrequency#2 | 0x0226 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: CutOffValue | 0x0040 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: EmergencyCreditLimit | 0x0010 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: EmergencyCreditThreshold | 0x0011 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: LowCreditWarningLevel | 0x0031 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: MaxCreditLimit | 0x0021 | 2 |
| Attribute Identifier (ENUM16) | Prepayment Information: MaxCreditPerTopUp | 0x0022 | 2 |
| Attribute Identifier (ENUM16) | Debt Attribute: DebtRecoveryAmount#1 | 0x0217 | 2 |
| Attribute Identifier (ENUM16) | Debt Attribute: DebtRecoveryAmount#2 | 0x0227 | 2 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Price Trailing Digits | 0x0617 | 2 |
| GetDayProfiles | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetDayProfiles | 0x01 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Calendar ID (UINT32) | 0xFFFFFFFE = Return the current Non-Disablement Calendar | 0xFFFFFFFE | 4 |
| Start Day Id (UINT8) | Read all day profiles | 0x01 | 1 |
| Number of Days (UINT8) | Read all day profiles | 0x00 | 1 |
| GetWeekProfiles | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetWeekProfiles | 0x02 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Calendar ID (UINT32) | 0xFFFFFFFE = Return the current Non-Disablement Calendar | 0xFFFFFFFE | 4 |
| Start Week Id (UINT8) | Read all week profiles | 0x01 | 1 |
| Number of Weeks (UINT8) | Read all week profiles | 0x00 | 1 |
| GetSeasons | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x000B | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSeasons | 0x03 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Calendar ID (UINT32) | 0xFFFFFFFE = Return the current Non-Disablement Calendar | 0xFFFFFFFE | 4 |
| GetSpecialDays | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0011 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSpecialDays | 0x04 | 1 |
| ZCL payload | |||
| Start Time (UTCTime) | Return all active/pending Special Days | 0x00000000 | 4 |
| Number of Events (UINT8) | Return all active/pending Special Days | 0x00 | 1 |
| Calendar Type (ENUM8) | 3 = Friendly Credit Calendar | 0x03 | 1 |
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Calendar ID (UINT32) | 0xFFFFFFFE = Return the current Non-Disablement Calendar | 0xFFFFFFFE | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 6-11 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0027 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Debt Attribute: DebtRecoveryTopUpPercentage#3 | 0x0239 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 16-bit integer | 0x21 | * |
Omitted if unsuccessful Attribute Value (UINT16) | Debt recovery vend percentage | * | * |
| Attribute Identifier (ENUM16) | Prepayment Information: OverallDebtCap | 0x0006 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Signed 32-bit integer | 0x2B | * |
Omitted if unsuccessful Attribute Value (INT32) | Debt recovery rate cap | * | * |
| Attribute Identifier (ENUM16) | Debt: DebtRecoveryFrequency#1 | 0x0216 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | Hourly | Daily | 0x00 | 0x01 | * |
| Attribute Identifier (ENUM16) | Debt: DebtRecoveryFrequency#2 | 0x0226 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | Hourly | Daily | 0x00 | 0x01 | * |
| Attribute Identifier (ENUM16) | Prepayment Information: CutOffValue | 0x0040 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Signed 32-bit integer | 0x2B | * |
Omitted if unsuccessful Attribute Value (INT32) | Cut off value | * | * |
| Attribute Identifier (ENUM16) | Prepayment Information: EmergencyCreditLimit | 0x0010 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Emergency credit limit | * | * |
| Attribute Identifier (ENUM16) | Prepayment Information: EmergencyCreditThreshold | 0x0011 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Emergency credit threshold | * | * |
| Attribute Identifier (ENUM16) | Prepayment Information: LowCreditWarningLevel | 0x0031 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Low credit threshold | * | * |
| Attribute Identifier (ENUM16) | Prepayment Information: MaxCreditLimit | 0x0021 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Maximum meter balance | * | * |
| Attribute Identifier (ENUM16) | Prepayment Information: MaxCreditPerTopUp | 0x0022 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Maximum meter balance | * | * |
| Attribute Identifier (ENUM16) | Debt Attribute: DebtRecoveryAmount#1 | 0x0217 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | DebtRecoveryRates[1]: amount | * | * |
| Attribute Identifier (ENUM16) | Debt Attribute: DebtRecoveryAmount#2 | 0x0227 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | DebtRecoveryRates[2]: amount | * | * |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0006 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Price Trailing Digits | 0x0617 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8 bit Bitmap | 0x18 | * |
Omitted if unsuccessful Attribute Value (BITMAP8) | Most significant nibble = digits to right of decimal point. Price is in millipence | * | * |
| PublishDayProfile (0-5 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0014 + total length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishDayProfile | 0x01 | 1 |
| ZCL payload | |||
| A separate PublishDayProfile response for each Day Profile will be returned by this command | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | * | 4 | |
| Day ID (UINT8) | A separate response for each Day Profile | * | 1 |
| Total Number of Schedule Entries (UINT8) | Total number of ScheduleEntries in this Day Profile | * | 1 |
| Command Index (UINT8) | A single response for each Day Profile | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single response for each Day Profile | 0x01 | 1 |
| Calendar Type (UINT8) | 3 = Friendly Credit Calendar | 0x03 | 1 |
| Day Schedule Entries (Refer to ZigBee spec) | Array of Day Schedule Entries. Each entry is interpreted as follows: ; Start Time (minutes from midnight, UINT16); Friendly Credit Enable (BOOLEAN) - 0x01 (Enabled) or 0x00 (not enabled) | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetDayProfiles if no records found | 0x01 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| PublishWeekProfile (0-2 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0017 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishWeekProfile | 0x02 | 1 |
| ZCL payload | |||
| A separate PublishWeekProfile response for each Week Profile will be returned by this command | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | * | 4 | |
| Week ID (UINT8) | A separate response for each Day Profile | * | 1 |
| Day ID Ref Monday (UINT8) | Reference to Day Profile for Monday | * | 1 |
| Day ID Ref Tuesday (UINT8) | Reference to Day Profile for Tuesday | * | 1 |
| Day ID Ref Wednesday (UINT8) | Reference to Day Profile for Wednesday | * | 1 |
| Day ID Ref Thursday (UINT8) | Reference to Day Profile for Thursday | * | 1 |
| Day ID Ref Friday (UINT8) | Reference to Day Profile for Friday | * | 1 |
| Day ID Ref Saturday (UINT8) | Reference to Day Profile for Saturday | * | 1 |
| Day ID Ref Sunday (UINT8) | Reference to Day Profile for Sunday | * | 1 |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetWeekProfiles if no records found | 0x02 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| PublishSeasons (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0011 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishSeasons | 0x03 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | * | 4 | |
| Command Index (UINT8) | A single response | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single response | 0x01 | 1 |
| Season Entry (Refer to ZigBee spec) | Array of up to 3 Season Entry(s). Each entry is interpreted as follows: ; Season Start Date (Date); Week ID Ref (UINT8) | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSeasons if no records found | 0x03 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| PublishSpecialDays (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0017 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishSpecialDays | 0x04 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | * | 4 | |
| Start Time (UTCTime) | Time when table becomes valid | * | 4 |
| Calendar Type (ENUM8) | 3 = Friendly Credit Calendar | 0x03 | 1 |
| Total Number of SpecialDays (UINT8) | Number of Special Days | * | 1 |
| Command Index (UINT8) | A single response | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single response | 0x01 | 1 |
| Special Day Entry (Refer to ZigBee spec) | Array of up to 20 Special Day Entry(s). Each entry is interpreted as follows: ; Special Day Date (Date); Day ID Ref (UINT8) | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSpecialDays if no records found | 0x04 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 6 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0025 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Block Period: ThresholdDivisor | 0x0203 | 2 |
| Attribute Identifier (ENUM16) | Block Period: ThresholdMultiplier | 0x0202 | 2 |
| Attribute Identifier (ENUM16) | Block Threshold: Block1Threshold | 0x0100 | 2 |
| Attribute Identifier (ENUM16) | Block Threshold: Block2Threshold | 0x0101 | 2 |
| Attribute Identifier (ENUM16) | Block Threshold: Block3Threshold | 0x0102 | 2 |
| Attribute Identifier (ENUM16) | Tariff Information: UnitofMeasure | 0x0615 | 2 |
| Attribute Identifier (ENUM16) | NoTierBlock1Price | 0x0400 | 2 |
| Attribute Identifier (ENUM16) | NoTierBlock2Price | 0x0401 | 2 |
| Attribute Identifier (ENUM16) | NoTierBlock3Price | 0x0402 | 2 |
| Attribute Identifier (ENUM16) | NoTierBlock4Price | 0x0403 | 2 |
| Attribute Identifier (ENUM16) | Tier1Block1Price | 0x0410 | 2 |
| Attribute Identifier (ENUM16) | Tier2Block1Price | 0x0420 | 2 |
| Attribute Identifier (ENUM16) | Tier3Block1Price | 0x0430 | 2 |
| Attribute Identifier (ENUM16) | Tier4Block1Price | 0x0440 | 2 |
| Attribute Identifier (ENUM16) | Currency | 0x0616 | 2 |
| Attribute Identifier (ENUM16) | Tariff Information: Price Trailing Digit | 0x0617 | 2 |
| Attribute Identifier (ENUM16) | Standing Charge | 0x0301 | 2 |
| GetDayProfiles | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetDayProfiles | 0x01 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Calendar ID (UINT32) | 0xFFFFFFFF = Return the current Tariff Switching Table | 0xFFFFFFFF | 4 |
| Start Day ID (UINT8) | Read all day profiles | 0x01 | 1 |
| Number of Days (UINT8) | Read all day profiles | 0x00 | 1 |
| GetWeekProfiles | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetWeekProfiles | 0x02 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Calendar ID (UINT32) | 0xFFFFFFFF = Return the current Tariff Switching Table | 0xFFFFFFFF | 4 |
| Start Week Id (UINT8) | Read all week profiles | 0x01 | 1 |
| Number of Weeks (UINT8) | Read all week profiles | 0x00 | 1 |
| GetSeasons | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x000B | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSeasons | 0x03 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Calendar ID (UINT32) | 0xFFFFFFFF = Return the current Tariff Switching Table | 0xFFFFFFFF | 4 |
| GetSpecialDays | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0011 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSpecialDays | 0x04 | 1 |
| ZCL payload | |||
| Start Time (UTCTime) | Return all active/pending Special Days | 0x00000000 | 4 |
| Number of Events (UINT8) | Return all active/pending Special Days | 0x00 | 1 |
| Calendar Type (ENUM8) | 0 = Delivered Calendar | 0x00 | 1 |
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Calendar ID (UINT32) | 0xFFFFFFFF = Return the current Tariff Switching Table | 0xFFFFFFFF | 4 |
| Get Current Price | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0004 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Get Current Price | 0x00 | 1 |
| ZCL payload | |||
| Command Options (BITMAP8) | Active Price | 0x00 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 6-10 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0036 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; disable default response; | 0b00011000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Block Period: ThresholdDivisor | 0x0203 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 24-bit integer | 0x22 | * |
Omitted if unsuccessful Attribute Value (UINT24) | Divisor | * | * |
| Attribute Identifier (ENUM16) | Block Period: ThresholdMultiplier | 0x0202 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 24-bit integer | 0x22 | * |
Omitted if unsuccessful Attribute Value (UINT24) | Multiplier | * | * |
| Attribute Identifier (ENUM16) | Block Threshold: Block1Threshold | 0x0100 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Threshold (1) | * | * |
| Attribute Identifier (ENUM16) | Block Threshold: Block2Threshold | 0x0101 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Threshold (2) | * | * |
| Attribute Identifier (ENUM16) | Block Threshold: Block3Threshold | 0x0102 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 48-bit integer | 0x25 | * |
Omitted if unsuccessful Attribute Value (UINT48) | Threshold (3) | * | * |
| Attribute Identifier (ENUM16) | Tariff Information: UnitofMeasure | 0x0615 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | kWh | 0x00 | * |
| Attribute Identifier (ENUM16) | NoTierBlock1Price | 0x0400 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | TariffBlockPriceMatrix[1] | * | * |
| Attribute Identifier (ENUM16) | NoTierBlock2Price | 0x0401 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | TariffBlockPriceMatrix[2] | * | * |
| Attribute Identifier (ENUM16) | NoTierBlock3Price | 0x0402 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | TariffBlockPriceMatrix[3] | * | * |
| Attribute Identifier (ENUM16) | NoTierBlock4Price | 0x0403 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | TariffBlockPriceMatrix[4] | * | * |
| Attribute Identifier (ENUM16) | Tier1Block1Price | 0x0410 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | TariffTOUPriceMatrix[1] | * | * |
| Attribute Identifier (ENUM16) | Tier2Block1Price | 0x0420 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | TariffTOUPriceMatrix[2] | * | * |
| Attribute Identifier (ENUM16) | Tier3Block1Price | 0x0430 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | TariffTOUPriceMatrix[3] | * | * |
| Attribute Identifier (ENUM16) | Tier4Block1Price | 0x0440 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | TariffTOUPriceMatrix[4] | * | * |
| Attribute Identifier (ENUM16) | Currency | 0x0616 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 16-bit integer | 0x21 | * |
Omitted if unsuccessful Attribute Value (UINT16) | 0x033A = 826 = GBP; 0x03D2 = 978 = Euro | 0x033A | 0x03D2 | * |
| Attribute Identifier (ENUM16) | Tariff Information: Price Trailing Digit | 0x0617 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit bitmap | 0x18 | * |
Omitted if unsuccessful Attribute Value (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point | 0x50 | * |
| Attribute Identifier (ENUM16) | Standing Charge | 0x0301 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | StandingCharge | * | * |
| PublishDayProfile (0-4 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0014 + total length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishDayProfile | 0x01 | 1 |
| ZCL payload | |||
| A separate PublishDayProfile response for each Day Profile will be returned by this command | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | * | 4 | |
| Day ID (UINT8) | A separate response for each Day Profile | * | 1 |
| Total Number of Schedule Entries (UINT8) | Total number of ScheduleEntries in this Day Profile | * | 1 |
| Command Index (UINT8) | A single response for each Day Profile | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single response for each Day Profile | 0x01 | 1 |
| Calendar Type (ENUM8) | 0 = Delivered Calendar | 0x00 | 1 |
| Day Schedule Entries (Refer to ZigBee spec) | Array of Day Schedule Entries. Each entry is interpreted as follows: ; Start Time (minutes from midnight, UINT16); Price Tier (ENUM8) | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetDayProfiles if no records found | 0x01 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| PublishWeekProfile (0-2 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0017 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishWeekProfile | 0x02 | 1 |
| ZCL payload | |||
| A separate PublishWeekProfile response for each Week Profile will be returned by this command | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | * | 4 | |
| Week ID (UINT8) | A separate response for each Day Profile | * | 1 |
| Day ID Ref Monday (UINT8) | Reference to Day Profile for Monday | * | 1 |
| Day ID Ref Tuesday (UINT8) | Reference to Day Profile for Tuesday | * | 1 |
| Day ID Ref Wednesday (UINT8) | Reference to Day Profile for Wednesday | * | 1 |
| Day ID Ref Thursday (UINT8) | Reference to Day Profile for Thursday | * | 1 |
| Day ID Ref Friday (UINT8) | Reference to Day Profile for Friday | * | 1 |
| Day ID Ref Saturday (UINT8) | Reference to Day Profile for Saturday | * | 1 |
| Day ID Ref Sunday (UINT8) | Reference to Day Profile for Sunday | * | 1 |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetWeekProfiles if no records found | 0x02 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| PublishSeasons (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0011 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishSeasons | 0x03 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | * | 4 | |
| Command Index (UINT8) | A single response | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single response | 0x01 | 1 |
| Season Entry (Refer to ZigBee spec) | Array of up to 3 Season Entry(s). Each entry is interpreted as follows: ; Season Start Date (Date); Week ID Ref (UINT8) | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSeasons if no records found | 0x03 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| PublishSpecialDays (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0017 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishSpecialDays | 0x04 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Issuer Calendar ID (UINT32) | * | 4 | |
| Start Time (UTCTime) | Time when table becomes valid | * | 4 |
| Calendar Type (ENUM8) | 0 = Delivered Calendar | 0x00 | 1 |
| Total Number of SpecialDays (UINT8) | Number of Special Days | * | 1 |
| Command Index (UINT8) | A single response | 0x00 | 1 |
| Total Number of Commands (UINT8) | A single response | 0x01 | 1 |
| Special Day Entry (Refer to ZigBee spec) | Array of up to 20 Special Day Entry(s). Each entry is interpreted as follows: ; Special Day Date (Date); Day ID Ref (UINT8) | * | * |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0707 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSpecialDays if no records found | 0x04 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Publish Price (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x001F | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Price | 0x00 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Rate Label (OCTETSTRING) | Unused, set to 0-length string | * | 1 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Current Time (UTCTime) | Current time | * | 4 |
| Unit of Measure (ENUM8) | m3 | 0x01 | 1 |
| Currency (UINT16) | 0x033A = 826 = GBP; 0x03D2 = 978 = Euro | 0x033A | 0x03D2 | 2 |
| Price Trailing Digit & Price Tier (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point. Price is in millipence; Least significant nibble = price tier | * | 1 |
| Number of Price Tiers & Register Tier (BITMAP8 (NIBBLES)) | Most significant nibble = maximum number of price tiers available; Least significant nibble = register tier used | * | 1 |
| Start Time (UTCTime) | Price is valid now | 0x00000000 | 4 |
| Duration In Minutes (UINT16) | Time in minutes the price remains valid | * | 2 |
| Price (UINT32) | Active Tariff Price. NOTE: the Response may contain an additional 19 octets after this parameter. Those 19 octets do not contain meaningful information and so, if present, should be ignored by all parties | * | 4 |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Get Current Price if the command did not succeed | 0x00 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Prepayment Information: Payment Control Configuration | 0x0000 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0006 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Prepayment Information: Payment Control Configuration | 0x0000 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 16-bit bitmap | 0x19 | * |
Omitted if unsuccessful Attribute Value (BITMAP16) | The 5 possible values are:; 0b0000110010010100 = Credit mode; 0b0000010010010111 = Prepayment mode, Suspend Debt Emergency = True, Suspend Debt Disabled = True; 0b0000000010010111 = Prepayment mode, Suspend Debt Emergency = True, Suspend Debt Disabled = False; 0b0000110010010111 = Prepayment mode, Suspend Debt Emergency = False, Suspend Debt Disabled = True; 0b0000100010010111 = Prepayment mode, Suspend Debt Emergency = False, Suspend Debt Disabled = False | 0b0000110010010100 | 0b0000010010010111 | 0b0000000010010111 | 0b0000110010010111 | 0b0000100010010111 | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| GetBillingPeriod | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetBillingPeriod | 0x0B | 1 |
| ZCL payload | |||
| Earliest Start Time (UTCTime) | Set so that currently in force billing calendar is returned | 0x00000000 | 4 |
| Min. Issuer Event ID (UINT32) | Not used | 0xFFFFFFFF | 4 |
| Number of Commands (UINT8) | Only return the first command so that only the currently in force billing calendar is returned | 0x01 | 1 |
| Tariff Type (BITMAP8 (NIBBLES)) | Most significant nibble is 0x0 (Reserved) and least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| PublishBillingPeriod (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0014 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishBillingPeriod | 0x09 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Not used | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set to current UTC time | * | 4 |
| Billing Period Start Time (UTCtime) | Start time | * | 4 |
| Billing Period Duration (UINT24) | If the Billing Period Duration Type is monthly, may have the value of 1 (so monthly), 3 (so quarterly), 6 (so six monthly) or 12 (so yearly). Otherwise, should have the value 1. | * | 3 |
| Billing Period Duration Type (BITMAP8) | See ZSE specification | * | 1 |
| Tariff Type (BITMAP8 (NIBBLES)) | Most significant nibble is 0x0 (Reserved) and least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 1 |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetBillingPeriod if the command did not succeed | 0x0B | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0000 | 2 | |
| Extended Header GBZ Command Length | 0x0007 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | BasicDeviceInformation: ManufacturerName | 0x0004 | 2 |
| Attribute Identifier (ENUM16) | BasicDeviceInformation: ModelIdentifier | 0x0005 | 2 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0007 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Supplier: SupplyDepletionState | 0x0608 | 2 |
| Attribute Identifier (ENUM16) | Supplier: SupplyTamperState | 0x0607 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0000 | 2 | |
| Extended Header GBZ Command Length | 0x0009 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | BasicDeviceInformation: ManufacturerName | 0x0004 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Character string | 0x42 | * |
Omitted if unsuccessful Attribute Value (CHARSTRING) | The string shall be 5 octets in length being the concatenation 0x04 | | (value of Manufacturer ID), where 0x04 is the length of the included value. The (value of Manufacturer ID) shall be a 4 octet utf-8 encoded, hexadecimal representation of the Manufacturer ID allocated by the ZigBee Alliance and so shall be the human readable equivalent of that 16 bit unsigned integer used by the Device in the Manufacturer Code parameter in relation to the OTA cluster. | * | * |
| Attribute Identifier (ENUM16) | BasicDeviceInformation: ModelIdentifier | 0x0005 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Character string | 0x42 | * |
Omitted if unsuccessful Attribute Value (CHARSTRING) | The string shall be 9 octets in length being the concatenation 0x08 | | (value of Image Type) | | (value of OTA Hardware Version), where 0x08 is the length of the included value. The (value of Image Type) shall be a 4 octet utf-8 encoded, hexadecimal representation of the 16 bit unsigned integer used by Devices in the value of the Image Type parameter in relation to the OTA cluster. The (value of OTA Hardware Version) shall be a 4 octet utf-8 encoded, hexadecimal representation of the 16 bit unsigned integer used by Devices in the value of the Hardware Version parameter in relation to the OTA cluster. | * | * |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0009 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Supplier: SupplyDepletionState | 0x0608 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | 0x03 means supply state is UNCHANGED; 0x00 means supply state is LOCKED | 0x00 | 0x03 | * |
| Attribute Identifier (ENUM16) | Supplier: SupplyTamperState | 0x0607 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | 0x03 means supply state is UNCHANGED; 0x00 means supply state is LOCKED | 0x00 | 0x03 | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| PublishConversionFactor | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishConversionFactor | 0x02 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCTime) | Means that the GSME shall apply immediately on receipt | 0x00000000 | 4 |
| Conversion Factor (UINT32) | Conversion factor | 0 - 0xFFFFFFFF | 4 |
| Conversion Factor Trailing Digit (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point | 0x50 | 1 |
| PublishCalorificValue | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0011 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishCalorificValue | 0x03 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCtime) | Means that the GSME shall apply immediately on receipt | 0x00000000 | 4 |
| Calorific Value (UINT32) | Calorific value | 0 - 0xFFFFFFFF | 4 |
| Calorific Value Unit (ENUM8) | MJ/m3 | 0x01 | 1 |
| Calorific Value Trailing Digit (BITMAP8 (NIBBLES)) | Most significant nibble = digits to right of decimal point | 0x10 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishConversionFactor | 0x02 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishCalorificValue | 0x03 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| SetUncontrolledFlowThreshold | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0015 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | SetUncontrolledFlowThreshold | 0x0E | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Uncontrolled Flow Threshold (UINT16) | Uncontrolled flow threshold | * | 2 |
| Unit of Measure (ENUM8) | m3/h | 0x01 | 1 |
| Multiplier (UINT16) | Multiplier | 0x0001 | 2 |
| Divisor (UINT16) | Divisor | 0x2710 | 2 |
| Stabilisation Period (UINT8) | Stabilisation period in tenths of seconds | * | 1 |
| Measurement Period (UINT16) | Measurement period in seconds | * | 2 |
| SetSupplyStatus | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x000B | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | SetSupplyStatus | 0x0D | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| SupplyTamper State (ENUM8) | 0x03 means supply state is UNCHANGED; 0x00 means supply state is LOCKED | 0x00 | 0x03 | 1 |
| SupplyDepletion State (ENUM8) | 0x03 means supply state is UNCHANGED; 0x00 means supply state is LOCKED | 0x00 | 0x03 | 1 |
| SupplyUncontrolled FlowState (ENUM8) | Supply Uncontrolled Flow State = OFF | 0x00 | 1 |
| LoadLimitSupply State (ENUM8) | Load Limit Supply State = UNCHANGED | 0x03 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to SetUncontrolledFlowThreshold | 0x0E | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to SetSupplyStatus | 0x0D | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| PublishBillingPeriod | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0014 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishBillingPeriod | 0x09 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Billing Period Start Time (UTCTime) | The date-time of the first billing calendar snapshot | * | 4 |
| Billing Period Duration (UINT24) | Duration = 1 (units specified in Duration Type parameter) | 0x000001 | 3 |
| Billing Period Duration Type (BITMAP8) | Periodicity where:; The least significant nibble is set as follows:; 0x1 = Days; 0x2 = Weeks; 0x3 = Months; The most significant nibble is set to 0x2 (Block Period Duration Control = 'Not Specified') | * | 1 |
| Tariff Type (BITMAP8 (NIBBLES)) | Most significant nibble is 0x0 (Reserved) and least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 1 |
| Publish Block Period | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0016 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Block Period | 0x01 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Block Period Start Time (UTCTime) | The date-time of the first billing calendar snapshot | * | 4 |
| Block Period Duration (UINT24) | Duration = 1 (units specified in Duration Type parameter) | 0x000001 | 3 |
| Block Period Control (BITMAP8) | Repeating block | 0b10 | 1 |
| Block Period Duration Type (BITMAP8) | Periodicity where:; The least significant nibble is set as follows:; 0x1 = Days; 0x2 = Weeks; 0x3 = Months; The most significant nibble is set to 0x2 (Block Period Duration Control = 'Not Specified'); This must be the same value as the Billing Period Duration Type above | * | 1 |
| Tariff Type (BITMAP8 (NIBBLES)) | Most significant nibble is 0x0 (Reserved) and least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 1 |
| Tariff Resolution Period (ENUM8) | Block Period | 0x01 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishBillingPeriod | 0x09 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Publish Block Period | 0x01 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| PublishBillingPeriod | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0014 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | PublishBillingPeriod | 0x09 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Not used | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set to current UTC time | * | 4 |
| Billing Period Start Time (UTCTime) | The date-time of the first billing calendar snapshot | * | 4 |
| Billing Period Duration (UINT24) | Reflects the required periodicity of billing calendar snapshots. If Billing Period Duration Type = months then may have the values of 1 (so monthly), 3 (so quarterly), 6 (so six monthly) or 12 (so yearly). If Billing Period Duration Type != months then must have the value 1. | * | 3 |
| Billing Period Duration Type (BITMAP8) | The least significant nibble is set to 0x3 (meaning months), 0x2 (weeks) or 0x1 (days); The most significant nibble is set to 0x2 (meaning Block Period Duration Control = 'Not Specified') | * | 1 |
| Tariff Type (BITMAP8 (NIBBLES)) | Most significant nibble is 0x0 (Reserved) and least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 1 |
| Publish Block Period | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0016 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Block Period | 0x01 | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Not used | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set to current UTC time | * | 4 |
| Block Period Start Time (UTCTime) | The date-time of the first billing calendar snapshot | * | 4 |
| Block Period Duration (UINT24) | Shall have the same value as the Billing Period Duration value in this Command. | * | 3 |
| Block Period Control (BITMAP8) | Repeating block; price acknowledgment not required | 0b10 | 1 |
| Block Period Duration Type (BITMAP8) | Shall have the same value as the Billing Period Duration Type value in this Command. | * | 1 |
| Tariff Type (BITMAP8 (NIBBLES)) | Most significant nibble is 0x0 (Reserved) and least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 1 |
| Tariff Resolution Period (ENUM8) | Block Period | 0x01 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to PublishBillingPeriod | 0x09 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0700 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Publish Block Period | 0x01 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| StartSampling | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | StartSampling | 0x07 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| StartSampling Time (UTCTime) | Execute immediately | 0x00000000 | 4 |
| SampleType (ENUM8) | 0 = Consumption Delivered | 0x00 | 1 |
| SampleRequest Interval (UINT16) | Time in seconds between samples | 0x0168 | 2 |
| MaxNumberof Samples (UINT16) | 4-hours sample data | 0x0029 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| StartSamplingResponse | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | StartSamplingResponse | 0x0D | 1 |
| ZCL payload | |||
| Sample ID (UINT16) | 0x0002 = Network Data Log. 0xFFFF means a sampling session could not be started | * | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Change Supply | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0015 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Supply | 0x0B | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Request Date/ Time (UTCtime) | Date and time supply change was requested, set = 0 | 0x00000000 | 4 |
| Implementation Date/Time (UTCtime) | 0 = now | 0x00000000 | 4 |
| Proposed Supply Status (ENUM8) | Close valve | 0x00 | 1 |
| Supply Control Bits (BITMAP8 (NIBBLES)) | Least significant nibble: 0x1 = Acknowledgement required | 0x01 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Supply Status Response (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Supply Status Response | 0x0C | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | * | 4 | |
| Issuer Event ID (UINT32) | * | 4 | |
| Implementation Date/Time (UTCTime) | * | 4 | |
| Supply Status (ENUM8) | Valve closed | 0x00 | 1 |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Change Supply | 0x0B | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0007 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Meter Status: RemainingBatteryLifeinDays | 0x0205 | 2 |
| Attribute Identifier (ENUM16) | Reading Information: SupplyStatus | 0x0014 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0009 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Meter Status: RemainingBatteryLifeinDays | 0x0205 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 16-bit integer | 0x21 | * |
Omitted if unsuccessful Attribute Value (UINT16) | Remaining battery capacity | * | * |
| Attribute Identifier (ENUM16) | Reading Information: SupplyStatus | 0x0014 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | 8-bit enumeration | 0x30 | * |
Omitted if unsuccessful Attribute Value (ENUM8) | Supply state | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Update CIN | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x000F + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Update CIN | 0x06 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| CIN Time (UTCTime) | Update immediately | 0x00000000 | 4 |
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| CustomerID Number (OCTETSTRING) | Customer ID Number (CIN) | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Update CIN | 0x06 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Meter Status: CurrentMeterID (used for current firmware version) | 0x0206 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0006 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Meter Status: CurrentMeterID | 0x0206 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Octet string | 0x41 | * |
Omitted if unsuccessful Attribute Value (OCTETSTRING) | Firmware Version (length is 5, the first octet having the value 0x04 and the remaining 4 octets being the value of Firmware Version) | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Change Supply | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0015 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Change Supply | 0x0B | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Request Date/Time (UTCtime) | Date and time supply change was requested, set = 0 | 0x00000000 | 4 |
| Implementation Date/Time (UTCtime) | 0 = now | 0x00000000 | 4 |
| Proposed Supply Status (ENUM8) | Arm supply | 0x01 | 1 |
| Supply Control Bits (BITMAP8 (NIBBLES)) | Least significant nibble: 0x1 = Acknowledgement required | 0x01 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Supply Status Response (0-1 instances) | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Supply Status Response | 0x0C | 1 |
| ZCL payload | |||
| Provider ID (UINT32) | * | 4 | |
| Issuer Event ID (UINT32) | * | 4 | |
| Implementation Date/Time (UTCTime) | * | 4 | |
| Supply Status (ENUM8) | Supply armed | 0x01 | 1 |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Change Supply | 0x0B | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Credit Adjustment | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Credit Adjustment | 0x05 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCtime) | 0 = now | 0x00000000 | 4 |
| Credit Adjustment Type (ENUM8) | 0 = incremental (adjust) | 0x00 | 1 |
| Credit Adjustment Value (INT32) | Credit adjustment value | * | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Credit Adjustment | 0x05 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Credit Adjustment | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Credit Adjustment | 0x05 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCtime) | 0 = now | 0x00000000 | 4 |
| Credit Adjustment Type (ENUM8) | 1 = absolute (reset) | 0x01 | 1 |
| Credit Adjustment Value (INT32) | 0 = reset | 0x00000000 | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Credit Adjustment | 0x05 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Credit Adjustment | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Credit Adjustment | 0x05 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCtime) | 0 = now | 0x00000000 | 4 |
| Credit Adjustment Type (ENUM8) | 3 = incremental (adjust Metering:BillToDateDelivered); ZigBee uses different attributes for credit and prepayment-mode meter balance: the device must accept CreditAdjustmentType = 0x03 to adjust Metering:BillToDateDelivered | 0x03 | 1 |
| Credit Adjustment Value (INT32) | Credit adjustment value | * | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Credit Adjustment | 0x05 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Credit Adjustment | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0010 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Credit Adjustment | 0x05 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Start Time (UTCtime) | 0 = now | 0x00000000 | 4 |
| Credit Adjustment Type (ENUM8) | 2 = absolute (reset Metering:BillToDateDelivered) | 0x02 | 1 |
| Credit Adjustment Value (INT32) | 0 = reset | 0x00000000 | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Credit Adjustment | 0x05 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Update SiteID | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x000F + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Update SiteID | 0x03 | 1 |
| ZCL payload | |||
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| SiteID Time (UTCTime) | 0 = now | 0x00000000 | 4 |
| Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| SiteID (OCTETSTRING) | MPRN | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Update SiteID | 0x03 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Publish Change of Supplier | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0018 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Change of Supplier | 0x01 | 1 |
| ZCL payload | |||
| Current Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Issuer Event ID (UINT32) | Set = current UTC time | * | 4 |
| Tariff Type (BITMAP8 (NIBBLES)) | Most significant nibble is 0x0 (Reserved) and least significant nibble is 0x0 (Delivered Tariff) | 0x00 | 1 |
| Proposed Provider ID (UINT32) | Unused, set = 0 | 0x00000000 | 4 |
| Provider Change Implementation Time (UTCtime) | 0 = now | 0x00000000 | 4 |
| Provider Change Control (BITMAP32) | No actions | 0x00001800 | 4 |
| Proposed Provider Name (OCTETSTRING) | Proposed provider name | * | * |
| Proposed Provider Contact Details (OCTETSTRING) | Proposed provider telephone number | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0708 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Publish Change of Supplier | 0x01 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Site ID | 0x0307 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0006 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Site ID | 0x0307 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Octet string | 0x41 | * |
Omitted if unsuccessful Attribute Value (OCTETSTRING) | MPRN | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Alert code | Refer to section 16 | * | 2 |
| Time stamp | Time and date when response was created | * | 4 |
| Publish Snapshot | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0028 + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Publish Snapshot | 0x06 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| Snapshot ID (UINT32) | Generated by device | * | 4 |
| Snapshot Time (UTCTime) | Time when the snapshot was taken | * | 4 |
| Total Snapshots Found (UINT8) | Only send the latest snapshot | 0x01 | 1 |
| Command Index (UINT8) | Entire payload returned in 1 command | 0x00 | 1 |
| Total Number of Commands (UINT8) | 0x01 | 1 | |
| Snapshot Cause (BITMAP32) | Refer to ZigBee standard, but shall include the most recent End of Billing Period Snapshot | * | 4 |
| Snapshot Payload Type (ENUM8) | SnapshotPayloadType = 6 | 0x06 | 1 |
| SnapshotSub-Payload (Refer to ZigBee spec) | In the SnapshotSub-Payload: the 'Number of Tiers in Use' shall be set to 0x04; the 'Tier Summation' values shall contain all four register values from the Tariff TOU Register Matrix; the 'Number of Tiers and Block Thresholds in Use' shall be set to 0x14; and the 'Tier Block Summation' values shall contain all four register values from the Tariff Block Counter Matrix | * | * |
| AE MAC | * | 12 | |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Meter Billing: BillToDateDelivered | 0x0A00 | 2 |
| Read Attributes | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; client-server; allow default response; | 0b00000000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes | 0x00 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Prepayment Information: Credit Remaining | 0x0001 | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 2 | 1 |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x00 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0006 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Meter Billing: BillToDateDelivered | 0x0A00 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Unsigned 32-bit integer | 0x23 | * |
Omitted if unsuccessful Attribute Value (UINT32) | Meter balance | * | * |
| Read Attributes Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0006 + length of any variable fields below | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Read Attributes Response | 0x01 | 1 |
| ZCL payload | |||
| Attribute Identifier (ENUM16) | Prepayment Information: Credit Remaining | 0x0001 | 2 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
Omitted if unsuccessful Attribute Data Type (ENUM8) | Signed 32-bit integer | 0x2B | * |
Omitted if unsuccessful Attribute Value (INT32) | Meter balance | * | * |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| GetSampledData | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x000C | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSampledData | 0x08 | 1 |
| ZCL payload | |||
| SampleID (UINT16) | 1 = Daily Consumption Log | 0x0001 | 2 |
| EarliestSampleTime (UTCTime) | Sample Start Time | * | 4 |
| SampleType (ENUM8) | 0 = Consumption Delivered | 0x00 | 1 |
| NumberOfSamples (UINT16) | 1-731 | * | 2 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header + Grouping Header | |||
| Refer to section 7 for construction of the MAC and Grouping Headers | |||
| GBZ payload - command | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| GetSampledDataResponse | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x03 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0023 + length of any variable fields below | 2 | |
| Additional Header Control | Reserved | 0x00 | 1 |
| Additional Header Frame Counter | 0 | 1 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; disable default response; | 0b00011001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | GetSampledDataResponse | 0x07 | 1 |
| Ciphered information length | * | 2 | |
| Ciphered information: See section 8.4. | |||
| Security Control | 0x31 | 1 | |
| Invocation Counter | 0x00000000 | 4 | |
| Encrypted ZCL payload | |||
| SampleID (UINT16) | 1 = Daily Consumption Log | 0x0001 | 2 |
| SampleStartTime (UTCTime) | Sample Start Time | * | 4 |
| SampleType (ENUM8) | 0 = Consumption Delivered | 0x00 | 1 |
| SampleRequestInterval (UINT16) | In this Use Case, 0xFFFF shall be interpreted as meaning 24 hours (or 86,400 seconds) as per the SMETS requirement. | 0xFFFF | 2 |
| NumberOfSamples (UINT16) | 1-731 | * | 2 |
| Samples (Refer to ZigBee spec) | Daily Consumption Log: Array of UINT24 | * | * |
| AE MAC | * | 12 | |
| Alternate response: if no instances of the ZCL/ZSE command immediately above are returned | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0702 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Alternate response to above: Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to GetSampledData if no records found | 0x08 | 1 |
| Status (ENUM8) | NOT_FOUND | 0x8B | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header | |||
| General-Ciphering | 0xDD | 1 | |
| transaction-id | Not needed, length = 0 | 0x00 | 1 |
| originator-system-title | Not needed, length = 0 | 0x00 | 1 |
| recipient-system-title | Not needed, length = 0 | 0x00 | 1 |
| date-time | Not needed, length = 0 | 0x00 | 1 |
| other-information | Not needed, length = 0 | 0x00 | 1 |
| key-info | Not needed, length = 0 | 0x00 | 1 |
| ciphered-service | |||
| length | Encoding(X) | * | |
| security header | |||
| security control byte (SC) | 0x11 | 1 | |
| invocation counter (IC) | Always = 0 | 0x00000000 | 4 |
| Grouping Header | |||
| General-Signing | 0xDF | 1 | |
| transaction-id | |||
| length | Length of Originator Counter + 1 | 0x09 | 1 |
| value | 0x01 || PPMID originator counter | 9 | |
| originator-system-title | |||
| length | Length of Entity Identifier | 0x08 | 1 |
| value | PPMID entity ID | 8 | |
| recipient-system-title | |||
| length | Length of Entity Identifier | 0x08 | 1 |
| value | Meter entity ID | 8 | |
| date-time | |||
| length | 0x00 | 0x0C | 1 | |
| value | Empty or a 12 character octet-string containing the date-time stamp for this response | 0 | 12 | |
| other-information | |||
| length | Length of other information octet string | * | 2 |
| value | See section 7 of GBCS | * | Message Code |
| Content | |||
| length | Encoding(X) | * | |
| Group Header (GHDR) | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Consumer Top Up | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0019 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Consumer Top Up | 0x04 | 1 |
| ZCL payload | |||
| Originating Device (ENUM8) | Source: 0x02=In-Home Display Device | 0x02 | 1 |
| TopUp Code (OCTETSTRING) | UTRN | * | 21 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header | |||
| General-Ciphering | 0xDD | 1 | |
| transaction-id | Not needed, length = 0 | 0x00 | 1 |
| originator-system-title | Not needed, length = 0 | 0x00 | 1 |
| recipient-system-title | Not needed, length = 0 | 0x00 | 1 |
| date-time | Not needed, length = 0 | 0x00 | 1 |
| other-information | Not needed, length = 0 | 0x00 | 1 |
| key-info | Not needed, length = 0 | 0x00 | 1 |
| ciphered-service | |||
| length | Encoding(X) | * | |
| security header | |||
| security control byte (SC) | 0x11 | 1 | |
| invocation counter (IC) | Always = 0 | 0x00000000 | 4 |
| Grouping Header | |||
| General-Signing | 0xDF | 1 | |
| transaction-id | |||
| length | Length of Originator Counter + 1 | 0x09 | 1 |
| value | 0x02 || PPMID originator counter | 9 | |
| originator-system-title | |||
| length | Length of Entity Identifier | 0x08 | 1 |
| value | Meter entity ID | 8 | |
| recipient-system-title | |||
| length | Length of Entity Identifier | 0x08 | 1 |
| value | PPMID entity ID | 8 | |
| date-time | |||
| length | 0x00 | 0x0C | 1 | |
| value | Empty or a 12 character octet-string containing the date-time stamp for this response | 0 | 12 | |
| other-information | |||
| length | Length of other information octet string | * | 2 |
| value | See section 7 of GBCS | * | Message Code |
| Content | |||
| length | Encoding(X) | * | |
| Group Header (GHDR) | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Consumer Top Up Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x000D | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; server-client; allow default response; | 0b00001001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Consumer Top Up Response | 0x03 | 1 |
| ZCL payload | |||
| Result Type (ENUM8) | 0x00 = Accepted; 0x01 = Rejected-Invalid Top Up; 0x02 = Rejected-Duplicate Top Up; 0x03 = Rejected-Error; 0x04 = Rejected-Max Credit Reached; 0x05 = Rejected-Keypad Lock; 0x06 = Rejected-Top Up Value Too Large; 0x10 = Accepted-Supply Enabled; 0x11 = Accepted-Supply Disabled; 0x12 = Accepted-Supply Armed | * | 1 |
| Top Up Value (INT32) | Top up value | * | 4 |
| Source of Top up (ENUM8) | Source: 0x02=In-Home Display Device | * | 1 |
| Credit Remaining (INT32) | Credit remaining, or 0xFFFFFFFF if credit was not accepted | * | 4 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header | |||
| General-Ciphering | 0xDD | 1 | |
| transaction-id | Not needed, length = 0 | 0x00 | 1 |
| originator-system-title | Not needed, length = 0 | 0x00 | 1 |
| recipient-system-title | Not needed, length = 0 | 0x00 | 1 |
| date-time | Not needed, length = 0 | 0x00 | 1 |
| other-information | Not needed, length = 0 | 0x00 | 1 |
| key-info | Not needed, length = 0 | 0x00 | 1 |
| ciphered-service | |||
| length | Encoding(X) | * | |
| security header | |||
| security control byte (SC) | 0x11 | 1 | |
| invocation counter (IC) | Always = 0 | 0x00000000 | 4 |
| Grouping Header | |||
| General-Signing | 0xDF | 1 | |
| transaction-id | |||
| length | Length of Originator Counter + 1 | 0x09 | 1 |
| value | 0x01 || PPMID originator counter | 9 | |
| originator-system-title | |||
| length | Length of Entity Identifier | 0x08 | 1 |
| value | PPMID entity ID | 8 | |
| recipient-system-title | |||
| length | Length of Entity Identifier | 0x08 | 1 |
| value | Meter entity ID | 8 | |
| date-time | |||
| length | 0x00 | 0x0C | 1 | |
| value | Empty or a 12 character octet-string containing the date-time stamp for this response | 0 | 12 | |
| other-information | |||
| length | Length of other information octet string | * | 2 |
| value | See section 7 of GBCS | * | Message Code |
| Content | |||
| length | Encoding(X) | * | |
| Group Header (GHDR) | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Select Available Emergency Credit | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0008 | 2 | |
| ZCL header | |||
| Frame control | Cluster-specific; not manufacturer specific; client-server; allow default response; | 0b00000001 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Select Available Emergency Credit | 0x00 | 1 |
| ZCL payload | |||
| Command Issue Date/ Time (UTCTime) | Date and time command is issued, set = 0 | 0x00000000 | 4 |
| Originating Device (ENUM8) | Source: 0x02=In-Home Display Device | 0x02 | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||
| Element | Meaning | Value | Octets |
|---|---|---|---|
| MAC Header | |||
| General-Ciphering | 0xDD | 1 | |
| transaction-id | Not needed, length = 0 | 0x00 | 1 |
| originator-system-title | Not needed, length = 0 | 0x00 | 1 |
| recipient-system-title | Not needed, length = 0 | 0x00 | 1 |
| date-time | Not needed, length = 0 | 0x00 | 1 |
| other-information | Not needed, length = 0 | 0x00 | 1 |
| key-info | Not needed, length = 0 | 0x00 | 1 |
| ciphered-service | |||
| length | Encoding(X) | * | |
| security header | |||
| security control byte (SC) | 0x11 | 1 | |
| invocation counter (IC) | Always = 0 | 0x00000000 | 4 |
| Grouping Header | |||
| General-Signing | 0xDF | 1 | |
| transaction-id | |||
| length | Length of Originator Counter + 1 | 0x09 | 1 |
| value | 0x02 || PPMID originator counter | 9 | |
| originator-system-title | |||
| length | Length of Entity Identifier | 0x08 | 1 |
| value | Meter entity ID | 8 | |
| recipient-system-title | |||
| length | Length of Entity Identifier | 0x08 | 1 |
| value | PPMID entity ID | 8 | |
| date-time | |||
| length | 0x00 | 0x0C | 1 | |
| value | Empty or a 12 character octet-string containing the date-time stamp for this response | 0 | 12 | |
| other-information | |||
| length | Length of other information octet string | * | 2 |
| value | See section 7 of GBCS | * | Message Code |
| Content | |||
| length | Encoding(X) | * | |
| Group Header (GHDR) | |||
| Profile ID | Smart Energy Profile | 0x0109 | 2 |
| Total number of GBZ Use Case Specific Component(s) | Number of grouped commands contained | 1 | 1 |
| Default Response | |||
| GBZ Use Case specific component | |||
| Extended Header Control Field | 0x01 | 1 | |
| Extended Header Cluster ID | 0x0705 | 2 | |
| Extended Header GBZ Command Length | 0x0005 | 2 | |
| ZCL header | |||
| Frame control | Profile-wide; not manufacturer specific; server-client; allow default response; | 0b00001000 | 1 |
| Transaction sequence number | Start at 0, increment for each ZCL/ZSE command in this GBZ payload | * | 1 |
| Command identifier | Default Response | 0x0B | 1 |
| ZCL payload | |||
| Command identifier (UINT8) | Response to Select Available Emergency Credit | 0x00 | 1 |
| Status (ENUM8) | Refer to ZigBee standard | * | 1 |
| Cryptographic protection | |||
| Refer to section 6 | |||