Elvaco CMe3100, User Manual

Page 1: ...CMe3100 DLMS Plugin User s Manual Version 1 8 CMe3100 DLMS Plugin User s Manual v1 8 ...

Page 2: ...8 5 3 4 2 Retrieving decoded data 18 5 3 5 Excluding OBIS codes from Push Reports 19 5 3 6 Meter mapping file properties 19 6 CONFIGURE PUSH REPORTS 21 6 1 DLMS PUSH REPORT SETTINGS 22 6 2 PUSH NOTIFICATIONS 22 6 3 DEFAULT DLMS SERVER SETTINGS 22 6 4 ENABLE PUSH REPORT OF LOAD PROFILE BILLING PROFILE 23 6 4 1 Select report type and schedule 23 6 4 2 Set DLMS server settings report receiver 24 6 5 ...

Page 3: ...jects 28 7 5 2 Meter logical device COSEM objects 33 7 6 PUSH NOTIFICATIONS 39 7 6 1 Periodical push data 39 7 6 2 Event triggered push of data 42 8 MANAGING CONFIGURATIONS 43 8 1 CONFIGURATION 43 8 2 BACKUP 43 9 DEVICE REPLACEMENT WORKFLOW 44 10 EXAMPLES AND GUIDES 45 DOCUMENT HISTORY 46 10 1 DOCUMENT SOFTWARE APPLIANCE 46 11 REFERENCES 47 12 TERMS AND ABBREVIATIONS 48 12 1 NUMBER REPRESENTATION ...

Page 4: ... The documentation and product are provided on an as is basis only and may contain deficiencies or inadequacies Elvaco AB takes no responsibility for damages liabilities or other losses by using this product 1 1 Copyright and Trademark 2022 Elvaco AB All rights reserved No part of the contents of this manual may be transmitted or reproduced in any form by any means without the written permission o...

Page 5: ...Version 1 8 2 Using this manual 2 1 Purpose and Audience This document covers installation configuration and usage of the CMe3100 DLMS Plugin add on 2 2 Models CMe3100 2 3 Additional and updated information Latest documentation version is available on Elvaco web site at https www elvaco com ...

Page 6: ...standards for Electricity metering data exchange by International Electrotechnical Commission The IEC 62056 standards are the International Standard versions of the DLMS COSEM specification DLMS or Device Language Message Specification originally Distribution Line Message Specification is the suite of standards developed and maintained by the DLMS User Association and has been adopted by the IEC T...

Page 7: ...lation procedure of the Plugin 4 1 Validate license information To be able to install the Plugin the Product must have the license for CMe3100 DLMS Plugin Validate the license information by navigating to Device Licenses Add ons See Figure 1 below Figure 1 Licenses Add ons page You may order licenses for any Add ons through contacting sales at Elvaco AB 5 ...

Page 8: ...n settings may be viewed through either Navigate to Configuration Services DLMS Click the Settings Elvaco DLMS link in the Add ons list to view the settings page of the DLMS Plugin Figure 2 DLMS Plugin Settings link 5 1 Overview The default selected tab in the DLMS Plugin settings is the Overview page The Overview page shows general information about the DLMS Plugin see Figure 3 Figure 3 DLMS Plug...

Page 9: ...uration for the Plugin OBIS meter mapping o Page containing settings for meter mapping information from M Bus meter data to COSEM data objects with OBIS code notation Help o Help section describing the DLMS Plugin linking to this document End user license agreement EULA Note You need to create appropriate OBIS meter mappings for meters used in order for readout of historical data and Push Reports ...

Page 10: ...interval for profiles Security Change settings to desired values and click save to store changes Figure 4 Settings page DLMS Settings 5 2 1 Enable disable the DLMS Plugin Enable or disable the Plugin by clicking the Activate DLMS checkbox 5 2 2 Configure listening TCP port number The TCP port number is the listening port for which the Plugin will listen for incoming TCP connections This port enabl...

Page 11: ...selection and Logical device addressing are supported in parallel 5 2 5 Value interval for profiles The Product enables poll push operation of three different generic profiles Load profile 1 Load profile 2 and Billing profile Figure 5 Settings page Value interval for profiles All three profiles can be configured individually to allow maximum flexibility regarding what value interval that is of int...

Page 12: ...he security policy can also be changed using the DLMS protocol see section 7 5 1 9 For security purposes the security policy can only be increased using the DLMS protocol This means that if the security policy should be decreased it must be done through using the GUI or any other configuration API for the Product For more information about security policy and which password and keys are used for a...

Page 13: ...CMe3100 DLMS Plugin User s Manual CMe3100 DLMS Plugin User s Manual page 13 48 2022 02 23 Version 1 8 Figure 7 Security ...

Page 14: ...c Recommended approach to meter mapping Always strive for a common global mapping file that works for all meters in the system This can be accomplished through for example A generic mapping file for all meter of a particular type water heat and if needed mapping several different M Bus keys to the same OBIS code The latter will bridge differences in how the M Bus keys are used in different meters ...

Page 15: ... on M Bus header information read from the meter These fields can also be set to all if the meter mapping should be applied regardless of for example manufacturer or version The column OBIS codes shows the number of mapped M Bus value fields to COSEM register objects If there is no mapping for a specific M Bus value the DLMS Plugin will exclude that value in all poll push operations and it will no...

Page 16: ...ited in a text editor preferably one that has support for highlighting JSON Update the contents of the file by connecting OBIS codes with corresponding M Bus keys VIF DIF combinations All OBIS codes must be configured for each entry in the mapping in order for the value to be available over DLMS The mapping can be made for a specific meter or made generic by setting manufacturer to all and or vers...

Page 17: ...ows all data to be queried over DLMS without mapping meter specific M Bus keys VIF DIF combinations to OBIS code There are two different ways to use simplified mapping 1 Retrieving raw M bus data 2 Retrieving decoded M bus data Raw M bus data and decoded M bus data can be retrieved over DLMS by using the corresponding keys in table 10 This is useful when using meters from multiple manufacturers M ...

Page 18: ...s headers can change over time for a specific meter for example as a result of a configuration change to the meter Example header serial number device identification created value data count manufacturer version device type access number status signature dif 0c vif 78 description fabrication no kind inst value tariff 0 subunit 0 storagenumber 0 dif 07 vif 7a description address kind inst value tar...

Page 19: ...mber 0 mbusSubUnit null mbusFunction null includeInPush ALL mbusTelegram 0 mbusKeys mbus telegram decoded header dlmsObisCode 0 0 1 3 128 255 dlmsScaler 0 dlmsUnit 0 dlmsClass data dlmsDataType 10 dlmsDefaultValue null mbusUnit null mbusDescriptionLong null mbusTariff null mbusStorageNumber 0 mbusSubUnit null mbusFunction null 5 3 5 Excluding OBIS codes from Push Reports By default all OBIS codes ...

Page 20: ...o a DLMS OBIS code Sub properties for property entries list of translation entries Property name Type Description dlmsClass String COSEM type clock register data profile_generic dlmsDataType Integer DLMS type dlmsDefaultValue String Default value used if a value is missing for the key For no value use null dlmsScaler Integer Numeric value used to scale the meters value The value may be negative Th...

Page 21: ... Standard Event Log gateway and meters Fraud Detection Log data gateway and meters Push Notification Notify a DLMS client when the meter list has changed Up to five different reports can be scheduled to run simultaneously Each report has individual settings with regards to type of report Load profile Billing profile Event log etc schedule server address and fallback server address Navigate to to C...

Page 22: ...ist changed by check uncheck the checkbox When enabled the product will send an event to the default DLMS server when a meter is added updated or removed See 7 6 2 1 for more information about the Push notifications 6 3 Default DLMS server settings Enter the default server address IP or hostname and TCP port to be used when sending push reports The backup server address and TCP port is used as a f...

Page 23: ...chedule is read only and shows the current read out schedule for meters connected to the Product Please note that the report schedule should be a multiple of the meter readout schedule The report is sent as soon as the last meter readout cycle has completed For example setting the meter readout schedule to 15 minutes and selecting 1 hour for load profile 1 a report will be sent as soon as every 4t...

Page 24: ...server in Default address and Port The Backup address and Port can be used as a fallback server if the report fails when sending report to the default address Figure 13 DLMS server settings report receivers A test report can also be triggered by clicking the Save and Send test report button 6 5 Enable Push Report of Standard event log Fraud detection log Standard event log and fraud detection log ...

Page 25: ...perations can be enabled to send load profiles billing profiles event log data and event notifications 7 1 Supported use cases Please see below for an overview of supported use cases Polling operations using TCP IP and xDLMS Services o Detection of logical devices using SAP Assignment o Detection of COSEM objects using association LN Long Names o Read load and billing profiles of connected M Bus m...

Page 26: ...ith MSByte order right justified to byte 8 The system title is built up from the logical device name of management logical device name Example Management logical device name gateway logical device name ASCII characters ELV000016000000 String hex representation 0x454C56303030303136303030303030 System title Byte array hex representation 0x454C560000F42400 7 3 Security There are three different authe...

Page 27: ... long Authentication key In DLMS for additional security an authentication key denoted AK is also specified When present it shall be part of the Additional Authenticated Data AAD The key must be at least 16 characters long Block cipher key The block cipher key also known as Encryption Key EK is used in the AES GCM algorithm The key must be at least 16 characters long Table 1 Encryption keys descri...

Page 28: ... is of interface class Data 1 The object holds a single LongUnsigned integer which is readable and writable on all logical devices The default channel selected after a successful association is the same as the logical device address The HES sets the value of this object using xDLMS SET Service Following APDU XML formatted for readability shows the format of such request selecting the management lo...

Page 29: ...255 Data 1 None R Specific Test Object 0 0 96 1 4 255 Data 1 None RW Standard Event Log 0 0 99 98 0 255 Profile Generic 7 None R Fraud Event Log 0 0 99 98 1 255 Profile Generic 7 None R Push Setup Gateway Standard Event Log 0 4 25 9 0 255 Push Setup 40 None R Push Setup Gateway Fraud Event Log 0 8 25 9 0 255 Push Setup 40 None R Push Setup On Install 0 7 25 9 0 255 Push Setup 40 None R Security Se...

Page 30: ...he corresponding channel which can be used for channel selection The APDU XML formatted for readability of the meter list should have the following format structure octet string COSEM logical device name of the gateway octet string array structure octet string COSEM logical device name of meter 1 octet string long unsigned Channel of meter 1 long unsigned structure structure structure structure oc...

Page 31: ...og Event Id Data type long unsigned This object holds the event id of the last event logged to Fraud Event Log 7 5 1 15 Fraud Event Log Event Message Data type visible string This object holds the event description of the last event logged to Fraud Event Log 7 5 1 16 Specific Test Object Data type octet string This object is used for testing and it should be ignored It doesn t hold any information...

Page 32: ...ts to be included in the Standard Event Log Push report For more information see 7 6 1 2 Push Event logs Attributes 1 Logical name 2 Push Object List 3 N A 4 N A 5 N A 6 N A 7 N A 7 5 1 19 Push Setup Gateway Fraud Event Log The push setup object holds the information about the objects to be included in the Fraud Event Log Push report For more information see 7 6 1 2 Push Event logs Attributes 1 Lo...

Page 33: ...ects Following COSEM objects are available in each meter logical device Description OBIS Code Interface Class Access A B C D E F Public client 16 Management client 1 SAP Assignment 0 0 41 0 0 255 SAP Assignment 17 R R Association LN 0 0 40 0 0 255 Association LN 15 R R Clock 0 0 1 0 0 255 Clock 8 R RW Logical Device Name 0 0 42 0 0 255 Data 1 R R Receive Frame Counter 0 0 43 1 0 255 Data 1 R R Cha...

Page 34: ...created from available data in the M Bus meter representing the meter logical device X According to OBIS meter mapping see section 5 3 X X X X X X Data 1 None R Table 3 Meter logical device COSEM objects 7 5 2 1 SAP Assignment SAP Assignment object can be read from the gateway to identify available logical devices 7 5 2 2 Association LN This object holds the list of available COSEM objects on curr...

Page 35: ...ion 7 5 2 7 Gateway Logical device name This object is a mirror of the logical device name of the gateway and is accessible on all meter logical devices in the gateway This enables read of the gateway logical device name when associating addressing a meter logical device See 7 5 1 4 for more information 7 5 2 8 Meter Firmware Version Data type octet string This object holds the meter firmware vers...

Page 36: ...on is configurable according to section 5 2 5 Attributes 1 Logical name 2 Buffer actual data Selector 0 all data and selector 1 from to implemented 3 Capture objects list of OBIS codes 4 N A 5 N A 6 N A 7 Entries in use in the database 8 Same as 7 COSEM objects OBIS codes Date Time 0 0 1 0 0 255 M Bus registers Depends on the OBIS meter mapping file see section 5 3 Limitations Maximum of 1000 rows...

Page 37: ...ata and selector 1 from to implemented 3 Capture objects list of OBIS codes 4 N A 5 N A 6 N A 7 Entries in use in the database 8 Same as 7 COSEM objects OBIS codes Date Time 0 0 1 0 0 255 Event object 0 0 96 11 0 255 Standard 0 0 96 11 1 255 Fraud Event message 0 128 96 11 0 255 Standard 0 128 96 11 1 255 Fraud Limitations Maximum of 1000 rows can be read in one request See 6 for available log ite...

Page 38: ...cts to be included in the Billing Data Push report For more information see 7 6 1 1 Push Profiles Attributes 1 Logical name 2 Push Object List 3 N A 4 N A 5 N A 6 N A 7 N A 7 5 2 21 Push Setup Gateway Standard Event Log The push setup object holds the information about the objects to be included in the Standard Event Log Push report For more information see 7 6 1 2 Push Event logs Attributes 1 Log...

Page 39: ... the value If it exists and the timestamp of the value is less than 60 seconds old the value is returned to the caller If the value is older or does not exist in the cache a readout from the meter is done This operation will interrupt any readout cycles in case they are running If the readout is successful the value is written to cache and returned to the caller In the case of a failing meter read...

Page 40: ...re unit and scaler for register 1 stored in profile structure structure unit and scaler for register m stored in profile structure array Each capture object must contain the following elements long unsigned interface class ID long unsigned octet string COSEM logical name octet string integer attribute index integer long unsigned data index long unsigned see 2 4 3 6 Each profile buffer entry must c...

Page 41: ...curity event section The fraud detection log only contains events from the Security event section The payload of the Data Notification APDU has the following structure for Gateway logical device management device octet string COSEM logical device name of the gateway octet string octet string COSEM logical name of the push setup object octet string octet string COSEM logical name of event log octet...

Page 42: ...eway is changed The event triggers a push with the event code On Installation which can be used by the HES to trigger a poll operation to update the meter list read meter list from the gateway The gateway will only trigger a single push even if more than one meter is added removed during an operation The hysteresis for grouping the event is three 3 minutes The payload of the Data Notification APDU...

Page 43: ...peration has finished the File repository section will contain the newly created configuration file This can then be used to update a device and or revert erroneous configurations To import a saved configuration Navigate to Configuration Manage configurations Click Choose File and select the exported configuration file from the old device Click upload To revert a configuration Navigate to Configur...

Page 44: ... needs to be replaced the configuration should be backed up from the device being replaced and import to the replacement device The steps for accomplishing this are described in section 8 Please note that the system title of the replacement device will be new since it s derived from the devices serial number The HES might need to be updated accordingly ...

Page 45: ...n 1 8 10 Examples and guides Please contact Elvaco to obtain integration support and access to example code Java DLMS Available examples and guides Reading historical data for load profile 1 load profile 2 billing period On demand readout of a meter Creating or updating an OBIS meter mapping file ...

Page 46: ...son 1 3 2016 09 16 Clarified content of standard event log and fraud detection log Emil Tirén 1 4 2016 11 21 Added new field in meter log push message containing gateway logical name section 7 6 1 2 Peter Janson 1 5 2017 01 23 Added more verbose description about OBIS meter mapping Emil Tirén 1 6 2017 03 30 Added 5 3 4 5 3 4 2 describing simplified mapping Daniel Svensson 1 7 2021 11 09 Add descri...

Page 47: ...rsion 1 8 11 References 1 DLMS UA 1000 2 Ed 8 0 Green book 2 DLMS UA 1000 1 Ed 12 0 Blue book 3 DLMS UA 1001 1 Ed 5 0 Yellow book 4 IDIS Package 2 IP profile Ed 2 0 5 EN13757 3 2013 Communication systems for and remote reading of meters Part 3 Dedication application layer 6 CMe3100 Log Events ...

Page 48: ...0 HES Head end system COSEM Companion Specification for Energy Metering DLMS Device language Message Specification OBIS Object Identification System IDIS Interoperable Device Interface Specifications 12 1 Number representation Decimal numbers are represented as normal number i e 10 ten Hexadecimal numbers are represented with prefix 0x i e 0x0A ten Binary numbers are represented with prefix 0b i e...