Service Reference Variant
Service details
Specific Errors
| Response Code | Response Code Description |
|---|---|
E110401 | The Firmware Version is not approved. The Firmware version ID does not align with an entry on the Central Products List. |
W110401 | The Update Firmware Warning contains between one and five lists of Device IDs for which the validation failed for each DeviceID: InvalidDeviceIDList . The DeviceID does not exist or the User is not the Import Supplier or Gas Supplier for a Meter connected to the same HAN as the PPMID. NotCommissionedDeviceIDList. The PPMID status is not ‘Commissioned’ or ‘Suspended’ or the Device is not a PPMID NotApplicableFirmwareDeviceIDList. The Firmware Version is not applicable to the PPMID OtherRequestsInProgressList. The PPMID already has another Firmware update request in progress. InvalidGBCSVersionList. The CHF associated with the PPMID Device has a GBCS Version prior to v4.1. |
E110402 | The firmware is not marked as active in the Central Products List and Smart Metering Inventory. |
E110403 | The DCC Systems calculated Hash value over the Manufacturer Image part of the FirmwareImage provided by the User within the Service Request differs from that held in the CPL for the specified FirmwareVersion. |
E110405 | The firmware image is not constructed as per the GBCS definition, i.e. the FirmwareImage does not contain both an OTA Header and a Firmware Image concatenated together, or the Length of the base64 encoded version of the GBCS defined Firmware “OTA Upgrade Image” exceeds 1024000. |
Source: DUIS 3.8.126.3
GBCS Use Case
UpdatePPMIDFirmwareDUIS Service Definition
| Data Item | Description / Allowable values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| FirmwareImage | The Firmware Image corresponding to the Firmware Version This is a base64 encoded version of the GBCS defined Firmware “OTA Upgrade Image”. The Firmware Image is the full OTA Upgrade Image as defined in GBCS. Note that this includes the Manufacturer Image and the OTA Header information. Please see GBCS for details of how to construct the OTA Upgrade Image | Restriction of xs:base64Binary (max Length = 10240000) | Yes | None | N/A |
| FirmwareVersion | An identifier representing a firmware image that has been approved for release by the User concerned. The Firmware version as held in the CPL and presented in the format XXXXXXXX where each X is one of the characters 0 to 9 or A to F. This value must align with the firmware version value listed on the Central Products List (excluding the colon separator between octet values) and the Firmware Hash held on the CPL must match the Manufacturer Image Hash pursuant to clause 6.1(i) of the Service Request Processing Document. For avoidance of doubt, there is no direct comparison made between this FirmwareVersion value to the File Version value contained in the OTA Header (as defined by GBCS). | sr:FirmwareVersion (Restriction of xs:string (minLength=1, maxLength = 8)) | Yes | None | N/A |
| DeviceIDList | Comma separated list of Device IDs. Containing a minimum of 1 and a maximum of 50000 Device IDs, each as defined by sr:EUI | Restriction of xs:string (minLength = 23 maxLength = 1199999 pattern = “([A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2},)*([A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2})”) | Yes Minimum 1 and Maximum 50,000 Device IDs | None | N/A |
| Data Item | Description / Allowable values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| InvalidDeviceIDList | Comma separated list of Device IDs for which the User ID is not the Import Supplier or Gas Supplier or the DeviceIds don’t exist. Containing a minimum of 1 Device ID, each as defined by sr:EUI | sr:DeviceIDList (Restriction of xs:string (minLength = 23 pattern = “([A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2},)*([A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2}-[A-Fa-f0-9]{2})”)) | No The Response will contain at least one of the 5 Lists and it could contain all of them | None | N/A |
| NotCommissionedDevice IDList | Comma separated list of Device IDs which aren’t in a status of ‘Commissioned’ or ‘Suspended’ or the Device is not a PPMID. Containing a minimum of 1 Device ID, each as defined by sr:EUI | sr:DeviceIDList (Restriction of xs:string (minLength = 23 pattern = as for InvalidDeviceIDList above)) | No The Response will contain at least one of the 5 Lists and it could contain all of them | None | N/A |
| NotApplicableFirmware DeviceIDList | Comma separated list of Device IDs for which the Firmware is not applicable. Containing a minimum of 1 Device ID, each as defined by sr:EUI | sr:DeviceIDList (Restriction of xs:string (minLength = 23 pattern = as for InvalidDeviceIDList above)) | No The Response will contain at least one of the 5 Lists and it could contain all of them | None | N/A |
| OtherRequestInProgressList | Comma separated list of Device IDs for which another Firmware Update request is in progress. Containing a minimum of 1 Device ID, each as defined by sr:EUI | sr:DeviceIDList (Restriction of xs:string (minLength = 23 pattern = as for InvalidDeviceIDList above)) | No The Response will contain at least one of the 5 Lists and it could contain all of them | None | N/A |
| InvalidGBCSVersionList | Comma separated list of Device IDs for which the CHF associated with PPMID device has a GBCS version prior to v4.1 | sr:DeviceIDList (Restriction of xs:string (minLength = 23 pattern = as for InvalidDeviceIDList above)) | No The Response will contain at least one of the 5 Lists and it could contain all of them | None | N/A |
The DCC Systems shall calculate a Hash over the Manufacturer Image part of the FirmwareImage provided by the User within the Service Request and ensure that the Hash calculated matches that held in the CPL for the specified FirmwareVersion. Where the DCC identifies any mismatch in Hash values, a Response Code of E110403 shall be returned to the User.
The DCC Systems shall monitor all Device Alerts received from the PPMID indicating the activation outcome (Alert Code 0x8F8B) received as a consequence of sending this Service Request.
Where the DCC identifies any Device Alert where the current Firmware Version returned by the Device matches an entry on the CPL for that Device Model and that Firmware Version is different to the value currently held in the Smart Metering Inventory for that Device, an update to the Smart Metering Inventory shall be made by the DCC.
The DCC Systems shall update the DeviceFirmwareVersion data item within the Smart Metering Inventory to record the new DeviceFirmwareVersion value for the specified Device ID received in the Response. Where the DeviceFirmwareVersion for the specified Device is now the current valid version, and the Device Status was ‘Suspended’ and the Firmware Version returned by the Device matches an entry on the CPL for that Device Model with a status of “Current” the DCC Systems shall update the Device Status to the status it held immediately prior to its suspension and DCC Alert N29 will be sent only to the Responsible Supplier.
If the Firmware Version returned by the Device matches an entry on the CPL for that Device Model with a status of ‘Removed’, the SMI Firmware Version will be updated, and the Device Status will be set to ‘Suspended’. In this case DCC Alert N50 will be sent to the Responsible Supplier. In addition, DCC Alert N28 will be sent only to the Responsible Supplier to notify the suspension of the Device. All DSP Future Dated and Scheduled Service Requests shall be deleted for the ‘Suspended’ Device and DCC Alerts N40 and N41 will be sent to the Users responsible for those Service Requests.
If the Firmware Version returned by the Device is invalid (doesn’t match an entry on the CPL for that Device Model), and that Firmware Version is different to the value currently held in the Smart Metering Inventory for that Device, DCC Alert N51 will be sent to the Responsible Supplier and the Smart Metering Inventory Firmware Version will be updated with the Firmware Version returned by the Device. As there is no entry on the CPL, the Device Status of the Device will be set to ‘Suspended’ and an additional DCC Alert N28 will be sent only to the Responsible Supplier. All DSP Future Dated Service Requests shall be deleted for the ‘Suspended’ Device and DCC Alerts N41 will be sent to the Users responsible for those Service Requests.
DUGIDS service matrix
| Footnote | Extract | Column | Cell Value | Source |
|---|---|---|---|---|
| 2 | See section 2.3.10 for details on Firmware Distribution Mode of Operation | DCC Only | Yes | DS.0226 Table 36 Service Request Matrix |
Message Patterns & Examples