Installation Guide ECL Portal API Web interface for ECL ... Installation Guide ECL Portal API Web

download Installation Guide ECL Portal API Web interface for ECL ... Installation Guide ECL Portal API Web

of 40

  • date post

    18-Jul-2018
  • Category

    Documents

  • view

    227
  • download

    1

Embed Size (px)

Transcript of Installation Guide ECL Portal API Web interface for ECL ... Installation Guide ECL Portal API Web

  • Installation Guide

    ECL Portal APIWeb interface for ECL Portal databases

    1Danfoss District Energy VI.HX.I1.02 DEN-SMT/DK

    1.0 Table of Contents ..................................................................................................................................................................................................................11.0 Introduction ...........................................................................................................................................................................................................................22.0 Version table ...........................................................................................................................................................................................................................23.0 Glossary ...................................................................................................................................................................................................................................24.0 General ...................................................................................................................................................................................................................................35.0 Security ...................................................................................................................................................................................................................................3

    5.1 Creating third party code ...............................................................................................................................................................................................45.2 Assigning access to a third party ...............................................................................................................................................................................5

    6.0 Interfaces .................................................................................................................................................................................................................................66.1 API format ............................................................................................................................................................................................................................76.2 Future versions ..................................................................................................................................................................................................................76.3 Time formats ......................................................................................................................................................................................................................7

    7.0 Master data service .............................................................................................................................................................................................................97.1 getEclMasterData request parameters .....................................................................................................................................................................9

    7.1.1 Examples of getEclMasterData request parameters ............................................................................................................................ 107.2 getEclMasterData response ....................................................................................................................................................................................... 10

    7.2.1 Example of getEclMasterData response .................................................................................................................................................... 107.2.2 Master data ........................................................................................................................................................................................................ 11

    7.3 Status codes for response ........................................................................................................................................................................................... 178.0 Readings ................................................................................................................................................................................................................................ 17

    8.1 getReadings Request ................................................................................................................................................................................................... 188.2 getReadings Response ................................................................................................................................................................................................ 19

    9.0 Using the interface ............................................................................................................................................................................................................ 219.1 Extracting master data .................................................................................................................................................................................................. 23

    9.1.1 M-bus, Main meter house ............................................................................................................................................................................... 259.1.2 M-bus, Solar heating, small tank .................................................................................................................................................................. 269.1.3 M-bus, Solar heating, large tank .................................................................................................................................................................. 289.1.4 ECL log, A367.1 example e ............................................................................................................................................................................. 309.1.5 Extracting readings ........................................................................................................................................................................................... 339.1.6 Read the latest values for one or more sensors on a meter connected to the ECL controller............................................... 339.1.7 Reading the most recently measured outdoor temperature ............................................................................................................ 349.1.8 Reading of Energy, Volume, Flow temperature and Return temperature for the houses main meter .............................. 359.1.9 Read the latest value for one or more sensors across meters connected to the ECL controller. .......................................... 359.1.10 Read a period of historical data for one or more sensors on one meter connected to the ECL controller. ................... 35

    9.2 Format differences in data extracted ....................................................................................................................................................................... 39

    1.0 Table of Contents

  • Installation Guide ECL Portal API

    2 DEN-SMT/DK VI.HX.I1.02 Danfoss District Energy

    1.0 Introduction

    This document is a description for a third party for use when implementing software clients to extract data from the ECL Comfort 310 Portal (ECL Portal).

    2.0 Version table

    Version Date Change

    1.00 25/09/2013 First version.

    1.10 25/10/2013 Section added about the creation of third party code, future version, time formats. JSON examples added for requests and responses.

    1.11 29/10/2013 Example added of difference in data extraction from ECL Portal and ECL Portal API.Example added of time format in readings.

    1.12 01/04/2014 A few detailed explanations and examples added.

    3.0 Glossary

    API Application Programming Interface. An interface for the sharing of application-specific information.

    Device A device. Typically used in connection with a log device.

    ECL Comfort 310 A district heating controller model from Danfoss A/S.

    HTTPS HyperText Transfer Protocol. An encrypted protocol used to transfer information.

    Configurable input.

    Some sensor inputs on an ECL Comfort 310 controller can be adjusted as an option to measure temperature, pulse, frequency, 0-10 V analogue signal or digital ON/OFF

    Customer A person, company or municipality that wants data extracted from the ECL Portal.

    JSON JavaScript Object Notation. An open data format for sharing data between a server and an Internet program.

    M-bus A communication protocol typically used by heat and energy meters.

    Paging Division into pages. In order to avoid too much information being transferred at one time, a volume of data is divided into a number of pages, only one of which is read at a time.

    Reading A reading. Log data extracted from the web API from a log device.

    Request A request to the web API.

    Response Response from the web API server to a request.

    REST Representational State Transfer. A software architecture style that can be used to design Internet services.

    Server code A unique code issued by Danfoss to a third party.

    SSL Secure Sockets Layer. Encryption for the secure sharing of information used, for example on the Internet (HTTPS).

    Master da