Softwer s HALO Smart Sensor API Softwer Bażiku
Quddiem
Dan id-dokument jiddeskrivi l-grupp ta 'faċilitajiet ta' l-Halo Smart Sensor magħruf kollettivament bħala l-API BAŻIKA, jew Interface ta 'Programmazzjoni ta' Applikazzjoni. Din id-diskussjoni hija maħsuba għall-użu minn programmaturi jew integraturi li huma interessati li jintegraw HALO Smart Sensors (HALOs) wieħed jew aktar ma' komponenti jew sistemi tas-softwer ta' parti terza (mhux IPVideo). B'mod ġenerali, l-API HALO hija maħsuba biex tittrasferixxi informazzjoni b'mod effiċjenti minn HALO fuq netwerk Ethernet konvenzjonali għall-programm estern. Biex tilħaq dan l-għan, l-API hija maqsuma fi tliet taqsimiet: Konnessjoni tas-Socket Mmexxija mill-Avvenimenti, Konnessjoni tas-Socket tat-Taħbit tal-Qalb, u Data tal-Avvenimenti URL. L-interface BACnet hija wkoll preżenti u koperta f'dokument separat.
Disinn API
L-API hija mfassla bl-użu ta 'formati standard tal-industrija bħal TCP/IP. HTTP, HTTPS, u JSON. Id-disinn ma jeħtieġ l-ebda teknika jew librerija speċjali jew proprjetarja li għandha tintuża fl-iżvilupp tal-programm jew l-applikazzjoni esterna. L-API hija flessibbli u tista 'tiġi kkonfigurata u pprogrammata biex twassal eżattament id-dejta meħtieġa u bl-aktar mod effiċjenti. Id-dettalji tat-tħaddim ta' kull waħda mit-taqsimiet ta' hawn fuq huma koperti fit-taqsimiet li ġejjin ta' din il-gwida.
Messaġġi Esterni
Din il-faċilità tintuża biex twassal twissijiet jew allarmi u data ta' Avveniment lil programm estern, sistema VMS, server, eċċ. meta Avveniment jiġi attivat (jiġi stabbilit). Messaġġi mhux obbligatorji jistgħu wkoll ikunu attivati biex jindikaw meta Avveniment jitneħħa (jiġi reset). Din il-kunsinna tista' ssir lil socket TCP/IP jew server HTTP/S f'ħin reali. Hemm firxa ta 'protokolli konfigurabbli b'kontenut customizable. L-awtentikazzjoni u l-kriptaġġ huma disponibbli.
Taħbit tal-qalb
Il-messaġġi tat-taħbit tal-qalb jintbagħtu f'intervall konfigurabbli (minflok meta jiġu attivati l-Avvenimenti) biex jipprovdu prova ta' live/disponibbiltà. Għandhom firxa simili ta' kapaċitajiet bħall-Messaġġi Esterni iżda tipikament ikunu kkonfigurati biex ikun fihom informazzjoni ġenerali dwar l-istat aktar milli dettalji dwar avveniment partikolari.
Dejta tal-Avveniment URL
Din il-faċilità hija disponibbli biss taħt NDA u għandha tintuża biss meta l-programm estern jeħtieġ aċċess għal kwalunkwe valuri, limiti u bnadar tal-istat tal-Avvenimenti. Din id-dejta ġeneralment tiġi rkuprata fuq talba mill-programm estern iżda mhux bi frekwenza għolja ħafna. Dan il-metodu ġeneralment iġib xi latenza meta tintuża rata ta' votazzjoni modesta. Ir-rati tipiċi tal-votazzjoni jvarjaw minn darba kull minuta għal darba kull 5 sekondi b'rata massima assoluta ta' darba kull sekonda. Dan il-metodu jista 'jintuża wkoll biex tiġi rkuprata data ta' appoġġ addizzjonali meta jiġi riċevut Avveniment (twissija).
Dettalji ta' Messaġġi Esterni
Sezzjoni tal-HALO web Interfaċċa Popup ta 'integrazzjoni jipprovdi għall-konfigurazzjoni ta' konnessjoni waħda ta 'parti 3 fejn valuri varji jistgħu jintbagħtu lil socket TCP remot jew server HTTP/HTTPS. Post holders (tokens) jintużaw biex jiddaħħlu valuri ħajjin fit-test trażmess. Għalkemm ittikkettat "Messaġġi Esterni," dan il-kanal jista 'jintuża għal kważi kull skop li jirrikjedi triggers ta' Avvenimenti f'ħin reali, mogħtija b'mod attiv minn HALO. Dan l-arranġament huwa pjuttost flessibbli għaliex selezzjonijiet fuq l-"Azzjonijiet" jiddeterminaw liema Avvenimenti HALO jittrasmettu permezz ta 'dan il-kanal.
Fil-modalità HTTP, l-Issettja u Irrisettja Strings huma l- URLs li għandhom jiġu mdaħħla u fformattjati kif meħtieġ mis-server tad-destinazzjoni mixtieqa. Kamp ta' Utent u Password jista' jintuża għall-awtentikazzjoni. Ara l-modalità HTTP hawn taħt.
Fil-modalità TCP, is-Set u Irrisettja Strings huma biss id-dejta ta 'messaġġ wieħed li jintbagħat lis-socket TCP li jirċievi. Jistgħu jiġu fformattjati kif meħtieġ mid-destinazzjoni. Id-destinazzjoni hija speċifikata fl-oqsma Indirizz u Port. Ara TCP Mode hawn taħt.
Għal kwalunkwe modalità, l-istatus mill-messaġġ l-aktar reċenti jintwera li jista 'jgħin biex jiffissa konnessjoni jew kwistjonijiet oħra. Tista' tuża l-buttuni tat-TEST tal-Avveniment fuq il-popup Azzjonijiet biex tisforza messaġġ:
Globali Mixgħul/Mitfi għal Issettja jew Irrisettja għandu jkun Mixgħul biex jippermetti dawk it-tipi ta' messaġġi. Ir-reset ħafna drabi ma jintużax għaliex il-bidu ta' Avveniment biss huwa ta' interess, iżda dan jista' jvarja. Kull Avveniment jista’ jispeċifika b’mod indipendenti jekk hux se jużax jew il-messaġġ Set jew Irrisettja fuq il-popup Azzjonijiet. Il-buttuni tal-boċċa tal-għajnejn se juru rappreżentazzjoni approssimattiva ta 'dak li jintbagħat wara s-sostituzzjonijiet tal-kliem kjavi u l-ifformattjar. Irrepeti Holdoff jista 'jintuża biex throttle messaġġi frekwenti billi jittardja qabel ma jista' jintbagħat ieħor. Dan isir b'mod indipendenti għal kull Avveniment. HALO għandu ħin ta' żamma inkorporat għal avvenimenti ta' 15-il sekonda biex jipprevjeni li l-Avvenimenti jerġgħu jibdew malajr. Jekk ridt tiżgura li mhux aktar minn Avveniment 1 ta' tip jintbagħat kull minuta, tista' tissettja Repeat Holdoff għal 60 (sekonda).
Dettalji tat-taħbit tal-qalb
It-trażmissjonijiet Heartbeat jiffunzjonaw b'mod simili għal dak ta' hawn fuq ħlief li m'hemm l-ebda interazzjoni mal-paġna Azzjonijiet. Minflok, it-trażmissjoni tal-Heartbeat isseħħ fuq bażi regolari kif ikkonfigurat bil-field Interval, Fil-mod HTTP, is-Set u Irrisettja Strings huma l- URLs li għandhom jiġu mdaħħla u fformattjati kif meħtieġ mis-server tad-destinazzjoni mixtieqa. Kamp ta' Utent u Password jista' jintuża għall-awtentikazzjoni. Ara l-modalità HTTP hawn taħt.
Filwaqt li l-għan primarju tal-Heartbeat huwa li jipprovdi prova tal-ħajja ta 'HALO Smart Sensor għal applikazzjoni remota, dan il-messaġġ jista' jintuża wkoll biex jittrasmetti sensuri magħżula jew informazzjoni attwali dwar l-istat tal-Avveniment. L-example hawn fuq tibgħat parametru ta 'sekwenza twila bil- URL li jinkludu l-isem Halo, maġġoranza tal-valuri tas-sensuri, u fl-aħħar Triggered=%ACTIVE% li jista 'jkun vojt jew lista ta' Avvenimenti attivati bħalissa.
Modalità HTTP (u HTTPS).
Il-kordi tal-Messaġġi Esterni u tat-Taħbit tal-Qalb jistgħu jkunu http: jew https: URLs kif meħtieġ. Il-mogħdija u l-parametri jistgħu jiddaħħlu kif meħtieġ mis-server tad-destinazzjoni. Kliem prinċipali bħal %NAME% (isem tat-tagħmir HALO) jew %EID% (id tal-avveniment) jistgħu jiddaħħlu kif meħtieġ u jiġu sostitwiti b'dejta rispettiva meta jintbagħat il-messaġġ. Lista ta 'kliem kjavi użati komunement huma murija għal referenza malajr.
Il- URL mogħdija jista' jkun fiha kliem ewlieni kif ukoll il-parametri għall- URL. Il-parametri jistgħu jkunu pari ISEM=VALUR jew oġġett JSON, jew format personalizzat skont is-server tad-destinazzjoni. Eżamples għall-Messaġġi Esterni jinkludu %EID% biex jindikaw l-Avveniment li wassal:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples għal Heartbeat jistgħu jżidu %ACTIVE% (Avvenimenti attivati bħalissa) jew valur tas-sensor:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Il-valuri %SENSOR:...% jużaw l-ismijiet misjuba fl-intestaturi tal-kolonna tas-sensorju tal-lemin fil-log evtYYYYMMDD.csv files. Dawn huma tipikament:
Jekk is-server tad-destinazzjoni jippreferi HTTP PUT jew POST minflok GET talbiet, inti tista 'prefiss il- URL ma PUT: jew POST:. Indipendentament, tista 'żżid tagħbija JSON li hija popolari ma' ħafna servers billi żżid il-kelma prinċipali [JSONBODY] segwita minn oġġett ifformattjat JSON. Eżample:
PUT:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”event”:”%EID%”}
Il- URL jappoġġja l-indirizz IP tipiku (u l-IPv6) u l-għażliet tal-port u l-password tal-utent, jew tista’ tuża l-oqsma tal-Utent u tal-Password jekk meħtieġ tkun is-server tad-destinazzjoni għal metodi ta’ awtentikazzjoni bħal Basic jew Digest:
https://username:password@123.321.123.321:9876/event…
Modalità TCP
Il-Messaġġi Esterni u l-Strings ta' Taħbit tal-Qalb huma biss għad-dejta peress li l-oqsma Indirizz u Port jispeċifikaw id-destinazzjoni. L-Indirizz jappoġġja ismijiet, IPv4 u IPv6.
Is-sekwenza tista' tiġi fformattjata bħall-porzjonijiet tad-dejta tal-messaġġi HTTP deskritti hawn fuq, jew kif meħtieġ mis-server tad-destinazzjoni.
Examples għall-Messaġġi Esterni jinkludu %EID% biex jindikaw l-Avveniment li wassal:
location=%NAME%,avveniment=%EID%
{“location”:”:%NAME%”,”avveniment”:”%EID%”}
Examples għal Heartbeat jistgħu jżidu %ACTIVE% (Avvenimenti attivati bħalissa) jew valur tas-sensor:
location=%NAME%&Triggered=%ACTIVE%
{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Il-kaxxi ta’ kontroll fil-kolonni “Integration Set” u “Integration Reset” jiddeterminaw liema Avvenimenti jqanqlu l-bgħit. Aktar dwar is-setup ta' Avvenimenti u Azzjonijiet huwa disponibbli fil-Gwida tal-Amministratur ta' HALO.
Kunsinna ta' Messaġġi ta' Avvenimenti JSON
Xi żviluppaturi jippreferu jirċievu dejta tal-Avvenimenti fformattjata bħala JSON awto-tikkettat standard tal-industrija aktar milli test sempliċi ASCII peress li l-ewwel huwa parsed b'mod aktar affidabbli u aktar faċli. Fuq il-HALO web paġna "Messaġġi" tab, tista 'tforni messaġġi JSON fl-issettjar "Messaġġi Esterni" "Issettja String" u "Irrisettja String" u fil-"Heartbeat" "Messaġġ."
Examples:
Issettja String tas-Settings "Messaġġi Esterni":
{ “apparat”:”%NAME%”, “avveniment”:”%EID%”, “allarm”:”iva”}
Dan se jibgħat messaġġ wieħed TCP jew UDP JSON lis-server speċifikat li jirrapporta l-isem tal-apparat faċli, l-isem tal-avveniment u li għadu kemm beda.
Irrisettja String ta' Settings ta' “Messaġġi Esterni”:
{ “apparat”:”%NAME%”, “avveniment”:”%EID%”, “allarm”:”le”}
Dan se jibgħat messaġġ wieħed TCP jew UDP JSON lis-server speċifikat li jirrapporta l-isem tal-apparat faċli, l-isem tal-avveniment u li l-kundizzjoni issa waqfet.
Messaġġ “Taħbit tal-qalb”:
{ “device”:”%NAME%”, “alive”:”%DATE% %TIME%”}
Dan perjodikament jibgħat messaġġ TCP jew UDP JSON lis-server speċifikat li jirrapporta li l-HALO huwa ħaj fil-ħin indikat.
Dokumenti / Riżorsi
 |
Softwer s HALO Smart Sensor API Softwer Bażiku [pdfGwida għall-Utent HALO Smart Sensor API Softwer Bażiku |
