Hugbúnaður s HALO Smart Sensor API Grunnhugbúnaður
Áfram
Þetta skjal lýsir hópi aðstöðu Halo Smart Sensor sem er sameiginlega þekktur sem BASIC API, eða forritunarviðmót. Þessi umræða er ætluð til notkunar fyrir forritara eða samþættingaraðila sem hafa áhuga á að samþætta einn eða fleiri HALO snjallskynjara (HALO) við þriðja aðila (ekki IPVideo) hugbúnaðarhluta eða kerfi. Almennt séð er HALO API ætlað að flytja upplýsingar á skilvirkan hátt frá HALO yfir hefðbundið Ethernet net yfir í ytra forritið. Til að ná þessu markmiði er API skipt í þrjá hluta: Event Driven Socket Connection, Heartbeat Socket Connection og Event Data URL. BACnet tengi er einnig til staðar og fjallað er um í sérstöku skjali.
API hönnun
API er hannað með því að nota iðnaðarstaðlaða snið eins og TCP/IP. HTTP, HTTPS og JSON. Hönnunin krefst ekki sérstakrar eða sértækrar tækni eða bókasöfn til að nota við þróun ytra forritsins eða forritsins. API er sveigjanlegt og hægt að stilla og forrita til að skila nákvæmlega þeim gögnum sem krafist er og á sem hagkvæmastan hátt. Farið er yfir upplýsingar um rekstur hvers af ofangreindum hlutum í eftirfarandi köflum þessarar handbókar.
Ytri skilaboð
Þessi aðstaða er notuð til að senda viðvaranir eða viðvaranir og atburðagögn til utanaðkomandi forrits, VMS kerfis, netþjóns osfrv. þegar atburður er settur af stað (er stilltur). Einnig er hægt að virkja valfrjáls skilaboð til að gefa til kynna þegar atburður hreinsar (er endurstilltur). Þessi afhending er hægt að gera til TCP/IP fals eða HTTP/S netþjóns í rauntíma. Það er úrval af stillanlegum samskiptareglum með sérhannaðar innihaldi. Auðkenning og dulkóðun eru í boði.
Hjartsláttur
Hjartsláttarskilaboð eru send með stillanlegu millibili (í stað þess að viðburðir eru settir af stað) til að sýna sönnun um lifandi/aðgengi. Þeir hafa svipaða möguleika og ytri skilaboð en myndu venjulega vera stillt til að innihalda almennar upplýsingar um ástand frekar en upplýsingar um tiltekinn atburð.
Atburðargögn URL
Þessi aðstaða er aðeins í boði samkvæmt NDA og ætti aðeins að nota þegar ytra forritið krefst aðgangs að öllum viðburðagildum, þröskuldum og ríkisfánum. Þessi gögn eru almennt sótt eftir beiðni af ytri forritinu en ekki með mjög mikilli tíðni. Þessi aðferð hefur almennt í för með sér einhverja töf þegar hóflegt könnunarhlutfall er notað. Dæmigerð könnunartíðni er á bilinu einu sinni á mínútu upp í einu sinni á 5 sekúndur með algjöran hámarkshraða einu sinni á sekúndu. Þessa aðferð er einnig hægt að nota til að sækja viðbótargögn þegar viðburður (viðvörun) er móttekin.
Upplýsingar um ytri skilaboð
Hluti af HALO web tengi Samþætting sprettiglugga gerir ráð fyrir uppsetningu á einni tengingu frá þriðja aðila þar sem hægt er að senda ýmis gildi á ytri TCP fals eða HTTP/HTTPS netþjón. Staðhaldarar (tákn) eru notaðir til að setja lifandi gildi inn í sendann texta. Þótt hún sé merkt „Ytri skilaboð“ er hægt að nota þessa rás í nánast hvaða tilgangi sem er sem krefst rauntíma atburðakveikja, virkt afhent af HALO. Þetta fyrirkomulag er nokkuð sveigjanlegt vegna þess að val á „Aðgerðum“ ákvarðar hvaða HALO viðburðir senda í gegnum þessa rás.
Í HTTP ham eru Stillingar og Endurstilla strengirnir URLs sem verður að slá inn og forsníða eins og krafist er af viðkomandi áfangaþjóni. Hægt er að nota reit fyrir notanda og lykilorð til auðkenningar. Sjá HTTP ham hér að neðan.
Í TCP ham eru Stillingar og Endurstilla strengirnir aðeins gögn einstakra skilaboða sem eru send í móttöku TCP fals. Þeir geta verið sniðnir eftir þörfum af áfangastað. Áfangastaðurinn er tilgreindur í reitunum Heimilisfang og Höfn. Sjá TCP Mode hér að neðan.
Fyrir hvora stillinguna er staða frá nýjustu skilaboðunum sýnd sem getur hjálpað til við að laga tengingu eða önnur vandamál. Þú gætir notað Event TEST hnappana á Action sprettiglugganum til að þvinga fram skilaboð:
Almennt kveikt/slökkt fyrir stilla eða endurstilla verður að vera á til að virkja þessar tegundir skilaboða. Endurstilling er oft ekki notuð vegna þess að aðeins upphaf viðburðar er áhugavert, en það getur verið mismunandi. Hver atburður getur sjálfstætt tilgreint hvort hann noti annaðhvort Set eða Reset skilaboðin á Action sprettiglugganum. Augnboltahnapparnir munu sýna grófa framsetningu á því sem er sent eftir lykilorðaskipti og snið. Hægt er að nota Repeat Holdoff til að stöðva tíð skilaboð með því að seinka áður en hægt er að senda annað. Þetta er gert sjálfstætt fyrir hvern viðburð. HALO er með innbyggðan biðtíma fyrir atburði upp á 15 sekúndur til að koma í veg fyrir hraða endurræsingu atburða. Ef þú vilt tryggja að ekki sé sent meira en 1 atburður af tegund á mínútu gætirðu stillt Endurtekið bið á 60 (sekúndur).
Upplýsingar um hjartslátt
Hjartsláttarsendingarnar virka á svipaðan hátt og hér að ofan nema að það er engin samskipti við Aðgerðir síðuna. Þess í stað á hjartsláttarsendingin sér stað reglulega eins og hann er stilltur með Interval reitnum, Í HTTP ham eru Stillingar og Endurstilla strengirnir URLs sem verður að slá inn og forsníða eins og krafist er af viðkomandi áfangaþjóni. Hægt er að nota reit fyrir notanda og lykilorð til auðkenningar. Sjá HTTP ham hér að neðan.
Þó að megintilgangur hjartsláttar sé að sanna líf HALO snjallskynjara til fjarstýrðs forrits, er einnig hægt að nota þessi skilaboð til að senda valda skynjara eða núverandi upplýsingar um atburðarstöðu. Fyrrverandiample hér að ofan sendir langa strengjabreytu með URL sem innihalda Halo nafnið, meirihluta skynjaragilda og loks Triggered=%ACTIVE% sem gæti verið tómt eða listi yfir atburði sem eru ræstir.
HTTP (og HTTPS) hamur
Ytri skilaboð og hjartsláttarstrengir geta verið http: eða https: URLs eftir þörfum. Slóð og færibreytur er hægt að slá inn eftir þörfum af áfangaþjóninum. Hægt er að setja inn leitarorð eins og %NAME% (HALO tækisheiti) eða %EID% (Auðkenni viðburðar) eftir þörfum og þeim verður skipt út fyrir viðkomandi gögn þegar skilaboðin eru send. Listi yfir algeng leitarorð er sýndur til fljótlegrar tilvísunar.
The URL slóð getur innihaldið leitarorð sem og færibreytur í URL. Færibreyturnar gætu verið NAME=VALUE pör eða JSON hlutur, eða sérsniðið snið eftir áfangaþjóninum. Fyrrverandiamples fyrir ytri skilaboð myndi innihalda %EID% til að gefa til kynna atburðinn sem kveikti:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples fyrir hjartslátt gæti bætt við %ACTIVE% (atburðir sem nú eru ræstir) eða skynjaragildi:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
%SENSOR:…% gildin nota nöfnin sem finnast í hægri dálknum skynjara í evtYYYYMMDD.csv log files. Þau eru venjulega:
Ef áfangaþjónninn kýs HTTP PUT eða POST í stað GET beiðna, geturðu sett forskeyti á URL með PUT: eða POST:. Sjálfstætt geturðu bætt við JSON hleðslu sem er vinsælt hjá mörgum netþjónum með því að bæta við [JSONBODY] leitarorði og síðan JSON sniðnum hlut. Fyrrverandiample:
PUT:https://server.com/event[JSONBODY]{“location”:”%NAME%”,,”event”:”%EID%”}
The URL styður dæmigerð IP-tölu (og IPv6) og valmöguleika fyrir port og notandalykilorð, eða þú getur notað reitina Notanda og Lykilorð ef þörf krefur til að vera áfangaþjónn fyrir auðkenningaraðferðir eins og Basic eða Digest:
https://username:password@123.321.123.321:9876/event…
TCP ham
Ytri skilaboð og hjartsláttarstrengir eru bara fyrir gögn þar sem heimilisfang og höfn tilgreina áfangastað. Heimilisfangið styður nöfn, IPv4 og IPv6.
Hægt er að forsníða strenginn eins og gagnahluta HTTP skilaboða sem lýst er hér að ofan, eða eins og krafist er af áfangaþjóninum.
Examples fyrir ytri skilaboð myndi innihalda %EID% til að gefa til kynna atburðinn sem kveikti:
staðsetning=%NAME%,viðburður=%EID%
{“location”:”:%NAME%”,,”event”:”%EID%”}
Examples fyrir hjartslátt gæti bætt við %ACTIVE% (atburðir sem nú eru ræstir) eða skynjaragildi:
location=%NAME%&Triggered=%ACTIVE%
{“location”:”:%NAME%”,,”NH3”:%SENSOR:NH3%}
Gátreitir í dálkunum „Samþættingarsett“ og „Endurstilla samþættingu“ ákvarða hvaða atburðir koma af stað sendingu. Meira um uppsetningu viðburða og aðgerða er að finna í HALO stjórnandahandbókinni.
Afhending JSON viðburðaskilaboða
Sumir forritarar kjósa að taka á móti viðburðagögnum sem eru sniðin sem iðnaðarstaðall sjálfmerkt JSON frekar en venjulegan ASCII texta þar sem sá fyrrnefndi er áreiðanlegri og auðveldari að flokka. Á HALO web síðu „Skilaboð“ flipann geturðu sent inn JSON skilaboð í „Ytri skilaboðum“ stillingum „Setja streng“ og „Endurstilla streng“ og í „Hjartsláttur“ „Skilaboð“.
Examples:
„Ytri skilaboð“ Stillingar Stillingarstrengur:
{ „tæki“:“%NAME%“, „event“:“%EID%“, „viðvörun“: „já“ }
Þetta mun senda stök TCP eða UDP JSON skilaboð til tilgreinds netþjóns sem tilkynnir um vinalegt tækisheiti, viðburðarheiti og að það hafi bara byrjað.
„Ytri skilaboð“ Stillingar endurstilla strengur:
{ “device”:”%NAME%”, “event”:”%EID%”, “alarm”:”no” }
Þetta mun senda stök TCP eða UDP JSON skilaboð til tilgreinds netþjóns sem tilkynnir um vinalegt tækisheiti, viðburðarheiti og að ástandið sé nú hætt.
„Hjartsláttur“ skilaboð:
{ „device“:“%NAME%“, „alive“:“%DATE% %TIME%“ }
Þetta mun reglulega senda TCP eða UDP JSON skilaboð til tilgreinds netþjóns sem tilkynnir að HALO sé á lífi á tilgreindum tíma.
Skjöl / auðlindir
 |
Hugbúnaður s HALO Smart Sensor API Grunnhugbúnaður [pdfNotendahandbók HALO Smart Sensor API Grunnhugbúnaður |
