Softueri bazë HALO Smart Sensor API
Përpara
Ky dokument përshkruan grupin e pajisjeve të sensorit inteligjent Halo, i njohur kolektivisht si API BAZË, ose Ndërfaqja e programimit të aplikacionit. Ky diskutim synohet të përdoret nga programuesit ose integruesit që janë të interesuar të integrojnë një ose më shumë sensorë inteligjentë HALO (HALO) me komponentë ose sisteme të softuerit të palës së tretë (jo IPVideo). Në përgjithësi, HALO API synon të transferojë informacion në mënyrë efikase nga HALO përmes një rrjeti konvencional Ethernet në programin e jashtëm. Për të përmbushur këtë qëllim, API ndahet në tre seksione: Lidhja e prizës së drejtuar nga ngjarjet, Lidhja e prizës së rrahjeve të zemrës dhe të dhënat e ngjarjes URL. Ndërfaqja BACnet është gjithashtu e pranishme dhe e mbuluar në një dokument të veçantë.
Dizajn API
API është projektuar duke përdorur formate standarde të industrisë si TCP/IP. HTTP, HTTPS dhe JSON. Dizajni nuk kërkon ndonjë teknikë ose bibliotekë të veçantë ose të pronarit për t'u përdorur në zhvillimin e programit ose aplikacionit të jashtëm. API është fleksibël dhe mund të konfigurohet dhe programohet për të ofruar saktësisht të dhënat e kërkuara dhe në mënyrën më efikase. Detajet e funksionimit të secilit prej seksioneve të mësipërme trajtohen në seksionet vijuese të këtij udhëzuesi.
Mesazhimi i jashtëm
Ky mjet përdoret për të dhënë sinjalizime ose alarme dhe të dhëna ngjarjesh në një program të jashtëm, një sistem VMS, server, etj. kur aktivizohet (caktohet) një Ngjarje. Mesazhet opsionale mund të aktivizohen gjithashtu për të sinjalizuar kur një Ngjarje pastrohet (rivendoset). Ky dërgim mund të bëhet në një prizë TCP/IP ose server HTTP/S në kohë reale. Ekziston një sërë protokollesh të konfigurueshme me përmbajtje të personalizueshme. Autentifikimi dhe kriptimi janë të disponueshme.
Rrahjet e zemrës
Mesazhet e rrahjeve të zemrës dërgohen në një interval të konfigurueshëm (në vend se kur aktivizohen Ngjarjet) për të siguruar prova të drejtpërdrejta/disponueshmërisë. Ata kanë një gamë të ngjashme aftësish si mesazhet e jashtme, por zakonisht do të konfiguroheshin që të përmbajnë informacione të gjendjes së përgjithshme dhe jo detaje për një ngjarje të veçantë.
Të dhënat e ngjarjes URL
Kjo pajisje është e disponueshme vetëm nën një NDA dhe duhet të përdoret vetëm kur programi i jashtëm kërkon qasje në të gjitha vlerat, pragjet e ngjarjeve dhe flamujt e shtetit. Këto të dhëna përgjithësisht merren sipas kërkesës nga programi i jashtëm, por jo me një frekuencë shumë të lartë. Kjo metodë në përgjithësi shkakton njëfarë vonese kur përdoret një normë votimi modeste. Normat tipike të votimit variojnë nga një herë në minutë në një herë në 5 sekonda me një shpejtësi maksimale absolute një herë në sekondë. Kjo metodë mund të përdoret gjithashtu për të tërhequr të dhëna shtesë mbështetëse kur merret një Ngjarje (lajmërim).
Detajet e mesazheve të jashtme
Një pjesë e HALO web Një dritare kërcyese e integrimit të ndërfaqes siguron konfigurimin e një lidhjeje të vetme të palës së tretë ku vlera të ndryshme mund të dërgohen në një prizë TCP në distancë ose në një server HTTP/HTTPS. Mbajtësit e vendeve (shenjat) përdoren për të futur vlera të drejtpërdrejta në tekstin e transmetuar. Edhe pse etiketuar "Mesazhet e jashtme", ky kanal mund të përdoret pothuajse për çdo qëllim që kërkon aktivizues të ngjarjeve në kohë reale, të ofruara në mënyrë aktive nga HALO. Ky rregullim është mjaft fleksibël sepse përzgjedhjet në "Veprimet" përcaktojnë se cilat Ngjarje HALO transmetojnë përmes këtij kanali.
Në modalitetin HTTP, vargjet Set dhe Reset janë URLs që duhet të futen dhe të formatohen siç kërkohet nga serveri i dëshiruar i destinacionit. Një fushë Përdoruesi dhe Fjalëkalimi mund të përdoret për vërtetim. Shikoni modalitetin HTTP më poshtë.
Në modalitetin TCP, vargjet Set dhe Reset janë vetëm të dhënat e një mesazhi të vetëm që dërgohet në prizën TCP marrëse. Ato mund të formatohen sipas nevojës nga destinacioni. Destinacioni specifikohet në fushat Adresa dhe Port. Shihni modalitetin TCP më poshtë.
Për cilindo modalitet, shfaqet statusi nga mesazhi më i fundit i cili mund të ndihmojë në rregullimin e lidhjes ose çështje të tjera. Ju mund të përdorni butonat TEST i ngjarjeve në dritaren kërcyese Veprimet për të detyruar një mesazh:
Global On/Off for Set ose Reset duhet të jetë Aktiv për të aktivizuar ato lloj mesazhesh. Rivendosja shpesh nuk përdoret sepse vetëm fillimi i një Ngjarje është me interes, por kjo mund të ndryshojë. Çdo Ngjarje mund të specifikojë në mënyrë të pavarur nëse do të përdorë mesazhin Set ose Reset në dritaren kërcyese Veprimet. Butonat e syrit do të shfaqin një paraqitje të përafërt të asaj që dërgohet pas zëvendësimit dhe formatimit të fjalëve kyçe. Repeat Holdoff mund të përdoret për të frenuar mesazhet e shpeshta duke vonuar përpara se të dërgohet një tjetër. Kjo bëhet në mënyrë të pavarur për ngjarje. HALO ka një kohë të integruar të pritjes për ngjarjet prej 15 sekondash për të parandaluar rikthimin e shpejtë të Ngjarjeve. Nëse dëshironi të siguroni që të dërgohet jo më shumë se 1 ngjarje e një lloji në minutë, mund ta vendosni Repeat Holdoff në 60 (sekonda).
Detaje të rrahjeve të zemrës
Transmetimet e rrahjeve të zemrës funksionojnë në mënyrë të ngjashme me sa më sipër, përveç se nuk ka asnjë ndërveprim me faqen Veprimet. Në vend të kësaj, transmetimi i rrahjeve të zemrës ndodh rregullisht siç është konfiguruar me fushën e Intervalit, në modalitetin HTTP, vargjet Set dhe Reset janë URLs që duhet të futen dhe të formatohen siç kërkohet nga serveri i dëshiruar i destinacionit. Një fushë Përdoruesi dhe Fjalëkalimi mund të përdoret për vërtetim. Shikoni modalitetin HTTP më poshtë.
Ndërsa qëllimi kryesor i rrahjeve të zemrës është të sigurojë prova të jetës së një sensori inteligjent HALO në një aplikacion në distancë, ky mesazh mund të përdoret gjithashtu për të transmetuar sensorë të zgjedhur ose informacion aktual të gjendjes së ngjarjes. Ishample më sipër dërgon një parametër të vargut të gjatë me URL që përfshijnë emrin Halo, shumicën e vlerave të sensorit dhe së fundi Triggered=%ACTIVE% që mund të jetë bosh ose një listë e ngjarjeve të aktivizuara aktualisht.
Modaliteti HTTP (dhe HTTPS).
Vargjet e mesazheve të jashtme dhe të rrahjeve të zemrës mund të jenë http: ose https: URLs sipas nevojës. Shtegu dhe parametrat mund të futen sipas nevojës nga serveri i destinacionit. Fjalë kyçe si %NAME% (emri i pajisjes HALO) ose %EID% (ID-ja e ngjarjes) mund të futen sipas nevojës dhe do të zëvendësohen me të dhënat përkatëse kur të dërgohet mesazhi. Një listë e fjalë kyçe të përdorura zakonisht shfaqet për referencë të shpejtë.
Të URL shtegu mund të përmbajë fjalë kyçe si dhe parametra të URL. Parametrat mund të jenë çifte NAME=VALUE ose një objekt JSON, ose një format i personalizuar në varësi të serverit të destinacionit. p.shampLejet për Mesazhimin e Jashtëm do të përfshinin %EID% për të treguar ngjarjen që shkaktoi:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
ExampLejet për rrahjet e zemrës mund të shtojnë %ACTIVE% (Ngjarje të aktivizuara aktualisht) ose një vlerë sensori:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Vlerat %SENSOR:…% përdorin emrat që gjenden në titujt e kolonës së sensorit të djathtë në regjistrin evtYYYYMMDD.csv files. Zakonisht ato janë:
Nëse serveri i destinacionit preferon HTTP PUT ose POST në vend të kërkesave GET, mund të vendosni parashtesë URL me PUT: ose POST:. Në mënyrë të pavarur, mund të shtoni një ngarkesë JSON e cila është e popullarizuar me shumë serverë duke shtuar fjalën kyçe [JSONBODY] e ndjekur nga një objekt i formatuar JSON. p.shampe:
PUT:https://server.com/event[JSONBODY]{“lokacioni”:”%NAME%”,”ngjarja”:”%EID%”}
Të URL mbështet adresën tipike IP (dhe IPv6) dhe opsionet e portit dhe fjalëkalimit të përdoruesit, ose mund të përdorni fushat Përdorues dhe Fjalëkalim nëse është e nevojshme të jetë serveri i destinacionit për metodat e vërtetimit si Basic ose Digest:
https://username:password@123.321.123.321:9876/event…
Modaliteti TCP
Vargjet e mesazheve të jashtme dhe të rrahjeve të zemrës janë vetëm për të dhëna pasi fushat Adresa dhe Porta specifikojnë destinacionin. Adresa mbështet emrat, IPv4 dhe IPv6.
Vargu mund të formatohet si pjesët e të dhënave të mesazheve HTTP të përshkruara më sipër, ose siç kërkohet nga serveri i destinacionit.
ExampLejet për Mesazhimin e Jashtëm do të përfshinin %EID% për të treguar ngjarjen që shkaktoi:
vendndodhja=%NAME%,ngjarja=%EID%
{“lokacioni”:”:%NAME%”,”ngjarja”:”%EID%”}
ExampLejet për rrahjet e zemrës mund të shtojnë %ACTIVE% (Ngjarje të aktivizuara aktualisht) ose një vlerë sensori:
vendndodhja=%NAME%&Triggered=%ACTIVE%
{“lokacioni”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Kutitë e kontrollit në kolonat "Set i Integrimit" dhe "Rivendosja e Integrimit" përcaktojnë se cilat Ngjarje shkaktojnë dërgimin. Më shumë për konfigurimin e Ngjarjeve dhe Veprimeve është në dispozicion në Udhëzuesin e Administratorit HALO.
Dorëzimi i mesazheve të ngjarjeve JSON
Disa zhvillues preferojnë të marrin të dhëna të Ngjarjeve të formatuara si standarde të industrisë të vetë-etiketuara JSON sesa tekst të thjeshtë ASCII pasi i pari analizohet më me besueshmëri dhe më lehtë. Në HALO web skeda e faqes "Mesazhet", mund të jepni mesazhe JSON në cilësimet "Mesazhe të jashtme" "Cilëso vargun" dhe "Rivendos vargun" dhe në "Rrahjet e zemrës" "Mesazhi".
Examples:
Vendosja e vargut të cilësimeve të "Mesazhet e jashtme":
{ "pajisja":"%NAME%", "ngjarja":"%EID%", "alarm":"po" }
Kjo do të dërgojë një mesazh të vetëm TCP ose UDP JSON në serverin e specifikuar që raporton emrin e pajisjes miqësore, emrin e ngjarjes dhe që sapo ka filluar.
Rivendosja e vargut të cilësimeve të "Mesazhet e jashtme":
{ "pajisja":"%NAME%", "ngjarja":"%EID%", "alarm":"jo" }
Kjo do të dërgojë një mesazh të vetëm TCP ose UDP JSON në serverin e specifikuar që raporton emrin e pajisjes miqësore, emrin e ngjarjes dhe se gjendja tani është ndalur.
Mesazhi "Rrahje zemre":
{ "pajisja":"%NAME%", "i gjallë":"%DATE% %TIME%" }
Kjo do të dërgojë periodikisht një mesazh TCP ose UDP JSON në serverin e specifikuar duke raportuar se HALO është gjallë në kohën e treguar.
Dokumentet / Burimet
 |
Softueri bazë HALO Smart Sensor API [pdfUdhëzuesi i përdoruesit Softueri themelor HALO Smart Sensor API |
