Softver s HALO Smart Sensor API Osnovni softver
Naprijed
Ovaj dokument opisuje skupinu značajki Halo Smart Sensora poznatih pod zajedničkim nazivom BASIC API ili Application Programming Interface. Ova je rasprava namijenjena programerima ili integratorima koji su zainteresirani za integraciju jednog ili više HALO pametnih senzora (HALO) sa softverskim komponentama ili sustavima treće strane (ne-IPVideo). Općenito, HALO API namijenjen je učinkovitom prijenosu informacija iz HALO-a preko konvencionalne Ethernet mreže u vanjski program. Kako bi se postigao ovaj cilj, API je podijeljen u tri odjeljka: Socket veza vođena događajima, Heartbeat Socket veza i Podaci o događajima URL. BACnet sučelje je također prisutno i obrađeno u zasebnom dokumentu.
Dizajn API-ja
API je dizajniran pomoću industrijskih standardnih formata kao što je TCP/IP. HTTP, HTTPS i JSON. Dizajn ne zahtijeva nikakve posebne ili vlasničke tehnike ili biblioteke koje bi se koristile u razvoju vanjskog programa ili aplikacije. API je fleksibilan i može se konfigurirati i programirati za isporuku točno potrebnih podataka i to na najučinkovitiji način. Pojedinosti o radu svakog od gornjih odjeljaka opisane su u sljedećim odjeljcima ovog vodiča.
Vanjsko slanje poruka
Ova se mogućnost koristi za isporuku upozorenja ili alarma i podataka o događaju vanjskom programu, VMS sustavu, poslužitelju itd. kada se događaj pokrene (postavi). Opcijske poruke također se mogu omogućiti da signaliziraju kada se događaj poništi (poništi). Ova isporuka može se izvršiti na TCP/IP utičnicu ili HTTP/S poslužitelj u stvarnom vremenu. Postoji niz konfigurabilnih protokola s prilagodljivim sadržajem. Dostupni su autentifikacija i enkripcija.
Otkucaji srca
Poruke otkucaja šalju se u intervalima koji se mogu konfigurirati (umjesto kada se pokreću događaji) kako bi se pružio dokaz o uživo/dostupnosti. Imaju sličan raspon mogućnosti kao i vanjska razmjena poruka, ali obično bi bile konfigurirane da sadrže informacije o općem stanju, a ne pojedinosti o određenom događaju.
Podaci o događajima URL
Ova je mogućnost dostupna samo prema NDA-u i trebala bi se koristiti samo kada vanjski program zahtijeva pristup svim vrijednostima događaja, pragovima i oznakama stanja. Ove podatke vanjski program općenito dohvaća na zahtjev, ali ne vrlo često. Ova metoda općenito uzrokuje određeno kašnjenje kada se koristi skromna stopa anketiranja. Uobičajene stope anketiranja kreću se od jednom u minuti do jednom u 5 sekundi s apsolutnom maksimalnom stopom od jednom u sekundi. Ova se metoda također može koristiti za dohvaćanje dodatnih popratnih podataka kada se primi događaj (upozorenje).
Pojedinosti o vanjskim porukama
Dio HALO-a web Skočni prozor za integraciju sučelja omogućuje konfiguraciju pojedinačne veze treće strane gdje se različite vrijednosti mogu slati na udaljenu TCP utičnicu ili HTTP/HTTPS poslužitelj. Držači mjesta (tokeni) koriste se za umetanje živih vrijednosti u preneseni tekst. Iako je označen kao "Vanjsko slanje poruka", ovaj se kanal može koristiti za gotovo sve svrhe koje zahtijevaju okidače događaja u stvarnom vremenu, koje aktivno isporučuje HALO. Ovaj raspored je prilično fleksibilan jer odabiri na “Radnje” određuju koji će se HALO događaji prenositi ovim kanalom.
U HTTP načinu rada nizovi za postavljanje i poništavanje su URLs koji se moraju unijeti i formatirati prema zahtjevima željenog odredišnog poslužitelja. Polja za korisnika i zaporku mogu se koristiti za provjeru autentičnosti. Pogledajte HTTP način rada u nastavku.
U TCP načinu rada, nizovi za postavljanje i poništavanje samo su podaci jedne poruke koja se šalje primateljskoj TCP utičnici. Mogu se formatirati prema potrebi odredišta. Odredište je navedeno u poljima Adresa i Port. Pogledajte TCP način u nastavku.
Za oba načina prikazuje se status iz najnovije poruke što može pomoći pri popravljanju veze ili drugim problemima. Možete upotrijebiti gumbe Event TEST na skočnom prozoru Radnje da prisilite poruku:
Globalno uključivanje/isključivanje za postavljanje ili ponovno postavljanje mora biti uključeno kako bi se omogućile te vrste poruka. Poništavanje se često ne koristi jer je od interesa samo početak događaja, ali to može varirati. Svaki događaj može zasebno odrediti hoće li koristiti poruku Postavi ili Poništi na skočnom prozoru Radnje. Gumbi očne jabučice prikazat će grubi prikaz onoga što se šalje nakon zamjene ključnih riječi i oblikovanja. Repeat Holdoff može se koristiti za prigušivanje čestih poruka odgodom prije slanja nove. To se radi neovisno o događaju. HALO ima ugrađeno vrijeme čekanja za događaje od 15 sekundi kako bi se spriječilo brzo ponovno pokretanje događaja. Ako želite osigurati da se ne šalje više od 1 događaja određene vrste u minuti, možete postaviti Repeat Holdoff na 60 (sekundi).
Detalji otkucaja srca
Prijenosi otkucaja srca funkcioniraju na sličan način kao gore osim što nema interakcije sa stranicom Radnje. Umjesto toga, prijenos otkucaja srca događa se redovito kako je konfigurirano s poljem Interval. U HTTP načinu, nizovi za postavljanje i poništavanje su URLs koji se moraju unijeti i formatirati prema zahtjevima željenog odredišnog poslužitelja. Polja za korisnika i zaporku mogu se koristiti za provjeru autentičnosti. Pogledajte HTTP način rada u nastavku.
Dok je primarna svrha otkucaja srca pružanje dokaza o životu HALO pametnog senzora udaljenoj aplikaciji, ova se poruka također može koristiti za prijenos odabranih senzora ili informacije o trenutnom stanju događaja. Bivšiample gore šalje dugi parametar niza s URL koji uključuju naziv Halo, većinu vrijednosti senzora i na kraju Triggered=%ACTIVE% koji može biti prazan ili popis trenutno aktiviranih događaja.
HTTP (i HTTPS) način
Nizovi za vanjske poruke i otkucaje srca mogu biti http: ili https: URLs po potrebi. Put i parametri mogu se unijeti prema potrebi odredišnog poslužitelja. Ključne riječi poput %NAME% (naziv HALO uređaja) ili %EID% (ID događaja) mogu se umetnuti prema potrebi i bit će zamijenjene odgovarajućim podacima kada se poruka pošalje. Popis često korištenih ključnih riječi prikazan je za brzu referencu.
The URL put može sadržavati ključne riječi kao i parametre za URL. Parametri mogu biti parovi NAME=VALUE ili JSON objekt ili prilagođeni format ovisno o odredišnom poslužitelju. nprampdatoteke za vanjsko slanje poruka uključivale bi %EID% za označavanje događaja koji je pokrenuo:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Exampdatoteke za otkucaje srca mogu dodati %ACTIVE% (trenutačno pokrenuti događaji) ili vrijednost senzora:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Vrijednosti %SENSOR:…% koriste imena koja se nalaze u naslovima stupaca desnog senzora u evtYYYYMMDD.csv zapisniku files. Obično su:
Ako odredišni poslužitelj preferira HTTP PUT ili POST umjesto GET zahtjeva, možete dodati prefiks URL s PUT: ili POST:. Neovisno, možete dodati JSON korisni teret koji je popularan kod mnogih poslužitelja dodavanjem ključne riječi [JSONBODY] nakon koje slijedi JSON formatirani objekt. nprampono:
PUT:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”event”:”%EID%”}
The URL podržava tipičnu IP adresu (i IPv6) i opcije porta i korisničke lozinke ili možete koristiti polja Korisnik i Lozinka ako je potrebno kao odredišni poslužitelj za metode provjere autentičnosti kao što su Osnovna ili Sažeta:
https://username:password@123.321.123.321:9876/event…
TCP način
Nizovi za vanjske poruke i otkucaje srca služe samo za podatke budući da polja Adresa i Port određuju odredište. Adresa podržava imena, IPv4 i IPv6.
Niz se može oblikovati kao gore opisani dijelovi podataka HTTP poruka ili kako to zahtijeva odredišni poslužitelj.
Exampdatoteke za vanjsko slanje poruka uključivale bi %EID% za označavanje događaja koji je pokrenuo:
lokacija=%NAME%,event=%EID%
{“location”:”:%NAME%”,”event”:”%EID%”}
Exampdatoteke za otkucaje srca mogu dodati %ACTIVE% (trenutačno pokrenuti događaji) ili vrijednost senzora:
lokacija=%NAME%&Triggered=%ACTIVE%
{“lokacija”:”:%IME%”,”NH3”:%OSENZOR:NH3%}
Potvrdni okviri u stupcima “Integration Set” i “Integration Reset” određuju koji događaji pokreću slanje. Više o postavljanju događaja i radnji dostupno je u HALO Administratorskom vodiču.
Isporuka JSON poruka događaja
Neki razvojni programeri radije primaju podatke o događajima formatirane kao industrijski standardni samooznačeni JSON umjesto običnog ASCII teksta jer je prvi pouzdaniji i lakši za analizu. Na HALO web stranici kartice “Poruke”, možete unijeti JSON poruke u postavkama “Vanjsko slanje poruka” “Postavi niz” i “Poništi niz” i u “Otkucaj srca” “Poruka”.
Examples:
Niz postavki postavki "Vanjskog slanja poruka":
{ “uređaj”:”%NAME%”, “event”:”%EID%”, “alarm”:”da” }
Ovo će poslati jednu TCP ili UDP JSON poruku navedenom poslužitelju koja izvješćuje o prijateljskom nazivu uređaja, nazivu događaja i da je upravo pokrenut.
Niz za poništavanje postavki "Vanjski razmjena poruka":
{ “uređaj”:”%NAME%”, “event”:”%EID%”, “alarm”:”ne” }
Ovo će poslati jednu TCP ili UDP JSON poruku navedenom poslužitelju koja izvješćuje o prijateljskom nazivu uređaja, nazivu događaja i da je stanje sada zaustavljeno.
Poruka "Otkucaji srca":
{ “uređaj”:”%NAME%”, “živ”:”%DATUM% %TIME%” }
Ovo će povremeno slati TCP ili UDP JSON poruku navedenom poslužitelju izvješćujući da je HALO živ u navedeno vrijeme.
Dokumenti / Resursi
 |
Softver s HALO Smart Sensor API Osnovni softver [pdf] Korisnički priručnik Osnovni softver HALO Smart Sensor API |
