How it Works
Danfoss
Loading...
E
Loading...
Loading...
ECL Portal API
Operating guide
40 pgs1.15 Mb0
Operating guide [da]
40 pgs1.17 Mb0

Danfoss ECL Portal API Operating guide [da]

Betjeningsguide
ECL Portal API Web interface til ECL Portal database
1.0 Indholdsfortegnelse
1.0 Indholdsfortegnelse .............................................................................................................................................................................................................................. 1
2.0 Introduktion ............................................................................................................................................................................................................................................. 2
3.0 Versionstabel ............................................................................................................................................................................................................................................ 2
4.0 Begrebsoversigt ...................................................................................................................................................................................................................................... 2
5.0 Generelt ............................................................................................................................................................................................................................................... 3
6.0 Sikkerhed ............................................................................................................................................................................................................................................... 3
6.1 Oprettelse af tredjepartskode .................................................................................................................................................................................................. 4
6.2 Tildeling af adgang til tredjepart ........................................................................................................................................................................................... 5
7.0 Snitflader ............................................................................................................................................................................................................................................... 6
7.1 API-format ....................................................................................................................................................................................................................................... 7
7.2 Fremtidige versioner ................................................................................................................................................................................................................... 7
7.3 Tidsformater ................................................................................................................................................................................................................................... 7
8.0 Stamdata service (Master Data) ........................................................................................................................................................................................................ 9
8.1 getEclMasterData request parametre ................................................................................................................................................................................... 9
8.2 getEclMasterData response .....................................................................................................................................................................................................10
8.4 Statuskoder for respons ............................................................................................................................................................................................................17
9.0 Aflæsningsservice (Readings) ......................................................................................................................................................................................................... 17
9.1 getReadings Request ................................................................................................................................................................................................................ 18
9.2 getReadings Response ............................................................................................................................................................................................................. 19
10.0 Brug af snitfladen ..............................................................................................................................................................................................................................21
10.1 Udtræk af stamdata ..................................................................................................................................................................................................................23
10.1.9 Udlæs seneste værdi for en eller flere sensorer på tværs af målere tilsluttet ECL regulatoren .......................................................35
10.1.10 Udlæs en periode af historiske data for en eller flere sensorer på én måler tilsluttet ECL regulatoren .....................................35
10.2 Formatforskelle på dataudtræk ............................................................................................................................................................................................39
© Danfoss |2021.01
AQ131886471802da-000301 | 1
Betjeningsguide ECL Portal API
2.0 Introduktion
Dette dokument er en beskrivelse til tredjepart, til brug ved implementering af softwareklienter til udtræk af data fra ECL Comfort 296 / 310 Portal (ECL Portal).
3.0 Versionstabel
Version Dato Ændring
1.00 2013-09-25 Første version
1.10 2013-10-25 Tilføjet afsnit om oprettelse af tredjepartskode, fremtidige version, tidsformater. Tilføjet JSON eksempler for forespørgsler og svar.
1.11 2013-10-29 Tilføjet eksempel om forskel på dataudtræk fra ECL Portal og ECL Portal-API. Tilføjet eksempel om tidsformat i aflæsninger.
1.12 2014-04-01 Tilføjet nogle få uddybende forklaringer og eksempler.
4.0 Begrebsoversigt
API Application Programming Interface. Et interface for udvekling af applicationsspecifik information.
Device En enhed. Typisk brugt i forbindelse med en log-enhed.
ECL Comfort 296/310 En ernvarmeregulatormodel fra Danfoss A/S.
HTTPS HyperText Transfer Protocol. En krypteret protokol til overførsel af information.
Konfigurerbar
indgang
Kunde En person, virksomhed eller kommune som vil have udlæst data fra ECL Portalen
JSON JavaScript Object Notation. Et åbent data format til udveksling af data mellem en server og et internetprogram.
M-bus En kommunikationsprotokol typisk anvendt af varme- og energimålere
Paging Sideinddeling. For at undgå at overføre alt for mange information på én gang inddeles en datamænge i flere
Reading En aflæsning. Log-data udlæst fra web-API’et fra en log-enhed
Request En forespørgsel til web-API’et
Response Svar fra web-API serveren på en forespørgsel
REST Representational State Transfer. En software arkitektur stil, der kan bruges til konstruktion af internettjenester
Serverkode En unik kode udstedt af Danfoss til tredjepart
SSL Secure Sockets Layer. En kryptering til sikker udveksling af information, der bl.a. anvendes på internettet (HTTPS)
Stamdata Grundlæggende data for en ECL Comfort 296 / 310 regulator
Nogle sensorindgange på en ECL Comfort 296 / 310 regulator kan valgfrit konfigureres til at måle temperatur, puls, frekvens, 0-10 V analog signal eller digital ON/OFF
sider, hvor kun én side læses af gangen.
Tredjepartskode En kode oprettet af kunden på ECL Portalen, som kunden udleverer til tredjepart
URL Unifor Resource Locator. En internetadresse
UTC Coordinated Universal Time. En standard for tidskoordinering med udgangspunkt i Greenwich, London.
Tidszoner angives i forhold til UTC.
Web-API Et API tilpasset internettet.
tredjepart Et eksternt firma, som en kunde får til at udvikle software til udlæsning af data fra ECL Portalen til et eksternt
system. Kan være identisk med kunden.
2 | © Danfoss| 2021.01
AQ131886471802da-000301
Betjeningsguide ECL Portal API
5.0 Generelt
De data, der er tilgængelige via ECL Portal web-API’et, afhænger af den ECL applikationsnøgle, der sidder i den pågældende ECL Comfort 296 / 310. Dvs. de tilgængelige datasæt er forskellige for hver ECL applikationstype og kan derudover også afhænge af de forskellige eksterne dataopsamlingsapparater, såsom M-bus-målere og konfigurerbare indgange, som ECL regulatorerne kan udstyres med.
ECL Portalen hjemhenter data fra ECL regulatorerne én gang i timen kort efter klokken hel. Den indbyggede ECL-log indeholder applikationsspecifikke signaler såsom målte temperaturer og temperaturreferencer samt eventuelt vindstyrke, tryk eller flow afhængig af den installerede applikation. ECL-loggen indeholder data med 15 minutters mellemrum. Hvis kunden har oprettet konfigurerbare indgange eller tilsluttet M-bus-målere, vil aktuelle værdier for disse også blive hentet én gang i timen.
Hvis det ikke er muligt at hente data fra en ECL regulator pga. kommunikationsfejl eller andet, vil ECL-loggen blive forsøgt hentet ved næste hjemtagning næste time. Den interne ECL-log i ECL regulatoren indeholder data for de seneste 10 dage, så hvis det ikke har været muligt at hente log fra en ECL regulator i 10 dage, vil data gå tabt på ECL portalen og vil dermed ikke være tilgængelig gennem web­API’et.
Så snart data er tilgængelig på ECL Portalen vil de også være tilgængelige gennem ECL Portal web-API’et. Det er ikke muligt at hente data gennem web-API’et, som ikke er tilgængelig på ECL Portalen. Hvis en kunde for eksempel sletter en ECL log eller M-bus-måler på ECL Portalen, vil den heller ikke længere være tilgængelig gennem web-API’et.
Der gemmes ikke data for konfigurerbare indgange og M-bus-målere i ECL regulatoren, så historiske værdier vil ikke blive udlæst ved næste loghentning, når der ikke har været kontakt til ECL Portalen.
Guides for individuelle ECL applikationer kan findes på www.ecl.doc.danfoss.com, hvis det skulle være nødvendigt for tredjepart at have mere specifik viden om de data, der kan trækkes ud af ECL regulatorerne.
En kommunikationsbeskrivelse for ECL regulatorer kan findes her: http://heating.danfoss.com/PCMPDF/VILGV502_ECL_Comfort_210_296_310_Communication.pdf eller ved at google ”ecl communication description” for at finde nyeste version. Kommunikationsbeskrivelsen indeholder bl.a. en generel liste med parametre, som logges af nogle applikationer.
6.0 Sikkerhed
Da der er tale om en ekstern snitflade mod omverdenen, er det særligt vigtigt at sikre, at man ikke kan skaffe sig adgang til andres data.
Første element i sikring af data er identifikation, så man kan validere, hvorvidt den klient, der kalder ECL Portal web-API’et, har ret til at se de data, der efterspørges. I forespørgslerne skal man derfor altid angive:
• Serverkode. Denne udstedes af Danfoss til tredjepart eller kunde, således at åbning for datasnitfladen er en aktiv handling foretaget af Danfoss. Her er tale om en oprettelse ved indgåelse af juridisk aftale.
• ECL serienummer. Anvendes til at identificere en ECL regulator af interesse. Serienummeret kan findes inde i ECL regulatorens menu eller på ECL Portalen
• Tredjepartskode. Oprettes af kunden på ECL Portalen og udleveres til tredjepart
Udover, at tredjepart eller kunden skal have oplyst en serverkode og kende serienummeret, så skal kunden selv knytte tredjepartskoder til ECL regulatoren. På den måde har kunden mulighed for selv at styre, hvilke tredjepart personer og systemer de vil lade trække på dataene ved at tildele dem forskellige tredjepartskoder, som naturligvis også kan inddrages igen enkeltvis.
Dvs., for at få fat i data fra en given ECL regulator, skal man kende dens serienummer, have udstedt en serverkode fra Danfoss og have tildelt sig selv, sit system eller tredjepart en ECL-specifik tredjepartskode.
Ganske som med traditionelle brugernavn/passwordkombinationer vil data kunne komme i de forkerte hænder, hvis kombinationen kompromitteres, da en udefrakommende i så fald vil kunne gøre brug af de samme koder og foretage sine egne forespørgsler. Sikkerheden beror således her på, hvordan kunden og tredjepart beskytter disse oplysninger.
Serverkoder udstedes til kunden/tredjepart enkeltvis og må ikke deles af flere kunder, da den i henhold til den juridiske aftale kan afmeldes ved ophør af aftale eller ved misbrug.
Datakommunikation gennem web-API’et kræver SSL-understøttelse. Hvis en klient sender forespørgsler over HTTP, vil den blive omdirigeret til HTTPS.
AQ131886471802da-000301
© Danfoss | 2021.01 | 3
Betjeningsguide ECL Portal API
6.1 Oprettelse af tredjepartskode
Brug menuen ”Tredjepartskoder”
Tildel et navn til tredjepartskoden for at holde styr på alle koder og marker ”Aktiveret” indstillingen for at gøre koden aktiv.
Koden vil nu være på listen over oprettede koder.
Tryk på linket ”ECL’er” for at komme til siden, hvor koden kan tilde­les specifikke ECL regulatorer.
Man kan her tildele samme kode til flere ECL regulatorer, og man kan tildele flere koder til samme ECL regulator, så man bedre kan styre, hvem der har adgang til hvad.
4 | © Danfoss| 2021.01
AQ131886471802da-000301
Betjeningsguide ECL Portal API
6.2 Tildeling af adgang til tredjepart
a) Hvis kunden ikke tidligere har givet den pågældende tredjepart adgang til data for nogle ECL regulatorer, som slutkunden administrerer, så opretter slutkunden en kode til tredjepart under menuen ECL > Tredjepartskoder. b) Slutkunden knytter den relevante ECL regulator til den relevante tredjepartskode. c) Slutkunden oplyser tredjepart om ECL serienummeret og tredjepartskoden.
Med disse 3 informationer (Serverkode, ECL serienummer, tredjepartskode) har tredjepart nu mulighed for at tilgå data for ECL regula­toren via web-API’et.
Her beskrives de konceptuelle snitflader, der vil blive tilgængelige via web-API’et. Med konceptuelle menes, hvad man kan spørge efter, herunder hvilke oplysninger, der kræves for at spørge, samt hvilke informationer man får retur fra sådanne forespørgsler.
Når man henter aflæsninger for en given periode, kan det vise sig, at perioden indeholder et stort antal aflæsninger, som ikke egner sig til at overføre via et http-request af én omgang. Derfor giver det god mening at operere med såkaldt paging. Dvs. at man i sin forespørgsel, ud over at indikere perioden, kan indikere, hvor mange aflæsninger man ønsker at modtage ad gangen. Af det svar man får retur, kan man så se, om man har fået alle aflæsninger med tilbage på ”første side”(/response), eller om man skal hente flere, og hvor mange man kan forvente at skulle hente i alt. På baggrund heraf kan man så spørge om den næste side og så fremdeles. Samtidig definerer systemet en standard sidestørrelse og en maksimal sidestørrelse, således at man ikke behøver at angive en sidestørrelse, og heller ikke risikerer, at en klient beder om et urealistisk stort load af data i én forespørgsel.
Da en ECL regulator kan operere med flere devices (log-enheder), med forskellige log-frekvenser, er det svært at lave en logisk ”sideom­brydning” i det tilfælde, at alle data ikke kan returneres på én gang. Når man henter aflæsninger, er det i forvejen relevant at vide, hvilke devices der er tilgængelige på en ECL regulator, hvilke der er aktive, etc. Der er således brug for at kunne skaffe sig den information, når der skal hentes aflæsninger, men også, såfremt tredjepart ønsker at lagre/synkronisere detaljer om ECL regulatorerne, devices og kanaler – såkaldt stamdata.
Eksempel på tilgængelige devices og kanaler i en ECL Comfort 296 / 310 regulator med en given applikation, der har tilsluttet to var­memålere via m-bus:
AQ131886471802da-000301
© Danfoss | 2021.01 | 5
Betjeningsguide ECL Portal API
7.0 Snitflader
Device type Kanaler Beskrivelse
EclLogDevice S1 Disse kanaler tilhører sensorer og referenceværdier,
der bruges af applikationen
S2
S3
S4
S5
S6
S7
RefS3
RefS4
RefS5
RefS9
RefS10
EclConfigInputDevice S9 Denne indgang benyttes ikke af applikationen og
kan derfor anvendes som konfigurerbar indgang
EclConfigInputDevice S10 Denne indgang benyttes ikke af applikationen og
kan derfor anvendes som konfigurerbar indgang
EclConfigInputDevice S11 Denne indgang benyttes ikke af applikationen og
kan derfor anvendes som konfigurerbar indgang. Kræver ECA 32 modul i ECL Comfort 296 / 310
EclConfigInputDevice S12 Denne indgang benyttes ikke af applikationen og
kan derfor anvendes som konfigurerbar indgang. Kræver ECA 32 modul i ECL Comfort 296 / 310
EclConfigInputDevice S13 Denne indgang benyttes ikke af applikationen og
kan derfor anvendes som konfigurerbar indgang. Kræver ECA 32 modul i ECL Comfort 296 / 310
EclMBusDevice volume_flow Disse kanaler er tilgængelige i den pågældende
varmemåler, der er tilsluttet via m-bus
flow_temperature
volume
EclMBusDevice volume_flow Disse kanaler er tilgængelige i den pågældende
varmemåler, der er tilsluttet via m-bus
flow_temperature
volume
energy
return_temperature
6 | © Danfoss| 2021.01
AQ131886471802da-000301
Betjeningsguide ECL Portal API
Der vil af den grund blive foretaget en opdeling i de services web-API’et stiller til rådighed. En service, som opererer med stamdata (masterData), og en service, som opererer med aflæsninger (readings). For at gøre overførslen af aflæsninger så optimal som mulig mht. performance, vil disse kald kun returnere de rå værdier. For at tolke dem (f.eks. mht. enheder m.v.) skal de således holdes op mod stamdata.
7.1 API-format
Web-API’et er et REST (REpresentational State Transfer) API via HTTPS(GET) requests, hvor argumenter udtrækkes som en kombination af URL komponenter og URL query parametre.
Responsformatet vil altid være minimalistisk JSON pga. performance. Senere i dette dokument vises eksempler på requests i det rette format.
Når tredjepart har modtaget serverkode, tredjepartskode og serienummer for en ECL regulator, kan de afprøve web-API’et ved at paste et eksempel fra et senere afsnit ind i en browser såsom Chrome, hvorved de vil få et svar tilbage. JSON Viewer plug-in’et til Notepad++ kan nemt bruges til at formatere den modtagne JSON tekst til et letlæseligt format.
7.2 Fremtidige versioner
Snitfladen er forberedt til, hvis der i fremtiden skulle ske ændringer i formatet ved, at der skal medsendes en snitfladeversion i forespørg­slerne. Versionsindikatoren skal angives på formen:
https://{host}/endpoint/{version}/...
hvor {version} skal erstattes med navnet på versionsformatet. For første version er versionsnavnet ”v1”. Se eksempler i senere afsnit, hvor det bruges. Endpoint kan være enten masterData eller readings, som bliver forklaret i senere afsnit.
Når nye versioner introduceres, vil der blive annonceret en slutdato for den gamle version, således, at tredjepartsfirmaer har en periode, hvor de kan opdatere deres software til den nye version.
Efter slutdatoen vil den gamle version ikke længere være tilgængelig. Når en nye version er tilgængelig, vil det blive annonceret på for­siden af ECL Portalen og/eller nyhedsbrev.
{host} skal erstattes med eclwebapi.danfoss.dk for web-API’et tilknyttet den danske ECL portal på ecl.portal.danfoss.dk. For web-API’et på den internationale ECL Portal skal {host} erstattes med eclwebapi.danfoss.com. Det er ikke muligt at tilgå ECL regulatorer på den danske portal gennem web-API’et til den internationale portal eller omvendt.
7.3 Tidsformater
Tidsstempler i web-API’et følger ISO 8601 standarden. Det vil sige, at tidsstempler som default vil være i UTC og angives som:
2013-04-18T08:53:00.0Z
I responsbeskeder vil tidsstempler altid være i UTC og tredjepartssoftware kan derefter omregne til andre tidszoner efter behov. I stam­data for individuelle ECL regulatorer angives den tidszone, som er blevet angivet under ECL regulatorens data af ejeren/administratoren på ECL Portalen.
Det er muligt at angive tidsstempler i andre tidszoner, når man efterspørger data ved at angive den lokale tidszone. Ovenstående tidsstempel vil dermed udtrykkes som
2013-04-18T10:53:00.0+02:00
”+”-tegnet skal udtrykkes som ”%2B” i forespørgsler og ”-”-tegn skal udtrykkes som ”%2D”
Hvis tiden i ECL regulatoren ikke passer, eller tidszonen på ECL Portalen er forkert, kan tidsstemplerne i de udtrukne data være mis­visende. Aflæsningseksempel for ECL-log udlæst fra ECL Portal-API 2013-10-29 kl. 09:40 dansk normaltid
AQ131886471802da-000301
© Danfoss | 2021.01 | 7
Betjeningsguide ECL Portal API
{ “tracking”: { “serverRequestId”: “0af3a240-0a36-45ae-b8af-9e24f52103eb”, “from”: “2013-10-29T09:40:45.318+01:00”, “direction”: “reverse”, “page”: 1, “pageSize”: 1000, “resultReadings”: 1000, “totalReadings”: 69346, “totalPages”: 70 }, “data”: [{ “externalDeviceId”: “cfbd9943-9e49-4d19-a052-6424de7041e8”, “readings”: [{
“id”: 124280485, “timestamp”: “2013-10-29T07:45:00.0Z”, “receivedTime”: “2013-10-29T08:00:04.55Z”, “manualEntry”: false, “value1”: 192, “value2”: 48.09, “value3”: 90, “value4”: 192, “value5”: 28.5, “value6”: 192, “value7”: 50, “value8”: 192, “value9”: 0, “value10”: 0 }, { “id”: 124280484, “timestamp”: “2013-10-29T07:30:00.0Z”, “receivedTime”: “2013-10-29T08:00:04.52Z”, “manualEntry”: false, “value1”: 192, “value2”: 48.09, “value3”: 90, “value4”: 192, “value5”: 28.5, “value6”: 192, “value7”: 50, “value8”: 192, “value9”: 0, “value10”: 0 } ] }] }
Den første ”from”-parameter er aktuelt tidspunkt for udlæsning, her vist med tidszone +01:00. ”timestamp” er ECL regulatorens tid for den aktuelle sample. ”receivedTime” er ECL Portalens tid på det tidspunkt, hvor den udlæste data fra ECL regulatoren. Da der udlæses data én gang i timen, vil der typisk være 4 samples (én for hvert kvarter) med samme ”receivedTime” værdi, men hvis der har været udfald i datakommunika­tionen, kan der være udlæst mere data på samme tid.
Hvis der ikke er data i databasen for det givne tidspunkt i den givne retning, vil data-feltet i responset være tomt.
Aflæsningseksempel for ECL-log udlæst fra ECL Portal-API’et 2014-04-01 kl. 12:05 dansk sommertid. Her er tiden i ECL regulatoren indstil­let forkert, og der er valgt en forkert tidszone (UTC+02:00 i stedet for UTC+01:00) på ECL Portalen.
8 | © Danfoss| 2021.01
AQ131886471802da-000301
Betjeningsguide ECL Portal API
{ “tracking”: { “serverRequestId”: “07c49346-aa90-4e45-9f20-610931d5887e”, “from”: “2014-04-01T12:05:32.430+02:00”, “direction”: “reverse”, “page”: 1, “pageSize”: 1, “resultReadings”: 14 }, “data”: [{ “externalDeviceId”: “5a84dbcc-a9c0-474f-9c12-5db4884fc6ed”, “readings”: [{ “id”: 79779710, “timestamp”: “2012-10-04T02:15:00.0Z”, “receivedTime”: “2014-04-01T10:00:52.293Z”, “manualEntry”: false, “value1”: -1.25, “value2”: -9.46, “value3”: 26.17, “value4”: 26.66, “value5”: -24.21, “value6”: 45.84, “value7”: 17.8, “value8”: 40.24, “value9”: 10, “value10”: 50.83, “value11”: 30, “value12”: 0 }] }] }
Den tilhørende log udlæst som en Excel-fil fra ECL Portalen viser:
Her kan man se, at ECL regulatorens tid ved den seneste sample var 2012-10-04 05:15:00, men i dataene fra web-API’et var tiden 2012-10­04 02:15:00Z. Der er således 3 timers forskel, som kommer fra tidszone (som er +2 timer) og sommertid (+1 time) Ved at sammenligne de tre tider (from, timeStamp og receivedTime) kan man tjekke, om tiden er indstillet korrekt i ECL regulatoren, og om den rigtige tidszone er valgt på ECL Portalen.
8.0 Stamdata service (Master Data)
Her beskrives, hvad stamdata servicen kan anvendes til. Servicen har i denne første version kun én metode. Metoden er getEclMasterData, og henter alle relevante stamdata for en given ECL regulator, herunder tilsluttede målere. Det omfatter også data, som er nødvendige for at tolke de aflæsninger, man kan hente. Neden­stående beskriver det konceptuelle indhold af request og response.
8.1 getEclMasterData request parametre
Parameter Beskrivelse Eksempel
serverCode Del af identifikation jf. afsnit 5 omkring sikkerhed. FirmaA
eclSerial Del af identifikation jf. afsnit 5 omkring sikkerhed. 123456792
eclAccessCode Del af identifikation jf. afsnit 5 omkring sikkerhed. Kode5
clientRequestId Valgfri tekst, som kan bruges til at implementere sporbarhed i tredjepart
systemer, der fungerer asynkront. Kan udelades, men vil ellers typisk være en autogenereret unik ID.
AQ131886471802da-000301
555b7f4d-7e1a-4d76-a4f0­be8fb52b7c80
© Danfoss | 2021.01 | 9
Betjeningsguide ECL Portal API
8.1.1 getEclMasterData request parametre eksempel
Eksempel med version=v1, serverCode=CompanyA, eclSerial=123456792, eclAccessCode= Code5.
https://{host}/masterdata/{version}/{eclSerial}?serverCode={serverCode}&eclAccessCode={eclAccessCode}
https://eclwebapi.danfoss.dk/masterdata/v1/123456792?serverCode=FirmaA&eclAccessCode=Kode5
8.2 getEclMasterData response
Af sporbarhedsmæssige årsager kommer følgende oplysninger retur i svaret fra serveren.
Element Beskrivelse Eksempel
clientRequestId Det ID, som blev sendt med under
selve requestet for at muliggøre sporbarhed hos tredjepart.
serverRequestId Serveren tildeler selv hver request
et unikt ID, da der ikke er krav om at man skal medsende et unikt klient ID på tværs af kunder. Dette ID kan bruges, hvis man er i tvivl om serverens håndtering af et request, da der vil blive logget forskellige statistiske informationer omkring hvert request (se afsnit 5.4 omkring sporbarhed).
8.2.1 getEclMasterData response eksempel
Stamdata er nærmere beskrevet i næste afsnit
{ “tracking”: { “serverRequestId”: “d4b86aa4-f4a0-4ce8-9f14-3c7bd3cc3c80” }, “masterData”: { “application”: “A376.1”, “applicationVersion”: “4.00”, “hardwareModel”: “ECL 296 / 310, 230 V”, “hardwareVersion”: “A”, “softwareBuild”: “7232”, “hardwareProductionTime”: “3.2010”, “firmwareVersion”: “1.48”, “serialNumber”: “123456792 ”, “createdOnPortal”: “2012-09-07T08:16:53.543Z”, “timezone”: “Europe/Copenhagen”, “location”: { “street”: “Solitudevej”, “streetNumber”: “13A”, “city”: “Andeby” }, “name”: “ECL name”, “portalGroup”: “Test ECL controllers”, “devices”: [List of log devices has been moved in this example] } }
555b7f4d-7e1a-4d76-a4f0­be8fb52b7c80
9cd4df10-09cc-4ec7-8b4e­c1180b21d9d9
10 | © Danfoss| 2021.01
AQ131886471802da-000301
Betjeningsguide ECL Portal API
8.2.2 Stamdata
Følgende grundlæggende stamdata kommer ligeledes retur med responset for selve ECL regulatoren.
Element Beskrivelse Eksempel
application Hvilken applikation ECL regulatoren
kører
applicationVersion Version af applikationen 4.00
hardwareModel Hardware modelnummer ECL 296 / 310, 230 V
hardwareVersion Hardware version A
softwareBuild * Software build nummer 7232
hardwareProductionTime Hardware produktionstidspunkt 3.2010
firmwareVersion Firmware versionsnummer 1.48
serialNumber Serienummer 123456792
createdOnPortal Dato for hvornår ECL regulatoren
blev oprettet på (først forbundet til) portalen
timezone Tidszone ECL regulatoren er placeret i
(valgt på ECL Portal)
location:Street ** Gade ECL regulatoren er placeret på
(hvis indtastet på ECL Portal)
A376.1
2013-04-18T08:53:00.0Z
Europe/Copenhagen
Solitudevej
location:StreetNumber ** Husnummer ECL regulatoren er
placeret på (hvis indtastet på ECL Portal)
location:Zip ** Postnummer ECL regulatoren er
placeret i (hvis indtastet på ECL Portal)
location:City ** By ECL regulatoren er placeret i (hvis
indtastet på ECL Portal)
location:Country ** Land ECL regulatoren er placeret i (hvis
indtastet på ECL Portal)
name Navn (indtastet på ECL Portal) Varme i kælderen
description ** Beskrivelse (hvis indtastet på ECL
Portal)
portalGroup ** Gruppe anført i EP til at gruppere ECL
regulatorer
*Denne streng var oprindelig ”hardwareBuild”, men er siden rettet til det korrekte ”softwareBuild” ** Disse data medsendes kun i stamdata, hvis de er udfyldt på ECL Portalen
Desuden vil der for hver device på ECL regulatoren returneres følgende oplysninger om selve devicet.
13A
6400
Andeby
Danmark
Kælderen
Gruppe1
AQ131886471802da-000301
© Danfoss | 2021.01 | 11
Betjeningsguide ECL Portal API
Element Beskrivelse Eksempel
type Angiver typen af device. Mulige udfald er ”EclLogDevice”,
”EclConfigInputDevice” og ”EclMBusDevice”
externalDeviceId Eksternt identifikationsnummer for devicet. Skal f.eks. bruges
for at kunne hente aflæsninger for devicet.
name Navn for devicet. For ECL-log er navnet altid ”EclLog”. For andre
typer er navnet valgfrit på ECL Portalen ved oprettelse.
active Angiver, hvorvidt device er i brug. Mulige værdier er
”false”/”true” Kun én ECL-log device kan være aktiv ad gangen, men der kan oprettes flere EclConfigInputDevices eller EclMBusDevices på samme tid. Den aktive ECL-log svarer til den aktuelt valgte portalapplikation
createdOnPortal Oprettelsestidspunkt for device i ISO 8601 format 2013-04-18T08:53:00.0Z
lastRead Sidste aflæsningstidspunkt i ISO 8601 format 2013-04-18T08:53:00.0Z
logAppName Aktuelt valgt portalapplikation. Der er mange forskellige
muligheder, så de vil ikke blive nævnt her. Mulige værdier er:
configInputType
-0-10V ADC
-Digital
-Flow switch
-Pulse
-Frequency Hvis det er en ukendt type returneres ”7” Kun for EclConfigInputDevices
EclLogDevice
c0f6563e-2bd0-4514­9539-db2c0c700d78
EclLog
True
A376.1 example a
0-10V ADC-Pt 1000
configInputDefinedMaxValue*
configInputDefinedMinValue **
configInputCircuitCloseText
configInputCircuitOpenText
configInputSensorId
mbusAddress
mbusSerialNumber
mbusType *** Kun for EclMBusDevices. Type for M-bus-måleren. Består af
channels
* Denne parameter indikerer, hvilken faktisk værdi som 10 V repræsenterer for 0-10 V ADC input ** Denne parameter indikerer, hvilken faktisk værdi som 0 V repræsenterer for 0-10 V ADC input *** Kendte typer er:
Kun for EclConfigInputDevices af typen 0-10 V ADC
Kun for EclConfigInputDevices af typen 0-10 V ADC
Kun for EclConfigInputDevices af typen ”Digital” eller ”Flow switch” for tilstanden ”close”
Kun for EclConfigInputDevices af typen ”Digital” eller ”Flow switch” for tilstanden ”open”
Kun for EclConfigInputDevices. Indikerer hvilken indgang den konfigurerbare indgang er oprettet på
Kun for EclMBusDevices. Adressen på M-bus-netværket.
Kun for EclMBusDevices. Unikt serienummer for M-bus-måleren
fabrikantkode og typekode
Kanalinformation vises i en senere tabel nedenunder
4
2
Signal OK
No signal
S9
15
06120815
KAM-08-0c
12 | © Danfoss| 2021.01
AQ131886471802da-000301
Loading...
+ 28 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use