UK Smart MeteringKnowledge ProjectStructured SRV and specimen referenceBrowse SRVs

Service Reference Variant

8.11 · Update HAN Device Log

Service details

Identifiers, rules, and applicability

Service reference
8.11
Service Reference Variant
8.11
DUIS section
3.8.114
Command variants
1, 2, 3
DUIS possible responses
AcknowledgementService Response from Device - GBCSPayloadResponse to a Command for Local Delivery Request - LocalCommand FormatCountersigned SMETS1 Response
Critical
No
Sensitive response
No
Protection against replay
Yes
On demand
Yes
Future dated
DSP
DSP scheduled
No
DCC only
No
SMETS1 applicability
Yes
SAPC requirement
Not stated
DUIS applicability
3.0, 3.1, 4.0, 5.0, 5.1, 5.2, 5.3

Cross-specification evidence

SMETS/CHTS to GBCS Mapping

This section shows the SMETS and CHTS attributes that can be read or written by the identified GBCS Use Case. Command requirements are shown separately from the mapped attributes.

CCS011 command0 attributes0x0001CHF

Command mapped to CCS01

  • CHTSAdd CHF Device Security Credentials4.5.1.2CHF

No mapped data attributes.

CCS021 command0 attributes0x0002CHF

Command mapped to CCS02

  • CHTSRemove CHF Device Security Credentials4.5.1.9CHF

No mapped data attributes.

Specific Errors

Response codes and descriptions

Response CodeResponse Code Description
E081101
The Device ID of a Device to be added to the CHF Whitelist is already associated with another CHF Whitelist
E081102
The Device ID of a Device to be removed is not included in the CHF Whitelist
E081104
The Device Type of the Device to be added to the Whitelist is invalid, e.g. if it is a Communications Hub Function or Gas Proxy Function
E081105
The status of the Device being added to the Whitelist is not ‘Installed not Commissioned’, ‘Pending’ or ‘Whitelisted’
E081106
If the Request Type is: ‘Add’. It doesn’t include the Add Device CHF Whitelist element ‘Remove’. It does include the Add Device CHF Whitelist element
E081107
The Device ID of the Device to be added to or removed from the Whitelist does not exist
E081108
The User Role is not authorised to add this Device Type to the HAN Device Log or remove it form it
E081109
The User is not the registered organisation for all of the MPxNs in the Service Request (This check supersedes the general Authorisation Check associated to Response Code E4 only for Request Type ‘Add' (please note the check associated to Response Code E4 is applicable to Request Type ‘Remove’))
E081110
The Service Request contains an Invalid MPAN Type, e.g. the Import MPxN is populated with an Export MPAN
E081111
The Service Request refers to a SMETS2+ Device and the InstallCode field is not 32 characters (representing 16 octets) in length.

Source: DUIS 3.8.114.3

GBCS Use Case

Use cases, device coverage, and applicability

Use Case / Message Code
CCS010x0001
DUIS Applicability
v3.0 – v5.3
GBCS Applicability
v1.0 – v4.3
GBCS Criticality
Non-Critical
Sensitive Response
No
Future Dated
DSP
GBT
No
SMETS1 Applicable
Yes
Eligible Roles
EISGISOUCHF
Use Case / Message Code
CCS020x0002
DUIS Applicability
v3.0 – v5.3
GBCS Applicability
v1.0 – v4.3
GBCS Criticality
Non-Critical
Sensitive Response
No
Future Dated
DSP
GBT
No
SMETS1 Applicable
Yes
Eligible Roles
EISGISOUCHF

DUIS Service Definition

Data items and DCC processing

Request data items

Table 244: UpdateHANDeviceLog (sr:UpdateHANDeviceLog) data items
Data ItemDescription / ValuesTypeMandatoryDefaultUnits
ExecutionDateTimeA User shall only add this Data Item to the Service Request where they require the Service Request to be executed at a future date and time. The UTC date and time the User requires the command to be executed on the Device. Date-time in the future that is either <= current date + 30 days or the date = ‘3000-12-31T00:00:00Z’xs:dateTimeNoNoneUTC Date-Time
DeviceIDDevice ID of a Device to be added to or removed from the Communications Hub Function Whitelist or removed from it. A User must send one Service Request per Device to add or remove from the Communications Hub Function (CHF) Device Log.sr:EUI (See clause 3.10.1.3)YesNoneN/A
RequestTypeIndicates whether the request is to add or remove the Device form the Communications Hub Function Whitelist. Valid set: Add RemoveRestriction of xs:string (Enumeration)YesNoneN/A
AddDeviceToCHFWhitelistList of data items required to add the Device to the Communications Hub Function Whitelist.sr:AddDeviceToCHFWhitelistDevice to be added to Whitelist: Yes Device to be removed from Whitelist: N/ANoneN/A
Table 245: AddDeviceToCHFWhitelist (sr:AddDeviceToCHFWhitelist) data items
Data ItemDescription / ValuesTypeMandatoryDefaultUnits
JoinTimePeriodDefines the time period in seconds during which the Communications Hub Function will permit the device being added to join the HAN and communicate with the Communications Hub Function.Restriction of xs:positiveInteger (minInclusive = 1 maxInclusive = 3600)YesNoneSeconds
InstallCodeInstallation Credentials. Minimum length 6 (octets) to Maximum Length 16 (octets) equating to from 12 to 32 charactersRestriction of xs:hexBinary (minLength = 6, maxLength = 16)YesNoneN/A
ImportMPxNThe reference number identifying an electricity or a gas metering point.sr:ImportMPxN (Restriction of xs:string (minLength = 1, maxLength = 13))ESME, HCALCS and GSME: Yes Otherwise: N/ANoneN/A
SecondaryImportMPANThe reference number identifying a Twin Element Import electricity secondary metering point.sr:MPAN (Restriction of xs:string (minLength = 13, maxLength = 13))NoNoneN/A
ExportMPANThe reference number identifying an Export electricity metering point.sr:MPAN (Restriction of xs:string (minLength = 13, maxLength = 13))NoNoneN/A

Additional System Processing - DUIS

Upon receipt of a successful Response resulting from the UpdateHANDeviceLog Service Request to Add a Device, the DCC shall, for the specified DeviceID identified within the Service Request, perform the following action.

  1. Update the Smart Metering Inventory and set the Device status of the DeviceId to ‘Whitelisted’
  2. Where the DeviceID to be added to HANDeviceLog is an Electricity Smart Meter or a Gas Smart Meter, the association between the DeviceID and its MPxN(s) is recorded in the Smart Metering Inventory and DCC Alert N16 is sent to the Electricity Distributor(s) or Gas Transporter (as applicable)

The DCC Systems shall wait for a timeout period to receive the updated Device Log from the CHF following the successful execution of an UpdateHANDeviceLog Service Request to Add a Device. The timeout period that the DCC Systems shall wait for the Alert is defined as “JoinTimePeriod” as specified within the Service Request plus a configurable network transmission time to allow delivery of the Alert over the SM WAN.

  1. If the CHF Device Log confirming communications have been established with the Device specified in the Service Request is received within the timeout period, then the DCC Systems shall notify the Responsible Supplier for the specified Device via a DCC Alert N24, and;
    1. For ESME, GSME, HCALCS and PPMID the Device Status is set to ‘InstalledNotCommissioned’ in the Smart Metering Inventory; and
    2. The DCC Systems shall initiate a Command to the Device using each available Key Agreement Device Certificate to determine which Key Agreement Device Certificate is currently in use by the Device. If the DCC receives a Response to a Command using a particular Key Agreement Device Certificate then the DCC Systems are updated to record this Key Agreement Device Certificate as currently in use by the Device.
  2. If the CHF Device Log confirming communications have been established with the Device specified in the Service Request is not received within the timeout period, then the DCC Systems informs the User via a DCC Alert N25.

When a User requests the Request Type “Add” variant of this Service Request 8.11, then an unsuccessful Command Response indicates that the CHF did not execute the Command, the details provided in the Service Request have NOT been successfully added to the CHF Device Log and no further actions are triggered by the DCC Systems.

When a User requests the Request Type “Remove” variant of this Service Request 8.11, then the Command Response indicates whether the specified Device provided in the Service Request was either successfully removed from the CHF Device Log or the removal was unsuccessful. Upon receipt of a successful Response resulting from the UpdateHANDeviceLog Service Request to Remove a Device, the DCC shall, where the Device Status is currently ‘Whitelisted’, set the Device status to ‘Pending’. No additional DCC Alerts are produced by the DCC Systems.

DUGIDS service matrix

DUGIDS DS.0226 Table 36 footnote extract

FootnoteExtractColumnCell ValueSource
1Service Request available in relation to Type 2 DevicesNameUpdate HAN Device LogDS.0226 Table 36 Service Request Matrix
9No for SMETS1 DevicesProtection Against ReplayYesDS.0226 Table 36 Service Request Matrix

Message Patterns & Examples

Pattern explorer

Open Message Patterns →

SMETS1 Supporting Requirements

Device-model variations and equivalent steps

Review the Section 18 requirements and their applicability across the documented manufacturer, Device Type, model, and firmware profiles.

Open S1SR Requirements →