Download Report Templates Reference Information

Report Templates
Reference Inform ation
CM e2100, CM i2110, CMi2120, CM i2130
Implem entation guidelines and reference
inform ation for report tem plates used by CM e
and CMi Series products
Report Tem plates Reference Inform ation– Version 1.0
Report Tem plates Reference Inform ation
Contents
CON TEN TS ............................................................................................................ 2
1
D OCU M EN T N OTES .................................................................................... 4
1.1
1.2
2
U SIN G THIS D OCU M EN T ............................................................................ 5
2.1
2.2
2.3
3
COPYRIGHT AND TRADEM ARK ......................................................................................... 4
CONTACTS ..................................................................................................................... 4
PURPOSE AND A UDIENCE ............................................................................................... 5
M ODELS ........................................................................................................................ 5
A DDITIONAL AND UPDATED INFORM ATION ....................................................................... 5
IM PLEM EN TA TION GU ID ELIN ES ................................................................. 6
3.1
3.2
3.3
IM PLEM ENTATION LEVEL ................................................................................................. 6
IM PLEM ENTATION LEVEL 1 .............................................................................................. 7
IM PLEM ENTATION LEVEL 2 .............................................................................................. 7
3.3.1
Receiving reports using E-M ail ................................................................................ 7
3.3.1.1 Requirem ents ................................................................................................ 7
3.3.1.2 Report formats .............................................................................................. 7
3.3.2
Receiving reports using FTP..................................................................................... 7
3.3.2.1 Requirem ents ................................................................................................ 8
3.3.2.2 Report formats .............................................................................................. 8
3.3.3
3.4
3.5
Receiving reports using HTTP.................................................................................. 8
3.3.3.1 Requirem ents ................................................................................................ 8
3.3.3.2 Report formats .............................................................................................. 8
IM PLEM ENTATION LEVEL 3 .............................................................................................. 9
3.4.1
3.4.2
3.4.3
3.4.4
Sending SMS to the product .................................................................................... 9
Disable responses ..................................................................................................... 9
Requesting m eter data betw een tw o dates............................................................. 9
Change configuration of retries for report1 ............................................................ 9
IM PLEM ENTATION LEVEL 4 ............................................................................................ 10
3.5.1
Changing or overriding w hich configuration server to synchronize configuration
w ith
10
3.5.2
Synchronization flow .............................................................................................. 10
3.5.3
HTTP GET/POST ...................................................................................................... 11
3.5.4
Synchronization file (cad file) ................................................................................. 12
3.5.5
Result notifications .................................................................................................. 13
3.5.6
Configuration keys and valid values ...................................................................... 13
3.5.7
Exam ple of starting synchronization using SMS w ith custom er specified
configuration server .............................................................................................................. 13
4
REPORT TEM PLA TES ................................................................................ 1 5
4.1
4.2
4.3
5
A SSIGNED REPORT TEM PLATE IDENTIFICATIONS............................................................. 15
STANDARD REPORT TEM PLATE LIST ............................................................................... 15
A DD-ON REPORT TEM PLATE LIST ................................................................................... 18
D EFIN ITION S ............................................................................................. 2 0
5.1
PROPERTIES OF A REPORT VALUE .................................................................................. 20
5.1.1
5.1.2
Serial-num ber property .......................................................................................... 20
Device-identification property ................................................................................ 21
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 2 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
5.2
6
Date property ........................................................................................................... 21
Value-data-count property ...................................................................................... 21
Description property ............................................................................................... 21
Unit property............................................................................................................ 25
Function property .................................................................................................... 26
Tariff property .......................................................................................................... 27
Sub-unit property .................................................................................................... 27
Storage-num ber property ....................................................................................... 27
5.2.1
5.2.2
5.2.3
5.2.4
Electricity m eters ..................................................................................................... 27
Water m eters ........................................................................................................... 27
District heat and cold m eters.................................................................................. 28
Gas m eters ............................................................................................................... 28
IDENTIFYING THE PROPERTIES AND USING CORRECT M ETER VALUES ............................... 27
D OCU M EN T HISTORY ............................................................................... 2 9
6.1
7
5.1.3
5.1.4
5.1.5
5.1.6
5.1.7
5.1.8
5.1.9
5.1.10
DOCUM ENT SOFTWARE AND HARDWARE APPLIANCE...................................................... 29
REFEREN CES ............................................................................................. 3 0
7.1
7.2
REFERENCES ................................................................................................................ 30
TERM S AND A BBREVIATIONS ........................................................................................ 30
7.2.1
Num ber representation........................................................................................... 30
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 3 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
1
Docum ent notes
All inform ation in this m anual, including product data, diagrams, charts, etc. represents
inform ation on products at the tim e of publication, and is subject to change w ithout prior
notice due to product improvem ents or other reasons. It is therefore recomm ended that
custom ers contact Elvaco AB for the latest product inform ation before purchasing a
CM e/CM i Series product.
The docum entation and product are provided on an “as is” basis only and m ay contain
deficiencies or inadequacies. Elvaco AB takes no responsibility for dam ages, liabilities or
other losses by using this product.
1 .1
Co p y r i g h t an d Tr ad em ar k
© 2010, Elvaco AB. All rights reserved. No part of the contents of this m anual m ay be
transmitted or reproduced in any form by any m eans w ithout the w ritten perm ission of
Elvaco AB. Printed in Sw eden.
CM e/CM i Series is a tradem ark of Elvaco AB, Sw eden.
1 .2
Co n t ac t s
Elvaco AB Headquarter
Energigatan 9
434 37 Kungsbacka
SWEDEN
Phone: +46 300 30250
Fax: +46 300 18440
E-M ail: [email protected]
Elvaco AB Technical Support
Phone: +46 300 434300
E-M ail: [email protected]
Online: http://w ww .elvaco.com
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 4 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
2
Using this docum ent
2 .1
Pu r p o se an d A u d i en c e
This docum ent covers reference inform ation and guidelines w hen selecting and using
report tem plates for CM e/CM i Series products. Use this docum ent together with CM e/CM i
Series User’s M anual and specific report tem plate docum entation.
For custom er specific tem plates, please contact Elvaco AB.
2 .2
M o d el s
CM e2100,CMi2110,CMi2120,CM i2130
2 .3
A d d i t i o n al an d u p d at ed i n f o r m at i o n
Latest docum entation version is available on Elvaco w eb site at http://w w w.elvaco.com.
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 5 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
3
Im plem entation guidelines
The CM e/CMi Series gives a w ide range of implem entation possibilities. This chapter
covers good implem entation practice and m ethod selection depending on custom er needs.
Without any developm ent needed, the product m ay be configured using SM S and Telnet.
This m ay not be the m ost effective w ay w hen handling a high volum e of products. Using
Elvaco hosted configuration profiles or im plem enting a product configuration server, the
product can be configured using HTTP w eb server requests. This will be closely described
in section 3.5.
This section is a guideline for good im plem entation practice and serves for starting up an
integration process. Please review the CM e/CM i Series User’s M anual w hich covers all the
comm ands, configuration keys, syntax and reference inform ation.
3 .1
Im p l em en t at i o n level
Elvaco has divided product implem entation into four levels. These levels are defined to
illustrate the tim e for im plem entation and give the developer a good understanding where
to start the im plem entation process and select the correct level of functionality. Please
review Table 1 for level description.
Im p l em ent at i on l ev el
Lev el o f f u nc t io n ali t y
Ty p ic al t i m e f o r
i m p l em ent at i on
Level 1
Transparent M -Bus
communication using GSM
CSD or TCP/IP on GPRS
netw ork.
Configuration of the product is
done by predefined
configuration profile from
Elvaco w eb server or by using
SM S or Telnet.
0 hours
Using standard M -Bus
m aster softw are
Level 2
Handle autom atic scheduled
pushed (E-M ail, FTP, HTTP)
reports to retrieve m eter values.
Configuration of the product is
done by predefined
configuration profile from
Elvaco w eb server or by using
SM S or Telnet.
8-16 hours
Level 3
Tw o w ay com munication for
configuration and starting
comm ands using SM S.
Configuration can also be done
by predefined configuration
profile from Elvaco w eb server.
8-16 hours
Level 4
Configuration of the product
using HTTP w eb server from
custom er implem ented
configuration server.
8-16 hours
Table 1 Im plem entation levels
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 6 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
3 .2
Im p l em en t at i o n level 1
When using transparent M -Bus communication, there are num erous softw are applications
available on the m arket. The product handles transparent M -Bus com munication according
to the M -Bus standard, but the request/response tim e delays m ust be adjusted to handle
GSM/GPRS netw ork response tim es. Depending on netw ork provider, the response tim e
can differ. A good recom m endation for a m axim um response tim e betw een
request/response is approxim ately 4 seconds.
From factory the product is listening and w ill answ er all incom ing GSM CSD calls and
open for transparent M -Bus comm unication. The TCP/IP transparent M -Bus
communication must be m anually started using com m and qset tm bus1/tm bus2 on.
3 .3
Im p l em en t at i o n level 2
Depending on IT structure of im plem entation platform , reports can be received from the
product using E-M ail, FTP and HTTP. In som e cases, im plem entation using E-M ail and FTP
m ay be the preferable. If the goal is to reach implem entation level 4, HTTP should be used
as the transfer protocol from start.
3 .3 .1 Rec ei v i n g r ep o r t s u si ng E-M ai l
When installing the product, the default setting is to send hourly value reports every day.
The report form at can be configured using comm and cfg. Please see CM e/CM i Series
User’s M anuals. When receiving E-M ail reports w ith m eter data, rules can be set up i.e. M S
Outlook to organize E-M ails as needed. There are also softw are applications available on
the m arket, w hich takes attached files and stores these files in a folder on disk. Watch
Directory, http://w ww .w atchdirectory.net, is one of the applications, w hich can handle
these kinds of operations.
3 .3 .1 .1
Req u ir em ent s
For the product to be able to send E-M ail reports, a SIM card w ith GPRS enabled m ust be
used. The product also needs an SMTP server to send the reports. The SMTP server is
norm ally autom atically detected, but in rare cases the server must be set m anually using
comm and qset em ail, see CM e Series User's M anual. This com m and is also used to set EM ail recipients.
3 .3 .1 .2
Rep o rt f o rm at s
There is a w ide range of E-M ail reports available. The m ajor difference betw een E-M ail
reports are:
1. if the m eter data should be attached as a file instead of printed in the body
2. if the m eter data should be sent in one file or separated in one file per device (m eter)
3. if the m eter data should be decoded and readable or in raw M -Bus data form at
The report template 1104 is a good choice if the report should be in m achine friendly
decoded form at and report template 1103 can be used if the receiving system handles raw
M -Bus data form at. Review section 4 for an overview of available tem plates.
3 .3 .2 Rec ei v i n g r ep o r t s u si ng FTP
FTP (File Transfer Protocol) is w idely used all over the world. This m ay be the choice when
there integration platform has an external FTP server available. The product is using
p assi ve m ode FTP, which resolves the problem of NATed TCP/IP traffic from a GPRS
netw ork to the internet.
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 7 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
3 .3 .2 .1
Req u ir em ent s
For the product to be able to send FTP reports, a SIM card with GPRS enabled must be
used. The product m ust be configured w here to send FTP reports, which can be set using
comm and qset ftp, see CM e Series User's M anual. Usernam e, password, port and default
upload directory can also be set using the comm and qset ftp.
The receiving FTP server m ust handle p assi ve FTP. This can som etim es be disabled by
firew all options. Verify firew all settings for passive FTP and FTP server application for
proper configuration.
3 .3 .2 .2
Rep o rt f o rm at s
There is a w ide range of FTP reports available. The m ajor difference betw een FTP reports
are:
1. if the m eter data should be sent in one file or separated in one file per device (m eter)
2. if the m eter data should be decoded and readable or in raw M -Bus data form at
The report template 2104 is a good choice if the report should be in m achine friendly
decoded form at and report template 2103 can be used if the receiving system handles raw
M -Bus data form at. Review section 4 for an overview of available tem plates.
3 .3 .3 Rec ei v i n g r ep o r t s u si ng HTTP
HTTP (Hypertext Transfer Protocol) is w idely used all over the w orld. This m ay be the
choice when the integration platform has an external w eb server available. The product is
using HTTP POST to send data to the server.
3 .3 .3 .1
Req u ir em ent s
For the product to be able to send HTTP reports, a SIM card w ith GPRS enabled m ust be
used. The product m ust be configured w here to send the HTTP reports, w hich can be set
using comm and qset http, see CM e Series User's Manual. Usernam e, password, port and
URL can also be set using the com m and qset http. HTTPS can be used for securing the
connection, w hich is accomplished by entering https instead of http in the URL of the w eb
server.
The reports sent from the product to the w eb server are created on the fly, thereby the
content length of the post is unknown w hen the HTTP headers are sent. Thus, the receiving
w eb server must handle chunked transfer encoding. This is norm ally not an issue when
using Microsoft IIS or Apache w eb server, w here chunked transfer encoding is handled
autom atically.
3 .3 .3 .2
Rep o rt f o rm at s
There is a w ide range of HTTP reports available. The m ajor difference betw een HTTP
reports are:
3. if the m eter data should be sent in one post or separated in one post per device (m eter)
4. if the m eter data should be decoded and readable or in raw M -Bus data form at
The report template 3104 is a good choice if the report should be in m achine friendly
decoded form at and report template 3103 can be used if the receiving system handles raw
M -Bus data form at. Review section 4 for an overview of available tem plates.
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 8 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
3 .4
Im p l em en t at i o n level 3
When the product is operational and is sending reports autom atically, there still m ay be
situations w hen the server application needs to request or send data to the product. This
can be accomplished by sending SM S to the product. The SMS can be a comm and to start
a report m anually, start a configuration process w ith a w eb server or to change
configuration.
SM S m ay not be the most reliable com munication protocol, but adding extra inform ation
to the SM S for identification and using the SM S functionality for correct purposes, it can
be a pow erful and easy w ay for integration.
3 .4 .1 Sen d i n g SM S t o t h e p r o d u c t
In the CM e/CMi Series User’s M anuals, all com m ands which can be sent using SM S is
tagged with access “SM S”. When the product receives an SM S, following process is
started:
1. If phone number security is enabled, is the sending phone number accepted?
2. Is the first line of the SM S a password for security level 1,2 or 3? If true, set proper
security level.
3. If 1) and 2) is parsed successfully, start parsing SMS comm and lines which can divided
w ith CRLF or sem i-colon “;”
4. If not the configuration key com mon.sm s.response.m ode is set to disable responses,
respond w ith the executed com m and response inform ation. The default value for
common.sms.response.m ode is “all”.
3 .4 .2 D i sab l e r esp o nses
In som e cases, the SM S response from the product m ay not be interesting for the sending
part. An example w ould be if the comm and is to start sending an HTTP POST report to a
w eb server, w hich is autom atically acknowledged when the report is received by the w eb
server and the SM S response is not giving any extra inform ation. Override the
configuration sms.response.m ode and set the value to “none”.
An example for starting com m and report1 and disable SM S responses would look like:
report1 sms.response.mode=none
3 .4 .3 Req u est i ng m et er d at a b et w een t w o d at es
This example describes how to start a report and send m eter data within two dates.
To resend m eter data betw een 2010-09-01 and 2010-09-03 w ith report tem plate 1104, send
the following SM S comm and:
Report 1104 filter.mode=interval filter.param=20100901,20100903
3 .4 .4 Ch ang e c o n f i gu r at i o n o f r et r i es f o r r ep o r t 1
This example describes how to change the report retries and the tim e betw een the retries.
To set num ber of retries to ten (9) and tim e betw een retries to five (5) minutes, send the
following SM S comm and:
set report1.schedule.retrymax=9 report1.schedule.retryoffset=300
Th e CM e/CM i Ser ies U ser ’s M an ual s c o ver s al l t h i s i nf o rm at i o n i n m o re det ai l .
Th ere i s al so nu m er o u s exam pl es f o r ev er y c om m and w h i ch can be sen t t o t h e
p r o d uc t .
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 9 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
3 .5
Im p l em en t at i o n level 4
The implem entation level 4 is a combination of im plem entation level 3 and adding a
product configuration server, w hich handles the distribution/product requests for new or
updated configuration. The product connects to the product configuration server when
using comm and sync and using com m and install with suffix.
Follow ing SM S comm and will force the product to execute comm and install and connect
to Elvaco distribution server (by default), and download configuration “elvaco”.
Install 1 elvaco
Follow ing SM S comm and will force the product to execute sync and connect to Elvaco
configuration server (by default), and download configuration “elvaco”.
Sync elvaco
Comm and install is used w hen installing the product for the first tim e or when m eter
configuration has changed. Comm and sync is used only when new configuration should
be downloaded to the product.
The configuration “elvaco” is concatenated w ith the com mon.system .cota.urlbase to
download the actual file from the configuration server. The actual url for configuration
“elvaco” would be: http://dist.elvaco.se/sync/cota/elvaco.cad.
3 .5 .1 Ch ang i n g o r o v er r i d i n g w h i c h co n f i g u r at i o n ser v er t o sy n c h r on i ze
c o n f i g u r at i o n w i t h
From factory default, the product will connect to http://dist.elvaco.se/ for synchronizing
configuration. This server setting can be changed using configuration keys
common.system.cota.urlbase, common.system.cota.url, comm on.system.cota.user,
common.system.cota.passw ord, comm on.system .cota.authm ode.
The configuration key urlbase is used to set the base url w hen using short nam es in
comm and install and sync. The configuration key url can be used to point out a specific
location of a configuration file.
Exam ple of executing sync and download a configuration file called m yconfig.cad at
http://m yserver.com:
Sync system.cota.url=http://myserver.com/myconfig.cad.
3 .5 .2 Sy n c h r o n izat i o n f l o w
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 10 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
Can be the same server
CMe Series
Sync Server
File server[1..n]
Result Server
Get synchronization file (cad file) from sync server
Send synchronization file (cad file)
Parse synchronization file
Synchronize files [1..n] (if set)
Send requested files
Set configuration keys and
values from configuration file
Post result to result server (if set)
Acknowledge
Reboot if any synchronization
took place
The CM e/CMi Series starts w ith requesting a synchronization file. The synchronization file
contains param eters to synchronize files and configuration keys to set in the product.
When the synchronization of files and configuration are com plete (or incomplete), the
product w ill send a result to a specified result server. The result server can be specified in
the cad file.
3 .5 .3 HTTP GET/POST
To identify the product, the HTTP header User-Agent is filled w ith the follow ing
inform ation:
User-Agent=TC65i/<imei> Profile/IMP-NG Configuration/CLDC-1.1
Model/<model> Hardware/<hw> Firmware/<fw> Application/<sw>
Serial/<serial>
Param et er descr i pt i o n
<imei>
15 digit product m odule IMEI num ber
<model>
Product model, i.e. CM e1000, CM e1100, CM e2000, CM e2100
<hw>
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 11 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
Product hardw are version, i.e R4A
<fw>
Product module firm w are version, i.e. 01.100
<sw>
Product softw are version, i.e. 1.1.0
<serial>
10 digit product serial num ber, i.e. 0006000000
3 .5 .4 Sy n c h r o n izat i o n f i l e (c ad f i l e)
The cad file contains the actual inform ation to synchronize. See Table 2 for synchronization
param eters. All cad files m ust have the extension .cad.
Param eter
Description
Sync-M ode
Synchronization m ode, must be set to
“server”
Syntax:
Sync-M ode: server
Sync-Notify-URL
Result server URL. Notifications w ill be
sent to this server address. Can be left
out.
Syntax:
Sync-Notify-URL: <notify url>
Sync-File-[0..n]-URL
Files to synchronize. The index m ust
start at 0 and be continuous. Can be
left out.
Syntax:
Sync-File-[0..n]-URL: <rem ote
url>,<local file>
Sync-Config-[0..n]
Configuration keys and values to
synchronize. The index must start at 0
and be continuous. Can be left out.
Syntax:
Sync- Config-[0..n]: <key>=<value>
Sync-Id
Identification w hich will be parsed into
the result notification. Can be left out.
Syntax:
Sync-Id: <id>
Param eter descriptions for cad-files
<notify url>
URL where to post notifications
<remote file>
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 12 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
URL where to get remote file
<local file>
Local path and filenam e where to put downloaded file
<key>
Configuration key to set
<value>
Configuration key value
<id>
User specific identification for this synchronization
Exam ple of cad file
Sync-Mode: server
Sync-Id: 1
Sync-Notify-URL: http://dist.elvaco.se/RequestLogger/index.aspx
Sync-Config-0: common.branding.company=Elvaco AB
Sync-Config-1: common.branding.address1=Energigatan 9
Table 2 Synchronization file (cad file)
3 .5 .5 Resu l t n o t i f i c at i o n s
If the param eter Sync-Notify-Url is set in the cad file, the product w ill post result
inform ation to given URL. The post is a standard HTTP post w ith a body containing the
result inform ation. Please see possible results in Table 3.
Result
Description
900 Success
Synchronization completed
successfully
920 Incompatible synchronizing mode
The Sync-M ode w as not set to “server”
921 Error synchronizing files. <error>
Generic synchronization error.
Exam ple of a notify post result body
900 Success
Sync-Id: 1
Table 3 Result notification post
3 .5 .6 Co n f i g u r at i o n k ey s and v al i d v al u es
The configuration keys and values set in the configuration file must be valid. If any key or
value is invalid, the configuration process will quit and an error m essage will be sent to
initiator and to the result server.
3 .5 .7 Ex am p l e o f st ar t i n g sy n ch r o n i zat i on u si ng SM S w i t h c u st o m er sp ec i f i ed
c o n f i g u r at i o n ser v er
This example show s how to start a synchronization process using SM S.
Follow ing configuration keys will be set:
-
report1.schedule.retrym ax
-
report1.schedule.retryoffset
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 13 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
The Sync-Id is set to 1234 and w ill be posted back to the result server for identifying the
configuration.
The configuration file url is set to http://m yserver.com /config/m yconfig.cad.
The result server url is set to http://m yserver.com/result/result.html
SM S t o t h e p r od u ct t o st art syn c hr o n i zat io n :
Sync system.cota.url=http://m yserver.com/config/m yconfig.cad
SM S f ro m t h e p r od u ct i n di cat in g sy nc hr o n i zat i o n st ar t ed :
Sync started.
OK
The product will download the configuration file using HTTP GET and set the configuration
keys as specified.
Th e f i l e m yc o nf i g .c ad co n t ent s w hi c h w i l l b e d o w n lo aded t o t h e p r od u ct :
Sync-Mode: server
Sync-Id: 1234
Sync-Notify-URL: http://myserver.com/result/result.html
Sync-Config-0: report1.schedule.retrymax=10
Sync-Config-1: report1.schedule.retryoffset=600
After the configuration file is processed, the product w ill send a HTTP POST w ith the result
inform ation.
Th e HTTP POST b o dy c o n t ent s sent t o t he r esu l t ser ver:
900 Success
Sync-Id: 1234
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 14 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
4
Report tem plates
Report templates are description files how to form at and send data from CM e/CM i Series
product to an external source. Templates are available for SM S, FTP, HTTP and E-M ail.
The report engine in CM e/CM i Series is very pow erful and can form at almost any output
data. Example of data form at is csv form atted files, xm l based data and hum an readable
html reports. The report data can be events, m eter data, system log reports etc.
CM e/CM i Series products are released with a standard set of reports, but can be enhanced
by Elvaco provided add-ons and custom er specific add-ons. Custom er specific add-ons are
not listed in this docum ent.
Please see Table 4 for current standard set of reports.
Please see Table 5 for current add-on set of reports.
4 .1
A ssi g n ed r ep o r t t em p l at e i d en t i f ic at i on s
Ran g e
N am e
0001-0999
Standard SM S reports
1000-1099
Standard E-M ail system reports
1100-1199
Standard E-M ail value reports
1500-1599
Add-on E-M ail reports
2000-2099
Standard FTP system reports
2100-2199
Standard FTP value reports
2500-2599
Add-on FTP reports
3000-3099
Standard HTTP system reports
3100-3199
Standard HTTP value reports
3500-3599
Add-on HTTP reports
xx0001-xx0999
Custom er specific SMS reports
xx1000-xx1099
Custom er specific E-M ail system reports
xx1100-xx1199
Custom er specific E-M ail value reports
xx2000-xx2099
Custom er specific FTP system reports
xx2100-xx2199
Custom er specific FTP value reports
xx3000-xx3099
Custom er specific HTTP system reports
xx3100-xx3199
Custom er specific HTTP value reports
Where xx is an Elvaco assigned custom er number, tw o digits 00-99.
4 .2
St an d ar d r ep o r t t em p l at e l ist
These templates are included in the default setup from factory.
Id
N am e
V er si o n
D escr i pt i o n
1
SM S
Installation
report
1.0
SM S report sent upon installation containing
status inform ation of last installation process.
See Report Tem plate Description 1
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 15 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
1001
Em ail
installation
report - htm l
1.0
E-M ail report sent upon installation
containing status inform ation of last
installation process in html form at.
See Report Tem plate Description 1001
1002
Em ail
installation
report - plain
1.0
E-M ail report sent upon installation
containing status inform ation of last
installation process in plain text form at.
See Report Tem plate Description 1002
1003
Em ail system
report - htm l
1.1
E-M ail report containing system settings and
status in html form at.
See Report Tem plate Description 1003
1004
Em ail log
report - htm l
1.0
E-M ail report containing system log in htm l
form at.
See Report Tem plate Description 1004
1005
Em ail event
report - htm l
1.0
E-M ail report sent upon a system event in
html form at.
See Report Tem plate Description 1005
1006
Em ail log
report attached file html
1.1
E-M ail report containing system log as
attached file. Body in html form at.
See Report Tem plate Description 1006
1101
Em ail value
report - htm l
1.0
E-M ail report containing value data from
active devices in a hum an readable form at.
Body in html form at.
See Report Tem plate Description 1101
1102
Em ail value
report raw html
1.0
E-M ail report containing value data from
active devices in raw data form at. Body in
html form at.
See Report Tem plate Description 1102
1103
Em ail value
report raw attached file
per device html
1.1
E-M ail report containing value data from
active devices in raw data form at as attached
file. Body in htm l form at.
See Report Tem plate Description 1103
1104
Em ail value
report attached file
per device html
1.1
E-M ail report containing value data from
active devices in hum an readable form at as
attached file per device. Body in htm l form at.
See Report Tem plate Description 1104
1105
Em ail value
report
extended attached file
per device html
1.1
E-M ail report containing value data from
active devices in hum an readable form at as
attached file per device. Report colum n
header data has prefix #. Body in htm l
form at.
See Report Tem plate Description 1105
1106
Em ail value
report
extended attached file
per device -
1.1
E-M ail report containing value data from
active devices in hum an readable form at as
attached file per device. Report colum n
header data has prefix #. The attached files
have zip extensions for possible spam filter
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 16 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
zip extension html
problems. Body in htm l form at.
See Report Tem plate Description 1106
1107
Em ail value
report energy
consum ption attached file
per device html
1.1
E-M ail report containing energy consumption
value data from active devices in hum an
readable form at as attached file per device.
Report colum n header data has prefix #. This
report only work together with devices
having field energy. Body in html form at.
See Report Tem plate Description 1107
1108
Em ail value
report
extended single file html
1.0
E-M ail report containing value data from
active devices in hum an readable form at in a
single attached file. Report column header
data has prefix #. Body in htm l form at.
See Report Tem plate Description 1108
2001
FTP install
report - single
file - plain
1.1
FTP report sent upon installation containing
status inform ation of last installation process.
See Report Tem plate Description 2001
2005
FTP event
report - single
file - plain
1.0
FTP report sent upon a system event.
See Report Tem plate Description 2005
2006
FTP log report
- single file plain
1.1
FTP report containing system log.
See Report Tem plate Description 2006
2007
FTP status
report - single
file - plain
1.0
FTP report containing current status of
product.
See Report Tem plate Description 2007
2101
FTP value
report - single
file - plain
1.1
FTP report containing value data from active
devices in a hum an readable form at.
See Report Tem plate Description 2101
2102
FTP value
report raw single file plain
1.1
FTP report containing value data from active
devices in raw data form at.
See Report Tem plate Description 2102
2103
FTP value
report raw file per device
- plain
1.1
FTP report containing value data from active
devices in raw data form at a file per device.
See Report Tem plate Description 2103
2104
FTP value
report - file
per device plain
1.1
FTP report containing value data from active
devices in hum an readable form at as file per
device.
See Report Tem plate Description 2104
2105
FTP value
report
extended - file
per device plain
1.1
FTP report containing value data from active
devices in hum an readable form at as file per
device. Report column header data has prefix
#.
See Report Tem plate Description 2105
2108
FTP value
report
extended single file -
1.1
FTP report containing value data from active
devices in hum an readable form at in a single
file. Report column header data has prefix #.
See Report Tem plate Description 2108
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 17 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
plain
3001
HTTP install
report - single
post - plain
1.1
HTTP report sent upon installation containing
status inform ation of last installation process.
See Report Tem plate Description 3001
3005
HTTP event
report - single
post - plain
1.1
HTTP report sent upon a system event.
See Report Tem plate Description 3005
3006
HTTP log
report - single
post - plain
1.1
HTTP report containing system log.
See Report Tem plate Description 3006
3007
HTTP status
report - single
post - plain
1.0
HTTP report containing current status of
product
See Report Tem plate Description 3007
3101
HTTP value
report - single
post - plain
1.1
HTTP report containing value data from
active devices in a hum an readable form at.
See Report Tem plate Description 3101
3102
HTTP value
report raw single post plain
1.1
HTTP report containing value data from
active devices in raw data form at.
See Report Tem plate Description 3102
3103
HTTP value
report raw post per
device - plain
1.1
HTTP report containing value data from
active devices in raw data form at as post per
device.
See Report Tem plate Description 3103
3104
HTTP value
report - post
per device plain
1.1
HTTP report containing value data from
active devices in hum an readable form at as
post per device.
See Report Tem plate Description 3104
3105
HTTP value
report
extended post per
device - plain
1.1
HTTP report containing value data from
active devices in hum an readable form at as
post per device. Report colum n header data
has prefix #.
See Report Tem plate Description 3105
3108
HTTP value
report
extended –
single post plain
1.0
HTTP report containing value data from
active devices in hum an readable form at in a
single post. Report column header data has
prefix #.
See Report Tem plate Description 3108
Table 4 Standard report tem plate list
4 .3
A d d -o n r ep o r t t em p l at e l i st
These templates must be bought and downloaded to the product. Visit w ww .elvaco.com
and login to buy add-ons to CM e/CM i Series products.
Id
N am e
V er si o n
D escr i pt i o n
3501
HTTP value
report - single
1.0
HTTP report containing value data from
active devices in XM L based form at.
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 18 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
post – XM L
form at
See Report Tem plate Description 3501
Table 5 Add-on report tem plate list
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 19 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
5
Definitions
This chapter covers definitions used to describe report data sent from CM e/CMi Series
products.
5 .1
Pr o p er t i es o f a r ep o r t val u e
Value reports contain m eter report data. The CM e/CM i Series products can handle any
standard M-Bus m eter, which forces the product to dynamically assign properties for each
available value for a m eter. The properties are build up upon the internal M -Bus decoder.
The properties are taken from the standard M -Bus EN13757.
A com bination of all properties for a value for a specific m eter w ithin one telegram shal l
be unique, but som etim es M -Bus slave implem entations don’t follow these
recomm endations. In those cases one or m ore values can have the exact sam e properties,
but the position of the value is not unique which must be used to distinguish the values.
The property nam es are globally used in all CM e/CM i Series docum entation to describe i.e.
report form ats.
Follow ing properties are describing the origin of a value:
N am e
D escr i pt i o n
Serial-number
The product serial num ber w hich has read and stored the value of a m eter.
Deviceidentification
The M -Bus slave secondary identification w hich a value belongs to.
Date
The create date of a value.
Value-datacount
The M -Bus telegram in w hich a value w as found.
Table 6 Properties describing the origin of a value
Follow ing properties are describing the definition of a specific value:
N am e
D escr i pt i o n
Description
Description of the value. This property is usually defining the type of the
value, i.e. energy, flow tem perature etc.
Unit
Unit of the value. This property defines the unit, i.e kWh, °C etc.
Function
Function of the value describing i.e min value, m ax value etc.
Tariff
The tariff of the value.
Sub unit
The sub unit of the value, i.e. a num eric value for extended inform ation of
a value.
Storage
num ber
The storage number of the value. Norm ally describing historic values.
Table 7 Properties describing the definition of a value
5 .1 .1 Ser i al -n u m b er p r o p er t y
The serial number is an 10-digit long num eric value. The first 4-digits identifies the product
type. An example of a serial-number from a CM e2100 product would look like:
0006xxxxxxxx, w here xxxxxxxx is the actual serial num ber of the product.
See Table 8 for current product type num bers:
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 20 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
Pr o d uc t
4 -d i g it t y p e n u m b er
CM e2100
0006
CM i2110
0012
CM i2120
Internal
antenna
0029
CM i2120
External
antenna
0027
CM i2130
0030
Table 8 Product type num bers
5 .1 .2 D ev i c e-i d en t i f i c at i o n p r o p er t y
Device-identification is the unique m eter id (M -Bus secondary address) which the m eter
value w as read from. The device-identification is an 8-digit num ber. This num ber can
norm ally be changed by the custom er on dem and.
The device-identification for a m eter is internally used in CM e/CMi Series to bind
inform ation for one m eter connected to a CM e/CM i Series product. Thus all m eters
connected to CM e/CM i Series product m ust have unique device-identification (secondary
address).
5 .1 .3 D at e p r o p er t y
Date is the tim estam p of the m eter value readout. Date/Tim e used in the CM e/CM i Series
products can be configured with UTC offset to set any tim e zone.
5 .1 .4 V al u e-d at a-c o u n t p r op er t y
The value-data-count property is used to distinguish value data read from one telegram to
another. The CM e/CMi Series products im plem ent autom atic FCB-bit toggling, w hich
m eans that the product will autom atically read all available data telegrams from a m eter. A
value of 0 m eans the value w as found in telegram 0, a value of 1 m eans that the value w as
found in telegram 1.
5 .1 .5 D esc r i p t i o n p r o p er t y
This property describes the type of a value. A type can be i.e. energy, pow er, flow
tem perature etc. Description can be one or a com bination of nam es as listed in Table 9.
The description can also be a custom specified string describing the value, w hich can
contain any character string.
Descriptions listed in Table 9 are taken from the M -Bus standard EN13757. All spaces in
description nam es are replaced w ith character – (hyphen). Com bination of description
nam es are separated w ith space character. This helps finding the prim ary description of
the value, i.e. the first word in the description nam e.
N am e
energy
volum e
m ass
on-tim e
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 21 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
op-tim e
pow er
volum e-flow
volum e-flow-ext
m ass-flow
flow-temp
return-temp
diff-temp
ext-tem p
pressure
date
datetim e
units-for-HCA
avg-duration
act-duration
fabrication-no
enhanced-id
address
reactive-energy
cold/w arm -temp-lim it
cum-cnt-m ax-pow er
credit
debit
access-number
device-type
m anufacturer
param eter-set-id
m odel/version
hw -version
fw -version
other-sw-version
custom er-location
Custom er
access-code-user
access-code-operator
access-code-system -operator
access-code-developer
password
error-flags-dev-spec
error-m ask
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 22 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
digital-output
digital-input
baudrate
response-delay-tim e
retry
rem ote-control-dev-spec
first-storage-for-cyclic-storage
last-storage-for-cyclic-storage
size-of-storage-block
storage-interval
tim e-point
duration-since-last-readout
start-of-tariff
duration-of-tariff
period-of-tariff
dim ensionless
Voltage
Current
reset-counter
cum-counter
control-signal
day-of-w eek
w eek-number
tim e-point-of-day-change
state-of-param -activation
special-supplier-inform ation
duration-since-last-cum
operation-tim e-battery
datetim e-of-battery-change
day-light-saving
listening-window -m anagem ent
cold/w arm -temp-lim it
rem aining-battery-lifetim e
count-m eter-stop
Reserved
m anufacturer-specific
no-error
too-m any-DIFE
storage-num ber-not-im pl
unit-num ber-not-impl
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 23 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
tariff-number-not-impl
function-not-im pl
data-class-not-im pl
data-size-not-impl
too-m any-VIFE
illegal-VIF-group
illegal-VIF-exponent
VIF/DIF-m ism atch
unimpl-action
no-data-available
data-overflow
data-underflow
data-error
prem ature-end-of-record
inc-per-input-pulse-on-input-channel-0
inc-per-input-pulse-on-input-channel-1
inc-per-output-pulse-on-input-channel-0
inc-per-output-pulse-on-input-channel-1
start-date/tim e-of
uncorrected-unit
acc-only-if-pos-contr
acc-of-abs-value-only-if-neg-contr
low er-lim it-value
exceeds-low er-lim it-value
datetim e-of-begin-of-first-low er-limit-exceeded
datetim e-of-end-of-first-low er-lim it-exceeded
datetim e-of-begin-of-last-low er-limit-exceeded
datetim e-of-end-of-last-low er-limit-exceeded
upper-lim it-value
exceeds-of-upper-lim it-value
datetim e-of-begin-of-first-upper-lim it-exceeded
datetim e-of-end-of-first-upper-lim it-exceeded
datetim e-of-begin-of-last-upper-lim it-exceeded
datetim e-of-end-of-last-upper-lim it-exceeded
duration-of-first-low er-lim it-exceeded
duration-of-last-low er-lim it-exceeded
duration-of-first-upper-lim it-exceeded
duration-of-last-upper-lim it-exceeded
duration-of-low er-lim it-exceeded
duration-of-upper-limit-exceeded
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 24 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
value-during-low er-lim it-exceeded
leak-values
datetim e-of-first-begin
datetim e-of-first-end
value-during-upper-lim it-exceeded
overflow-values
datetim e-of-last-begin
datetim e-of-last-end
future-value
Table 9 Standard description property values
5 .1 .6 U n i t p r o p er t y
This property describes the unit of a value. A unit can be i.e. Wh, kWh, °C etc. Units can be
one or a com bination of nam es as listed in Table 10 The unit can also be a custom
specified string describing the value, which can contain any character string.
Units listed in Table 10 are taken from the M -Bus standard EN13757. All spaces in
description nam es are replaced w ith character – (hyphen). Com bination of units nam es are
separated with space or slash (/) character. This helps finding the prim ary unit of the value,
i.e. the first w ord in the unit nam e.
N am e
Wh
J
m3
Kg
second(s)
m inute(s)
hour(s)
day(s)
W
m 3/h
m 3/m in
m 3/sec
kg/h
°C
K
Bar
M Wh
kVARh
GJ
Ton
feet^ 3
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 25 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
USgallon
USgallon/min
USgallon/h
MW
GJ/h
°F
local-curreny-unit(s)
Baud
Bittim es
m onth(s)
year(s)
V
A
reserved
/s
/min
/h
/day
/w eek
/month
/year
/revol/m easurem
/liter
/m 3
/kg
/K
/kWh
/GJ
/kW
/k* liter
/V
/A
*s
* s/V
* s/A
* s/A
Table 10 Standard unit property values
5 .1 .7 Fu n c t i o n p r op er t y
This property describes the function of a value. A function can be i.e. m inim um value,
m aximum value etc
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 26 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
Functions listed in Table 11 are taken from the M -Bus standard EN13757.
N am e
D escr i pt i o n
inst-value
The value is an instantaneous value (Current value)
m ax-value
The value is a m aximum value at a specific date/time
m in-value
The value is a minimum value at a specific date/time
err-value
The value contains error and should not be treated as qualified
value.
Table 11 Standard function property values
5 .1 .8 Tar i f f p r o p er t y
Tariff property is a num eric value describing the tariff of a value.
5 .1 .9 Su b -u n i t p r o p er t y
Sub-unit property is a num eric value describing the sub-unit of a value. Sub-unit is often
used to distinguish almost identical values, i.e. softw are version from a m eter can be of
sub-unit 0 and softw are version of the M -Bus m odule used to com municate w ith the m eter
can be of sub-unit 1.
5 .1 .1 0
St o r ag e-n u m b er p r op er t y
Storage-num ber property is a num eric value describing the storage-number of a value.
Storage-num ber is norm ally used to identify a load profile or other historical value.
5 .2
Id en t i f y i n g t h e p r o p er t i es an d u si n g co r r ec t m et er v al ues
Depending on m eter used, a w ide range of data can be available. A standard electricity
m eter norm ally provides num erous of extra information besides i.e. energy and pow er.
This section describes how to find and identify comm only used inform ation from standard
M -Bus m eters. Please note that depending on m eter, this inform ation m ay vary.
5 .2 .1 El ec t r i c i t y m et er s
Please review Table 12 for commonly used values from electricity m eters.
V al ue of
i n t er est
D escr i pt i o n
Unit
Fu nc t i on
Tar if f
Su b -u n it
St o rag e
n u m ber
Current
energy
m eter stand
energy
Wh
inst-value
0
0
0
Current
pow er
pow er
W
inst-value
0
0
0
Current
energy
m eter stand
– Tariff 1
energy
Wh
inst-value
1
0
0
M aximum
pow er
pow er
W
m ax-value
0
0
0
Table 12 Com m only used properties for electricity m eters
5 .2 .2 Wat er m et er s
Please review Table 13 for commonly used values from w ater m eters.
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 27 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
V al ue of
i n t er est
D escr i pt i o n
Unit
Fu nc t i on
Tar if f
Su b -u n it
St o rag e
n u m ber
Current
volum e
m eter stand
volum e
m3
inst-value
0
0
0
Table 13 Com m only used properties for water m eters
5 .2 .3 D i st r i c t h eat an d c o l d m et er s
Please review for com monly used values from district heat and cold m eters.
V al ue of
i n t er est
D escr i pt i o n
Unit
Fu nc t i on
Tar if f
Su b -u n it
St o rag e
n u m ber
Current
energy
m eter stand
energy
Wh
inst-value
0
0
0
Current
volum e
m eter stand
volum e
m3
inst-value
0
0
0
Current
pow er
pow er
W
inst-value
0
0
0
Current
forw ard
tem perature
flow-temp
°C
inst-value
0
0
0
Current
backw ard
tem perature
return-temp
°C
inst-value
0
0
0
Current
tem perature
difference
diff-temp
K
inst-value
0
0
0
Current
volum e flow
volum e-flow
m 3/h
inst-value
0
0
0
Table 14 Com m only used properties for district heat and cold m eters
5 .2 .4 Gas m et er s
Please review for com monly used values from gas m eters.
V al ue of
i n t er est
D escr i pt i o n
Unit
Fu nc t i on
Tar if f
Su b -u n it
St o rag e
n u m ber
Current
volum e
m eter stand
volum e
m3
inst-value
0
0
0
Current
volum e flow
volum e-flow
m 3/h
inst-value
0
0
0
Table 15 Com m only used properties for gas m eters
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 28 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
6
6 .1
Docum ent History
V er si o n
D at e
D escr i pt i o n
A u t h or
1.0
2010-09-27
First release
David Vonasek
D o c u m en t so f t w ar e an d h ar d w ar e ap p l i an ce
Ty pe
V er si o n
D at e
Co m m ent s
Hardw are
-
-
-
Softw are
>1.1.0
2009-11
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 29 (30)
2010-09-28
Version 1.0
Report Tem plates Reference Inform ation
7
References
7 .1
Ref er en c es
[1] CM e Series User’s M anual
[2] CM i2110 User’s M anual
[3] CM i2120 User’s M anual
[4] CM i2130 User’s M anual
[5] Report Tem plate Description [n], w here n is the report tem plate id
7 .2
Ter m s an d A b b r ev iat i o n s
A b b rev iat i o n
D escr i pt i o n
7 .2 .1 N u m b er r ep r esen t at i o n
Decim al numbers are represented as norm al num ber, i.e. 10 (ten).
Hexadecim al num bers are represented w ith prefix 0x, i.e. 0x0A (ten)
Binary num bers are represented with prefix 0b, i.e. 0b00001010 (ten)
Report Tem plates Reference
Inform ation .Docx
Public/Published
page | 30 (30)
2010-09-28
Version 1.0