DLMS Class Description P05.H 09.09.09

8/2/2019 DLMS Class Description P05.H 09.09.09

1/190

Class Description

Firmware: Compiled for P05.HRevision Date: 09.09.2009

Landis+Gyr AG Revision Date: 09.09.2009 Page 1 / 190


2/190

Class Description Compiled for P05.H

Table of Contents

1 Introduction 41.1 Purpose of this Document................................................................................................................41.2 Validity Scope....................................................................................................................................41.3 Referenced Documents.....................................................................................................................4

1.4 Terms, Definitions and Abbreviations.............................................................................................4

2 Direct Memory Access 52.1 Used Rose Model...............................................................................................................................52.2 Common Description........................................................................................................................52.3 How to Navigate Through the Data Structure.................................................................................62.3.1 Building the Meter Model..................................................................................................................62.3.2 Property Description.........................................................................................................................62.3.3 Physical Model of Base....................................................................................................................72.4 Files Needed to Generate the Physical Address Table................................................................132.5 What Else can be Read?.................................................................................................................132.6 Special Things to Take Care...........................................................................................................13

2.6.1 Dependencies as Described Above................................................................................................132.6.2 Permanently Storing of RAM Data in EEPROM..............................................................................14

3 Classes 153.1 Protocol Selector [1-0-80-10122]....................................................................................................153.2 Data [1-0-1-20013]............................................................................................................................163.3 Diagnostic Register [3-0-81-20009]................................................................................................163.4 Energy Register [3-0-81-20010] .....................................................................................................203.5 Error Register [3-0-81-20011]..........................................................................................................223.6 General Value Register [3-0-0-20013].............................................................................................253.7 General Count Register [3-0-81-20015]..........................................................................................263.8 Meter State Register [3-0-80-20016]...............................................................................................273.9 Event Register [3-0-81-20018].........................................................................................................283.10 Energy Pulse Register [3-0-80-20020]..........................................................................................343.11 PF-Register [3-0-0-20053]..............................................................................................................363.12 Coincidental Demand Register[4-0-0-20049]...............................................................................373.13 Demand Pmax Register [4-0-0-20051]..........................................................................................393.14 PF-min Register [4-0-0-20054]......................................................................................................413.15 Extrema Register [4-0-0-20080]....................................................................................................433.16 Extrema Extended Register [4-0-1-20081]...................................................................................443.17 Demand Register [5-0-1-20050]..................................................................................................463.18 Event Log [7-1-5-20030]................................................................................................................483.19 Load Profile [7-1-5-20031].............................................................................................................51

3.20 Intermediate Value [7-1-5-20032]..................................................................................................543.21 Clock [8-0-80-0]..............................................................................................................................583.22 Script Table Class [9-0-1-10800]...................................................................................................633.23 Special Days Table [11-0-80-0].....................................................................................................643.24 DLMS Association View [12-0-1-0]...............................................................................................653.25 Association View LN [15-0-1-0].....................................................................................................663.26 SAP Assignment [17-0-0-0]...........................................................................................................673.27 IEC Set Up [19-0-80-0]...................................................................................................................673.28 Activity Calendar [20-0-81-0]........................................................................................................703.29 Monitor Register [21-0-81-0].........................................................................................................743.30 Single Action Schedule [22-0-81-0]..............................................................................................773.31 HDLC Setup [23-0-1-0]...................................................................................................................80

3.32 Modem configuration [27-0-81-0].................................................................................................823.33 PSTN auto answer [28-0-0-0]........................................................................................................873.34 Tariff Application [10002-0-81-0]..................................................................................................883.35 Measurement System MMI3 [10009-0-80-0].................................................................................95



3/190


3.35.1 Measurement System Calibration Data .....................................................................................1053.36 Object List [10010-0-1-0].............................................................................................................1083.37 Set Mode List [10011-0-1-0].........................................................................................................1123.38 Battery [10014-0-80-0].................................................................................................................1153.39 End List [10016-0-1-0]..................................................................................................................1163.40 Object of Rubbish [10017-0-82-0]...............................................................................................1193.41 Temperature Calibration [10018-0-80-0].....................................................................................124

3.42 Exception Handler [10020-0-81-0]..............................................................................................1243.43 VAA Definition [10022-0-80-0].....................................................................................................1263.44 Control Status [10025-0-80-0].....................................................................................................1283.45 Pulse Input [10026-0-80-0]..........................................................................................................1293.46 Battery Mode [10035-0-0-0].........................................................................................................1303.47 Reset Control System [10040-0-81-0].........................................................................................1313.48 Service Mode List [10051-0-0-0].................................................................................................1323.49 BatteryMonitoringActivate [10056-0-0-20040]...........................................................................1353.50 CalibrationModeActivate [10056-0-0-20041]..............................................................................1353.51 AlertIndicatorActivate [10056-0-0-20047]...................................................................................1353.52 SignalStrengthActivate [10056-0-0-20048].................................................................................1363.53 Demand Configuration Register [10080-0-2-0]..........................................................................1363.54 Meter Function [10100-0-81-0]....................................................................................................1413.55 Readable items [10110-0-0-0]......................................................................................................1443.56 GPRS CSD Modem Setup [10133-0-80-0]...................................................................................1443.57 Security Access light [10166-0-80-0]..........................................................................................1463.58 ASW Specific Attribute [10610-0-1-0].........................................................................................1483.59 ESW Specific Attribute [10611-0-80-0].......................................................................................1483.60 Instantaneous Pulse Output [10630-0-81-0]..............................................................................1493.61 SmsController [10660-0-80-0].....................................................................................................1553.62 Dedicated Event Log Config Class [10900-0-0-0]......................................................................1563.63 Dedicated Event Log Normal [10910-0-0-0]...............................................................................1583.64 Dedicated Event Log Simple [10920-0-0-0]................................................................................162

3.65 Dedicated Event Log Extended [10930-0-0-0]............................................................................1673.66 Dedicated Event Log HighestMaximumDemand [10940-0-0-0]................................................1723.67 Dedicated Event Log VoltageQuality [10950-0-0-0]...................................................................1753.68 Dedicated Event Log Parameter Change [10960-0-1-0]............................................................1793.69 Object GSM-Information [20052-0-80-0].....................................................................................182

4 Description of special Objects 1844.1 Hardware Identification.................................................................................................................1844.2 Storage of Dates............................................................................................................................1854.3 Identification Numbers..................................................................................................................1854.4 Measurement Constants...............................................................................................................1864.5 Counter Registers.........................................................................................................................187

4.5.1 Time Counting Registers..............................................................................................................1874.5.2 Event Counting Registers.............................................................................................................1874.6 Readable Items..............................................................................................................................1884.7 Display Objects..............................................................................................................................1884.8 Logical names of CIMA Objects...................................................................................................188



4/190


1 Introduction

1.1 Purpose of this Document

This paper contains two main parts used by the tool software developers to implement their parametrisation

software accessing the meter either by COSEM defined methods or by an internal used direct memory access tothe meter data.

1.2 Validity Scope

This paper may only be used by the development group of SIERRA. It's written by the meter software developers.

1.3 Referenced Documents

Ref. Doc-Number Title AuthorRef. 1,2,6 DLMS UA 1000-1:2007,

Eighth EditionCOSEM Identification System and Interface Classes (Blue Book) DLMS User Association

Ref. 3 H SIERRA 0078 Sierra Technical Specification C. Loder

Ref. 4 DKE AK 461.0.8 EDIS (Energie Daten Identifikations System) Version 1.6 1996

Ref. 5 H SIERRA 0132 Hardware Identification Dialog Meters T. Lindauer

Ref. 7 DLMS UA 1000-2:2007,Sixth Edition

DLMS/COSEM Architecture and Protocols (Green Book) DLMS User Association

1.4 Terms, Definitions and Abbreviations

Some names defined by COSEM were changed to fulfil the coding rules established. Underlines _ are generallyreplaced by starting the next word with a capital letter. To build a logical model use the internal terms.

COSEM Internal term

logical_name LogicalName

value CurrentValue

scaler_unit UnitScale



5/190


2 Direct Memory Access

2.1 Used Rose Model

Here we see the rose model of our base classes and as an example the classes used for an energy register.

Rose model of meter application objects

A

Mab_MeterApplicationBase

DLMSidentifier : Unsigned16RamDataSize : Unsigned16

EepromInitDataSize : Unsigned16IsA : Mab_ApplicationEnumType

VirtualName : Mab_VirtualNameEnumTypeRamData : Mab_RamData

EepromData : Mab_EepromDataFirstPropDesc : Mab_PropertyDescrEepromInitData : Mab_EepromDataNext : Mab_MeterApplicationBaseFirst : Mab_MeterApplicationBase

Mab_PropertyDescr

ReadVAAsWriteVAAs

Id(DLMSoffset)StorageLocation

DataTypeDataSize

DataOffset..........

Next : Mab_PropertyDescr

A

Mab_RamData

A

Mab_EepromData

IdString : UCHAR[12]LogicalName : UCHAR[8]

UnitScale : UnitAndScaleType

Mab_ApplicationEnumType

Mab_VirtualNameEnumType

Mer_EepromData

ConfiguredAndActivated : BOOLEANRamBackup : Mer_RamData

Mer_RamData

CurrentValue : Signed48Active : BOOLEAN

MValueNumber : Unsigned8

Mer_EnergyRegister

RamBackup

IsA

VirtualName

RamData

EepromData

FirstPropDesc

EepromInitData

Next

S

First

All this dataare in ROM

The name in the link map is:Mab_ApplicationBase_First

Next

2.2 Common DescriptionThis is an access method that may only be used for L&G internal stuff like development tests, parametrisation atoperations or special handling of our test group.This access method is dependent on the following items:

Used microprocessor Used compiler Compiled meter version Used C data type definitions

To see how to get the physical addresses of the different data we have to know the data model and where thedifferent data are stored.



6/190


2.3 How to Navigate Through the Data Structure

The entry point is the static First pointer of the class Mab_ApplicationBase. It's named Mab_ApplicationBase_Firstand stored in ROM (as every instance of Mab_ApplicationBase). This pointer points to the first data structure.The next object can be accessed by the Next pointer of the current structure. A NULL pointer indicates the end ofthe list.All these pointers point to a data structure allocated in ROM. So you are not able to modify them.For EOS meters

we have to declare all pointers to a constant with the keyword "const".The modifiable data can be accessed with the help of the pointers to the RamData and EepromData. The pointer toRamData is a real pointer used by the micro to address the data. The pointer to EepromData is a virtual pointer intothe serial EEPROM array.RamDataSize is used for generic backup and restore functions. EepromInitData and EepromInitDataSize is used tomake the first initialisation of the meter with a predefined and not modifiable configuration.

2.3.1 Building the Meter Model

All objects of the Mab_ApplicationBase together build the meter model (configuration) there are three mainattributes that identify the currently used class (real COSEM or proprietary COSEM style class with a possible"subclass") and DLMS addressing structure:

DLMSidentifierThis is the DLMS variable address of the LogicalName (please refer to the COSEM class to DLMSmapping) of the current object.Objects which are not accessable by communication have a value of ZERO in this attribute.

IsAThis is the identification of the class type of the current object. It corresponds with the class_id of theCOSEM specification. Subclasses (e.g. energy register within the register class) are additionally markedwith a subtype attribute as the first proprietary attribute.

FirstPropDescrThis points to the description of the first attribute accessible by DLMS.

Intern we also use a virtual addressing (attribute VirtualName) to identify a specific Object within a group of thesame class. This is an enumeration and (contrary to the LogicalName and IdString) not modifiable.

2.3.2 Property Description

The property description is used for every attribute you like to read out or write via DLMS. The functions that usethis property description are Mab_ApplicationBase_readProperty() and Mab_ApplicationBase_writeProperty(). Theproperty description describes the attribute type. All property descriptions of a class are organised in a simple list.Every class has its own list.

Data structure for a property description

typedef struct Mab_PropertyDescrDataTypeTag{

struct Mab_PropertyDescrDataTypeTag* Next; Pointer to property description of the next attributeUnsigned16 MemoryOffset; Memory offset in bytes. The offset is counted from

RamData (if RAM variable), from EepromData (ifEEPROM variable) or from this pointer (if ROMvariable).

Unsigned8 AttributeNumber; Number of attributes. Increments with 8, is alsothe DLMS address offset to the DLMSidentifier(DLMS base address of the object)

Cod_DataIdentifierType AttributeType; Defines the DLMS data type. If the internal datatype differs from the DLMS data type we are usinga own data type. This type defines the dataconversion from the internal to the external datatype.

Mab_MemoryKindEnumType KindOfMemory; defines where the variable is located: RAM, ROM,EEPROM

Unsigned8 AttributeLength; defines the size of the variable in bytes} Mab_PropertyDescrDataType;



7/190


2.3.3 Physical Model of Base

Each of the following classes is derived from this base class.

typedef struct Mab_ApplicationBaseDataTypeTag{

Mab_ApplicationBaseVFTType const* VFT;

struct Mab_ApplicationBaseDataTypeTag const* Next;

Mab_PropertyDescrDataType* FirstPropDesc;Unsigned16 DLMSidentifier;

void* RamData;

Emd_DataMemoryPointerType RamDataBackup

Unsigned16 RamDataSize;

Emd_DataMemoryPointerType EepromData;

void const* EepromInitData;

void const* RamDataBackupInitData

Unsigned16 EepromInitDataSize;

Mab_ApplicationEnumType IsA;

Mab_VirtualNameEnumType VirtualName;

Unsigned8 OwnClassVersion;

} Mab_ApplicationBaseDataType;

No first initialization for production; these attributes do not exist in code for production.This is not true for the EOS meter because there is always an initialisation for the production

typedef struct {Mab_IdStringDataType IdString;Mab_LogicalNameType LogicalName;Mab_UnitScaleType UnitScale;Array of Unsigned8 AttrVaaAccList;

Mab_UnitScaleType DisplayUnitScale;} Mab_EepromDataDataType;

The basic attributes have the following meaning and structure. The first two attributes are defined by COSEM andthe following three are proprietary.

LogicalName Type: octetstring [6]

Contains an identification the data contained in CurrentValue. Identifiers are specified based on the OBISidentification system. (Ref. 1). A list of the LogicalName values is give in Logical names of CIMA Objects.

UnitScale Type: UnitScaleType:

Provides information on the unit and the scaler of the value used for DLMS communications.

structure { scaler, unit }

scaler: integer8 This is the exponent (to the base of 10)of the multiplication factor. Remark: if the value is notnumerical then the scaler = 0 shall be used.unit: enum enumeration defining the physical unit as shown below:



8/190




9/190


unit::= enum Unit Quantity Unit name SI definition

(comment)

(1) a time year

(2) mo time month

(3) wk time week 7*24*60*60 s

(4) d time day 24*60*60 s

(5) h time hour 60*60 s(6) min. time min 60 s

(7) s time (t) second s

(8) (phase) angle degree rad*180/

(9) C temperature (T) degree celsius K-273.15

(10) currency (local) currency

(11) m length (l) metre m

(12) m/s speed (v) metre per second m/s

(13) m3 volume (V)

rV , meter constant or pulse value (volume)

cubic metre m3

(14) m3 corrected volume cubic metre m3

(15) m3/h volume flux cubic metre per

hour

m3/(60*60s)

(16) m3/h corrected volume flux cubic metre per

hour

m3/(60*60s)

(17) m3/d volume flux m3/(24*60*60s)

(18) m3/d corrected volume flux m3/(24*60*60s)

(19) l volume litre 10 -3 m3

(20) kg mass (m) kilogram

(21) N force (F) newton

(22) Nm energy newtonmeter J = Nm = Ws(23) Pa pressure (p) pascal N/m2

(24) bar pressure (p) bar 105 N/m2

(25) J energy joule J = Nm = Ws

(26) J/h thermal power joule per hour J/(60*60s)

(27) W active power (P) watt W = J/s

(28) VA apparent power (S) volt-ampere

(29) var reactive power (Q) var

(30) Wh active energy

rW , active energy meter constant or pulse value

watt-hour W*(60*60s)

(31) VAh apparent energy

rS , apparent energy meter constant or pulsevalue

vo lt-ampere-hour VA* (60*60s)

(32) varh reactive energy

rB , reactive energy meter constant or pulsevalue

var-hour var*(60*60s)

(33) A current (I) ampere A

(34) C electrical charge (Q) coulomb C = As

(35) V voltage (U) volt V

(36) V/m electrical field strength (E) volt per metre V/m

(37) F capacitance (C) farad C/V = As/V

(38) resistance (R) ohm = V/A

(39) m2/m resistivity ( ) m

(40) Wb magnetic flux () weber Wb = Vs

(41) T magnetic flux density (B) tesla Wb/m2



10/190


unit::= enum Unit Quantity Unit name SI definition

(comment)

(42) A/m magnetic field strength (H) ampere per metre A/m

(43) H inductance (L) henry H = Wb/A

(44) Hz frequency (f, ) hertz 1/s

(45) 1/(Wh) RW , active energy meter constant or pulsevalue

(46) 1/(varh) RB , reactive energy meter constant or pulsevalue

(47) 1/(VAh) RS , apparent energy meter constant or pulsevalue

(48) V2h volt-squared hour

rU2h , volt-squared hour meter constant or pulsevalue

vo lt-squared-hours V2(60*60s)

(49) A2h ampere-squared hour

rI2h , ampere-squared hour meter constant orpulse value

ampere-squared-hours

A2(60*60s)

(50) kg/s mass flux kilogram per second

kg/s

(51) S, mho conductance siemens 1/(52) K temperature (T) kelvin

(53) 1/(V2h) RU2 h , volt-squared hour meter constant orpulse value

(54) 1/(A2h) RI2h , ampere-squared hour meter constant orpulse value

(55) 1/m3 RV , meter constant or pulse value (volume)

(56) percentage %

(57) Ah ampere-hours Ampere-hour

(60) Wh/m3 energy per volume 3,6*103 J/m 3

(61) J/m3 calorific value, wobbe

(62) Mol % molar fraction of gas composition mole percent (Basic gascomposition unit)

(63) g/m3 mass density, quantity of material (Gas analysis,accompanyingelements)

(64) Pa s dynamic viscosity pascal second (Characteristic of gas stream)

.

(253) reserved

(254) other other unit

(255) count no unit, unitless, count

Some examples are shown below.

Value Scaler Unit Data

263788 -3 m3 263.788 m3

593 3 Wh 593 kWh

3467 0 V 3467 V

DisplayUnitScale Type: UnitScaleType

Provides information on the unit and the scaler of the value used for display. It has the same type as UnitScale

above.



11/190


Implementation Notes:

1) Valid scalers are those which can be shown in the display with the existing symbols:

0: units or no scaling3: k = kilo6: M = Mega

2) In case of energy and demand registers, this value must be set in accordance to the attribute UnitMeterof themeasurement system used:

3: k = kilo if UnitMeter = 0 (kWh)6: M = Mega if UnitMeter = 1 (MWh)

IdString Type: octetstring [12]Contains the identification number which is showed on display and readout together with the current value. It isusually coded using the EDIS identification system [Ref. 4]. The string must be 0x00 terminated.

Only for LCD PICO:

The last byte (byte 12) [in case of ELIO meters] or the first byte after the terminating zero-character of the

identifier, or, if the identifier has 11 characters, the 12th byte [in case of PICO meters] of the IdString of all energyregisters (see class Energy Register) is used to select the display symbols that represent the register. There aretwo display symbols: Frame and Rate (see figure below)

Frame

Rate

The individual bits of the 12th byte are used to select if the corresponding symbol is shown (bit =1) or is turned off(bit = 0). The correspondence between the bits and the symbols is the following:

Frame of Rate 4 Frame of Rate 3 Frame of Rate 2 Frame of Rate 1 Rate 4 Rate 3 Rate 2 Rate 1Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

All other unused bytes of IdString must be set to 0x00.

AttrVaaAccList Array [Number of attributes] of Unsigned8.

The definition of AttrVaaAccList depends on the security system used. There are two types of security systems:

Security Access VAA Definition

Security System Normal (CIMA)

class 10021

Security Access

class 10022

VAA Definition

Security System Simple (ELIO)class 10171Security Access Simple

class 10172VAA Definition Simple Security

Security System Light (EOS)Class 10166-0-60-0Security System Light

Class 10022-0-1-0VAA Definition

Security System Normal

AttrVaaAccList provides a reference to a read and write access list for each of the attributes of a class. It isorganized as an array: each attribute has a byte where the reference to the corresponding access list is made.

Byte 1 Byte 2 Byte 3 Byte N

Ref. to access list Ref. to access list Ref. to access list Ref. to access list

Attribute 1 Attribute 2 Attribute 3 Attribute N



12/190


The number set as reference to the access list corresponds to the desired list number as defined in SecurityAccess.

0 = ReadWriteList01 = ReadWriteList12 = ReadWriteList2 ..

127 = ReadWriteList127

Note: This attribute is always readable.

Security System Simple

AttrVaaAccList directly defines the read and write access for every attribute of a class. It is organized as an array:Every attribute has a byte where the read and write access is defined for every Vaa.


Access definition Access definition Access definition Access definition


The access definition is made with the bits of each byte as shown below:

Read Write

Vaa16 Vaa4 Vaa1 Vaa16 Vaa4 Vaa1

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

Security System light

AttrVaaAccList provides a reference to a read and write access list for each of the attributes of a class. It isorganized as an array: each attribute has a byte where the reference to the corresponding access list is made.


Ref. to access list Ref. to access list Ref. to access list Ref. to access list


The number set as reference to the access list corresponds to the desired list number as defined in SecurityAccess.

0 = ReadWriteList01 = ReadWriteList12 = ReadWriteList2 ..

63 = ReadWriteList63

Note: This attribute is always readable.

Only the following VAA's are used:


Vaa16 Vaa8 Vaa7 Vaa5 Vaa4 Vaa3 Vaa2 Vaa1

subtype Type: Unsigned16

Used to identify the proprietary subclasses of general class like Data or Register. Its value is 10000 (dec.)



13/190


2.4 Files Needed to Generate the Physical Address Table

To get all the physical addresses we have a tool called Xtractor.The Xtractor needs the following files:

build.lnk or EOS.x30 File generated by the linker in XCOFF or ELF /Dwarf 1.0 or 2.0 format.

config.c Source file. Contains the declarations of the DSW-objects.

Mab_app.h Source file.

Cgf_Port.h Source file.

Use Optional rom data types: The editor of the Xtractor allows to specify the type to use when analysingthe structure of an object eeprom part. Normaly, this type is the type of thevariable whose address is stored into object.EepromInitData. However, it isalso possible to directly specify the type to use.

2.5 What Else can be Read?

2.6 Special Things to Take Care

2.6.1 Dependencies as Described Above

2.6.1.1 Used microprocessor

There are two mainly used concepts of storing multiple byte data types (word, long): MSByte first and LSByte first.The used 78k0 is an Intel based micro and uses LSByte first.Some micros (specially 16/32 bit micros) are using a word alignment for multiple byte data types and for structureddata types (struct, array). I don't know why, but the 78k0 uses also a word alignment.All these dependencies are very stable and change only if we would change the micro family. So, don't worryabout! ! The M16C group of Renesas controllers uses the same Intel hex format as the K4 from NEC.

2.6.1.2 Used compiler

Some compilers allocate the members of a struct data type in the reverse order of the declaration. It's very seldomand compiler vendors normally never change their philosophy. IAR allocates the members in the same order asthey are declared.Due to the word alignment there may be some byte holes in a struct (or an array of struct with odd size) if there arebyte and multiple byte types mixed. Most compilers optimise the total size used for a struct by allocating byte sizemembers in these holes. This results in a chaotic order of the struct members.If this optimisation is used can be decided by the compiler vendor and can be added in a new compiler versionwithout any warning (normally only a remark in the readme file). It's up to the compiler vendor if this optimisationcan be switched off.

This optimisation can also be done by hand (like we are doing it) by ordering first the multiple byte data type andthen the single byte members.The current version of the IAR compiler makes no byte stuffing optimisation.The information of type allocation is only stored in the debug information of the object file for the emulator. We haveno description how to get this information out of that file. If we want to produce this information automatically withthe particular compiler version used for a specific meter version, we must create a test file, which has simpleconstants in ROM holding the offset information for each member of the structs we need.For the first versions this can be done by hand.

Restriction for the IAR M16C compiler: We have to use Byte align Objects in the general target settings.Otherwise the Rom default alignment is wrong. We have also to use the type specific word "const" to declare apointer to a constant. These pointers have a length of 4 Bytes instead of 2 or 3 Bytes with another compiler.

2.6.1.3 Compiled meter version

For each compiled meter version a new physical address table must be created. Together with older tables we canproduce a compatibility list that describes which address table is compatible with which meter versions.



14/190


2.6.1.4 Used C data type definitions

Changing the C data type definitions is directly coupled with the generation of a new meter version. So please referto the handling above.

2.6.2 Permanently Storing of RAM Data in EEPROM

All RAM data of an object have a one to one backup copy in the EEPROM data. Never try to modify the EEPROMcopy to produce a new value in the RAM. It will be overwritten at the next power down sequence.To permanently modify data in RAM you must modify the RAM data and produce a power down (to backup thedata in EEPROM. After the power up the new data get restored from EEPROM.



15/190


3 Classes

3.1 Protocol Selector [1-0-80-10122]

Firmware name: Psr_ProtocolSelector

Defines the initial protocol used in the various interfaces (channels) of the Fox3 meter.

ProtocolSelector 0..n class_id=1, version=0, OwnClassVersion=80

Attributes Data Type Min Max Def

1 LogicalName (static) octetstring 0000F01301FF

2 ProtocolAssignmentList (static.) Array[4]

Proprietary Attributes

3 subtype (const) Unsigned16 101224 OwnClassVersion (const) Unsigned8 805 AttrVaaAccList (static) octetstring 0x06 00 02 02

Attribute Description

ProtocolAssignmentList Array[4]Used to assign a protocol (e.g IEC or hdlc) to a selected communications channel. This attribute can handle up tofour channels, which are addressed separately by the individual array elements.

1st Element 2nd Element 3rd Element 4th Element

ProtocolAssignmentList Channel 1 Channel 2 Channel 3 Channel 4

Optical InferfaceElectrical interface 1

(Base board)Electrical interface 2

(Auxillary board)Not used

Each element of the array contains a structure with two fields: ClassId (Unsigned16) and LogicalName (type octet-

string[6]:

1st array element 2nd array element 4th array element

ProtocolAssignmentList ClassId LogicalName ClassId LogicalName ClassId LogicalName

The protocol selection is done by choosing the class ID and the logical of name of the class which contains thedesired protocol settings:

Protocol Class ID Logical Name Internal Object Interface

none 0 FFFFFFFFFFFF none

auto protocol (IEC orHDLC)

1 0000F01301FF Psr_ProtocolSelector Only supported by the electricalinterfaces 1+2

IEC 190000140001FF IECsetupDataCh1 Optical Interface0001140001FF IECsetupDataCh2 Electrical Interface 1

0002140001FF IECsetupDataCh3 Electrical Interface 2

HDLC 23

0001160000FF HDLCsetupDataCh1 Optical Interface

0002160000FF HDLCsetupDataCh2 Electrical Interface 1

0003160000FF HDLCsetupDataCh3 Electrical Interface 2

Implementation note: Internally (in the code) the virtual name is stored, but at interface level (DLMScommunication or pre-processing for production with the DLMS converter) the logical name and the class_id isused.

In Autoprotocol mode the electrical interface has no Autobaud. This means that it uses only one opening baudratecorresponding to the one set in attribute comm_speed of the HDLC setup class.Electrical interface with Autoprotocol: it never uses AutobaudOptical interface with Autoprotocol: it always uses Autobaud



16/190


The default value is defined below:

Channel 1 (Auto) Channel 2 (Auto) Channel 3 (Auto) Channel 4 (none)

1 0000F01301FF 1 0000F01301FF 1 0000F01301FF 0 FFFFFFFFFFFF

3.2 Data [1-0-1-20013]

This class is used to handle unitless quantities, mainly identification numbers. A list of these numbers is given insection Identification Numbers.

Data 0..n class_id=1, version=0, OwnClassVersion=1,

subtype=20013


1 LogicalName (static) octet-string[6]

2 CurrentValue (dyn.) instance specific


3 subtype (const) long-unsigned 20013

4 OwnClassVersion (const) unsigned 1

5 AttrVaaAccList (static) octet-string[6]

6 IdString (static) octet-string[12]


CurrentValue Type: instance specific

The content of the current value can be of any simple type, e.g. a string or a numeric value. The information onthe actual type is provided by the reference to its dlms type identifier.

3.3 Diagnostic Register [3-0-81-20009]

This class is used to process diagnostic values such as voltage, current, frequency, etc. It produces two outputs:one for display, monitoring, readout and the second for profiles. The diagnostic values for profiles are processed

with a low pass (averaging) filter. The filter is coupled to the demand measuring period.

Register 0..n class_id=3, version=0, OwnClassVersion=81


1. LogicalName (static) octetstring2. DisplayValue (dyn.) Instance

Specific3. UnitScale (static) UnitScaleType4. res_attribute15. res_attribute2

Specific Methods m / o

6. reset () O

7. res_service1Proprietary Attributes

8. subtype (const) Unsigned16 20009



17/190


9. OwnClassVersion (const) Unsigned8 8110. IdString (static) octetstring11. FilterValue (dyn.) Integer3212. MvalueNumber (static) Unsigned8 0 1613. AttrVaaAccList (static) octetstring14. DisplayUnitScale (static) UnitScaleType15. Resolution (static) Unsigned8

16. DiagnosticFlags(static)

Unsigned817. FilterCoeff (static) Unsigned818. ResetSourceSelection (static) Unsigned8


DisplayValue Integer32

This attribute holds the diagnostic value which is used for display, readout and external monitoring. The type ofdiagnostic value is selected using the attribute MvalueNumber below. The DisplayValue is scaled usingUnitScale. Its display and readout format can be selected using the attribute Resolution below

FilterValue Integer32

This attribute holds a diagnostic value which is filtered (averaged) for profiles. The average is calculated duringthe same time as selected for the measuring period of the demand measurement. The averaging characteristicsof the filter for this value are set using the attribute FilterCoeff below.

MValueNumber Unsigned8

Selects one of the diagnostic channels D1..D34.MValueNumber is set to the desired channel number accordingto the table below. A value of 0 indicates an unused register and therefore no value is processed. The thirdcolumn (default use of the channels) shows only examples which may be modified at any time. Implementationnote: the diagnostic register D10 and only this register, must be used for the calculation of the power factor asindicated in the table.

Assignment of the Diagnostic Registers for firmware P05:

Register Assignment MValueNumber

DiagnosticRegister34 Total Harmonic Distortion L3 84



DiagnosticRegister31 Total Harmonic Distortion all phases 81

DiagnosticRegister30 Power Factor L3 80



DiagnosticRegister27 Total Power Factor 77

DiagnosticRegister26 Apparent Power L3 76

DiagnosticRegister25 Apparent Power L2 75DiagnosticRegister24 Apparent Power L1 74

DiagnosticRegister23 Apparent Power All Phases 73

DiagnosticRegister22 Reactive Power L3 72



DiagnosticRegister19 Reactive Power all phases 69

DiagnosticRegister18 Active Power L3 68



DiagnosticRegister15 Active Power all phases 65

DiagnosticRegister14 Angle U3-I3 64DiagnosticRegister13 Angle U2-I2 63

DiagnosticRegister12 Angle U1-I1 62



18/190


Register Assignment MValueNumber

DiagnosticRegister11 Angle U1-U3 61



DiagnosticRegister8 Mains Frequency 58

DiagnosticRegister7 Current L3 57

DiagnosticRegister6 Current L256

DiagnosticRegister5 Current L1 55

DiagnosticRegister4 Neutral Current 54

DiagnosticRegister3 Primary Voltage L3 53



Resolution Unsigned8

This attribute allows to select the number of digits used before and after the decimal point for display and readoutpurposes. It is used for the DisplayValue but it does not affect its contents. The integer part is called pre-point andthe fractional part is called post-point. The selection is made using the two nibbles of the byte as shown.

Upper nibble Lower nibbleNumber of post-point digits Number of pre-point digits

DiagnosticFlags Unsigned8

A set of flags (coded in bits) which control some display features and the working mode of the register.

Bits

7 6 5 4 3 2 1 0DisplayValue: 1=enabled display =>"0"; 0=disabled display => - - ;PrimaryValues: 1= PrimaryValues; 0=normalNot usedNot used

Not usedNot usedNot usedNot used

DisplayValue: This bit allows selecting the way in which the DisplayValue is displayed when its value equalszero. If DisplayValue is set to 0, the DisplayValue is displayed with dashes ( - - ); ifDisplayValue is set to 1, the DisplayValue is displayed numerically ( 0 ). The actual number ofdigits shown depends on the settings made for attribute Resolution.

PrimaryValues: If this bit is set, than the PrimaryValue for this DiagnosticRegisters is calculated. For the followingdiagnostic measurements the secondary and the primary value is available:

VoltageCurrentActive PowerReactive PowerApparent Power

FilterCoeff Unsigned8

This attribute allows to select the properties of the filter used to average the values which are used for profiles.The averaging time is the same as selected for the capture period. The filter properties are given in two nibbles ofFilterCoefficient: the upper nibble has information of undersampling and the lower selects either the real averagecalculation or a factor relevant to the time constant for the filtering function.

Upper nibble Lower nibble

Number of values for undersampling Exponent of two of filters factor

The following table shows the values that must be used for the selected demand measuring periods:



19/190


Calculation method Z.D Z.QDemand Measuring

Period [min]Filtering Average

calculationUppernibble

Lowernibble

Uppernibble

Lowernibble

No filtering - - 0 0 0 0

1 yes - 1 5 5 5

2 yes - 1 6 5 6

3 yes - 1 6 5 64 yes - 1 6 5 6

5 yes - 1 7 6 7

10 yes - 1 8 6 8

15 yes - 2 8 9 8

20 yes - 3 8 B 8

30 yes - 4 8 9 9

60 yes - 8 8 9 A

1 - yes 1 0 1 0

2 - yes 1 0 1 0

3 - yes 1 0 1 0

4 - yes 1 0 1 0

5 - yes 1 0 1 010 - yes 1 0 1 0

15 - yes 1 0 1 0

20 - yes 1 0 2 0

30 - yes 1 0 2 0

60 - yes 1 0 4 0

The filter coefficients in the Z.Q meter are different as the data processing in Z.Q meters is done with a periodicityof 200ms, whereas in the Z.D meters it is 1000ms.

Implementation note: The following formula is used for this infinite impulse response (IIR) digital filter:

y[n] = y[n-1] + (a(x[n]-y[n-1])

wherey = FilteredValuex = CurrentValuea = 1/(2LowerNibbleOfFilterCoefficient)

andUndersampling according to UpperNibbleOfFilterCoefficient

If the real average calculation is selected, under sampling rate has to be set to a value that the amount of addedmeasurement values over a demand measuring period does not exceed 65000 at all (e.g. demand period would be400min / 24000sec. under sampling rate has to be set to 2). In the table above the maximum amount is set to 5000.To calculate those under sampling rates use the formula:

tSystemMeasuremen

odDemandPeri

t

tx

>

000'5

wherex = minimum under sampling ratetDemandpPeriod = actual demand measurement pediod (in sec.)tMeasurementSystem = data processing time of actual meter (for Z.Q 0.2sec., for Z.D 1.0sec.)

If upper nibble and lower nibble are set to 0, the filtered value holds the last actual measurement value.

ResetSourceSelection Type: Unsigned8

This attribute indicates when the internal average value summation and internal average value counter of theDiagnosticRegister is reset by internal functionalities such as cumulation reset, EOI, etc. The sources which canreset the contents of those internal values are selected bit wise as indicated in the figure below. If a bit is set to 1,

the average value summation and average value counter is reset to 0 (and from now a new average period starts)when the corresponding function occurrs; when set to 0 there is no reset. i.e. when all bits are set to 0 the energyregister cumulates the energy continuously and behaves as a normal register. The calculation mode is notaffected by this byte.



20/190


Bits7 6 5 4 3 2 1 0

Reset after Demand ResetReset after Measurement Period (demand calculation)Reset after Registration Period (load profile registration)Reset after Registration Period (2nd load profile registration)ReservedReserved

ReservedReserved

3.4 Energy Register [3-0-81-20010]

This class defines registers used for cumulation of energy and ampere-hours (Ah).

Register 0..n class_id=3, version=0,

OwnClassVersion=81


1 LogicalName (static) octetstring2 CurrentValue (dyn.) Instance Specific3 UnitScale (static) UnitScaleType4 res_attribute15 res_attribute2


6 reset () O

7 res_service1


8 subtype (const) Unsigned16 20010

9 OwnClassVersion (const) Unsigned8 8110IdString (static) octetstring11MvalueNumber (static) Unsigned16 0 812ConfiguredAndActivated (static) BOOLEAN 0 113AttrVaaAccList (static) octetstring14DisplayUnitScale (static) UnitScaleType15StatusFlags (mixed) Unsigned816ResetSourceSelection (static) Unsigned8 017 DigitsEnergyNormalMode (static) Unsigned818 DigitsEnergyCalibrationMode (static) Unsigned8

Proprietary Methods m / o

Implementation notes:

Firmware Versions P05:1) The instances EnergyTotalRegistersM13 to EnergyTotalRegistersM15 and the EnergyRegisters49 toEnergyRegister51 are fixed (in the firmware) assigned for Ah registration of phases L1 to L3 respectively.

2) The Ah registered during battery operation are fixed added to the registers at startup in normal mode.


CurrentValue Type: Long64Register contents. The CurrentValue is stored using 6 bytes in the following format:



21/190


Higher bytes Lower bytes

Sign and magnitude 32 Not used* Unsigned16pre-point post-point

A decimal point is assumed between the pre-point and the post-point sectors. The prepoint consists of 4 bytesformatted as sign and magnitude 32 (MSB = sign). The post-point has 2 bytes formatted as unsigned16. For DLMS

communication purposes the CurrentValue is packed in a Long64.*Implementation note: Due to memory alignment problems of the processor, two bytes are left unused betweenpostpoint and the decimal point.

The scaling of this value is determined by the setting of the attribute UnitMeter in the Measuring system used. IfUnitMeter is set to 0 (KWh) then the decimal point corresponds to KWh and the lower word shows 1/65536 of KWh;if set to 1 (MWh) then the decimal point corresponds to MWh and the lower word shows 1/65536 of MWh. Thescaling of attribute DisplayUnitScale must be set accordingly. When accessing to this attribute via DLMS, its scalingis given by the difference between the settings of DisplayUnitScale and UnitScale.

Examples: Assuming UnitMeter is set to 0 and CurrentValue = 0x78563412 i.e.: pre-point =0x00007856 post-point = 0x3412

- If DisplayUnitScale is scaled to Kilo 103 and UnitScale is scaled to Kilo (103 ) then a DLMS read will result in 0x7856 KWh

- If DisplayUnitScale is scaled to Kilo 103 and UnitScale is scaled to Units (100 ) then a DLMS read will result in 0x01D610BB Wh (thatequals 0x78563412 / 0x10000 * 1000)

MValueNumber Type: Unsigned16

Selects up to two of the measurement channels M1..M15 as sources for the register. For the definition of themeasurement channels refer to the used measurement system. The number of the selected channels (1 for M1, 2for M2 ..12 for M12) is given in each of the bytes. The lower byte is used for selecting one channel and the upperfor selecting a second one. A value of 0 in a byte indicates that no channel is selected for that byte. This attribute isused together with StatusFlags (see below) for adding or subtracting values to the contents of the register(CurrentValue). * see also implementation note for Ah!

Upper byte Lower byte

Reference to channel Reference to channel

ConfiguredAndActivated Type:BOOLEAN

Indicates if the register is not only configured (a static handling at compilation time), but also active (not in themeaning of a tariff activation). If it is false, the register is also not visible by the get object list service.It may be set only under producer access (by special L&G tool).

StatusFlags Type:Unsigned8

A set of flags (coded in bits) which control the working mode of the register.


X X NoResidualHandling

SecondaryValues

X A/S Calculationmode

active

Active: This bit is used (written) by the firmware for tariff purposes. When set to 1 the register is active, i.e. itcounts the energy; otherwise the register does not count the energy. In order to activate an energyregister it is necessary to select it in the class Tariff Application attribute OutputAssignment. Use thebytes labeled EnergyRegister1 .. EnergyRegister16.

Calculation mode: (this bit was called Delta in the previous version of this class). Calculation mode forCurrentValue. When set to 1, the CurrentValue can register positive and negative values (if negativeenergy is input when the register is 0, it registers negative values)Note: implemented but not tested;when set to 0 it is used as normal cumulative register and can only register positive values (ifnegative energy is input when the register is 0, it rolls over to the maximum positive value).

A/S: This flag is used in conjunction with MvalueNumber. When set to 0, the values of the measuring channelsreferenced by the nibbles ofMvalueNumberare added to the value in CurrentValue; when set to 1,

the value referenced by the lower nibble is added and the value referenced by the upper nibble issubtracted from the value in CurrentValue.


Decimal point


22/190


SecondaryValues: This bit is used to select the source of the registration for the EnergyRegister. If this bit is set toone, secondary values are used (i.e. the values after the transformer in the stations where the meteris placed, usually low voltages and currents). When this bit is set to 0 primary values are used. Thisis not supported in certification mode. Note: When secondary values are chosen, the meter ignoresthe 10's or 100's or 1000's scaling which may be applied using attribute ScaleFactorEnergy in theObjectOfRubbish. These factors are only relevant for primary values. The same number of pre-pointand post-point digits are used for the readout of both primary and secondary values. Implementation

Note: Ah registration is always made with secondary values otherwise there might be overrunproblems.NoResidualHandling: This bit is used to select if the residuals of the energy register are handled. The attribute

DigitsEnergyNormalMode determines the resolution used for the residual handling. When this bit isset to 0 the residuals are handled; when set to 1 they are not handled.


This attribute indicates when the CurrentValue of the EnergyRegister is reset by internal functionalities such ascumulation reset, EOI, etc. The sources which can reset the contents of CurrentValue are selected bit wise asindicated in the figure below. If a bit is set to 1, the CurrentValue is reset to 0 when the corresponding functionoccurs; when set to 0 there is no reset. i.e. when all bits are set to 0 the energy register cumulates the energycontinuously and behaves as a normal register. The calculation mode is not affected by this byte.

Bits7 6 5 4 3 2 1 0

Reset after Demand ResetReset after Measurement Period (demand calculation)Reset after Registration Period (load profile registration)Reset after Registration Period (2nd load profile registration)ReservedReservedReservedReserved

DigitsEnergyNormalMode Type: Unsigned8Defines the number of digits used to display or readout energy registers (either cumulative or delta) in normalmode. The information is coded in the two nibbles of the byte. The pre-point digits refer to the digits to the leftthe decimal point (integer part) and the post-point to the digits to the right of the decimal point (fractional part)


Number of post-point digits Number of pre-point digits

DigitsEnergyCalibrationMode Type: Unsigned8Defines the number of digits used to display or readout energy registers (either cumulative or delta) in calibrationmode. The information is coded in the two nibbles of the byte. The pre-point digits refer to the digits to the leftthe decimal point (integer part) and the post-point to the digits to the right of the decimal point (fractional part)


Number of post-point digits Number of pre-point digits

3.5 Error Register [3-0-81-20011]

Firmware name: ErrorHandler

This class offers a register for marking individual errors which may occur during the meter operation. The errors areorganised in four categories according to EDIS [Ref. 4].

Register 1 class_id=3, version=0, OwnClassVersion=81Attributes Data Type Min Max Def

1 LogicalName (static) octetstring2 CurrentValue (dyn.) octetstring



23/190


3 UnitScale (static) UnitScaleType4 res_attribute15 res_attribute2

Specific Methods M / o

6 reset () O7 res_service1Proprietary Attributes

8 subtype (const) Unsigned16 200119 OwnClassVersion (const) Unsigned8 8110 IdString (static) octetstring11 Mask (static) octetstring12 ErrMask4DispActive (static) BOOLEAN13 ErrMask4ReadoutActive (static) BOOLEAN14 AttrVaaAccList (static) octetstring15 DisplayUnitScale (static) UnitScaleType16 ResetMask (static) octetstring17 ResetMaskAccessList (static) Unsigned818 ErrorShadowRegister (dyn.) octetstring19 ErrorLog (dyn) octetstring

CurrentValue Type: OctetString (4 bytes)The CurrentValue is also called ErrorCategories and has the current state of the error register. This attribute iswritten by the firmware. It is organized in four categories according to EDIS: Time Base Failures, Read / WriteAccess Failures, Checksum Failures, Other Failures. The errors of each category are coded in one byte.

Byte 1 Byte 2 Byte 3 Byte 4

Time Base Read / Write Access Checksum Other Failures

Each category has individual error flags (bits) as shown below. When a bit is set to 1 it indicates an error state; 0means no error.

Time Base category:

Bits

7 6 5 4 3 2 1 0 Error Nr 1000000 Low battery2000000 Invalid time/date

Read / Write Access category:

Bits

7 6 5 4 3 2 1 0 Error Nr 10000 Main Memory (RAM)20000 Backup/Parameter Memory (EEPROM)40000 Measuring System (HMC, LINDA, SAPPHIRE)80000 Time Base (CTS)

100000 Load Profile Memory (FLASH, EEPROM)200000 Ripple Control Receiver (Option 1)400000 Communication Board (Option 2)800000 MMI board

Checksum category:

Bits

7 6 5 4 3 2 1 0 Error Nr 100 ROM (NEC P)



24/190


200 Backup Data (EEPROM)400 Parameter (EEPROM)800 Load Profile Data (FLASH, EEPROM)

1000 Intermediate values and Eventlog (or Intermediate Values only if bit 5 is used)2000 Eventlog4000 Calibration Data8000 2nd Load Profile

Other Failures category:Bits

7 6 5 4 3 2 1 0 Error Nr 01 Invalid power down02 Measuring System Overflow04 Re-programming data not valid08 Setting mode not completed10 System failure (Watchdog, Illegal OPCode ...)20 Communication locked (n times wrong password)40 Eeprom identifier not valid80 Wrong hardware ID

Mask Type: OctetString (4 byte)

Individual errors of any category can be masked if it is desired to hide them from display or communicationchannels. The mask has exactly the same format as the CurrentValue (see above). If a bit is set to 1, thecorresponding error flag is shown; if set to 0, the corresponding error flag is masked and thus not shown (shownas no error) in the appropriated display and / or communication channel. The masking of an error bit has noinfluence to its setting i.e. all error bits are set / reset independently of the state of this mask.

ErrMask4DispActive BOOLEAN

If true, the mask for display is active; i.e. the masked errors are not shown (shown as no error) in autoscroll modeonly. It is not possible to mask in the other modes of display.

ErrMask4ReadoutActive BOOLEAN

If true, the mask for readout is active; i.e. the masked errors are not shown (shown as no error) in any readout.DLMS read get the current value independent of the mask.

ResetMask Type: OctetString (4 bytes)

Individual error bits of any category can be selected to allow the bits to be cleared in the field (with an access levelas defined by the list pointed by ResetMaskAccessList). The mask has exactly the same format as theErrorRegisters. If a bit is set to 1, the corresponding error bit will be cleared when the access level of the metercorresponds to any one of those defined by the list pointed by ResetMaskAccessList; if set to 0, the correspondingerror bit is not cleared. The masking of an error bit has no influence to its setting i.e. all error bits are set when thecorresponding error condition exists independently of the state of this mask.

ResetMaskAccessList Type: Unsigned8

The contents of this attribute defines the list number (see attribute ReadWriteListin class SecurityAccess)whichis used to define the access level for selective error bit clearing. Also refer to attribute ResetMask above.

ErrorShadowRegister Type: OctetString (4 bytes)

The ShadowRegister has the same structure as attribute ErrorCategories. This attribute is written by thefirmware. It registers the same errors as attribute ErrorCategories, but it keeps record of all errors occurred inthe life time of a meter. It is not possible to delete this shadow register in the field.

Production feature: A new IEC formatted write command ( W2, 0xFF12 (0000) ) Reset ShadowRegister andErrorLog will be implemented. This command will be only accepted by the meter if its security system is open.Reading the ErrorShadowRegister or ErrorLog can be done by IEC unformatted read or via DLMS.

ErrorLog Type: OctetString (63 bytes)ErrorLog is written by the firmware. It registers the number of occurrences of certain predefined errors. Theregistration includes the timestamp of the first and the last occurrences of the errors. This attribute is kept in RAM-



25/190


backup; i.e. it is saved in non volatile memory with each backup. It is coded as a sequence of 6 elements, one foreach error:

1st Byte - 9th Byte 10th Byte - 18th Byte 19th Byte - 27th Byte 28th Byte - 36th Byte 37th Byte - 45th Byte

Element 1: Error 01 Element 2: Error 200 Element 3: Error 400 Element 4: Error 800 Element 5: Error 1000

46st Byte - 54th Byte 55th Byte - 63th Byte

Element 6: Error 4000 Element 7: Error 8000

Each element has the timestamps and the counter of occurrences as shown:

1st Byte - 4th Byte 5th Byte - 8th Byte 9th Byte

Element x TimeStamp first TimeStamp last Counter

TimeStamp first: Records the time stamp when the corresponding error occurred for the first time. Format:Unsigned32, number of seconds after 1.1.1990.

TimeStamp last: Records the time stamp when the corresponding error occurred for the last time. Format:Unsigned32, number of seconds after 1.1.1990.

Counter: It counts the number of occurrences of the corresponding error. Format: Unsigned8, permitscounting from 0 to 255; when its maximum is reached the counter stands still on the max valueand does not count anymore.

3.6 General Value Register [3-0-0-20013]

This class is used to handle general values of different types. It is often used for pure display registers or to showattributes of other classes as register values with an own OBIS code.

General Value Register 0..n class_id=3, version=0, OwnClassVersion=0,

subtype=20013


1 LogicalName (static) octet-string[6]

2 CurrentValue (dyn.) instance specific

3 UnitScale (static) UnitScaleType

4 res_attribute1

5 res_attribute2


6 reset () o

7 res_service1


8 subtype (const) long-unsigned 20013

9 OwnClassVersion (const) unsigned 0

10 IdString (static) octet-string

11 AttrVaaAccList (static) octet-string[12]

12 DisplayUnitScale (static) UnitScaleType



26/190



CurrentValue Type: instance specific

The content of the current value can be of any simple type, e.g. a string or a numeric value. The information of theactual type is provided by the reference to its dlms type identifier. The output is formatted using the UnitScaleattribute.

3.7 General Count Register [3-0-81-20015]

This is a counter register used for general purposes.



1 LogicalName (static) octetstring2 CountValue (dyn.) Unsigned323 UnitScale (static) UnitScaleType4 res_attribute1

5 res_attribute2Specific Methods m / o

6 reset () O7 res_service1


8 subtype (const) Unsigned16 200159 OwnClassVersion (const) Unsigned8 8010 IdString (static) octetstring11 AttrVaaAccList (static) octetstring12 DisplayUnitScale (static) UnitScaleType13 StatusFlag (mixed) Unsigned814 ResetSourceSelection (static) Unsigned8

CountValue Type: Unsigned32

Register contents used as counter.

StatusFlags Type:Unsigned8

A set of flags (coded in bits) which control the working mode of the register.


X X X X X RTC Battery counter Main Battery counter active

Active: This bit is written by the firmware to activate or inactivate a general count register. When set to 1 the

register is active, i.e. it counts; otherwise the register does not count.

Main Battery counter: This bit is used to indicate that the register is used for counting main battery time. Thisindication is used by the firmware for special handling when resetting all general countregisters or replacing the main battery.

RTC Battery counter: This bit is used to indicate that the register is used for counting RTC battery time. Thisindication is used by the firmware for special handling when resetting all general countregisters or replacing the RTC battery.


This attribute indicates when the CountValue of the General Count Register is reset by internal functionalities suchas cumulation reset, EOI, etc. The reset sources are selected bit wise as indicated in the figure below. If a bit is setto 1, the CountValue is reset to 0 when the corresponding function occurrs; when set to 0 there is no reset. i.e.when all bits are set to 0 the General Count Register counts upwards and behaves as a normal register.



27/190


Bits7 6 5 4 3 2 1 0

Reset after Demand ResetNot used (same as energy register)Reset after Registration Period (load profile registration)Reset after Registration Period (2nd load profile registration)ReservedReserved

ReservedReserved

3.8 Meter State Register [3-0-80-20016]

Firmware name: StateOfOperating, StateOfInternalSignals.

This class is used for the EDIS status register (C.4 and C.5) according to VDEW Version 2.1 of 14.04.2002

Register 0..n class_id=3, version=0, OwnClassVersion=80Attribute(s) Data Type Min Max Def

1 LogicalName (static) octetstring2 CurrentValue (dyn.) Instance Specific3 UnitScale (static) UnitScaleType4 res_attribute15 res_attribute2Specific Methods m / o

6 reset () O

7 res_service1

Proprietary Attributes8 subtype (const) Unsigned16 200169 OwnClassVersion (const) Unsigned8 80

10 IdString (static) octetstring11 AttrVaaAccList (static) octetstring12 DisplayUnitScale (static) UnitScaleType


CurrentValue Type: Octetstring [4]

Register contents shows states of the meter according to DIN 43863-3. This value is updated by the meter.

Implementation note: No RamDataType! CurrentValue will be calculated during read routine of the communication.

Order of the octets during readout in BMM, IEC Data Readout and DLMS is as follows:

Octet 4 Octet 3 Octet 2 Octet 1


Unused octets are filled up with 0.

The content of the CurrentValue for the different status registers according EDIS is coded as follows:

Internal control signals (C.4)

bit 1. Octet 2. Octet 3. Octet 4. Octet

b7 Control Signal 1 Control Signal 9 Direction signal P + not usedb6 Control Signal 2 Control Signal 10 Direction signal Q + Param. Switch 1b5 Control Signal 3 Control Signal 11 not used not used

b4 Control Signal 4 Control Signal 12 not used not usedb3 Control Signal 5 Control Signal 13 not used not usedb2 Control Signal 6 Control Signal 14 not used not used



28/190


b1 Control Signal 7 Control Signal 15 not used not usedb0 Control Signal 8 Control Signal 16 not used not used

Signal Description State definition DSW parameter Param. Switch 1 state of the parameterisation switch 1 0 = off; 1 = on (internal) HW signalDirection Signal P+ same as the display symbol +P 0 = -P or creep; 1 = +P (internal) P signalsDirection Signal Q+ same as the display symbol +Q 0 = -Q or creep; 1 = +Q (internal) Q signalsControl Signal x State of the internal control signal (CS) at the

corresponding x output of the OR-matrix0 = inactive; 1 = active CSx signals in the OR-

matrixNot used Unused bits Always set to 0 none

Internal operating status (C.5)

bit 1. Octet 2. Octet 3. Octet 4. Octet

b7 Voltage L1 Start-Up, active not used Reset Lock, manualb6 Voltage L2 Start-Up, reactive Set State Reset Lock, optical I/Fb5 Voltage L3 Start-Up, apparent TOU Control enabled Reset Lock, electrical I/Fb4 Phase sequence correct not used not used not usedb3 not used not used not used not used

b2 not used not used not used not usedb1 not used not used not used not usedb0 not used not used Alert occurred not used

Signal Description State definition DSW parameter Phase Sequence Correct same as display symbols L1 L2 L3 blinking 0 = incorrect; 1 = correct (internal) phase sequence signalVoltage Lx same as display symbol Lx 0 = off; 1 = on (internal) phase detection signalStart-Up, Apparent Active or reactive measurement above creep 0 = measurement inactive

1 = measurement active(internal) creep detection activeor reactive

Start-Up, Reactive Reactive measurement above creep 0 = measurement inactive1 = measurement active

(internal) creep detection active

Start-Up, Active Active measurement above creep 0 = measurement inactive1 = measurement active

(internal) creep detection active

TOU Control enabled RCR signals can control rate switching 0 = control off; 1 = on AndInputGroupEnableSet State Meter parameters may be set (set menu) 0 = inactive; 1 = active (internal) state of meter Reset Lock, electrical I/F * Lockout of reset signals after activation of a

cumulation with a communication commandvia CU or electrical interface *

0 = lock inactive; 1 = active (internal) state of lock timer(electrical I/F)

Reset Lock, optical I/F * Lockout of reset signals after activation of acumulation with a communication commandvia the optical interface *

0 = lock inactive; 1 = active (internal) state of lock timer(optical I/F)

Lock, manual Lockout of reset signals after activation of amanual cumulation

0 = lock inactive; 1 = active (internal) state of lock timer

Alert occurred An alert is registered 0 = no alert; 1 = alert Bit AlertOccurred (Nr. 106) of EventRegister

Not used Unused bits Always set to 0 none* Note: these two bits are set together whenever either channel is used, because the firmware can not recognize the specific channel

3.9 Event Register [3-0-81-20018]

Firmware name: Mpa_EventRegister

The event register handles events and changes in the error register. This class has several attributes to allow theenabling and filtering of the events. The event status bits as specified in the document H-DIAFIRE-1022 DetailedDescription of Events and Alarms.doc. The status of all these bits is held in an array of bytes. Similarly theselection for enabling events to trigger the event log or to set alerts or operational status bits is done using arrays ofbytes of the same dimensions as the event status.It is possible to inhibit multiple triggering produced by fast occurring events using one of 5 event timers. Thesetimers may be programmed with resolution of one minute. After the first registration of an event, further

registrations are inhibited during the programmed time defined in the timer. Many of the events may be also filteredin their own classes (for example in the monitor registers),




29/190



1 LogicalName (static) octetstring2 CurrentValue (dyn.) Unsigned8 0 FF 03 UnitScale (static) UnitScaleType4 res_attribute15 res_attribute2


6 reset () O7 res_service1


8 subtype (const) Unsigned16 200189 OwnClassVersion (const) Unsigned8 410 IdString (static) octetstring11 AttrVaaAccList (static) octetstring 0 812 EventStatus (dyn.) octetstring[25] 0 113 EventFilterSet (static) octetstring[25]14 EventFilterClear (static) octetstring[25]15 Timer (dyn.) octetstring[5]16 TimerControl (static) octetstring[5]17 Timeout (static) octetstring[5]

18 EdisStatus (dyn.) Unsigned3219 EdisStatusForEventlog (dyn.) Unsigned3220 AlertMask (static) octetstring[25]21 OperationalStatusMask (static) octetstring[25]22 EdisStatusForAdditiona

lLoadProfile(dyn.) Unsigned32


CurrentValue (LastEventNumber) Type:Unsigned8

This attribute is written by the firmware and it holds the event number of the last event which occurred. The list ofthe event numbers is given in EventStatus below.

EventStatus Type:OctetString [25]

An array of [20] bytes written by the firmware whose bits indicate the current status of 160 events, 32 of whichcorrespond to the errors. The events are coded in 25 bytes as shown below. The errors are coded in the sameway as they are defined in the class Error Register.

Every event is coded with a bit: 1 means the event is active; 0 means the event is inactive. The event bits are set(to 1) once they are detected; concerning their resetting the events are classified in three types: dynamic(once theevent is registered its status is automatically reset to 0), static(event clears by itself once its setting conditionceases) and fix (the event must be explicitly cleared e.g. via communication). Every event is represented with anevent number from 1 to 160 which is shown by CurrentValue. The following table shows the list of all events:

The document: H-DIAFIRE-1022 Detailed Description of Events and Alarms.doc contains the most recent anddetailed information on the EventStstus. This document is stored in SourceSafe ObjectIf



30/190


Byte bit Event / Alert Ev. Nr Byte bit Event / Alert Ev. Nr

0 Meter Parameter / Configuration changed 1 0 SmsFail 1051 Clearing of tariff registers 2 1 AlertOccurred 1062 Clearing of periodic data memory 3 2 SmsAlert 107

0 3 Eventlog cleared 4 13 3 Missing measurement voltage on all phases 1084 Battery low 5 4 Missing measurement current on all phases 1095 Battery removed (Not used) 6 5 Under voltage on all phases 1106 Battery ok 7 6 Apparent power too high 1117 Cumulation (Billing Period Reset) 8 7 Active power on L1 too high 112

0 Summer/winter season changed 9 0 Active power on L2 too high 1131 Adjusted time/date (old time/date) 10 1 Active power on L3 too high 1142 Adjusted time/date (new time/date) 11 2 Reactive power on L1 too high 115

1 3 State of control inputs changed to inactive 12 14 3 Reactive power on L2 too high 1164 State of control inputs changed to active 13 4 Reactive power on L3 too high 1175 Start of interval SOI of period 1 or period 2 14 5 Apparent power on L1 too high 1186 EOI Regular Internal of Period 1 15 6 Apparent power on L2 too high 1197 EOI Regular External of Period 1 16 7 Apparent power on L3 too high 120

0 Undervoltage on L1 VLA1 17 0 Voltage without Current on L1 1211 Undervoltage on L2 VLA2 18 1 Voltage without Current on L2 1222 Undervoltage on L3 VLA3 19 2 Voltage without Current on L3 123

2 3 Overvoltage on L1 VHA1 20 15 3 VT / CT Error Correction and CustomerAdjustment

124

4 Overvoltage on L2 VHA2 21 4 No Voltage and no current on L1 1255 Overvoltage on L3 VHA3 22 5 No Voltage and no current on L2 1266 Power down 23 6 No Voltage and no current on L3 1277 Power up 24 7 EnergyRegisterCleared 128

0 Overcurrent (overload) on L1 CTA1 25 16 0 MissingCurrentL1ForIwithoutU 1291 Overcurrent (overload) on L1 CTA2 26 1 MissingCurrentL2ForIwithoutU 1302 Overcurrent (overload) on L1 CTA3 27 2 MissingCurrentL3ForIwithoutU 131

3 3 Overcurrent (overload) on neutral CTA4 28 3 IwithoutUOnAllPhases 1324 Power factor threshold alert PFTA1 29 4 TerminalCoverOpened 1335 Power factor threshold alert PFTA2 30 5 StrongDCFieldDetected 1346 Power factor threshold alert PFTA3 31 6 FrontCoverOpened 1357 Power factor threshold alert PFTA4 32 7 EnablingOrDisablingOfEvent 136

0 Demand threshold alert DTA1 33 17 0 VoltageQuality_LL_Ph1 1371 Demand threshold alert DTA2 34 1 VoltageQuality_ LL_Ph2 1382 Demand threshold alert DTA3 35 2 VoltageQuality_ LL_Ph3 139

4 3 Demand threshold alert DTA4 36 3 VoltageQuality_L_Ph1 1404 Demand threshold alert DTA5 37 4 VoltageQuality_L_Ph2 141

5 Demand threshold alert DTA6 38 5 VoltageQuality_L_Ph3 1426 Demand threshold alert DTA7 39 6 VoltageQuality_H_Ph1 1437 Demand threshold alert DTA8 40 7 VoltageQuality_H_Ph2 144

0 Tampering alert (not used) 41 18 0 VoltageQuality_H_Ph3 1451 EOI Irregular (by time changing) Period 1 42 1 VoltageQuality_HH_Ph1 1462 EOI Rate Switching (tariff changing) Period 1 43 2 VoltageQuality_HH_Ph2 147

5 3 Corrupt measurement 44 3 VoltageQuality_HH_Ph3 1484 Clearing of Error Register 45 4 OpenShortenedCTPhase1 1495 Extreme temperature in meter > 60C 46 5 OpenShortenedCTPhase2 1506 Auxiliary bus operation 47 6 OpenShortenedCTPhase3 1517 Calibration data changed (Down Load Table). 48 7 PossibleDemandMaxima 152

0 Missing voltage L1 49 19 0 EndOfDemandMaximaWindow 1531 Missing voltage L2 50 1 CommSessionClosedChannel1 1542 Missing voltage L3 51 2 CommSessionClosedChannel2 155

6 3 Missing current L1 52 3 CommSessionClosedChannel3 156

4 Missing current L2 53 4 CommSessionClosedChannel4 1575 Missing current L3 54 5 Clearing of billing values profile 1586 Current without voltage L1 55 6 Clearing of energy values profile 1597 Current without voltage L2 56 7 Power up after long power down 160

0 Current without voltage L3 57 20 0 Meter changed 1611 Missing Additional Power Supply 58 1 Passive TOU activated 1622 All registers cleared 59 2 Meter Data OK 163

7 3 Buffer of Certification Sealed LogBook is full 60 3 Measurement System OK 1644 Active power too high 61 4 Communication Unit OK 1655 Reactive power too high 62 5 Firmware updated 1666 Wrong phase sequence 63 6 Enable Local Operation 1677 Over current in Neutral (not used) 64 7 Remote Connect 168

0 LowBattery, (Error 01 00 00 00) 65 21 0 Remote Disconnect 1691 InvalidTimeDate, (Error 02 00 00 00) 66 1 Remote On 1702 Reserved 67 2 Remote Off 171

8 3 Reserved 68 3 Enable Local Connection 1724 Reserved 69 4 Local On 1735 Reserved 70 5 Local Off 1746 Reserved 71 6 Max Demand over Threshold 1757 Reserved 72 7 Missing voltage L1 disappears 176



31/190


Byte bit Event / Alert Ev. Nr Byte bit Event / Alert Ev. Nr

0 RW_ access_ MainMemory, (Error 01 00 00) 73 22 0 Missing voltage L2 disappears 1771 RW_ access_ BackupParameterMemory, (Error

02 00 00)74

1 Missing voltage L3 disappears 1782 RW_ access_ MeasuringSystem, (Error 04 00 00) 75 2 Under voltage on L1 VLA1 disappears 179

9 3 RW_ access_ TimeBaseFlag, (Error 08 00 00) 76 3 Under voltage on L2 VLA2 disappears 1804 RW_ access_ LoadProfileMemory, (Error 10 00

00)77

4 Under voltage on L3 VLA3 disappears 1815 RW_ access_ RippleControlReceiver, (Error 20 00

00)

78

5 Over voltage on L1 VHA1 disappears 1826 RW_ access_ CommunicationBoard, (Error 40 00

00)79

6 Over voltage on L2 VHA2 disappears 1837 RW_ access_ MmiBoard (Error 80 00 00) 80 7 Over voltage on L3 VHA3 disappears 184

0 Checksum error ROM, (Error 01 00) 8123 0

Missing measurement voltage on all phases existno longer 185

1 Checksum error BackupData, (Error 02 00) 82 1 Max Demand over Threshold disappears 1862 Checksum error ParameterData, (Error 04 00) 83 2 Terminal Cover Closed 187

10 3 Checksum error LoadProfileData, (Error 08 00) 84 3 No longer Strong DC Field Detected 1884 Checksum error IntermediateData, (Error 10 00) 85 4 Active power too high disappears 1895 Checksum error EventLogData, (Error 20 00) 86 5 Reactive power too high disappears 1906 Checksum error CalibrationData, (Error 40 00) 87 6 Average voltage high 1917 Checksum error 2ndLoadProfileData, (Error 80

00)88

7 Average voltage low 192

0 InvalidPowerDown, (Error 01) 89 24 0 Clearing of 2nd load profile 193

1 MeasuringSystem, (Error 02) 90 1 SOI of Period 2 1942 ReProgrammingFail, (Error 04) 91 2 Current unbalanced 19511 3 SettingModeFailure, (Error 08) 92 3 Voltage unbalanced 196

4 SystemFailure, (Error 10) 93 4 Frequency high 1975 CommunicationLocked, (Error 20) 94 5 Frequency low 1986 EepromIdentifierFail, (Error 40) 95 6 Reserved 1997 WrongHardwareID, (Error 80) 96 7 Reserved 200

0 EOI Regular Internal of Period 2 971 EOI Regular External of Period 2 982 EOI Irregular (by time changing) Period 2 99

12 3 EOI Rate Switching (tariff changing) Period 2 1004 L1 delievers energy 1015 L2 delievers energy 1026 L3 delievers energy 1037 GeneralCountRegisterCleared 104

EventFilterSet Type: OctetString [25]

This attribute specifies those events that shall create an entry in the event log when their corresponding status bitsare set (=1). EventFilterSet is coded in the same way as EventStatus above. Those bits of EventFilterSet which areset to one will produce an entry in the event log when their corresponding status bits (in EventStatus) are set (=1).

EventFilterClear Type: OctetString [25]

This attribute specifies those events that shall create an entry in the event log when their corresponding status bitsare cleared (=0). EventFilterSet is coded in the same way as EventStatus above. Those bits of EventFilterSetwhich are set to one will produce an entry in the event log when their corresponding status bit (in EventStatus) arecleared (=0). This attribute may be used to create an event when a threshold register returns to normal.

Timer Type:OctetString [5]

An array of 5 bytes which holds the current value of the five timers (see also TimerControlandTimeoutbelow).This attribute is written by the firmware. The value of each byte shows the resting time expressed in minutes. Theorder of the bytes is the same for all three attributes: Timer, TimerControlandTimeout.

Byte 0 Byte 1 Byte 2 Byte 3 Byte 4Rest time of 1st timer Rest time of 2nd timer Rest time of 3rd timer Rest time of 4th timer Rest time of 5th timer

TimerControl Type: OctetString [5]

This is an array of 5 bytes which specifies those events that are inhibited during a specified timeout after their

occurrence. When a selected event occurs, a capture is triggered once and it can only be re-triggered after thespecified timeout has expired.This feature is used to avoid multiple event log entries whithin a short

DLMS Class Description P05.H 09.09.09

Documents

Transcript of DLMS Class Description P05.H 09.09.09