Meddalwedd s HALO Smart Sensor API Meddalwedd Sylfaenol
Ymlaen
Mae'r ddogfen hon yn disgrifio'r grŵp o gyfleusterau Synhwyrydd Clyfar Halo a elwir gyda'i gilydd yr API SYLFAENOL, neu Ryngwyneb Rhaglennu Cymwysiadau. Bwriedir i'r drafodaeth hon gael ei defnyddio gan raglenwyr neu integreiddwyr sydd â diddordeb mewn integreiddio un neu fwy o Synwyryddion Clyfar HALO (HALOs) gyda chydrannau neu systemau meddalwedd trydydd parti (nad ydynt yn IPVideo). Yn gyffredinol, bwriad API HALO yw trosglwyddo gwybodaeth yn effeithlon o HALO dros rwydwaith Ethernet confensiynol i'r rhaglen allanol. I gyflawni'r nod hwn, mae'r API wedi'i rannu'n dair adran: Cysylltiad Soced a Yrrir gan Ddigwyddiad, Cysylltiad Soced Curiad Calon, a Data Digwyddiad URL. Mae rhyngwyneb BACnet hefyd yn bresennol ac wedi'i gynnwys mewn dogfen ar wahân.
Dylunio API
Mae'r API wedi'i gynllunio gan ddefnyddio fformatau safonol y diwydiant fel TCP/IP. HTTP, HTTPS, a JSON. Nid yw'r dyluniad yn gofyn am unrhyw dechnegau neu lyfrgelloedd arbennig neu berchnogol i'w defnyddio wrth ddatblygu'r rhaglen neu'r cymhwysiad allanol. Mae'r API yn hyblyg a gellir ei ffurfweddu a'i raglennu i ddarparu'r union ddata sydd ei angen ac yn y modd mwyaf effeithlon. Ymdrinnir â manylion gweithrediad pob un o'r adrannau uchod yn adrannau canlynol y canllaw hwn.
Negeseuon Allanol
Defnyddir y cyfleuster hwn i gyflwyno rhybuddion neu larymau a data Digwyddiad i raglen allanol, system VMS, gweinydd, ac ati pan fydd Digwyddiad yn cael ei sbarduno (yn cael ei osod). Gellir galluogi negeseuon dewisol hefyd i ddangos pan fydd Digwyddiad yn clirio (yn cael ei ailosod). Gellir gwneud y dosbarthiad hwn i soced TCP/IP neu weinydd HTTP/S mewn amser real. Mae amrywiaeth o brotocolau ffurfweddadwy gyda chynnwys y gellir ei addasu. Mae dilysu ac amgryptio ar gael.
Curiad y galon
Anfonir negeseuon curiad calon ar gyfnod ffurfweddu (yn lle pan fydd Digwyddiadau'n cael eu sbarduno) i ddarparu prawf byw / argaeledd. Mae ganddynt ystod debyg o alluoedd â Negeseuon Allanol ond byddent fel arfer yn cael eu ffurfweddu i gynnwys gwybodaeth gyffredinol am y cyflwr yn hytrach na manylion am ddigwyddiad penodol.
Data Digwyddiad URL
Dim ond o dan NDA y mae'r cyfleuster hwn ar gael a dim ond pan fydd y rhaglen allanol yn gofyn am fynediad at unrhyw un a holl werthoedd y Digwyddiad, y trothwyon a'r baneri gwladwriaeth y dylid ei ddefnyddio. Yn gyffredinol, mae'r rhaglen allanol yn adfer y data hwn yn ôl y galw ond nid yn aml iawn. Mae'r dull hwn yn gyffredinol yn achosi rhywfaint o hwyrni pan ddefnyddir cyfradd pleidleisio gymedrol. Mae cyfraddau pleidleisio arferol yn amrywio o unwaith y funud i unwaith bob 5 eiliad gydag uchafswm cyfradd absoliwt o unwaith yr eiliad. Gellir defnyddio'r dull hwn hefyd i adalw data ategol ychwanegol pan dderbynnir Digwyddiad (rhybudd).
Manylion Negeseuon Allanol
Adran o'r HALO web rhyngwyneb Integration naid yn darparu ar gyfer ffurfweddu cysylltiad 3ydd parti unigol lle gellir anfon gwerthoedd amrywiol i soced TCP o bell neu weinydd HTTP/HTTPS. Defnyddir dalwyr lleoedd (tocynnau) i fewnosod gwerthoedd byw yn y testun a drosglwyddir. Er ei bod wedi'i labelu'n “Negeseuon Allanol,” gellir defnyddio'r sianel hon at bron unrhyw ddiben sy'n gofyn am sbardunau Digwyddiad amser real, a ddarperir yn weithredol gan HALO. Mae'r trefniant hwn yn eithaf hyblyg oherwydd bod detholiadau ar y “Camau Gweithredu” yn pennu pa Ddigwyddiadau HALO sy'n trosglwyddo trwy'r sianel hon.
Yn y modd HTTP, y Llinynnau Gosod ac Ailosod yw'r URLs y mae'n rhaid eu mewnbynnu a'u fformatio fel sy'n ofynnol gan y gweinydd cyrchfan dymunol. Gellir defnyddio maes Defnyddiwr a Chyfrinair ar gyfer dilysu. Gweler modd HTTP isod.
Yn y modd TCP, dim ond data un neges sy'n cael ei anfon i'r soced TCP sy'n derbyn yw'r Llinynnau Gosod ac Ailosod. Gellir eu fformatio yn ôl yr angen gan y cyrchfan. Mae'r cyrchfan wedi'i nodi yn y meysydd Cyfeiriad a Phorthladd. Gweler Modd TCP isod.
Ar gyfer y naill fodd neu'r llall, dangosir statws o'r neges ddiweddaraf a all helpu i drwsio cysylltiad neu faterion eraill. Gallech ddefnyddio'r botymau Event TEST ar y naidlen Actions i orfodi neges:
Rhaid i Global On / Off ar gyfer Gosod neu Ailosod fod Ymlaen i alluogi'r mathau hynny o negeseuon. Ni ddefnyddir ailosod yn aml oherwydd dim ond dechrau Digwyddiad sydd o ddiddordeb, ond gall hynny amrywio. Gall pob Digwyddiad nodi'n annibynnol a fydd yn defnyddio naill ai'r neges Gosod neu'r neges Ailosod ar y ffenestr naid Gweithredoedd. Bydd y botymau pelen llygad yn dangos cynrychiolaeth fras o'r hyn a anfonir ar ôl amnewidion allweddair a fformatio. Gellir defnyddio Holdoff Ailadrodd i sbarduno negeseuon cyson trwy oedi cyn y gellir anfon un arall. Gwneir hyn yn annibynnol fesul Digwyddiad. Mae gan HALO amser dal integredig o 15 eiliad ar gyfer digwyddiadau er mwyn atal Digwyddiadau rhag ail-gychwyn yn gyflym. Pe baech am sicrhau nad yw mwy nag 1 Digwyddiad o'r math yn cael ei anfon y funud, gallech osod Repeat Holdoff i 60 (eiliadau).
Manylion curiad calon
Mae trosglwyddiadau Curiad y Galon yn gweithredu mewn ffordd debyg i'r uchod ac eithrio nad oes unrhyw ryngweithio â'r dudalen Camau Gweithredu. Yn lle hynny, mae'r trosglwyddiad Curiad Calon yn digwydd yn rheolaidd fel y'i ffurfiwyd gyda'r maes Interval, Yn y modd HTTP, y Llinynnau Gosod ac Ailosod yw'r URLs y mae'n rhaid eu mewnbynnu a'u fformatio fel sy'n ofynnol gan y gweinydd cyrchfan dymunol. Gellir defnyddio maes Defnyddiwr a Chyfrinair ar gyfer dilysu. Gweler modd HTTP isod.
Er mai prif bwrpas Curiad y Galon yw darparu prawf o fywyd Synhwyrydd Clyfar HALO i raglen bell, gellir defnyddio'r neges hon hefyd i drosglwyddo synwyryddion dethol neu wybodaeth gyfredol am gyflwr Digwyddiad. Mae'r cynample uchod yn anfon paramedr llinyn hir gyda'r URL sy'n cynnwys yr enw Halo, mwyafrif o werthoedd synhwyrydd, ac yn olaf Triggered=% ACTIVE% a allai fod yn wag neu'n rhestr o Ddigwyddiadau a ysgogwyd ar hyn o bryd.
Modd HTTP (a HTTPS).
Gall llinynnau Negeseuon Allanol a Curiad Calon fod yn http: neu https: URLs yn ôl yr angen. Gellir cofnodi llwybr a pharamedrau yn ôl yr angen gan y gweinydd cyrchfan. Mae modd mewnosod geiriau allweddol fel %NAME% (enw dyfais HALO) neu %EID% (Digwyddiad id) yn ôl yr angen a bydd y data priodol yn cael ei ddisodli pan anfonir y neges. Dangosir rhestr o eiriau allweddol a ddefnyddir yn gyffredin er mwyn cyfeirio atynt yn gyflym.
Mae'r URL gall llwybr gynnwys geiriau allweddol yn ogystal â'r paramedrau i'r URL. Gall y paramedrau fod yn barau NAME=VALUE neu'n wrthrych JSON, neu'n fformat addasedig yn dibynnu ar y gweinydd cyrchfan. Exampbyddai les ar gyfer Negeseuon Allanol yn cynnwys %EID% i ddangos y Digwyddiad a ysgogodd:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Exampgallai les ar gyfer Curiad Calon ychwanegu % ACTIVE% (Digwyddiadau a ysgogwyd ar hyn o bryd) neu werth synhwyrydd:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Mae gwerthoedd % SENSOR:…% yn defnyddio'r enwau a geir ym mhenawdau colofn dde'r synhwyrydd yn log evtYYYYYMMDD.csv files. Maent fel arfer yn:
Os yw'n well gan y gweinydd cyrchfan HTTP PUT neu POST yn lle ceisiadau GET, gallwch ragddodiad y URL gyda PUT: neu POST:. Yn annibynnol, gallwch ychwanegu llwyth tâl JSON sy'n boblogaidd gyda llawer o weinyddion trwy ychwanegu'r allweddair [JSONBODY] ac yna gwrthrych wedi'i fformatio gan JSON. Example:
RHOI:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”event”:”%EID%”}
Mae'r URL yn cefnogi opsiynau cyfeiriad IP nodweddiadol (a IPv6) ac opsiynau porth a chyfrinair defnyddiwr, neu gallwch ddefnyddio'r meysydd Defnyddiwr a Chyfrinair os oes angen fel y gweinydd cyrchfan ar gyfer dulliau dilysu fel Sylfaenol neu Crynhoad:
https://username:password@123.321.123.321:9876/event…
Modd TCP
Mae llinynnau Negeseuon Allanol a Curiad Calon ar gyfer data yn unig gan fod y meysydd Cyfeiriad a Phorthladd yn nodi cyrchfan. Mae'r Cyfeiriad yn cefnogi enwau, IPv4 ac IPv6.
Gellir fformatio'r llinyn fel y darnau data o negeseuon HTTP a ddisgrifir uchod, neu fel sy'n ofynnol gan y gweinydd cyrchfan.
Exampbyddai les ar gyfer Negeseuon Allanol yn cynnwys %EID% i ddangos y Digwyddiad a ysgogodd:
lleoliad=%NAME%, digwyddiad=%EID%
{“lleoliad”:”:%NAME%”, “digwyddiad”:”%EID%”}
Exampgallai les ar gyfer Curiad Calon ychwanegu % ACTIVE% (Digwyddiadau a ysgogwyd ar hyn o bryd) neu werth synhwyrydd:
lleoliad=%NAME%&Triggered=% ACTIVE%
{“lleoliad”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Mae blychau ticio yn y colofnau “Set Integration” ac “Integration Reset” yn pennu pa Ddigwyddiadau sy'n sbarduno anfon. Mae rhagor o wybodaeth am sefydlu Digwyddiadau a Chamau Gweithredu ar gael yng Nghanllaw Gweinyddwr HALO.
Cyflwyno Negeseuon Digwyddiad JSON
Mae'n well gan rai datblygwyr dderbyn data Digwyddiad wedi'i fformatio fel JSON hunan-labelu safonol y diwydiant yn hytrach na thestun ASCII plaen gan fod y cyntaf yn cael ei ddosrannu'n fwy dibynadwy ac yn haws. Ar yr HALO web tudalen “Negeseuon”, gallwch gyflenwi negeseuon JSON mewn gosodiadau “Negeseuon Allanol” “Set String” ac “Ailosod Llinynnol” ac yn y “Curiad Calon” “Neges.”
Examples:
Llinyn Gosod Gosodiadau “Negeseuon Allanol”:
{ “dyfais”: ”%NAME%”, “digwyddiad”: ” %EID%”, “larwm”: “ie” }
Bydd hyn yn anfon un neges TCP neu UDP JSON at y gweinydd penodedig yn adrodd enw'r ddyfais gyfeillgar, enw'r digwyddiad a'i fod newydd ddechrau.
Llinyn Ailosod Gosodiadau “Negeseuon Allanol”:
{ “dyfais”: ”%NAME%”, “digwyddiad”: ” %EID%”, “larwm”: ”na” }
Bydd hyn yn anfon un neges TCP neu UDP JSON i'r gweinydd penodedig yn adrodd enw'r ddyfais gyfeillgar, enw'r digwyddiad a bod y cyflwr bellach wedi dod i ben.
Neges “Curiad Calon”:
{ “dyfais” : ” % NAME % ” , “ yn fyw ” : ” %DATE% %TIME% ” }
O bryd i'w gilydd bydd hyn yn anfon neges TCP neu UDP JSON at y gweinydd penodedig yn adrodd bod yr HALO yn fyw ar yr amser a nodir.
Dogfennau / Adnoddau
 |
Meddalwedd s HALO Smart Sensor API Meddalwedd Sylfaenol [pdfCanllaw Defnyddiwr Meddalwedd Sylfaenol API Synhwyrydd Smart HALO |
