Report Templates Reference Information
Contents
1. r Post result to result server if set Acknowledge Reboot if any synchronization took place The CMe CMi Series starts with requesting a synchronization file The synchronization file contains parameters to synchronize files and configuration keys to set in the product When the synchronization of files and configuration are complete or incomplete the product will 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 with the following information User Agent TC65i lt imei gt Profile IMP NG Configuration CLDC 1 1 Model lt model gt Hardware lt hw gt Firmware lt fw gt Application lt sw gt Serial lt serial gt Parameter description lt imei gt 15 digit product module IMEI number lt model gt Product model i e CMe1000 CMe1100 CMe2000 CMe2100 lt hw gt Se TT TFT E Report Templates Reference page 11 30 2010 09 28 Information Docx Public Published Version 1 0 rm Report Templates Reference Information elvaco Product hardware version i e R4A E Product module firmware version i e 01 100 lt sw gt Product software version i e 1 1 0 lt serial gt 10 digit product serial number i e 0006000000 3 5 4 Synchronization file cad file The cad2. elvacz CNic SERIES Report Templates The everything meter Reference Information CMe2100 CMi2110 CMi2120 CMi2130 Implementation guidelines and reference information for report templates used by CMe and CMi Series products Report Templates Reference Information Version 1 0 rm Report Templates Reference Information elvaco Contents CONTENTS resets sse sasiasbissoa saiasco nadas E been da saias ssa tias Das ca Cenas aniinaaes 2 1 DOCUMENT NOTES EEN KEEN KEEN EEN EE EEN ENEE ENEE EE EE En 4 1 1 COPYRIGHT AND Eege 4 1 2 CONTACTO eege 4 2 USING THIS DOCUMENT see NEEN KEEN ENEE ENEE ENEE EE EE EE ENEE EE En 5 2 1 PURPOSE AND AUDIENCE NNN 5 2 2 MODEL ee 5 2 3 ADDITIONAL AND UPDATED INFORMATION 5 3 IMPLEMENTATION GUIDELINES nee ENKEN EEN KEEN KEEN KEEN ENEE Ek 6 3 1 IMPLEMENTA TION WE VEL eer ehre heet 6 3 2 IMPLEMENTA NON LEVEE T E 7 3 3 IMPLEMENTATION LEVEL Dieese SS seamen NEnENER EAA ne nnn nn Ennen 7 3 3 1 Receiving reports using E Mail EE 7 Do bd EENEG 7 33 12 Report ege EE 7 3 3 2 Receiving reports USING EE 7 Dai EE 8 Doc WEE EE 8 3 3 3 Receiving reports USING TAL UR E 8 De dd RCQUITCINGIUS eege EES 8 Soo EE 8 3 4 MIP ES VENTA ONE VES ria 9 3 4 1 Sending SMS rorbeporoduct 9 3 4 2 Disable CSO OS CS eases eraser eset eee sea ose ee tie a vest eee ee sete nan 9 3 4 3 Requesting meter data between two dates 9 3 4 4 Change configuration Of retries for report 9 3 5 IMPLEMENTATION LEVEL A EEN
3. 10 3 5 1 Changing or overriding which configuration server to synchronize configuration with 10 35 2 Synchronization TOW E 10 d o MP QENPOS Re emer a Re ee mr er AE SO SS 11 3 5 4 Synchronization file cad FIC A 12 oo Fesul notiicallonS E 13 3 5 6 Configuration keys and valid values 13 3 5 7 Example of starting synchronization using SMS with customer specified configuration TEE 13 4 REPORT TEMPLATES eege Seed SE eege 15 4 1 ASSIGNED REPORT TEMPLATE IDENTIEICATIONS 15 4 2 STANDARD REPORT TEMPLATE LIS Tansini a EEA E 15 4 3 ADD ON REPORT TEMPLATE LIST 18 5 DEFINIMNONS asse cae assesses nA aa 20 5 1 PROPERTIES OF A REPORT VALUE AA 20 511 Serial number DIO DONNY E 20 5 1 2 Device identification Dropertk 21 EE SAAE ES RE Eee Report Templates Reference page 2 30 2010 09 28 Information Docx Public Published Version 1 0 rT Report Templates Reference Information e Ma Shs Ree EE 21 5 1 4 Value data count Droperfk 21 519 EENHEETEN 21 EE EE 25 517 ee eege resp raat twa are eee 26 EEN 27 do DUDE OOD E EE 27 5 1 10 Storage number POPs ty sssccsssccccseececnsecccnscssesecnsussecssuseesausesensusessessussssnanesessessens 27 5 2 IDENTIFYING THE PROPERTIES AND USING CORRECT METER VALUES sassssasssssnnnnnnnnenrnnnnns 27 DAT ElCCUICIY E 27 5 2 2 e e 27 5 2 3 District heat and cold meters EEN 28 DAZ GK e 28 6 DOCUMENT HISTORY enee NEEN ENEE ENEE ENEE ENEE ENEE ENEE ENNEN ENEE EE 29 6 1 DOCUMENT SOFTWARE
4. 46 300 30250 Fax 46 300 18440 E Mail info elvaco com Elvaco AB Technical Support Phone 46 300 434300 E Mail support elvaco se Online http Awww elvaco com SaaS SSS SESS a Report Templates Reference page 4 30 2010 09 28 Information Docx Public Published Version 1 0 rT Report Templates Reference Information e Ma 2 Using this document 2 1 Purpose and Audience This document covers reference information and guidelines when selecting and using report templates for CMe CMi Series products Use this document together with CMe CMi Series User s Manual and specific report template documentation For customer specific templates please contact Elvaco AB 2 2 Models CMe2100 CMi2110 CMi2120 CMi2130 2 3 Additional and updated information Latest documentation version is available on Elvaco web site at http Awww elvaco com aaa SESE PPP Report Templates Reference page 5 30 2010 09 28 Information Docx Public Published Version 1 0 rm Report Templates Reference Information elvaco 3 Implementation guidelines The CMe CMi Series gives a wide range of implementation possibilities This chapter covers good implementation practice and method selection depending on customer needs Without any development needed the product may be configured using SMS and Telnet This may not be the most effective way when handling a high volume of products Using Elvaco hosted configuration profiles or implementing a
5. AND HARDWARE APPLIANCE cceecseceeseeccceeeuseuseeseueeeuseuseusseueaeees 29 7 Bie a Eeer 30 7 1 REFERENCES ee 30 7 2 RS OS ege 30 7 2 1 Number representation sinissmssiesas vin yctiedecnrvtedadaewshesvavsees ida do dn anda verter 30 Eos eee SS P ORPA E PRESS A BIB BPBR E E EEBEPSB amp BE f TITO PPP Report Templates Reference page 3 30 2010 09 28 Information Docx Public Published Version 1 0 rr Report Templates Reference Information e Ma 1 Document notes All information in this manual including product data diagrams charts etc represents information on products at the time of publication and is subject to change without prior notice due to product improvements or other reasons It is therefore recommended that customers contact Elvaco AB for the latest product information before purchasing a CMe CMi Series product The documentation and product are provided on an as is basis only and may contain deficiencies or inadequacies Elvaco AB takes no responsibility for damages liabilities or other losses by using this product 1 1 Copyright and Trademark 2010 Elvaco AB All rights reserved No part of the contents of this manual may be transmitted or reproduced in any form by any means without the written permission of Elvaco AB Printed in Sweden CMe CMi Series is a trademark of Elvaco AB Sweden 1 2 Contacts Elvaco AB Headquarter Energigatan 9 434 37 Kungsbacka SWEDEN Phone
6. See Report Template Description 1101 1102 Email value 1 0 E Mail report containing value data from report raw active devices in raw data format Body in html html format See Report Template Description 1102 1103 Email value 1 1 E Mail report containing value data from report raw active devices in raw data format as attached attached file file Body in html format per device See Report Template Description 1103 html 1104 Email value 1 1 E Mail report containing value data from report active devices in human readable format as attached file attached file per device Body in html format per device See Report Template Description 1104 html 1105 Email value 1 1 E Mail report containing value data from report active devices in human readable format as extended attached file per device Report column attached file header data has prefix Body in html per device format html See Report Template Description 1105 1106 Email value 1 1 E Mail report containing value data from report active devices in human readable format as extended attached file per device Report column attached file header data has prefix The attached files per device have zip extensions for possible spam filter EEB EPBBM rr TE Report Templates Reference page 16 30 2010 09 28 Information Docx Public Published Version 1 0 Report Templates Reference Information elvace zip extension html problems Body in html format See Report Templat
7. data should be decoded and readable or in raw M Bus data format The report template 3104 is a good choice if the report should be in machine friendly decoded format and report template 3103 can be used if the receiving system handles raw M Bus data format Review section 4 for an overview of available templates aa SS SESS a Report Templates Reference page 8 30 2010 09 28 Information Docx Public Published Version 1 0 rm Report Templates Reference Information elvaco 3 4 3 4 1 3 4 2 3 4 3 3 4 4 Implementation level 3 When the product is operational and is sending reports automatically there still may be situations when the server application needs to request or send data to the product This can be accomplished by sending SMS to the product The SMS can be a command to start a report manually start a configuration process with a web server or to change configuration SMS may not be the most reliable communication protocol but adding extra information to the SMS for identification and using the SMS functionality for correct purposes it can be a powerful and easy way for integration Sending SMS to the product In the CMe CMi Series User s Manuals all commands which can be sent using SMS is tagged with access SMS When the product receives an SMS following process is started 1 If phone number security is enabled is the sending phone number accepted 2 Is the first line of the SMS a password for sec
8. in raw data format single file See Report Template Description 2102 plain 2103 FTP value 1 1 FTP report containing value data from active report raw devices in raw data format a file per device file per device See Report Template Description 2103 plain 2104 FTP value 1 1 FTP report containing value data from active report file devices in human readable format as file per per device device plain See Report Template Description 2104 2105 FTP value 1 1 FTP report containing value data from active report devices in human readable format as file per extended file device Report column header data has prefix per device plain See Report Template Description 2105 2108 FTP value 1 1 FTP report containing value data from active report devices in human readable format in a single extended file Report column header data has prefix single file See Report Template Description 2108 EEN Report Templates Reference page 17 30 2010 09 28 Information Docx Public Published Version 1 0 Report Templates Reference Information elvace plain 3001 HTTP install 1 1 HTTP report sent upon installation containing report single status information of last installation process post plain See Report Template Description 3001 3005 HTTP event 1 1 HTTP report sent upon a system event report single See Report Template Description 3005 post plain 3006 HTTP log 1 1 HTTP report containing system log report single See Re
9. not unique which must be used to distinguish the values The property names are globally used in all CMe CMi Series documentation to describe i e report formats Following properties are describing the origin of a value Name Description Serial number The product serial number which has read and stored the value of a meter Device The M Bus slave secondary identification which a value belongs to identification Date The create date of a value Value data The M Bus telegram in which a value was found count Table 6 Properties describing the origin of a value Following properties are describing the definition of a specific value Name Description Description Description of the value This property is usually defining the type of the value i e energy flow temperature 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 max value etc Tariff The tariff of the value Sub unit The sub unit of the value i e a numeric value for extended information of a value Storage The storage number of the value Normally describing historic values number Table 7 Properties describing the definition of a value 5 1 1 Serial number property The serial number is an 10 digit long numeric value The first 4 digits identifies the product type An example of a serial number from a CMe2100 product would look like 0006xxxxxxxx where xxxxxxxx is the a
10. product configuration server the product can be configured using HTTP web server requests This will be closely described in section 3 5 This section is a guideline for good implementation practice and serves for starting up an integration process Please review the CMe CMi Series User s Manual which covers all the commands configuration keys syntax and reference information 3 1 Implementation level Elvaco has divided product implementation into four levels These levels are defined to illustrate the time for implementation and give the developer a good understanding where to start the implementation process and select the correct level of functionality Please review Table 1 for level description Implementation level Level of functionality Typical time for implementation Level 1 Transparent M Bus O hours communication using GSM Using standard M Bus CSD or TCP IP on GPRS master software network Configuration of the product is done by predefined configuration profile from Elvaco web server or by using SMS or Telnet Level 2 Handle automatic scheduled 8 16 hours pushed E Mail FTP HTTP reports to retrieve meter values Configuration of the product is done by predefined configuration profile from Elvaco web server or by using SMS or Telnet Level 3 Two way communication for 8 16 hours configuration and starting commands using SMS Configuration can also be done by predefined configuration profile from Elvaco web serve
11. Templates Reference Information e Vacs The Sync ld is set to 1234 and will be posted back to the result server for identifying the configuration The configuration file url is set to http myserver com config myconfig cad The result server url is set to http myserver com result result html SMS to the product to start synchronization Sync system cota url http myserver com config myconfig cad SMS from the product indicating synchronization started Sync started OK The product will download the configuration file using HTTP GET and set the configuration keys as specified The file myconfig cad contents which will be downloaded to the product Sync Mode server sync Id 1234 Sync Notify URL http myserver com result result html Sync Config 0 reportl schedule retrymax 10 Sync Config 1l reportl schedule retryoffset 600 After the configuration file is processed the product will send a HTTP POST with the result information The HTTP POST body contents sent to the result server 900 Success Sync Id 1234 ERR IIMMDBI IPB PPUJPEE Report Templates Reference page 14 30 2010 09 28 Information Docx Public Published Version 1 0 rr Report Templates Reference Information elvaco 4 4 1 Report templates Report templates are description files how to format and send data from CMe CMi Series product to an external source Templates are available for SMS FTP HTTP and E Mail The report eng
12. alue is an instantaneous value Current value max value The value is a maximum value at a specific date time min 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 Tariff property Tariff property is a numeric value describing the tariff of a value 5 1 9 Sub unit property Sub unit property is a numeric value describing the sub unit of a value Sub unit is often used to distinguish almost identical values i e software version from a meter can be of sub unit 0 and software version of the M Bus module used to communicate with the meter can be of sub unit 1 5 1 10 Storage number property Storage number property is a numeric value describing the storage number of a value Storage number is normally used to identify a load profile or other historical value 5 2 Identifying the properties and using correct meter values Depending on meter used a wide range of data can be available A standard electricity meter normally provides numerous of extra information besides i e energy and power This section describes how to find and identify commonly used information from standard M Bus meters Please note that depending on meter this information may vary 5 2 1 Electricity meters Please review Table 12 for commonly used values from electricity meters Value of Description Unit Function Tariff Sub un
13. as found in telegram 0 a value of 1 means that the value was found in telegram 1 Description property This property describes the type of a value A type can be i e energy power flow temperature etc Description can be one or a combination of names as listed in Table 9 The description can also be a custom specified string describing the value which can contain any character string Descriptions listed in Table 9 are taken from the M Bus standard EN13757 All spaces in description names are replaced with character hyphen Combination of description names are separated with space character This helps finding the primary description of the value i e the first word in the description name Name energy volume mass on time ESNPDKRt MRM TR FT E Report Templates Reference page 21 30 2010 09 28 Information Docx Public Published Version 1 0 rT Report Templates Reference Information e Ma op time power volume flow volume flow ext mass flow flow temp return temp diff temp ext temp pressure date datetime units for HCA avg duration act duration fabrication no enhanced id address reactive energy cold warm temp limit cum cnt max power credit debit access number device type manufacturer parameter set id model version hw version fw version other sw version customer location Customer access code user access code operator access code system operator access code developer password e
14. ctual serial number of the product See Table 8 for current product type numbers EDEsseXR ESP O Report Templates Reference page 20 30 2010 09 28 Information Docx Public Published Version 1 0 rr Report Templates Reference Information elvaco 5 1 2 5 1 3 5 1 4 5 1 5 Product 4 digit type number CMe2100 0006 CMi2110 0012 CMi2120 0029 Internal antenna CMi2120 0027 External antenna CMi2130 0030 Table 8 Product type numbers Device identification property Device identification is the unique meter id M Bus secondary address which the meter value was read from The device identification is an 8 digit number This number can normally be changed by the customer on demand The device identification for a meter is internally used in CMe CMi Series to bind information for one meter connected to a CMe CMi Series product Thus all meters connected to CMe CMi Series product must have unique device identification secondary address Date property Date is the timestamp of the meter value readout Date Time used in the CMe CMi Series products can be configured with UTC offset to set any time zone Value data count property The value data count property is used to distinguish value data read from one telegram to another The CMe CMi Series products implement automatic FCB bit toggling which means that the product will automatically read all available data telegrams from a meter A value of O means the value w
15. e Description 1106 1107 Email value 1 1 E Mail report containing energy consumption report energy value data from active devices in human consumption readable format as attached file per device attached file Report column header data has prefix This per device report only work together with devices html having field energy Body in html format See Report Template Description 1107 1108 Email value 1 0 E Mail report containing value data from report active devices in human readable format ina extended single attached file Report column header single file data has prefix Body in html format html See Report Template Description 1108 2001 FTP install 1 1 FTP report sent upon installation containing report single status information of last installation process file plain See Report Template Description 2001 2005 FTP event 1 0 FTP report sent upon a system event report single See Report Template Description 2005 file plain 2006 FTP log report 1 1 FTP report containing system log single file See Report Template Description 2006 plain 2007 FTP status 1 0 FTP report containing current status of report single product file plain See Report Template Description 2007 2101 FTP value 1 1 FTP report containing value data from active report single devices in a human readable format file plain See Report Template Description 2101 2102 FTP value 1 1 FTP report containing value data from active report raw devices
16. eview section 4 for an overview of available templates 3 3 2 Receiving reports using FTP FTP File Transfer Protocol is widely used all over the world This may be the choice when there integration platform has an external FTP server available The product is using passive mode FIP which resolves the problem of NATed TCP IP traffic from a GPRS network to the internet ee Report Templates Reference page 7 30 2010 09 28 Information Docx Public Published Version 1 0 rm Report Templates Reference Information elvaco 3 3 2 1 Requirements For the product to be able to send FTP reports a SIM card with GPRS enabled must be used The product must be configured where to send FTP reports which can be set using command gset ftp see CMe Series User s Manual Username password port and default upload directory can also be set using the command aset ftp The receiving FTP server must handle passive FTP This can sometimes be disabled by firewall options Verify firewall settings for passive FTP and FTP server application for proper configuration 3 3 2 2 Report formats 3 3 3 3 3 3 1 There is a wide range of FTP reports available The major difference between FTP reports are 1 if the meter data should be sent in one file or separated in one file per device meter 2 if the meter data should be decoded and readable or in raw M Bus data format The report template 2104 is a good choice if the report should be in machine f
17. f interest Current volume m3 inst value 0 volume meter stand Current volume flow m3 h inst value 0 volume flow Table 15 Commonly used properties for gas meters Sub unit Sub unit Sub unit Storage number 0 Storage number 0 Storage number 0 Report Templates Reference Information Docx Public Published page 28 30 2010 09 28 Version 1 0 rT Report Templates Reference Information e Ma 6 Document History Version Date Description Author 1 0 2010 09 27 First release David Vonasek 6 1 Document software and hardware appliance Type Version Date Comments Hardware Software gt 1 1 0 2009 11 EEN Report Templates Reference page 29 30 2010 09 28 Information Docx Public Published Version 1 0 rT Report Templates Reference Information e Ma 7 References 7 1 References 1 CMe Series User s Manual 2 CMi2110 User s Manual 3 CMi2120 User s Manual 4 CMi2130 User s Manual 5 Report Template Description n where n is the report template id 7 2 Terms and Abbreviations Abbreviation Description 7 2 1 Number representation Decimal numbers are represented as normal number i e 10 ten Hexadecimal numbers are represented with prefix Ox i e 0x0A ten Binary numbers are represented with prefix Ob i e 0600001010 ten ee Report Templates Reference page 30 30 2010 09 28 Information Docx Public Published Version 1 0
18. file contains the actual information to synchronize See Table 2 for synchronization parameters All cad files must have the extension cad Parameter Description Sync Mode Synchronization mode must be set to server Syntax Sync Mode server Sync Notify URL Result server URL Notifications will be sent to this server address Can be left out Syntax Sync Notify URL lt notify url gt Sync File 0 n URL Files to synchronize The index must start at O and be continuous Can be left out Syntax Sync File 0 n URL lt remote url gt lt local file gt 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 lt key gt lt value gt Sync ld Identification which will be parsed into the result notification Can be left out Syntax Sync ld lt id gt Parameter descriptions for cad files SIMONE Taig Ue lh URL where to post notifications lt remote file gt EEE Report Templates Reference page 12 30 2010 09 28 Information Docx Public Published Version 1 0 re Report Templates Reference Information elvaco URL where to get remote file oca Local path and filename where to put downloaded file lt a gt Configuration key to set lt value gt Configuration key value lt id gt User specific identification for this synchronization Example of cad file Sync Mode server Sync Id 1 S
19. he 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 names are replaced with character hyphen Combination of units names are separated with space or slash character This helps finding the primary unit of the value i e the first word in the unit name Name Wh J m3 Kg second s minute s hour s day s W m3 h m3 min m3 sec kg h C K Bar MWh kVARh GJ Ton feet 3 EE Report Templates Reference page 25 30 2010 09 28 Information Docx Public Published Version 1 0 rm Report Templates Reference Information e Ma USgallon USgallon min USgallon h MW GJ h F local curreny unit s Baud Bittimes month s year s V A reserved s min h day week month year revol measurem liter m3 kg IK kWh GJ kW k liter IN A s s V s A s A Table 10 Standard unit property values 5 1 7 Function property This property describes the function of a value A function can be i e minimum value maximum value etc ERP PPPPB ooo EEB Report Templates Reference page 26 30 2010 09 28 Information Docx Public Published Version 1 0 rr Report Templates Reference Information elvaco Functions listed in Table 11 are taken from the M Bus standard EN13757 Name Description inst value The v
20. in the default setup from factory Id Name Version Description 1 SMS 1 0 SMS report sent upon installation containing Installation status information of last installation process report See Report Template Description 1 EENE Report Templates Reference page 15 30 2010 09 28 Information Docx Public Published Version 1 0 Report Templates Reference Information elvace 1001 Email 1 0 E Mail report sent upon installation installation containing status information of last report html installation process in html format See Report Template Description 1001 1002 Email 1 0 E Mail report sent upon installation installation containing status information of last report plain installation process in plain text format See Report Template Description 1002 1003 Email system 1 1 E Mail report containing system settings and report html status in html format See Report Template Description 1003 1004 Email log 1 0 E Mail report containing system log in html report html format See Report Template Description 1004 1005 Email event 1 0 E Mail report sent upon a system event in report html html format See Report Template Description 1005 1006 Email log 1 1 E Mail report containing system log as report attached file Body in html format attached file See Report Template Description 1006 html 1101 Email value 1 0 E Mail report containing value data from report html active devices in a human readable format Body in html format
21. ine in CMe CMi Series is very powerful and can format almost any output data Example of data format is csv formatted files xml based data and human readable html reports The report data can be events meter data system log reports etc CMe CMi Series products are released with a standard set of reports but can be enhanced by Elvaco provided add ons and customer specific add ons Customer specific add ons are not listed in this document Please see Table 4 for current standard set of reports Please see Table 5 for current add on set of reports Assigned report template identifications Range Name 0001 0999 Standard SMS reports 1000 1099 Standard E Mail system reports 1100 1199 Standard E Mail value reports 1500 1599 Add on E Mail 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 Customer specific SMS reports xx 1000 xx1099 Customer specific E Mail system reports xx1100 xx1199 Customer specific E Mail value reports xx2000 xx2099 Customer specific FTP system reports xx2100 xx2199 Customer specific FTP value reports xx3000 xx3099 Customer specific HTTP system reports xx3100 xx3199 Customer specific HTTP value reports Where xx is an Elvaco assigned customer number two digits 00 99 4 2 Standard report template list These templates are included
22. it Storage interest number Current energy Wh inst value O 0 0 energy meter stand Current power W inst value O 0 0 power Current energy Wh inst value 1 0 0 energy meter stand Tariff 1 Maximum power W max value O 0 0 power Table 12 Commonly used properties for electricity meters 5 2 2 Water meters Please review Table 13 for commonly used values from water meters BEEN Report Templates Reference page 27 30 2010 09 28 Information Docx Public Published Version 1 0 Report Templates Reference Information elvace Value of Description Unit Function Tariff interest Current volume m3 inst value 0 volume meter stand Table 13 Commonly used properties for water meters 5 2 3 District heat and cold meters Please review for commonly used values from district heat and cold meters Value of Unit Function Tariff interest Description Current inst value 0 energy meter stand energy Wh Current volume m3 inst value 0 volume meter stand Current inst value 0 power power W Current flow temp 1G inst value O forward temperature Current return temp C inst value O backward temperature Current diff temp K inst value O temperature difference Current volume flow m3 h inst value 0 volume flow Table 14 Commonly used properties for district heat and cold meters 5 2 4 Gas meters Please review for commonly used values from gas meters Value of Description Unit Function Tarif
23. l 1 inc per output pulse on input channel 0 inc per output pulse on input channel 1 start date time of uncorrected unit acc only if pos contr acc of abs value only if neg contr lower limit value exceeds lower limit value datetime of begin of first lower limit exceeded datetime of end of first lower limit exceeded datetime of begin of last lower limit exceeded datetime of end of last lower limit exceeded upper limit value exceeds of upper limit value datetime of begin of first upper limit exceeded datetime of end of first upper limit exceeded datetime of begin of last upper limit exceeded datetime of end of last upper limit exceeded duration of first lower limit exceeded duration of last lower limit exceeded duration of first upper limit exceeded duration of last upper limit exceeded duration of lower limit exceeded duration of upper limit exceeded SSS SS SSE Report Templates Reference page 24 30 2010 09 28 Information Docx Public Published Version 1 0 rT Report Templates Reference Information e Ma value during lower limit exceeded leak values datetime of first begin datetime of first end value during upper limit exceeded overflow values datetime of last begin datetime of last end future value Table 9 Standard description property values 5 1 6 Unit property This property describes the unit of a value A unit can be i e Wh kWh C etc Units can be one or acombination of names as listed in Table 10 T
24. ng is to send hourly value reports every day The report format can be configured using command cfg Please see CMe CMi Series User s Manuals When receiving E Mail reports with meter data rules can be set up i e MS Outlook to organize E Mails as needed There are also software applications available on the market which takes attached files and stores these files in a folder on disk Watch Directory http www watchdirectory net is one of the applications which can handle these kinds of operations 3 3 1 1 Requirements For the product to be able to send E Mail reports a SIM card with GPRS enabled must be used The product also needs an SMTP server to send the reports The SMTP server is normally automatically detected but in rare cases the server must be set manually using command gset email see CMe Series User s Manual This command is also used to set E Mail recipients 3 3 1 2 Report formats There is a wide range of E Mail reports available The major difference between E Mail reports are 1 if the meter data should be attached as a file instead of printed in the body 2 if the meter data should be sent in one file or separated in one file per device meter 3 if the meter data should be decoded and readable or in raw M Bus data format The report template 1104 is a good choice if the report should be in machine friendly decoded format and report template 1103 can be used if the receiving system handles raw M Bus data format R
25. ought and downloaded to the product Visit www elvaco com and login to buy add ons to CMe CMi Series products Id 3501 Name HTTP value report single Version 1 0 Description HTTP report containing value data from active devices in XML based format EPP Po rsrrrererrrrITT EEE Report Templates Reference page 18 30 2010 09 28 Information Docx Public Published Version 1 0 As Report Templates Reference Information e Va CO post XML See Report Template Description 3501 format Table 5 Add on report template list ES Report Templates Reference page 19 30 2010 09 28 Information Docx Public Published Version 1 0 rr Report Templates Reference Information elvaco 5 Definitions This chapter covers definitions used to describe report data sent from CMe CMi Series products 5 1 Properties of a report value Value reports contain meter report data The CMe CMi Series products can handle any standard M Bus meter which forces the product to dynamically assign properties for each available value for a meter The properties are build up upon the internal M Bus decoder The properties are taken from the standard M Bus EN13757 A combination of all properties for a value for a specific meter within one telegram shall be unique but sometimes M Bus slave implementations don t follow these recommendations In those cases one or more values can have the exact same properties but the position of the value is
26. port Template Description 3006 post plain 3007 HTTP status 1 0 HTTP report containing current status of report single product post plain See Report Template Description 3007 3101 HTTP value 1 1 HTTP report containing value data from report single active devices in a human readable format post plain See Report Template Description 3101 3102 HTTP value 1 1 HTTP report containing value data from report raw active devices in raw data format single post See Report Template Description 3102 plain 3103 HTTP value 1 1 HTTP report containing value data from report raw active devices in raw data format as post per post per device device plain See Report Template Description 3103 3104 HTTP value 1 1 HTTP report containing value data from report post active devices in human readable format as per device post per device plain See Report Template Description 3104 3105 HTTP value 1 1 HTTP report containing value data from report active devices in human readable format as extended post per device Report column header data post per has prefix device plain See Report Template Description 3105 3108 HTTP value 1 0 HTTP report containing value data from report active devices in human readable format in a extended single post Report column header data has single post prefix plain See Report Template Description 3108 Table 4 Standard report template list 4 3 Add on report template list These templates must be b
27. r Level 4 Configuration of the product 8 16 hours using HTTP web server from customer implemented configuration server Table 1 Implementation levels EE PDRTYM MM PTS PE Report Templates Reference page 6 30 2010 09 28 Information Docx Public Published Version 1 0 rm Report Templates Reference Information elvaco 3 2 Implementation level 1 When using transparent M Bus communication there are numerous software applications available on the market The product handles transparent M Bus communication according to the M Bus standard but the request response time delays must be adjusted to handle GSM GPRS network response times Depending on network provider the response time can differ A good recommendation for a maximum response time between request response is approximately 4 seconds From factory the product is listening and will answer all incoming GSM CSD calls and open for transparent M Bus communication The TCP IP transparent M Bus communication must be manually started using command gset tmbus1 tmbus2 on 3 3 Implementation level 2 Depending on IT structure of implementation platform reports can be received from the product using E Mail FTP and HTTP In some cases implementation using E Mail and FTP may be the preferable If the goal is to reach implementation level 4 HTTP should be used as the transfer protocol from start 3 3 1 Receiving reports using E Mail When installing the product the default setti
28. r The actual url for configuration elvaco would be http dist elvaco se sync cota elvaco cad 3 5 1 Changing or overriding which configuration server to synchronize configuration with 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 common system cota user common system cota password common system cota authmode The configuration key urlbase is used to set the base url when using short names in command install and sync The configuration key url can be used to point out a specific location of a configuration file Example of executing sync and download a configuration file called myconfig cad at http myserver com Sync system cota url http myserver com myconfig cad 3 5 2 Synchronization flow EE PRB SSS E F R ES e I fPTYPT T Y EF TfS EE Report Templates Reference page 10 30 2010 09 28 Information Docx Public Published Version 1 0 re Report Templates Reference Information elvaco Can be the same server File server 1 n Result Server Get synchronization file cad file from sync server ee ee Send synchronization file cad file Synchronize files 1 n if set Send requested files Set configuration keys and values from configuration file I a sc a
29. riendly decoded format and report template 2103 can be used if the receiving system handles raw M Bus data format Review section 4 for an overview of available templates Receiving reports using HTTP HTTP Hypertext Transfer Protocol is widely used all over the world This may be the choice when the integration platform has an external web server available The product is using HTTP POST to send data to the server Requirements For the product to be able to send HTTP reports a SIM card with GPRS enabled must be used The product must be configured where to send the HTTP reports which can be set using command qset http see CMe Series User s Manual Username password port and URL can also be set using the command gset http HTTPS can be used for securing the connection which is accomplished by entering https instead of http in the URL of the web server The reports sent from the product to the web server are created on the fly thereby the content length of the post is unknown when the HTTP headers are sent Thus the receiving web server must handle chunked transfer encoding This is normally not an issue when using Microsoft IIS or Apache web server where chunked transfer encoding is handled automatically 3 3 3 2 Report formats There is a wide range of HTTP reports available The major difference between HTTP reports are 3 if the meter data should be sent in one post or separated in one post per device meter 4 if the meter
30. rror flags dev spec error mask ER Report Templates Reference page 22 30 2010 09 28 Information Docx Public Published Version 1 0 rT Report Templates Reference Information e Vacs digital output digital input baudrate response delay time retry remote control dev spec first storage for cyclic storage last storage for cyclic storage size of storage block storage interval time point duration since last readout start of tariff duration of tariff period of tariff dimensionless Voltage Current reset counter cum counter control signal day of week week number time point of day change state of param activation special supplier information duration since last cum operation time battery datetime of battery change day light saving listening window management cold warm temp limit remaining battery lifetime count meter stop Reserved manufacturer specific no error too many DIFE storage number not impl unit number not impl Report Templates Reference page 23 30 2010 09 28 Information Docx Public Published Version 1 0 rr Report Templates Reference Information elvaco tariff number not impl function not impl data class not impl data size not impl too many VIFE illegal VIF group illegal VIF exponent VIF DIF mismatch unimpl action no data available data overflow data underflow data error premature end of record inc per input pulse on input channel 0 inc per input pulse on input channe
31. urity level 1 2 or 3 If true set proper security level 3 If 1 and 2 is parsed successfully start parsing SMS command lines which can divided ave with CRLF or semi colon 4 If not the configuration key common sms response mode is set to disable responses respond with the executed command response information The default value for common sms response mode is all Disable responses In some cases the SMS response from the product may not be interesting for the sending part An example would be if the command is to start sending an HTTP POST report to a web server which is automatically acknowledged when the report is received by the web server and the SMS response is not giving any extra information Override the configuration sms response mode and set the value to none An example for starting command report and disable SMS responses would look like reportl sms response mode none Requesting meter data between two dates This example describes how to start a report and send meter data within two dates To resend meter data between 2010 09 01 and 2010 09 03 with report template 1104 send the following SMS command Report 1104 filter mode interval filter param 20100901 20100903 Change configuration of retries for report1 This example describes how to change the report retries and the time between the retries To set number of retries to ten 9 and time between retries to five 5 minutes send the follo
32. wing SMS command set reportl schedule retrymax 9 reportl schedule retryoffset 300 The CMe CMi Series User s Manuals covers all this information in more detail There is also numerous examples for every command which can be sent to the product aaa SSS ESSE PE Report Templates Reference page 9 30 2010 09 28 Information Docx Public Published Version 1 0 rm Report Templates Reference Information elvaco 3 5 Implementation level 4 The implementation level 4 is a combination of implementation level 3 and adding a product configuration server which handles the distribution product requests for new or updated configuration The product connects to the product configuration server when using command sync and using command install with suffix Following SMS command will force the product to execute command install and connect to Elvaco distribution server by default and download configuration elvaco Install 1 elvaco Following SMS command will force the product to execute sync and connect to Elvaco configuration server by default and download configuration elvaco Sync elvaco Command install is used when installing the product for the first time or when meter configuration has changed Command sync is used only when new configuration should be downloaded to the product The configuration elvaco is concatenated with the common system cota urlbase to download the actual file from the configuration serve
33. ync Notify URL http dist elvaco se RequestLogger index aspx Sync Config 0 common branding company Elvaco AB Sync Config 1l1 common branding addressl Energigatan 9 Table 2 Synchronization file cad file 3 5 5 Result notifications If the parameter Sync Notify Url is set in the cad file the product will post result information to given URL The post is a standard HTTP post with a body containing the result information Please see possible results in Table 3 Result Description 900 Success Synchronization completed successfully 920 Incompatible synchronizing mode The Sync Mode was not set to server 921 Error synchronizing files lt error gt Generic synchronization error Example of a notify post result body 900 Success Synce Lar 1 Table 3 Result notification post 3 5 6 Configuration keys and valid values 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 message will be sent to initiator and to the result server 3 5 7 Example of starting synchronization using SMS with customer specified configuration server This example shows how to start a synchronization process using SMS Following configuration keys will be set report1 schedule retrymax report1 schedule retryoffset ESSES Sa Report Templates Reference page 13 30 2010 09 28 Information Docx Public Published Version 1 0 rr Report
Download Pdf Manuals
Related Search