HALO Smart Sensor API softwarearen oinarrizko softwarea
Aurrera
Dokumentu honek OINARRIZKO API edo Aplikazioen Programazio Interfaze bezala ezagutzen den Halo Smart Sensor-aren instalazioen multzoa deskribatzen du. Eztabaida hau HALO Smart Sentsore (HALO) bat edo gehiago integratzeko interesa duten programatzaile edo integratzaileek hirugarrenen (IPVideo ez diren) software osagai edo sistemekin integratzeko pentsatuta dago. Oro har, HALO APIaren helburua da informazioa modu eraginkorrean transferitzea HALOtik ohiko Ethernet sare baten bidez kanpoko programara. Helburu hori betetzeko, APIa hiru ataletan banatzen da: Gertaera gidatutako socket konexioa, Heartbeat socket konexioa eta gertaeren datuak URL. BACnet interfazea ere presente dago eta aparteko dokumentu batean estalita dago.
API Diseinua
APIa industriako formatu estandarrak erabiliz diseinatu da, hala nola TCP/IP. HTTP, HTTPS eta JSON. Diseinuak ez du eskatzen kanpoko programa edo aplikazioaren garapenean erabiltzeko teknika edo liburutegi berezirik edo jabedunik. APIa malgua da eta behar diren datuak zehatz-mehatz eta modu eraginkorrenean emateko konfiguratu eta programatu daiteke. Aurreko atal bakoitzaren funtzionamenduaren xehetasunak gida honen hurrengo ataletan azaltzen dira.
Kanpoko mezularitza
Instalazio hau alertak edo alarmak eta Gertaeren datuak kanpoko programa bati, VMS sistemari, zerbitzariari eta abarrei emateko erabiltzen da Gertaera bat abiarazten denean (konfiguratuta dagoenean). Aukerako mezuak ere gaitu daitezke Gertaera bat garbitzen denean (berrezartzen den) seinalatzeko. Bidalketa hau TCP/IP socket edo HTTP/S zerbitzari batera egin daiteke denbora errealean. Eduki pertsonalizagarriak dituzten protokolo konfiguragarri ugari daude. Autentifikazioa eta enkriptatzea eskuragarri daude.
Bihotz-taupadak
Bihotz-taupaden mezuak konfigura daitekeen tarte batean bidaltzen dira (gertaerak abiarazten direnean ordez) zuzeneko/eskuragarritasunaren froga emateko. Kanpoko mezularitzaren antzeko gaitasun sorta dute, baina normalean egoeraren informazio orokorra edukitzeko konfiguratuko lirateke gertaera jakin bati buruzko xehetasunak baino.
Gertaeren datuak URL
Instalazio hau NDA baten arabera bakarrik dago erabilgarri eta kanpoko programak Gertaeren balio, atalase eta estatu-bandera guztietarako sarbidea eskatzen duenean soilik erabili behar da. Datu hauek, oro har, kanpoko programak eskatuta eskuratzen ditu baina ez oso maiztasun handian. Metodo honek, oro har, nolabaiteko latentzia izaten du galdeketa-tasa apala erabiltzen denean. Bozketa-tasa tipikoak minutuko behin eta 5 segundoko behin bitartekoak dira, segundoko behin gehienezko tasa absolutuarekin. Metodo hau laguntza-datu osagarriak berreskuratzeko ere erabil daiteke Gertaera (alerta) jasotzen denean.
Kanpoko mezularitzaren xehetasunak
HALOren atal bat web interfazea Integrazio popup-ak hirugarrenen konexio bakar baten konfigurazioa eskaintzen du, non hainbat balio urruneko TCP socket batera edo HTTP/HTTPS zerbitzari batera bidal daitezkeen. Leku-markak (tokens) erabiltzen dira zuzeneko balioak txertatzeko transmititutako testuan. "Kanpoko mezularitza" etiketatua izan arren, kanal hau ia edozein helburutarako erabil daiteke HALOk aktiboki emandako gertaeren abiarazleak behar dituen denbora errealean. Antolaketa hau nahiko malgua da, "Ekintzen" aukerak zehazten baitu zein HALO Gertaerek kanal honen bidez transmititzen duten.
HTTP moduan, ezarri eta berrezarri kateak dira URLnahi den helmugako zerbitzariak eskatzen duen moduan sartu eta formateatu behar diren s. Erabiltzailea eta pasahitza eremua erabil daiteke autentifikaziorako. Ikus behean HTTP modua.
TCP moduan, ezarri eta berrezarri kateak hartzaile TCP socketera bidaltzen den mezu bakar baten datuak baino ez dira. Helmugaren arabera formateatu daitezke. Helbidea Helbidea eta Portua eremuetan zehazten da. Ikusi TCP modua behean.
Modu batean zein bestean, azken mezuaren egoera bistaratzen da eta horrek konexioa edo beste arazo batzuk konpontzen lagun dezake. Ekintzak popup-eko Gertaera TEST botoiak erabil ditzakezu mezu bat behartzeko:
Aktibatu/Desaktibatu globala Ezarri edo Berrezarrirako Aktibatuta egon behar da mezu mota horiek gaitzeko. Berrezarri askotan ez da erabiltzen Gertaera baten agerpena bakarrik interesgarria delako, baina hori alda daiteke. Gertaera bakoitzak modu independentean zehaztu dezake Ezarri edo Berrezarri mezua Ekintzen laster-leihoan erabiliko duen. Begi-botoiek gako-hitzak ordezkatu eta formateatu ondoren bidaltzen denaren irudikapen laburra erakutsiko dute. Repeat Holdoff maiz mezuak zapaltzeko erabil daiteke, beste bat bidali aurretik atzeratuz. Ekitaldi bakoitzeko modu independentean egiten da. HALOk 15 segundoko gertaeretarako atxikipen-denbora integratua du, Gertaerak azkar berriro abiarazteko saihesteko. Mota bateko gertaera bat baino gehiago bidaltzen ez dela ziurtatu nahi bazenu minutuko, Repeat Holdoff 1 (segundo) ezar dezakezu.
Bihotz-taupadaren xehetasunak
Bihotz-taupadaren transmisioek aurrekoaren antzera funtzionatzen dute, Ekintzak orriarekin ez dagoela interakziorik izan ezik. Horren ordez, Bihotz-taupadak transmisioa aldizka gertatzen da Tarte eremuarekin konfiguratutako moduan, HTTP moduan, Ezarri eta Berrezarri kateak dira. URLnahi den helmugako zerbitzariak eskatzen duen moduan sartu eta formateatu behar diren s. Erabiltzailea eta pasahitza eremua erabil daiteke autentifikaziorako. Ikus behean HTTP modua.
Heartbeat-en helburu nagusia HALO Smart Sensor baten bizitzaren froga urruneko aplikazio bati eskaintzea den arren, mezu hau hautatutako sentsoreak edo gertaeren egoeraren informazioa transmititzeko ere erabil daiteke. Adibampgoiko fitxategiak kate luzeko parametro bat bidaltzen du URL Halo izena, sentsoreen balio gehienak eta, azkenik, Triggered=%ACTIVE% hutsik egon liteke edo unean abiarazitako Gertaeren zerrenda.
HTTP (eta HTTPS) modua
Kanpoko mezularitza eta taupadaren kateak http: edo https izan daitezke: URLbehar den moduan. Ibilbidea eta parametroak helmugako zerbitzariak behar bezala sar ditzake. %NAME% (HALO gailuaren izena) edo %EID% (Event id) bezalako gako-hitzak behar bezala txerta daitezke eta dagozkien datuekin ordezkatuko dira mezua bidaltzen denean. Erabiltzen diren gako-hitzen zerrenda bat erakusten da azkar erreferentzia izateko.
The URL bideak gako-hitzak eta parametroak izan ditzake URL. Parametroak NAME=VALUE bikoteak edo JSON objektu bat izan daitezke, edo formatu pertsonalizatua helmuga zerbitzariaren arabera. AdibampKanpoko mezularitzarako fitxategiak %EID% sartuko luke abiarazi duen Gertaera adierazteko:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
ExampHeartbeat-erako fitxategiek % ACTIVE% (gaur egun abiarazitako Gertaerak) edo sentsore-balio bat gehi dezakete:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
%SENSOR:...% balioek evtYYYYMMDD.csv erregistroko eskuineko sentsore zutabeen goiburuetan aurkitutako izenak erabiltzen dituzte files. Normalean hauek dira:
Helmugako zerbitzariak HTTP PUT edo POST nahiago baditu GET eskaerak baino, aurrizkia egin dezakezu URL PUT: edo POST:-rekin. Era independentean, zerbitzari askotan ezaguna den JSON karga bat gehi dezakezu [JSONBODY] gako-hitza eta JSON formatuko objektu bat gehituz. Adibample:
JARRI:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”event”:”%EID%”}
The URL IP helbidea (eta IPv6) eta ataka eta erabiltzailearen pasahitz aukera tipikoak onartzen ditu, edo Erabiltzailea eta Pasahitza eremuak erabil ditzakezu, behar izanez gero, oinarrizko edo Digest bezalako autentifikazio metodoetarako helmugako zerbitzaria izan:
https://username:password@123.321.123.321:9876/event…
TCP modua
Kanpoko Mezularitza eta Bihotz-taupadak datuetarako soilik dira Helbidea eta Portua eremuek helmuga zehazten baitute. Helbideak izenak onartzen ditu, IPv4 eta IPv6.
Katea goian deskribatutako HTTP mezuen datu-zatien antzera formateatu daiteke edo helmugako zerbitzariak eskatzen duen moduan.
ExampKanpoko mezularitzarako fitxategiak %EID% sartuko luke abiarazi duen Gertaera adierazteko:
kokapena=%NAME%,gertaera=%EID%
{“location”:”:%NAME%”,”event”:”%EID%”}
ExampHeartbeat-erako fitxategiek % ACTIVE% (gaur egun abiarazitako Gertaerak) edo sentsore-balio bat gehi dezakete:
kokapena=%NAME%&Aktibatuta=%ACTIVE%
{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
"Integrazio-multzoa" eta "Integrazioa berrezarri" zutabetako kontrol-laukiek zehazten dute bidalketa abiarazten duten gertaerak. Gertaeren eta Ekintzen konfigurazioari buruzko informazio gehiago dago HALO Administratzailearen Gidan.
JSON gertaera-mezuak bidaltzea
Garatzaile batzuek nahiago dute JSON auto-etiketaturiko industria estandar gisa formateatutako Gertaeren datuak jasotzea ASCII testu arrunta baino lehena fidagarriagoa eta errazago analizatzen baita. HALO-n web orrialdean "Mezularitza" fitxan, JSON mezuak eman ditzakezu "Kanpoko mezularitza" ezarpenetan "Ezarri katea" eta "Berrezarri katea" eta "Bihotz-taupadak" "Mezua".
Examples:
"Kanpoko mezularitza" Ezarpenak Ezarri katea:
{ “gailu”:”%NAME%”, “gertaera”:”%EID%”, “alarma”:”bai” }
Honek TCP edo UDP JSON mezu bakarra bidaliko dio zehaztutako zerbitzariari gailuaren izena, gertaeren izena eta hasi berria dela jakinaraziz.
"Kanpoko mezularitza" ezarpenak berrezarri katea:
{ “gailu”:”%NAME%”, “gertaera”:”%EID%”, “alarma”:”ez” }
Honek TCP edo UDP JSON mezu bakarra bidaliko dio zehaztutako zerbitzariari gailuaren izena, gertaeren izena eta egoera gelditu dela jakinaraziz.
"Bihotz-taupadak" mezua:
{ “device”:”%NAME%”, “alive”:”%DATE% %TIME%” }
Honek aldian-aldian TCP edo UDP JSON mezu bat bidaliko dio zehaztutako zerbitzariari, adierazitako unean HALO bizirik dagoela jakinaraziz.
Dokumentuak / Baliabideak
 |
HALO Smart Sensor API softwarearen oinarrizko softwarea [pdfErabiltzailearen gida HALO Smart Sensor API oinarrizko softwarea |
