MIOS
MIOS
MIOS
001
Format
Version 2.3
th
Date 16 july 09
Table Of Contents Page
1 INTRODUCTION ................................................................................................................. 5
7.1 RESPONSIBILITY OF CFW FOR PREPARING MRI AND DOWNLOADING DATA FROM MRI ..... 29
7.2 RESPONSIBILITY OF PREPARING MRI AND DOWNLOADING DATA FROM MRI (API2) .......... 29
7.3 PREPARING MRI AND DOWNLOADING DATA FROM MRI CONFIGURATION FILE ................... 30
7.3.1 Dictionary of preparing MRI and downloading data from MRI configuration file ........ 31
Public
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 2 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 3 of 107
15 ANNEXURE ..................................................................................................................... 96
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 4 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 5 of 107
1 Introduction
1.1 Purpose
The intention of this document is to provide possible way forward by the metering companies so that
utilities can use common IT infrastructure to gather information from meters of all manufacturers. This
initiative should help the utilities to protect their investments in reading and billing infrastructure for
meters of all types. In order to achieve this goal this document provides specification of software
which can be used for acquiring meter data of different manufacturer & to provide data in common
format for further processing of meter data.
1.2 Scope
The computer system operates on different hardware & operating system. For the purpose of
simplicity PC hardware & Microsoft Windows operating system is used as operating platform. The
common framework software will operate on this platform & meter manufacturer will provide APIs for
this platform. It has been believed that meter manufacturer specific software will continue to operate.
The software written from this specification will simplify utilities every day work but there will still be
few technical operations left out for which manufacturer software will be used.
It has been assumed that the target application is to collect meter data from a fixed network on need
basis. The specification evolved here does not address on line data collection application or does not
address SCADA application. Since different meter continue to operate in it’s own way different makes
of meter will not be connected on the same connection point. Similarly meters can not operate with
different baudrate on the same network.
The common frame work software is not expected to operate on MRI. MRIs will continue to operate as
it is operating today whereby different manufacturer’s software co-exists on a common MRI.
This document does not specify that all meters will supply the same information. This document only
suggests that the same parameter is represented in the uniform way.
It is expected that each manufacturer will supply APIs as per the latest released version of the MIOS-
UMRCF specification. Each API will only comply to the respective manufacturer’s meters. The user of
the APIs (e.g. utility / System Integrator) will have to make their own arrangement for developing
software complying to Common framework specification (CFW).
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 6 of 107
1.4 References
No. Name Description
1 XML Legal site on XML standard www.w3c.org
2 RIPEMD - Algorithm for authentication. www.esat.kuleuven.ac.be
160
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 7 of 107
Meter
Make #1 #1 MRD #1 MRI #1 CFC
The common framework will provide interface for APIs to be plugged in. The above diagram
shows three important functionality reading the meters & common format converter being plugged
in the CFW. This will ultimately result in Common Data Format (CDF).
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 8 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 9 of 107
10. API shall take path/filenames and other parameter specified in configuration files provided
to the API and should not hardcode anything. Tag values written in this document are
suggested paths and are for example only.
11. Result file and common data format file generated should have all XML tags and
attributes in upper case.
12. API should create log file which can be used for debugging/troubleshooting purpose.
User
selects the
operation
to be
performed
with meter
IP address and
Port number
Common Manufacturer’s
framework modules (API)
program
This is Interprocess protocol to have an effective means of communication between the two
systems. The two systems will communicate with each other through sockets by establishing a
TCP/IP connection and passing messages on this channel.
The system suggested ion this section is mainly designed to take care of the situation where
immediate attention is to be drawn during normal or abnormal condition. Smaller message will be
transferred via TCP/ IP link while bigger message will still be transferred via configuration file.
• This protocol passes meter wise information. Therefore, for each meter reading it will
pass one message to the manufacturer API whereas the API in turn passes a message
for each meter reading with instance number.
• CFW will control the traffic to the API & on TCP/IP message stream.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 10 of 107
5.1 Header
The message header would be comprised of the following fields:
Header Length: This contains the length of the header record. This is fixed to 16 for this protocol
Data Length: The length of the data packet to read after the message header
Note: All the field values shall be passed in ASCII format, for example 12 will be sent as ‘12’ and
so on.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 11 of 107
03 Abort & 00: Abort Meter 00: Abort Request CFW to API
close reading 01: Abort & close
Operation 01: Abort MRI
download
02: Abort MRI
prepare
03: Abort Convert
to common format
04 Report 00:Meter reading 00: In progress Response API to CFW
progress 01:MRI download 01: Connection
02:MRI prepare established.
03:Convert to 02: Meter reading
common format started
03: Meter reading
finished
04: CDF conversion
successful
05: Idle state
51: Cannot establish
connection – No dial
tone
52: Cannot establish
connection – Local
Modem not
responding
53: Cannot establish
connection – Line
busy
54: Cannot establish
connection – Port
not available
55: Cannot establish
connection – No
hand shaking
56: Line
disconnected
57: CDF Conversion
failed – File
structure corrupted
58: CDF Conversion
failed – file write
error
59: CDF Conversion
failed – File not
found
60 :User Abort
61: Process stopped
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 12 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 13 of 107
common format
06 Request for 00:Default value 00:Default value Request CFW to API
API
identificatio
n
07 Response 00:Default value 00:Default value Response API to CFW
to API
identificatio
n
command
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 14 of 107
1600870100000001C:\Program Files\CFW\SML\ConfigurationFiles\READCFG \
InstanceID_Readcfgfile .XML
There is no data in this command; therefore the data length is 00. The above packet will be
enclosed within TCP/IP framework.
There is data in this command; therefore the data length is 38. The above packet will be enclosed
within TCP/IP framework.
There is no data in this command, therefore the data length is 00. The above packet will be
enclosed within TCP/IP framework. In case of multiple thread of an API abort command will only
kill a particular instance Id of the TCP / IP link. In case instance Id is 0000 then all the instances
will be closed & API will be terminated.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 15 of 107
To indicate BR at which the connection is established the message format can be as follows:
1600040400010001,4800
For Audit Trail Mode: - API will respond more frequently to CFW while meter reading is going
on.
Example:-
0001|1600080200000001|ACCEPTED
1600250400010001|TRND0001,MakingConnection
1600400400000001|TRND0001,ReadingInstParams, Message:1
1600400400000001|TRND0001,ReadingInstParams, Message:2
1600400400000001|TRND0001,ReadingInstParams, Message:3
1600400400000001|TRND0001,ReadingInstParams, Message:5
1600360400000001|TRND0001,ReadingEnergy, Message:1
1600360400000001|TRND0001,ReadingEnergy, Message:2
For Silent Mode: - API will respond only at start and end step to CFW while meter reading action
is performed. Example:-
1600080200000003|ACCEPTED
1600160400030003|TRND0001,Success
For Mile stone Mode: - API will respond only on major steps to CFW while meter reading action
is going on. Example:-
1600080200000002|ACCEPTED
1600250400000002|TRND0001,MakingConnection
1600260400000002|TRND0001,ReadingInstParams
1600220400000002|TRND0001,ReadingEnergy
Header
Field Size Example
Header Length 2 16
Data Length 4 0041
Command 2 05
Command Qualifier 2 00
Additional Qualifier 2 00
Instance Number 4 0001
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 16 of 107
Data
No Field
1 Message
The entire packet will be like 1600410500000001 Meter No XYZ0001, Phase 2- Step 2 complete
The above packet will be enclosed within TCP/IP framework.
Example 6. Request for API identification
Header
Field Size Example
Header Length 2 16
Data Length 4 0000
Command 2 06
Command Qualifier 2 00
Additional Qualifier 2 00
Instance Number 4 0001
Header
Field Size Example
Header Length 2 16
Data Length 4 0010
Command 2 07
Command Qualifier 2 00
Additional Qualifier 2 00
Instance Number 4 0001
6 Meter Reading
This function enables CFW to meter of any make. User will select the data to be read from meter.
CFW will generate configuration file which will specify connection details and data to be read from
meter. CFW will invoke Manufacturer reading module (API 1) to read the meter and store the data
in manufacturer specific format in manufacturer folder.
Multiple meter reading option is applicable only when more than one meter is connected on the
same network (or on the same telephone line). When multiple meters reading option is chosen
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 17 of 107
each meter is read sequentially. Next meter reading is started once first meter reading is
completed.
User
selects the Meter
Connection details
operation Make #1
(Connection type,
to be
Baudrate, Device
performed
ID,
with meter
port)
What to read from
meter? Meter
ReadMeter Make #2
Audit trail/
Result log
Meter
Common Manufacturer’s Make #3
framework Reading (MR)
program modules (API)
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 18 of 107
<READAPI>
<INSTANCEID>0009</INSTANCEID>
<CONNECTIONDETAIL>
<BAUDRATE>1200</BAUDRATE>
<CONNECTIONTYPE>PSTN</CONNECTIONTYPE>
<MODEMMAKE>MultiTech ZX</MODEMMAKE>
<MODEMCONFIGFILE>C:\CFW\modem.cfg</MODEMCONFIGFILE>
<DIALRETRY>3</DIALRETRY>
<PORT>COM1</PORT>
<TELEPHONENUMBER>989156</TELEPHONENUMBER>
<MULTIPLEMETERS>No</MULTIPLEMETERS>
<SERIAL>NDP18271</SERIAL>
<DEVICEID>0</DEVICEID>
</CONNECTIONDETAIL>
<WHATTOREAD>
<INSTPARAM>Yes</INSTPARAM>
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 19 of 107
<ENERGYDATA>0</ENERGYDATA>
<EVENTS>no</EVENTS>
<LOADPROFILE>
<DAYS>0</DAYS>
<TYPE>partial</TYPE>
</LOADPROFILE>
</WHATTOREAD>
<PATHANDNAME>
<DATAFILEPATH>C:\CFW\MANUFACTURER\SEMS\METERDATA</DATAFILEPATH>
<RESULTFILE>C:\CFW\MANUFACTURER\SEMS\READRESULT\ReadResult_0009_0501200512158.XML</RESULTF
ILE>
</PATHANDNAME>
<COMMAND>
<TIMESYNCH>No</TIMESYNCH>
<MDRESET>No</MDRESET>
<TAMPERRESET>No</TAMPERRESET>
</COMMAND>
</READAPI>
Element Details
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 20 of 107
MODEMCONFIGFILE, TELEPHONENUMBER
Is Contained by: READAPI
Attribute : None
Occurrence: Single
DataType: N/A
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 21 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 22 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 23 of 107
Contains: None
Is Contained by: PROFILEDATA
Attribute : None
Occurrence: Single
DataType: Can only take values defined above
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 24 of 107
PATHANDNAME Description: Specify the path and name for the files used by
CFW and API1.
Contains: DATAFILEPATH, RESULTFILE
Is Contained by: READAPI
Attribute : None
Occurrence: Single
DataType: N/A
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 25 of 107
Occurrence: Single
DataType: Alphanumeric
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 26 of 107
Element Description
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 27 of 107
Attribute : None
Occurrence: Single
DataType: N/A
INSTANCE Description: This node will appear for every instance result. If result of the
instance id is to be appended in same file then a new instace tag shall be
created.
Contains: Serial, DATETIME, RESULT, OUTPUTFILENAME,
INSTANCEID
Is Contained by: ReadingResult
Attribute : None
Occurrence: One or more
DataType: N/A
INSTANCEID Description: This contains the value of instance number which is a running
number for the request given by CFW to API. It should be four digit number
with ‘0’ appended in beginning if number is less then 4 digit.
Contains: None
Is Contained by: INSTANCE
Attribute : None
Occurrence: Single
DataType: Numeric
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 28 of 107
Occurrence: Multiple
DataType: Alphanumeric
DEVIATION Description: Holds the sub-tags of ‘WhatToRead’ tag for which deviation is
taken.
Contains: Empty sub-tags of WHATTOREAD
Is Contained by: Instance
Attribute : None
Occurrence: Single
DataType: None
0 Success
1 Failure
6.4.3 Support to read remote device having one or multiple meter data
Remote device periodically reads data from meter and stores the same into it’s local memory.
CFW will have to collect the data from this device.
API1 will support reading meter or remote device. The read data will be stored in manufacture
specific folder. Remote device support is restricted to device supplied by the meter manufacturer.
Tag to be passed in Reading Configuration file is explained below
<REMOTEDEVICE> Two possible values either METER or RMD. If the value is “RMD” then
API will get to know that the reading will happen from remote device therefore read
accordingly, If this tag is not present the default value would be assumed as mater.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 29 of 107
7.1 Responsibility of CFW for Preparing MRI and downloading data from MRI
User Communication
selects the and other details MRI
operation (MRI type, Make #1
to be Baudrate,
performed Comport)
with meter What to read from
meter/MRI ..? Clear MRI
MRI
Clear MRI ? MRI Operation Make #2
Prepare
Invoke MRI API Result log
with above details
Manufacturer’s MRI
Common Make #3
framework MRI Prepare &
Downloading
program
modules (API)
1) Ask from user what action does he want to perform either Preparing MRI or Download form
MRI
2) According to point 1, create configuration in XML format. This file contains information like
a. What operation to perform (Prepare/Download)
b. What to read from meter (Instantaneous, energy, events, tampers)
c. MRI makes and communication details baudrate (between PC & MRI) & comport.
d. Whether or not to clear the MRI files.
3) CFW should provide facility to select meter manufacturer whose APIs are to be invoked
during preparing or downloading operation.
4) Invoking meter manufacturer specific MRI API for preparing or downloading operation.
5) Deciding course of action based on the result file.
6) The naming convention of MRI read configuration file is INSTANCEID_MRICFGFILE.XML for
e.g. 0003_ MRICFGFILE.XML
7) The naming convention of MRI result configuration file is
INSTANCEID_MRIRESULTFILE.XML
8) Configuration file should contain meters of only one make.
7.2 Responsibility of preparing MRI and downloading data from MRI (API2)
1) Prepare MRI
a. Delete all temporary or incomplete files from MRI.
b. Upload schedule files in MRI.
c. Create result file.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 30 of 107
2) Download MRI
a. Read from MRI and transfer data files in manufacturer specific folder on PC.
b. Delete all temporary or incomplete files from MRI.
c. Create result file.
d. The data file name should be prefixed with ‘MRI’ letter.
Note: API shall take path/filenames and other parameter specified in configuration files provided to the
API and should not hardcode anything. Tag values written in this document are suggested paths and
are for example only
7.3 Preparing MRI and downloading data from MRI configuration file
Prepare MRI feature is optional & may not be supported by all meter manufacturer.
This file contains the information about Whattoread (Instantaneous, energy, events, tampers), make
of MRI, Data format, Path related information, port or whether to clear the MRI or not. The structure of
the file is
Prepare e.g.
<MRIAPI>
<INSTANCEID>0001<INSTANCEID>
<WHICHMRI> MRI MAKE1 </WHICHMRI>
<DATAFORMAT>NORMAL </DATAFORMAT> OR COMPRESSED
<PROTOCOLTYPE>STANDARD</PROTOCOLTYPE>
<IPADDRESS>120.75.29.30</IPADDRESS>
<PORT> COM1 </PORT> -- PORT NUMBER IF IP ADDRESS IS GIVEN ( 10020)
<BAUDRATE>9600</BAUDRATE>
<SERIAL>NDP18271</SERIAL>
<PREPARE>
<WHATTOREAD type=”full/custom>
<INSTPARAM>Yes</INSTPARAM>
<ENERGYDATA>1</ENERGYDATA>
<EVENTS>no</EVENTS>
<LOADPROFILE>
<DAYS>0</DAYS>
<TYPE>partial</TYPE>
</LOADPROFILE>
</WHATTOREAD>
<DELETEFROMMRI>YES </DELETEFROMMRI>
<PATHANDNAME>
<MRISCHEDULEFILEPATH>C:\DATA\ </ MRISCHEDULEFILEPATH >
<RESULTFILE>C:\CFW\MANUFACTURER\0001_MRIRESULTFILE.XML</RESULTFILE> (ALWAYS IN APPEND
MODE)
</PATHANDNAME>
</PREPARE>
</MRIAPI>
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 31 of 107
Download e.g.
<MRIAPI>
<INSTANCEID>0002<INSTANCEID>
<WHICHMRI> MRI MAKE1 </WHICHMRI>
<DATAFORMAT>NORMAL </DATAFORMAT> OR COMPRESSED
<PROTOCOLTYPE>STANDARD</PROTOCOLTYPE>
<IPADDRESS>120.75.29.30</IPADDRESS>
<PORT> COM1 </PORT> -- PORT NUMBER IF IP ADDRESS IS GIVEN ( 10020)
<BAUDRATE>9600</BAUDRATE>
<SERIAL>NDP18271</SERIAL>
<DOWNLOAD>
<DELETEFROMMRI>YES </DELETEFROMMRI>
<PATHANDNAME>
<PCDATAFILEPATH>C:\CFW\MANUFACTURER\ABC</PCDATAFILEPATH>
<RESULTFILE>C:\CFW\MANUFACTURER\ 0002_MRIRESULTFILE.XML</RESULTFILE> (ALWAYS IN APPEND
MODE)
</PATHANDNAME>
</DOWNLOAD>
</MRIAPI>
7.3.1 Dictionary of preparing MRI and downloading data from MRI configuration file
Element Description
MRIAPI Description: This is root node for preparing MRI and downloading data
from MRI configuration file.
Contains:
WHICHMRI,DATAFORMAT,PROTOCOLTYPE,IPADDRESS,PORT,
BAUDRATE, PREPARE,DOWNLOAD
Is Contained by: None
Attribute : None
Occurrence: Single
DataType: N/A
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 32 of 107
Attribute : None
Occurrence: Single
DataType: Numeric
DATAFORMAT Description: Holds value of data type which can either be compressed
or can be normal. This is an optional tag.
Contains: None
Is Contained by: MRIAPI
Attribute: Compressed, Normal
Occurrence: Single
DataType: Alphanumeric
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 33 of 107
Occurrence: Single
DataType: Alphanumeric
DOWNLOAD Description: This is root node for download data from MRI. This is an
optional tag
Contains: PATHNAME, DELETEFROMMRI
Is Contained by: MRIAPI
Attribute : None
Occurrence: Single
DataType: Numeric
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 34 of 107
DataType: Numeric
PCDATAFILEPATH Description: Specify the path where the files are to be transferred to
PC
Contains: None
Is Contained by: PATHNAME
Attribute : None
Occurrence: Single
DataType: Alphanumeric
OUTPUTFILENAME Description: Specify the path where the files are to be transferred to
PC
Contains: Filename
Is Contained by: PATHNAME
Attribute : None
Occurrence: Single
DataType: Alphanumeric
FILENAME Description: Specify the path where the files are to be transferred to
PC
Contains: None
Is Contained by: OUTPUTFILENAME
Attribute : None
Occurrence: Multiple
DataType: Alphanumeric
PREPARE Description: This is root node for preparing MRI. This is an optional tag
Contains: PATHNAME, WHATTOREAD
Is Contained by: MRIAPI
Attribute : None
Occurrence: Single
DataType: Numeric
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 35 of 107
WHATTOREAD Description: Specifies about what data to be read from Meter. It has
two attributes 1. Full 2. Custom
FULL- All data to be read from Meter
Customer- Partial data to be read Meter
Contains: INSTPARAM, BILLINGDATA, LOADPROFILE, EVENTS
Is Contained by: PREPARE
Attribute : FULL, Custom
Occurrence: Single
DataType: N/A
ENERGYDATA Description: Holds 0 for current, -1 for history1 (the most recent), -2 for
history set previous to the most recent & so on. Holds 1 for complete
reading. Holds ‘NO’ if Energy data should not be read. The selection is
not applicable for information appearing under D6, D7.
Contains: None
Is Contained by: WHATTOREAD
Attribute : None
Occurrence: multiple
DataType: Can only take values defined above
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 36 of 107
Occurrence: Single
DataType: None
DAYS Description: Holds number of days of profile data to be read. ‘0’ days
will indicate no data to read. This is an optional tag.
Contains: None
Is Contained by: PROFILEDATA
Attribute : None
Occurrence: Single
DataType: Numeric
EVENTS Description: Holds ‘YES’ if events data is to be read and ‘NO if events
data is not to be read. This is an optional tag.
Contains: None
Is Contained by: WHATTOREAD
Attribute : None
Occurrence: Single
DataType: Can only take values defined above
RESULTFILE Description: Holds the name of file which contains consequence of the
operation.
Contains: None
Is Contained by: PATHANDNAME
Attribute : None
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 37 of 107
Occurrence: Single
DataType: Alphanumeric
Element Description
MRIRESULT Description: This is root node for prepare MRI or download data from
MRI result file
Contains: INSTANCE
Is Contained by: None
Attribute : None
Occurrence: Single
DataType: N/A
INSTANCE Description: This node will appear for every instance result. If result of
the instance id is to be appended in same file then a new instance tag
shall be created.
Contains: DATETIME, RESULT, OUTPUTFILENAME,
INSTANCEID,MODE
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 38 of 107
MODE Description: Hold values of Operation perform on MRI. The MODE have
two value
PREPARE
DOWNLOAD
Contains: None
Is Contained by: INSTANCE
Attribute : None
Occurrence: Single
DataType: Alphanumeric
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 39 of 107
operation.
Contains: None
Is Contained by: INSTANCE
Attribute : None
Occurrence: Single
DataType: Numeric
0 Success
1 Failure
2 Partial Success – On
multiple meter data
transfer all files are not
transferred.
0 Success
1 Failure
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 40 of 107
Common
Common
format
framework
Converter
program (CFC) module
(API)
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 41 of 107
<ERRORPATH>C:\CFC\MANUFACTURER\ABC\CONVERSIONERROR</ERRORPATH>
<SCOPE CONVERTFILE=”ALL”[OR “SPECIFIC”]> </SCOPE>
<FILENAME>SOURCEFILENAME1</FILENAME>
<FILENAME>SOURCEFILENAME2</FILENAME>
</SCOPE> [IN CASE OF SPECIFIC]
<DESTPATH>C:\CFC\CDF</DESTPATH>
<SEED>A345B267</SEED>
<RESULTFILE> C:\CFC\MANUFACTURER\ABC\RESULT\CFCRESULT01.XML</RESULTFILE>.
</CFCAPI>
Element Descption
INSTANCEID Description: This contains the value of instance number which is a running
number for the request given by CFW to API. It should be four digit number
with ‘0’ appended in beginning if number is less then 4 digit.
Contains: NONE
Is Contained by: None
Attribute : None
Occurrence: Single
DataType: Numeric
SOURCEPATH Description: Holds the value of the path from which CDF converter module
will take the manufacturer specific format files.
Contains: None
Is Contained by: CFCAPI
Attribute : None
Occurrence: Single
DataType: Alphanumeric
DONEPATH Description: Holds the value of the path to which CDF converter module
will move the manufacturer specific format files after successful conversion.
Contains: None
Is Contained by: CFCAPI
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 42 of 107
Attribute : None
Occurrence: Single
DataType: Alphanumeric
ERRORPATH Description: Holds the value of the path to which CDF converter module
will move the manufacturer specific format files in case of failure.
Contains: None
Is Contained by: CFCAPI
Attribute : None
Occurrence: Single
DataType: Alphanumeric
SCOPE Description: Hold the information about the files which needs to be
converted into common format.
Contains: FILENAME
Is Contained by: CFCAPI
Attribute :
ConvertFile – If value of Convertfile attribute is “ALL” then all files in the
source path will be converted else if the value of convertfile attribute is
”SPECIFIC” then the fiels listed in FileName tags will be converted.
Occurrence: Single
DataType: N/A
FILENAME Description: Hold the name of files which needs to be converted into
common format.
Contains:
Is Contained by: CFCAPI
Attribute : None
Occurrence: One or more
DataType: Alphanumeric
DESTPATH Description: Holds the value of the path where CDF converter module will
create the CDF files.
Contains: None
Is Contained by: CFCAPI
Attribute : None
Occurrence: Single
DataType: Alphanumeric
SEED Description: Holds license key from which authenticator will be generated.
If seed tag is not in configuration file then no authenticator will be generated
in CDF file
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 43 of 107
Contains: None
Is Contained by: CFCAPI
Attribute : None
Occurrence: Single
DataType: Alphanumeric
RESULTFILE Description: Holds name of the result file along with complete path.
Contains: None
Is Contained by: CFCAPI
Attribute : None
Occurrence: Single
DataType: Alphanumeric
Element Description
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 44 of 107
DataType: N/A
INSTANCE Description: This node will appear for every instance result. If result of the
instance id is to be appended in same file then a new instace tag shall be
created.
Contains: INSTANCEID ,CONVERTTIME, DATETIMEFORMAT, RESULT,
OUTPUTFILENAME
Is Contained by: CFCRESULT
Attribute : None
Occurrence: One or more
DataType: N/A
INSTANCEID Description: This contains the value of instance number which is a running
number for the request given by CFW to API. It should be four digit number
with ‘0’ appended in beginning if number is less then 4 digit.
Contains: NONE
Is Contained by: None
Attribute : None
Occurrence: Single
DataType: Numeric
CONVERTTIME Description: This contains the date and time when the manufacturer specific
file was converted into common XML format.
Contains: None
Is Contained by: INSTANCE
Attribute : None
Occurrence: One or more
DataType: N/A
DATETIMEFORMAT Description: Holds the tags containing value of date time format used during
conversion.
Contains: GENERAL , Tag specific date format such as D3
Is Contained by: INSTANCE
Attribute : None
Occurrence: Single
DataType: None
GENERAL Description: Holds the value of the date time format which is applicable for
entire XML document. Exception to this is defined in the next occurring tags.
In case year is not available from meter then ‘yyyy’ will be written. For
example 01-01-yyyy 00:00:00 is to be written.
Contains: none
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 45 of 107
Tag name such as Description: Holds the value of the date time format which is applicable for
Dn all the sub tags appearing under a particular tag. For rest of the tags date
format described under general is applicable.
Contains: none
Is Contained by: DATETIMEFORMAT
Attribute : None
Occurrence: Single
DataType: string -- dd-mm (This is an example not a rule)
CONVERT Description: This tag contains the information about whether the conversion
of particular meter reading was successful or failed. This will repeat for all
metering reading which is being converted.
Contains: None
Is Contained by: CFCAPI
Attribute :
SERIAL – Holds the value of serial number. Data type -String
DATETIME – Holds the value of date time of meter reading. Data Type –
Date in dd-mm-yyyy hh:mm
RESULT – Holds result for success or failure of the conversion on the meter
reading.
OUTFILENAME – Holds the name of output file generated after successful
conversion. In case conversion fails the value will be blank. The value will not
contain path as path is same as DESTPATH
Occurrence: One or more
DataType: N/A
0 Success
1 Failure
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 46 of 107
Element Description
CDF Description: CDF tag is the root element and all data is
placed below this tag. Multiple utility data can come
underneath this tag.
Contains: UTILITYTYPE, AUTHENTICATOR
Is Contained by: None
Attribute : None
Occurrence: Single
DataType: N/A
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 47 of 107
Attribute : None
Occurrence: Single
DataType: Alphanumeric
Data type – There are different type of data available for the utility. The definition and interpretation of
data type should be done with respect to Utility type code Standard codes for data type can be
defined up to D1000. Code above D1000 can be used for manufacturer specific data type. These
codes should be interpreted based on meter manufacturer.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 48 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 49 of 107
Occurrence: Single
DataType:
D9 Description: Contains the information about when
meter was written externally to change settings with
occurrence date & time. This is also termed as
transaction with meter
Contains: TRANSACTION
Is Contained by: UTILITYTYPE
Attribute :
Occurrence: Single
DataType:
D12
Description: This contains Power ON duration for
phases based on reset type ie. Daily / monthly.
This is hold by tag D12.
Contains: FLAG
Is Contained by: UTILITYTYPE
Attribute :
Occurrence: Single
DataType:
General Information – This information comes under <D1> is used for general information. This
contains the information specific to the meter. Standard codes for general information can be defined
up to G1000. Code above G1000 can be used for manufacturer specific data type. These codes
should be interpreted based on meter manufacturer. Origin of data is not required.
Tags defined for general information parameters are
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 50 of 107
G1
Description: Holds the value of meter serial number.
This is the metering device ID which uniquely identifies
the metering device.
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alphanumeric
G2
Description: Holds the value of date time stamp as per
meter at the time of reading.
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Date time. The format of date time is dd-mm-
yyyy hh:mm:ss
G3
Description: Holds the value of date time stamp as per
PC/MRI at the time of reading.
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Date time. The format of date time is dd-mm-
yyyy hh:mm:ss
G4
Description: Holds the value of date time stamp at the
time of MRI dumping to PC. The format of date time is
dd-mm-yyyy hh:mm:ss
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Date time. The format of date time is dd-mm-
yyyy hh:mm:ss
G7
Description: Holds the value of ratio of Programmed
PT Primary to Programmed PT secondary in meter.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 51 of 107
G9
Description: Holds the value of Programmed PT
Primary in meter. Value is always in Volts
Origin of data: CFW/Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Numeric
G10
Description: Holds the value of Programmed CT
Primary in meter. Value is always in Amps
Origin of data: CFW/Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Numeric
G11 Description: Holds the value of Programmed PT
Secondary in meter. Value is always in Volts
Origin of data: CFW/Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 52 of 107
Occurrence: Single
DataType: Numeric
G12
Description: Holds the value of Programmed CT
Secondary in meter. Value is always in Amp
Origin of data: CFW/Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Numeric
G13 Description: Holds the value of Meter class. This is
class of accuracy of meter
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alphanumeric
G14 Description: Holds the value of Meter rating. (5-6, 5-20)
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alphanumeric
G15 Description: Holds the value of Meter type. Meter type
means HT(3ph-3W), HT(3ph-4W),LT(3ph-3W), LT(3ph-
4W), WC(3ph-4W),WC(1ph-2W)
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alphanumeric. Can only take values defined
above.
G16 Description: Holds the value of Meter Scaling. Meter
scaling can have value Primary/Secondary.
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 53 of 107
Attribute : None
Occurrence: Single
DataType: Can have value Primary or Secondary
G17 Description: Holds the value of Meter Program Name
including version number
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alphanumeric
G19 Description: Holds the value of cumulative successful
meter reading count
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Numeric
G20 Description: Holds the value of MD integration period
(Possible values - 1 mt, 2mts, 5 mts,15mts, 30mts,
60mts)
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Numeric
G21 Description: Holds the value of additional information.
Origin of data: CFW
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alphanumeric
G22
Description: Holds the value of manufacturer code and
name.
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 54 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 55 of 107
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alphanumeric
G30 Description: Holds the version number of
interoperability document to which the common format
complies
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: String. (For example 1.80)
G31 Description: Holds the version number of API from
which the common format is generated
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: String ( For example 1.1.0.1)
G32 Description: Holds the value of cumulative maximum
demand reset count.
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Numeric
G33 Description: Holds the value of MIOS membership ID
issued by MIOS forum and as received in reading result
file generated by Read API
Origin of data: Manufacturer API
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alpha Numeric
G34 Description: Holds the value of Meter range.
(Standard, long range)
Origin of data: Manufacturer API
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 56 of 107
Contains: None
Is Contained by: D1
Attribute : None
Occurrence: Single
DataType: Alpha
Instantaneous parameter – Instantaneous parameter data is hold under D2 tag. All data is provided
by manufacturer API
Description: Holds the code, value and unit of
INSTPARAM
instantaneous parameter
Contains: None
Is Contained by: D2
Attribute : CODE – Parameter code
VALUE – Value of the parameter
UNIT – Unit of the parameter
Occurrence: One or more
DataType: (CODE) – Alphanumeric
(VALUE) – Numeric
(UNIT) – Alphanumeric
Billing register data - Tag<D3> is used for Billing register information. There are many type Billing
registers supported in energy meters. The values of these registers are frozen at every billing.
Standard codes for cumulative data registers can be defined up to B1000. Code above B1000 can be
used for manufacturer specific data type. These codes should be interpreted based on meter
manufacturer.
D3-nn Description: <D3-nn> tag will appear for each bill date
where nn will be history number and 0 corresponds to
current (present) values, 01 corresponds to most recent
bill values and so on. <D3-00> indicates date & time of
reading the meter.
Contains: None
Is Contained by: D3
Attribute : DATETIME – Holds the value of frozen value
date time stamp (except for D3-00 which is described
above) (date will remain blank if meter does not store
MD reset date & time).
MECHANISM –Mechanism used to do MD reset. This
can take four values “Push Button”,
“Auto” (Bill date), “Command” (includes Tariff change),
“” (blank is to indicate MD reset is not performed)
Occurrence : One or more
DataType : DateTime .The format is dd-mm-yyyy
hh:mm. Mechanism - Alpha
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 57 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 58 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 59 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 60 of 107
(VALUE) – Numeric
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 61 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 62 of 107
B18
Description: This contains Energy Crossover
Counts.
Contains: Billing Data
Is Contained by: D3-00.
Attribute: 2-Attributes.
PARAMCODE -Hold the code of the Energy.
COUNT-Holds the count of the particular Energy
crossover.
Occurrence: One or More
Data Type: N/A
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 63 of 107
Attribute: 2-Attributes.
EVENTCODE-Holds the code of the event.
COUNT-Holds the count of the Tamper event occurred.
Occurrence: Multiple
Data Type: N/A
Load Profile data – Load Profile data is value of the parameter for defined integration period for
specified days. Tag D4 is used to hold profile data.
Description: Contains every day data. This tag will
DAYPROFILE
repeat for all date for which load profile is available.
Contains: IP
Is Contained by: D4
Attribute: DATE – Date of the profile .
Occurrence: One or more
DataType: DATE - The format is dd-mm-yyyy
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 64 of 107
Events data - <D5> tag is used events data information. Events data contains events code and
sometimes snapshot of the electrical parameters when the event occurred.
EVENT Description: Contains code, time and status of the
events. This tag will repeat for all events.
Contains: SNAPSHOT
Is Contained by: D5
Attribute: CODE – Code the events
TIME –Time of the event. If time does not
come then blank should be used as value.
DURATION – This attribute is optional and
indicate the duration of event. This attribute can come
only when status attribute had value ‘1’.
STATUS – ‘0’ if event had occurred and ‘1’ if
event had restored.
Occurrence: One or more
DataType: (CODE) – Alphanumeric
(TIME) – DateTime . The format is dd-mm-
yyyy hh:mm
(DURATION) – The format is
DDD:hh:mm:ss
(STATUS)- Can only take values defined
above
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 65 of 107
Daily energy register snapshot - This contains value of Daily energy snapshot. This is hold by tag
D6. Typical usage is for logging mid night energy snapshot
SNAPSHOT Description: Contains the value for the date. This tag
will repeat for all dates.
Contains: REGISTER
Is Contained by: D6
Attribute: DATETIME – Date time stamp of the
snapshot
Occurrence: One or more
DataType: DATETIME . The format is dd-mm-yyyy
hh:mm:ss
Daily duration indicator for the parameter between the specified threshold - This data contains
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 66 of 107
information about “supply quality”. Supply quality is duration in percentage or minutes for the
parameters persisting between specified thresholds, such as
30% duration between (Vn – 10%) to Vn
20% duration between (Vn – 20%) to (Vn -10%)
This is hold by tag D7.
DAILYDATA Description: Contains the value for the date. This tag
will repeat for all dates.
Contains: REGISTER
Is Contained by: D7
Attribute: DATE – Date of the data i
Occurrence: One or more
DataType: DATE . The format is dd-mm-yyyy
REGISTER Description: Contains the value for the date. This tag
will repeat for all dates.
Contains: None
Is Contained by: DAILYDATA
Attribute: PARAMCODE – Parameter code
STARTLIMIT – Start limit of threshold
ENDLIMIT – End limit of threshold
VALUE – Value of the data
UNIT – Unit of value
Note: 0 limit indicates nominal value of the parameter.
Positive value of limit indicates above nominal and
negative value indicates below nominal.
Occurrence: One or more
DataType: (PARAMCODE) – Alphanumeric
(STARTLIMIT) –Numeric
(ENDLIMIT)- Numeric
(VALUE) - Numeric
(UNIT) - Alphanumeric
Current Meter settings : This data contains information about the current setting in the meter.
These settings changes less frequently. This is hold by D8.
APPCALC Description: Holds the value on which apparent
calculation is based. The possible values are
0 for Lag and
1 for Lag+Lead
Contains: None
Is Contained by: D8
Attribute: None
Occurrence: One
DataType: 0 or 1
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 67 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 68 of 107
Flags - <D10> tag is used for meter health information. This information can be used to find out faulty
meters.
FLAG Description: Contains code and value of flag. This tag
will repeat for all flags.
Contains: None
Is Contained by: D10
Attribute: CODE – Code of the transaction
VALUE – 0 for false and 1 for true
Occurrence: One or more
DataType: (CODE) – Alphanumeric
(VALUE) – 0,1
Sag & Swell information- This contains value of Sag & Swell count. This is hold by tag D11.
DATA Description: Contains the value for the date. This tag
will repeat for all dates.
Contains: SAGSWELL
Is Contained by: D11
Attribute: DATETIME – Date time stamp of the
snapshot
Occurrence: One or more
DataType: DATETIME . The format is dd-mm-yyyy
hh:mm:ss
SAGSWELL Description: Contains the value for Sag & Swell count.
This tag will repeat for all Phases supported.
Contains: None
Is Contained by: DATA
Attribute: CODE – parameter code
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 69 of 107
Phase Power-ON time- This contains Power ON duration for phases based on reset type ie.
Daily / monthly. This is kept by tag D12.
RESET TYPE Description: It contains the type of automatic reset
which can be daily or monthly.
Attribute: 1 Represents daily & 2 Represents monthly.
DataTYpe: Numeric
ROOSTERDATA Description: Contains the value for the date. This tag
will repeat for all dates.
Contains: ROOSTERING
Is Contained by: D12
Attribute: DATETIME – Date time stamp of the
snapshot
Occurrence: One or more
DataType: DATETIME . The format is dd-mm-yyyy
hh:mm:ss
9.2.2 CDF
CDF is root tag for the common data format file. All tags will come below this tag. Structure of the file
will look like
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 70 of 107
…….
……
</DN>
</UTILITYTYPE>
<AUTHENTICATOR>A123DCA889FEDBC</AUTHENTICATOR>
</CDF>
<D1>
<G1>S0000001</G1>
<G2>01/01/2004 10:00:00</G2>
<G3>01/01/2004 10:01:00</G3>
<G4>01/01/2004 12:01:00</G4>
<G5>100</G5>
<G6>240</G6>
<G7>100</G7>
<G8>240</G8>
</D1>
Membership ID
Purpose of membership ID: To ensure that APIs are not freely exchanged in the market. Every API
will self identify to whom the API was issued.
Tracking
From where one can read membership ID? The membership ID will be embedded within API.
o The membership ID will have to be read from configuration file for API1 & from CDF
file for API3.
Where is the output available? The
• For API1 – The membership ID will appear in Result file.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 71 of 107
An ID will be issued during registration process (Web Site /Manual) to the party who is seeking for
membership of MIOS The seeking party may be meter manufacturer, Utility or any third party.
The Membership ID format would be as following:
Length = 5 Alphanumeric characters
In which first two digits are reserved for character ‘A’ to Z’’ and rest 3 are reserved for numbers
ranging from 000 to 999.
<D2>
<INSTPARAM CODE=”P1-1-1-1-0” VALUE=”240.34” UNIT=”V” />
<INSTPARAM CODE=”P1-1-2-1-0” VALUE=”220.34” UNIT=”V” />
<INSTPARAM CODE=”P1-1-3-1-0” VALUE=”250.34” UNIT=”V” />
<INSTPARAM CODE=”P2-1-1-1-0” VALUE=”40.34” UNIT=”A” />
<INSTPARAM CODE=”P2-1-2-1-0” VALUE=”50.34” UNIT=”A” />
<INSTPARAM CODE=”P2-1-3-1-0” VALUE=”55.34” UNIT=”A” />
</D2>
Example 1
Data under <D3> will look like
<D3>
<D3-00 DATETIME="03-08-2003 10:00" MECHANISM=””>
<B1 TODZONE="1" STARTTIME="00:00" ENDTIME="7:00"/>
<B1 TODZONE="2" STARTTIME="07:00" ENDTIME="10:00"/>
<B1 TODZONE="1" STARTTIME="10:00" ENDTIME="17:00"/>
<B1 TODZONE="2" STARTTIME="17:00" ENDTIME="22:00"/>
<B1 TODZONE="1" STARTTIME="22:00" ENDTIME="00:00"/>
<B2 DATETIME=”01-07-2003 00:00” MECHANISM=”AUTO”/>
<B3 PARAMCODE="P7-1-5-1-0" VALUE="2000" UNIT="K"/>
<B3 PARAMCODE="P7-2-1-1-0" VALUE="2000" UNIT="K"/>
<B3 PARAMCODE="P7-3-5-1-0" VALUE="2000" UNIT="K"/>
<B4 TOD="1" PARAMCODE="P7-1-5-1-0" VALUE="1000" UNIT="K"/>
<B4 TOD="1" PARAMCODE="P7-2-5-1-0" VALUE="1000" UNIT="K"/>
<B4 TOD="2" PARAMCODE="P7-1-5-1-0" VALUE="1000" UNIT="K"/>
<B4 TOD="2" PARAMCODE="P7-2-5-1-0" VALUE="1000" UNIT="K"/>
<B5 PARAMCODE="P7-4-5-1-0" VALUE="500" OCCDATE="06-07-2003 14:45" UNIT="K"/>
<B5 PARAMCODE="P7-6-5-1-0" VALUE="700" OCCDATE="20-07-2003 13:15" UNIT="K"/>
<B6 TOD=”1” PARAMCODE="P7-6-5-1-0" VALUE="700" OCCDATE="20-07-2003 13:15"
UNIT="K"/>
<B6 TOD=”2” PARAMCODE="P7-6-5-1-0" VALUE="650" OCCDATE="19-07-2003 12:15"
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 72 of 107
UNIT="K"/>
<B7 PARAMCODE="P7-4-5-1-0" VALUE="1200" UNIT="K"/>
<B8 TOD=“1” PARAMCODE="P7-4-5-1-0" VALUE="900" UNIT="K"/>
<B8 TOD=“2” PARAMCODE="P7-4-5-1-0" VALUE="700" UNIT="K"/>
<B9 PARAMCODE= “P4-4-4-1-0” VALUE="0.9" />
<B10 TOD="1" PARAMCODE= “P4-4-4-1-0” VALUE="0.8" />
<B10 TOD="2" PARAMCODE= “P4-4-4-1-0” VALUE="0.8" />
<B11 VALUE=”123542”/>
<B12 VALUE=”4334”/>
<B16 VALUE=”TARIFFNAME”/>
</D3-00>
<D3-01 DATETIME="01-07-2003 00:00" MECHANISM=”AUTO”>
<B2 DATETIME=”21-06-2003 10:00” MECHANISM=”COMMAND”/>
<B3 PARAMCODE="P7-1-5-1-0" VALUE="1000" UNIT="K"/>
<B3 PARAMCODE="P7-2-1-1-0" VALUE="1200" UNIT="K"/>
<B3 PARAMCODE="P7-3-5-1-0" VALUE="600" UNIT="K"/>
<B4 TOD="1" PARAMCODE="P7-1-5-1-0" VALUE="900" UNIT="K"/>
<B4 TOD="1" PARAMCODE="P7-2-5-1-0" VALUE="900" UNIT="K"/>
<B4 TOD="2" PARAMCODE="P7-1-5-1-0" VALUE="900" UNIT="K"/>
<B4 TOD="2" PARAMCODE="P7-2-5-1-0" VALUE="900" UNIT="K"/>
<B5 PARAMCODE="P7-1-5-1-0" VALUE="400" OCCURRENCEDATE="06-06-2003 14:45" UNIT="K"/>
<B5 PARAMCODE="P7-3-5-1-0" VALUE="600" OCCURENCEDATE="20-06-2003 13:15" UNIT="K"/>
<B6 TOD=”1” PARAMCODE="P7-3-5-1-0" VALUE="700" OCCURENCEDATE="20-07-2003 13:15"
UNIT="K"/>
<B6 TOD=”2” PARAMCODE="P7-3-5-1-0" VALUE="650" OCCURENCEDATE="19-07-2003 12:15"
UNIT="K"/>
<B7 PARAMCODE="P7-1-5-1-0" VALUE="1000" UNIT="K"/>
<B8 TOD=“1” PARAMCODE="P7-1-5-1-0" VALUE="900" UNIT="K"/>
<B8 TOD=“2” PARAMCODE="P7-1-5-1-0" VALUE="700" UNIT="K"/>
<B9 PARAMCODE="P4-4-4-0-0" VALUE="0.9" />
<B10 TOD="1" VALUE="0.8" />
<B11 VALUE=”123542”/>
<B12 VALUE=”4334”/>
<B16 VALUE=”TARIFFNAME”/>
</D3-01>
<D3-02 DATETIME="01-06-2003 00:00" MECHANISM=”AUTO”>
<B3 PARAMCODE="P7-1-5-1-0" VALUE="1000" UNIT="K"/>
<B3 PARAMCODE="P7-2-1-1-0" VALUE="1200" UNIT="K"/>
<B3 PARAMCODE="P7-3-5-1-0" VALUE="600" UNIT="K"/>
<B4 TOD="1" PARAMCODE="P7-1-5-1-0" VALUE="900" UNIT="K"/>
<B4 TOD="1" PARAMCODE="P7-2-5-1-0" VALUE="900" UNIT="K"/>
<B4 TOD="2" PARAMCODE="P7-1-5-1-0" VALUE="900" UNIT="K"/>
<B4 TOD="2" PARAMCODE="P7-2-5-1-0" VALUE="900" UNIT="K"/>
<B5 PARAMCODE="P7-1-5-1-0" VALUE="400" OCCURRENCEDATE="06-06-2003 14:45" UNIT="K"/>
<B5 PARAMCODE="P7-3-5-1-0" VALUE="600" OCCURENCEDATE="20-06-2003 13:15" UNIT="K"/>
<B6 TOD=”1” PARAMCODE="P7-3-5-1-0" VALUE="700" OCCURENCEDATE="20-07-2003 13:15"
UNIT="K"/>
<B6 TOD=”2” PARAMCODE="P7-3-5-1-0" VALUE="650" OCCURENCEDATE="19-07-2003 12:15"
UNIT="K"/>
<B7 PARAMCODE="P7-1-5-1-0" VALUE="1000" UNIT="K"/>
<B8 TOD=“1” PARAMCODE="P7-1-5-1-0" VALUE="900" UNIT="K"/>
<B8 TOD=“2” PARAMCODE="P7-1-5-1-0" VALUE="700" UNIT="K"/>
<B9 PARAMCODE="P4-4-4-0-0" VALUE="0.9" />
<B10 TOD="1" VALUE="0.8" />
<B11 VALUE=”123542”/>
<B12 VALUE=”4334”/>
<B16 VALUE=”TARIFFNAME”/>
</D3-02>
</D3>
Example 2
<D3>
<D3-00 DATETIME="27-08-2008 11:34" MECHANISM="">
<B17 VALUE = "41000"/>
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 73 of 107
</D3-00>
<D3-01 DATETIME="27-07-2008 11:34" MECHANISM="">
<B17 VALUE = "40000"/>
</D3-01>
</D3>
Example 3
<D3>
<D3-00 DATETIME="27-08-2008 11:34" MECHANISM="">
<B18 PARAMCODE ="P7-6-5-2-0" COUNT="2"/>
<B18 PARAMCODE ="P7-6-5-3-0" COUNT="2"/>
</D3-00>
</D3>
Example 4
<D3>
<D3-00 DATETIME="27-08-2008 11:34" MECHANISM="">
<B19 PARAMCODE="P7-6-5-2-0" VALUE="3456.67" UNIT="k"/>
<B19 PARAMCODE="P7-6-5-1-0" VALUE="3456.67" UNIT="k"/>
</D3-00>
<D3-01 DATETIME="01-08-2008 11:34" MECHANISM="">
<B19 PARAMCODE="P7-6-5-2-0" VALUE="3456.67" UNIT="k"/>
<B19 PARAMCODE="P7-6-5-1-0" VALUE="3456.67" UNIT="k"/>
</D3-01>
</D3>
Example 5
<D3>
<D3-01 DATETIME="27-08-2008 11:34" MECHANISM="">
<B20 EVENTCODE ="2" COUNT="2"/>
<B20 EVENTCODE ="11" COUNT="2"/>
</D3-01>
</D3>
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 74 of 107
Low PF 107
Current Reversal 108
Under Voltage 109
Over Voltage 110
Under Current 111
Over Current 112
Current Bypass 113
RTC Advance 114
RTC Retard 115
Magnetic Tamper 116
Neutral Disturbance 117
• PFlag – Pflag is parameter specific status indicator which indicates validity/invalidity of the
value of a parameter such as variable overflow. Pflag can only have Boolean value (0 or
1).The following table list the flag and their code
Condition Code
Variable Overflow 1
<D4 INTERVALPERIOD=”15”>
<DAYPROFILE DATE=”01-07-2003” >
<IP INTERVAL =0 >
<PARAMETER PARAMCODE=”P7-1-5-1-0” VALUE=”0” UNIT=”K”>
<PARAMETER PARAMCODE=”P1-1-1-1-0” VALUE=”0” UNIT=”K”/>
<D4 INTERVALPERIOD=”15”>
<DAYPROFILE DATE=”01/07/2003” >
<IP INTERVAL =1 >
<IFLAG CODE=’101’ VALUE=’1’/>
<IFLAG CODE=’102’ VALUE=’0’/>
<IFLAG CODE=’103’ VALUE=’1’/>
<PARAMETER PARAMCODE=”P7-1-5-1-0” VALUE=”0” UNIT=”K”>
<PFLAG CODE=’0’ VALUE=’1’/>
</PARAMETER>
<PARAMETER PARAMCODE=”P1-1-1-1-0” VALUE=”0” UNIT=”K”/>
</IP>
<IP INTERVAL =2 >
<IFLAG CODE=’101’ VALUE=’1’/>
<IFLAG CODE=’102’ VALUE=’0’/>
<PARAMETER PARAMCODE=”P7-1-5-1-0” VALUE=”102” UNIT=”K”>
<PFLAG CODE=’1’ VALUE=’1’/>
</PARAMETER>
<PARAMETER PARAMCODE=”P1-1-1-1-0” VALUE=”113” UNIT=”V”/>
</IP>
….
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 75 of 107
…
</DAYPROFILE>
<DAYPROFILE DATE=”02/07/2003” >
…..
….
</DAYPROFILE>
</D4>
<D4 INTERVALPERIOD=”15”>
<DAYPROFILE DATE=”01-07-2003” >
Code Events
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 76 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 77 of 107
Standard codes for events can be defined up to 1000. Code above 1000 can be used for
manufacturer specific data type. These codes should be interpreted based on meter manufacturer.
</D5>
In case TIME attribute value is not supported by meters at the time of restoration ( STATUS=’1’) then
event tag will look like
In case TIME attribute value and DURATION both are supported by meter at the time of restoration (
STATUS=’1’) then event tag will look like
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 78 of 107
The above example shows that R- phase voltage had remained 3 hours between nominal to -10%
band, remained 7 hours between nominal to +10% band and had remained 5 hours between +10%
and +20% of voltage band
Code Transaction
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 79 of 107
Standard codes for transaction can be defined up to 1000. Code above 1000 can be used for
manufacturer specific data type. These codes should be interpreted based on meter manufacturer.
<D9>
<TRANSACTION CODE=5 DATETIME=21/04/2006 12:10/>
<TRANSACTION CODE=3 DATETIME=25/04/2006 14:10/>
<TRANSACTION CODE=5 DATETIME=28/04/2006 10:10/>
</D9>
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 80 of 107
Code Transaction
<D10>
<FLAG CODE=1 VALUE=0 />
<FLAG CODE=2 VALUE=1 />
</D10>
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 81 of 107
Standard codes for parameters can be defined up to P1000. Code starting with Mn (M1, M2, M3 & so
on) can be used for manufacturer specific data type. These codes should be interpreted based on
meter manufacturer code.
9.3.2 Voltage
Voltage codes can be derived from following qualifier.
Qualifier1
Qualifier1 denotes the type of value. Table below defines the code.
Code Description
1 Phase to phase
2 Phase to neutral
Qualifier2
Qualifier2 denotes phase. Table below defines the code
Code Description
1 R- phase
2 Y-phase
3 B-phase
4 R-Y phase
5 B-Y phase
6 R-B phase
7 System(All phases)
Qualifier3
Qualifier3 denotes whether it is instantaneous, maximum, minimum or average voltage. These values
are over a period. Table below defines the code
Code Description
1 Instantaneous
2 Maximum for defined duration
3 Minimum for defined duration
4 Average for defined duration
Qualifier4
Qualifier4 is not applicable and hence 0 shall be used.
Example
Voltage parameters code will be generated as P1-<Qualifier1>-<Qualifier2>-<Qualifier3>-0
• Code for phase to phase R-Y phase Instantaneous voltage will be P1-1-4-1-0.
• Code for phase to neutral B-phase Average voltage will be P1-2-3-4-0.
• Code for phase to phase Maximum system voltage will be P1-1-7-2-0.
9.3.3 Current
Qualifier1
Qualifier1 denotes the type of value. Table below defines the code.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 82 of 107
Code Description
1 Line Current
2 Active Current
3 Reactive Current
Qualifier2
Qualifier2 denotes phase. Table below defines the code
Code Description
1 R- phase
2 Y-phase
3 B-phase
4 Neutral
5 System(All phases)
Qualifier3
Qualifier3 denotes whether it is maximum, minimum or average current. These values are over a
period. Table below defines the code
Code Description
1 Instantaneous
2 Maximum for defined duration
3 Minimum for defined duration
4 Average for defined duration
Qualifier4
Qualifier 4 is not applicable.
Example
Current parameters code will be generated as P2-<Qualifier1>-<Qualifier2>-<Qualifier3>-0
• Code for R-phase instantaneous line current will be P2-1-1-1-0
• Code for instantaneous system line current will be P1-1-5-1-0.
9.3.4 Power
Positive values of power will indicate import (or lag) and negative value will indicate export (or lead).
Qualifier1
Qualifier1 denotes the type of value. Table below defines the code.
Code Description
1 Active – Fundamental
2 Active – Total
3 Reactive
4 Apparent
Qualifier2
Qualifier2 denotes phase. Table below defines the code
Code Description
1 R- phase
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 83 of 107
2 Y-phase
3 B-phase
4 System(All phases)
Qualifier3
Qualifier3 denotes whether it is maximum, minimum or average power. Table below defines the code
Code Description
1 Instantaneous
2 Maximum for defined duration
3 Minimum for defined duration
4 Average for defined duration
Qualifier4
Qualifier 4 is not used.
Example
Power parameters code will be generated as P3-<Qualifier1>-<Qualifier2>-<Qualifier3>-<Qualifier4>
• Code for active total R-phase average power will be P3-2-1-4-0.
• Code for reactive B-phase instantaneous power will be P3-3-3-1-0.
Qualifier1
Qualifier1 denotes phase. Table below defines the code
Code Description
1 R- phase
2 Y-phase
3 B-phase
4 System(All phases)
Qualifier2
Qualifier2 denotes whether it is maximum, minimum or average voltage. Table below defines the code
Code Description
1 Instantaneous
2 Maximum for defined duration
3 Minimum for defined duration
4 Average for defined duration
Qualifier3
Qualifier3 denotes the direction. Table below defines the code.
Code Description
0 Not applicable
1 Import
2 Export
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 84 of 107
Qualifier4
Qualifier4 is not used and will be zero
.
Example
Power factor parameters code will be generated as P4-<Qualifier1>-<Qualifier2>-<Qualifier3>-0
• Code for instantaneous R-phase power factor for will be P4-1-1-0-0.
• Code for Average import power factor will be P4-4-4-1-0
Qualifier1
Qualifier1 denotes phase. Table below defines the code
Code Description
3P,4W 3P, 3W
1 R phase angle RY
2 Y phase angle 0
3 B phase angle BY
Qualifier2
Qualifier2 is not applicable and hence 0 shall be used.
Qualifier3
Qualifier3 is not applicable and hence 0 shall be used.
Qualifier4
Qualifier4 is not applicable and hence 0 shall be used.
Example
Voltage angle parameters code will be generated as P5-<Qualifier1>-0-0-0
• Code for R-Y voltage angle for will be P5-1-0-0-0.
Qualifier1
Qualifier1 denotes phase. Table below defines the code
Code Description
1 R phase
2 Y phase
3. B phase
4 System
Qualifier2
Qualifier4 is not applicable and hence 0 shall be used.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 85 of 107
Qualifier3
Qualifier4 is not applicable and hence 0 shall be used.
Qualifier4
Qualifier4 is not applicable and hence 0 shall be used.
Example
Power factor angle parameters code will be generated as P7-<Qualifier1>-0-0-0
Code for R phase power factor angle for will be P7-1-0-0-0.
Qualifier1
Qualifier1 denotes the type of value. Table below defines the code.
Code Description
1 Active energy
2 Reactive energy
3 Apparent energy
4 Active demand
5 Reactive demand
6 Apparent demand
Qualifier2
Qualifier4 denotes direction. Table below defines the code. For quadrant definition see appendix ?.
Code Description (As per Possible use
quadrant)
0 Not applicable Will applicable for
Qualifier 4 >1.
1 Q1 Reactive energy, import while
active import
2 Q2 Reactive energy, import while
active export
3 Q3 Reactive energy, export while
active export
4 Q4 Reactive energy, export while
active import
5 (Q1+Q4) 1. Active Import
2. Apparent while active
import
3. Reactive energy, lag +
lead while active import
6 (Q2+Q3) 1. Active Export
2. Apparent while active
export
3. Reactive energy, lag +
lead while active export
7 Q1+Q2 Reactive Import
8 Q3+Q4 Reactive Export
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 86 of 107
Qualifier3
Qualifier3 further qualifies the energy type. Table below defines the code.
Code Description
0 Not applicable
1 Fundamental
2 Total
3 Defrauded
Qualifier4
Qualifier4 is used for threshold based energy registers.
Code Description
0 Not threshold based
1 Threshold based
2 Voltage Threshold based – High
(ABT application)
3 Voltage Threshold based – Low
(ABT application)
4 Maximum for defined duration
5 Minimum for defined duration
Example
Energy parameters code will be generated as P7-<Qualifier1>-<Qualifier2>-<Qualifier3>-<Qualifier4>
• Code for active import total energy will be P7-1-5-2-0.
• Code for Reactive import while active import energy will be P7-2-1-0.
• Code for apparent import + export fundamental energy will be P7-3-12-1-0
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 87 of 107
Qualifier 1
Code Description
1 Voltage
2 Current
Qualifier2
Qualifier2 is not applicable and hence 0 shall be used.
Qualifier3
Qualifier3 is not applicable and hence 0 shall be used.
Qualifier4
Qualifier4 is not applicable and hence 0 shall be used.
Example
Phase sequence parameters code will be generated as P8-<Qualifier1>-0-0-0
Code for voltage phase sequence will be P8-1-0-0-0.
9.3.10 Frequency
Frequency code can be derived from following qualifiers
Qualifier1
Qualifier1 denotes instantaneous, maximum , minimum or average frequency. Table below defines
the code
Code Description
1 Instantaneous
2 Maximum for defined duration
3 Minimum for defined duration
4 Average for defined duration
Qualifier2
Qualifier2 is not applicable and hence 0 shall be used.
Qualifier3
Qualifier3 is not applicable and hence 0 shall be used.
Qualifier4
Qualifier4 is not applicable and hence 0 shall be used.
Example
Frequency parameters code will be generated as P9-<Qualifier1>-0-0-0
• Code for instantaneous frequency will be P9-1-0-0-0.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 88 of 107
Qualifier1
Qualifier1 denotes phase. Table below defines the code
Code Description
1 R with respect to R phase voltage
2 Y with respect to R phase voltage
3 B with respect to R phase voltage
Qualifier2
Qualifier2 is not applicable and hence 0 shall be used.
Qualifier3
Qualifier3 is not applicable and hence 0 shall be used.
Qualifier4
Qualifier4 is not applicable and hence 0 shall be used.
Example
Current angle parameters code will be generated as P10-<Qualifier1>-0-0-0
• Code for R-Y current angle will be P10-1-0-0-0.
9.3.12 Duration
It can take value as ‘No Power’ or ‘No Load’. It is generally used in instantaneous interval (D4)
parameters. P11 tag is defined as follows
Qualifier1
Code Description
1 No Power ad
2 No Load
Qualifier2
Qualifier2 is not applicable and hence 0 shall be used.
Qualifier3
Qualifier3 is not applicable and hence 0 shall be used.
Qualifier4
Qualifier4 is not applicable and hence 0 shall be used.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 89 of 107
The 'authenticator' is a number which is sent with a message so that a check can be made by the
receiver of the message that it has not been altered since it left the sender. For authenticators in
general the sender and receiver share the knowledge of a seed S which is otherwise secret. If M is
the message, the authenticator is a function of S and M. It is calculated by the sender and again by
the receiver. If the receiver's calculated value equals the authenticator value received with the
message, the message is assumed to be correct. Authenticator verification module is API4.
1. Data + Se (API3 + Si ) Authenticator value
2. Data + Authenticator value CDF file
3. CDF + Se (API4 + Si ) Authenticator value
Authenticator found in step 1 & step 3 should match.
<Authenticator>Authenticator Value</Authenticator>
All meter manufacturers must use authentication algorithm RIPEMD-160.
Common Common
Data Format Data Format
(Generated by Authenticator = (Generated by
CFC module) fn (Data + Seed) CFC module)
Authenticator =
fn (Data + Seed)
Manufact
urer’s API4 Authenticator
Data match or
CDF Authenticator
mismatch
External Seed
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 90 of 107
11 Future expandability
Interoperability standard provide following advantages
• All new innovation in metering will be handled by manufacturer API’s and will be transparent
to CFW. However to use new features CFW may have to implement new interfaces.
• Any change in new meter reading protocol or disparity in the old and new version meters will
be handled by manufacturer API.
• As CDF is an XML file so it is easy to add any data/parameter.
• Any addition or removal of tag will not affect any software (for analysis or billing software)
which uses this file format as it will ignore the tags which are not required and also take
appropriate action if some tag which is required by the software is not present.
• All meter manufacturers are free to add any new data/parameter they support in XML file
without requiring any permission or looking for compatibility. So this does not stop
innovations from any vendors in metering field. For this 200 tags have been provided to each
manufacturer. The numbering of these tags are as follows:
1. L&T G1000
2. SML G1200
3. Elster G1400
4. Datapro G1600
5. DukeArnics G1800
6. HSPL G2000
7. Genus G2200
8. Omniagate G2400
9. Easun Reyrolle G2600
10. Capital Power G2800
11. Bentec G3000
12. Delhi control devices G3200
13. ICSA G3400
14. Holley Meters G3600
• The naming convention of the diffetent meter manufacturer’s are given below:
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 91 of 107
Omniagate
Bentec
ICSA
(ECE)
• As this format is open and defined so it is not dependent on any single party.
12 Log Maintenance
All API’s should create log file which can be used for debugging/troubleshooting the communication
between CFW/API and API/meter. Though API’s creates log file but CFW should not use log for any
practical purpose other then debugging the API.
1. API should create log file in \LOG subfolder relative the folder where API exists. For example
if API resides in C:\CFW\SEMS folder then log file shall be created in C:\CFW\SEMS\LOG
folder.
2. The log file name should be YYYYMMDD.log, where YYYY stands for year , MM stands for
month, DD stands for day.
3. Log file should contain information about
a. Communication between CFW and API.
b. Communication between reading API and modem.
4. The log file contains following field. All fields are delimited by ‘|’
a. Date Time in dd/mm/yyyy hh:mm:ss format
b. Direction with respect to API. In case of communication between API and CFW API
will only write sent and received. In case of communication with modem API will write
sent to modem and received from modem.
c. Comport – In case of communication with modem comport shall be added to log file.
It can be blank if it is communication between CFW and API.
d. Instance ID
e. Command
f. Data/Description
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 92 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 93 of 107
14 Glossary of terms
14.1 Not applicable qualifier in a parameter code
The parameter code will be defined as ‘P1-Q1-Q2-Q3-Q4’.
Zero shall be used as qualifier if the qualifier is not applicable for that parameter. Absence of any
qualifier is not legal parameter code e.g. <P1-a-b-c> is not a legal tag, it shall be P1-a-b-c-0 as a legal
tag.
Active
Quadrant 4 Quadrant 1
Active Import Active Import
Reactive Export Reactive Import
PF Leading, < 0 PF Lagging, > 0
Capacitive Inductive
Reactive
Quadrant 3 Quadrant 2
Active Export Active Export
Reactive Export Reactive Import
PF Lagging, > 0 PF Leading, < 0
Inductive Capacitive
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 94 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 95 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 96 of 107
15 Annexure
15.1 API compatibility with Reading configuration file
Each manufacturer shall provide reading configuration file information in this format along with API
Manufacture Name:
TelephoneNumber
Port
MultipleMeters
Serial
Device ID
InstParam
EnergyData
Settings
ProfileData
Days
Type
Events
TimeSynch
MDReset
TamperReset
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 97 of 107
Reason for change <Brief description of why this additional tag is required >
15.3 Folders path for temporary files and software hardware specification
Sr. Folder Path for Windows Supporting
HDD
No Manufacturer’s temporary files for XP with RAM CPU Platform
Name API1, API2, API3 SP2 OS
1 Capital Power Application Yes 1Gb P IV 2 GB .Net 2.0
System path\garb or 2.4 or
2 Elster Yes higher GHz higher JVM 1.6.0
3 L&T Application Yes or .Net 2.0
path\temp higher
4 Genus C:\CFW\Genus\temp Yes .Net 2.0
5 Secure Meters Application Yes No
path\temp additional
6 Easun Reyrolle Application Yes .Net 2.0
path\temp
7 ICSA Application Yes .Net 2.0
path\temp
8 HPL Socomec Application path\tmp Yes .Net 2.0
9 Delhi control Yes
devices
10 Bentec Application Yes .Net 2.0
path\temp
11 Holley Meters Yes
12 Omne-agate
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 98 of 107
16 Document History
16.1 Version 01.00
Date 23rd Feb 2k4 Written Author Reviewed SML, L&T, Approved SML, L&T,
by by Elster by Elster
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 99 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 100 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 101 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 102 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 103 of 107
b) Addition in reading API responsibility. API should leave modem at factory default setting and
1200 baudrate.
a) Section 9.3.8 clarity provided for energy & demand code. Additional qualifier code added in
the demand under P7 tag.
b) Section 9.2.1 Demand calculation method clarification is given for fixed window (B5,B6) or
sliding window (B14,B15).
c) Phase sequence – Voltage & current qualifier added. Section 9.3.9
d) Tag G8 description is corrected. Instead of PT primary & secondary it is CT primary & CT
secondary.
e) Section 6.3 – Current meter setting and transaction data added in what to read tag.
f) Section 9.2.1 – D8, D9, D10 tags for Current meter setting, transaction data and flag data
added.
g) Section 9.2.11 – Current meter setting tags added
h) Section 9.2.12 – Transaction data tags added
i) Section 9.2.13 - Flag data tags added
j) Section 15.2 – Manufacturer specific tag addition template added.
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 104 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 105 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 106 of 107
Public File Name: MIOS Universal Meter Reading common format V2.3.doc
Universal Meter Reading & Common Doc. No. 001
Format
Version 2.3
th
Table Of Contents Date 16 July 09
Page 107 of 107
o B17(Billing period power on duration), B18 (Energy cross over count), B19
(Cumulative energy during magnetic tamper) , B20 (Reset specific information) added
Public File Name: MIOS Universal Meter Reading common format V2.3.doc