Lojisyèl la HALO Smart Sensor API Gid Itilizatè Lojisyèl Debaz

Kontni kache

1 Lojisyèl HALO Smart Sensor API lojisyèl de baz

2 Pi devan

9 HTTP (ak HTTPS) mòd

Lojisyèl HALO Smart Sensor API lojisyèl de baz

Pi devan

Dokiman sa a dekri gwoup enstalasyon Halo Smart Sensor yo ke yo rekonèt kolektivman kòm API BASIC, oswa Entèfas Programming Aplikasyon. Diskisyon sa a fèt pou itilize pa pwogramè oswa entegratè ki enterese nan entegre youn oswa plis HALO Smart Sensors (HALO) ak konpozan oswa sistèm lojisyèl 3yèm pati (ki pa IPVideo). An jeneral, API HALO a gen entansyon transfere enfòmasyon avèk efikasite soti nan HALO sou yon rezo Ethernet konvansyonèl nan pwogram ekstèn lan. Pou akonpli objektif sa a, API a divize an twa seksyon: Koneksyon Socket Kondwi Evènman, Koneksyon Socket Batman kè, ak Done Evènman. URL. Koòdone BACnet tou prezan ak kouvri nan yon dokiman separe.

API Design

API a fèt ak fòma estanda endistri tankou TCP/IP. HTTP, HTTPS, ak JSON. Konsepsyon an pa egzije okenn teknik espesyal oswa pwopriyetè oswa bibliyotèk yo dwe itilize nan devlopman pwogram ekstèn oswa aplikasyon an. API a fleksib epi li ka konfigirasyon ak pwograme pou bay egzakteman done ki nesesè yo ak nan fason ki pi efikas. Detay yo sou operasyon chak nan seksyon ki anwo yo kouvri nan seksyon sa yo nan gid sa a.

Mesaj ekstèn

Yo itilize etablisman sa a pou delivre alèt oswa alam ak done Evènman nan yon pwogram ekstèn, sistèm VMS, sèvè, elatriye lè yon Evènman deklanche (se mete). Mesaj opsyonèl yo ka pèmèt tou pou siyal lè yon Evènman efase (se reset). Livrezon sa a ka fèt nan yon priz TCP/IP oswa sèvè HTTP/S an tan reyèl. Gen yon seri pwotokòl configurable ak kontni customizable. Otantifikasyon ak chifreman ki disponib.

Batman kè

Mesaj batman kè yo voye nan yon entèval configurable (olye pou yo lè Evènman yo deklanche) pou bay prèv ap viv/disponibilite. Yo gen yon seri kapasite menm jan ak mesaje ekstèn men yo ta tipikman dwe configuré pou genyen enfòmasyon jeneral eta olye ke detay sou yon evènman an patikilye.

Done Evènman URL

Etablisman sa a disponib sèlman anba yon NDA epi yo ta dwe itilize sèlman lè pwogram ekstèn lan mande aksè nan nenpòt ak tout valè Evènman, papòt, ak drapo eta a. Done sa yo jeneralman rekipere sou demann pa pwogram ekstèn lan men pa nan yon frekans trè wo. Metòd sa a jeneralman gen kèk latansi lè yo itilize yon to vote modès. Pousantaj biwo vòt tipik yo varye ant yon fwa pa minit ak yon fwa pou chak 5 segonn ak yon pousantaj maksimòm absoli yon fwa pa segonn. Metòd sa a ka itilize tou pou rekipere done sipò adisyonèl lè yo resevwa yon Evènman (alèt).

Detay ekstèn mesaj

Yon seksyon nan HALO la web koòdone Entegrasyon popup bay pou konfigirasyon yon sèl koneksyon 3yèm pati kote yo ka voye divès valè nan yon priz TCP aleka oswa yon sèvè HTTP/HTTPS. Moun ki gen plas (jeton) yo itilize pou mete valè vivan nan tèks transmèt la. Malgre ke yo make "Mesaj ekstèn," kanal sa a ka itilize pou prèske nenpòt rezon ki egzije deklanche Evènman an tan reyèl, aktivman delivre pa HALO. Aranjman sa a se byen fleksib paske seleksyon sou "Aksyon yo" detèmine ki Evènman HALO transmèt atravè kanal sa a.

Nan mòd HTTP, Mete ak Reyajiste kòd yo se URLs ki dwe antre ak fòma jan sèvè destinasyon an vle. Ou ka itilize yon jaden Itilizatè ak Modpas pou otantifikasyon. Gade mòd HTTP anba a.

Nan mòd TCP, Set ak Reset Strings yo se sèlman done yo nan yon mesaj sèl ki voye nan priz TCP k ap resevwa a. Yo ka fòma jan sa nesesè pa destinasyon an. Se destinasyon an espesifye nan Adrès ak Port jaden yo. Gade mòd TCP anba a.

Pou nenpòt ki mòd, sitiyasyon ki soti nan mesaj ki pi resan parèt ki ka ede se fikse koneksyon oswa lòt pwoblèm. Ou ta ka itilize bouton TÈS Evènman yo sou popup Aksyon yo pou fòse yon mesaj:

Global On/Off pou Mete oswa Reset dwe Limen pou pèmèt kalite mesaj sa yo. Reyajiste souvan pa itilize paske sèlman aparisyon yon Evènman ki enterese, men sa ka varye. Chak Evènman ka poukont yo presize si li pral itilize swa mesaj la Set oswa Reyajiste sou popup Aksyon yo. Bouton je yo pral montre yon reprezantasyon ki graj nan sa yo voye apre sibstitisyon mo kle ak fòma. Repete Holdoff ka itilize pou ratrape mesaj souvan pa retade anvan yo ka voye yon lòt. Sa a se fè poukont chak Evènman. HALO gen yon tan kenbe entegre pou evènman 15 segonn pou anpeche rapid re-deklanchman nan Evènman yo. Si ou te vle asire ke yo pa voye plis pase 1 Evènman nan yon kalite pa minit, ou ta ka mete Repeat Holdoff a 60 (segonn).

Detay batman kè

Transmisyon Heartbeat yo fonksyone menm jan ak sa ki anwo a eksepte ke pa gen okenn entèraksyon ak paj Aksyon yo. Olye de sa, transmisyon Heartbeat la fèt sou yon baz regilye jan konfigirasyon ak jaden an Entèval, Nan mòd HTTP, Set ak Reset String yo se URLs ki dwe antre ak fòma jan sèvè destinasyon an vle. Ou ka itilize yon jaden Itilizatè ak Modpas pou otantifikasyon. Gade mòd HTTP anba a.

Pandan ke objektif prensipal batman kè a se bay prèv lavi yon HALO Smart Sensor nan yon aplikasyon aleka, mesaj sa a ka itilize tou pou transmèt detèktè yo chwazi oswa enfòmasyon aktyèl sou eta Evènman an. Ansyen anample pi wo a voye yon paramèt fisèl long ak la URL ki enkli non Halo a, yon majorite nan valè Capteur, ak anfen Deklanche =% ACTIVE% ki ta ka vid oswa yon lis Evènman deklanche kounye a.

HTTP (ak HTTPS) mòd

Mesaj ekstèn ak kòd batman kè yo ka http: oswa https: URLs jan sa nesesè. Chemen ak paramèt ka antre jan sa nesesè pa sèvè destinasyon an. Mo kle tankou %NAME% (non aparèy HALO) oswa %EID% (id Evènman) ka mete jan sa nesesè epi yo pral ranplase ak done respektif lè mesaj la voye. Yo montre yon lis mo kle yo itilize souvan pou referans rapid.
La URL chemen ka genyen mo kle osi byen ke paramèt yo nan URL. Paramèt yo ta ka NAME=VALUE pè oswa yon objè JSON, oswa yon fòma koutim ki depann de sèvè destinasyon an. Egzamples pou ekstèn Messagerie ta gen ladan %EID% pou endike Evènman ki te deklanche:

https://server.com/event/%NAME%/%EID%
https://server.com/event?location=%NAME%&event=%EID%

https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}

Examples pou Heartbeat ta ka ajoute %ACTIVE% (aktyèlman deklanche Evènman) oswa yon valè Capteur:

https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
%SENSOR:...% valè yo itilize non yo jwenn nan tit kolòn detèktè adwat yo nan evtYYYYMMDD.csv. files. Yo anjeneral:

Si sèvè destinasyon an prefere HTTP PUT oswa POST olye pou yo GET demann, ou ka prefiks la URL ak PUT: oswa POST:. Poukont li, ou ka ajoute yon chaj JSON ki popilè ak anpil sèvè lè w ajoute mo kle [JSONBODY] ki te swiv pa yon objè fòma JSON. Egzample:
PUT:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”event”:”%EID%”}
La URL sipòte adrès IP tipik (ak IPv6) ak opsyon pò ak modpas itilizatè, oswa ou ka itilize jaden Itilizatè ak Modpas si sa nesesè pou sèvè destinasyon an pou metòd otantifikasyon tankou Basic oswa Digest:
https://username:password@123.321.123.321:9876/event…

TCP mòd

Mesaj ekstèn ak strings batman kè yo se jis pou done depi jaden yo Adrès ak Port presize destinasyon an. Adrès la sipòte non, IPv4 ak IPv6.
Ka fisèl la dwe fòma tankou pòsyon done nan mesaj HTTP ki dekri pi wo a, oswa jan sèvè destinasyon an mande.
Examples pou ekstèn Messagerie ta gen ladan %EID% pou endike Evènman ki te deklanche:
kote=%NAME%,evènman=%EID%
{“location”:”:%NAME%”,”event”:”%EID%”}
Examples pou Heartbeat ta ka ajoute %ACTIVE% (aktyèlman deklanche Evènman) oswa yon valè Capteur:
Location=%NAME%&Deklanche=%ACTIVE%
{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}

Kach yo nan kolòn "Entegrasyon Set" ak "Reset Entegrasyon" yo detèmine ki Evènman ki deklanche voye. Gen plis enfòmasyon sou konfigirasyon Evènman ak Aksyon yo disponib nan Gid Administratè HALO a.

Livrezon JSON Evènman Mesaj
Gen kèk devlopè ki pito resevwa done Evènman fòma kòm estanda endistri ki gen etikèt sou pwòp tèt ou JSON olye ke tèks ASCII klè kòm ansyen an se pi serye ak pi fasil analize. Sou HALO la web paj "Mesaj" tab la, ou ka bay mesaj JSON nan paramèt "Mesaj ekstèn" "Mesaj" ak "Reset String" ak nan "Heartbeat" "Mesaj la".

Examples:
Anviwònman "Mesaj ekstèn" Mete chaîne:

{“device”:”%NAME%”, “event”:”%EID%”, “alam”:”wi”}
Sa a pral voye yon sèl TCP oswa UDP JSON mesaj bay sèvè a espesifye rapòte non zanmitay aparèy la, non evènman ak ke li jis kòmanse.

Anviwònman "Mesaj ekstèn" Reyajiste kòd:
{“device”:”%NAME%”, “event”:”%EID%”, “alam”:”non”}
Sa a pral voye yon sèl TCP oswa UDP JSON mesaj bay sèvè a espesifye rapòte non zanmitay aparèy la, non evènman an e ke kondisyon an te sispann kounye a.

Mesaj "Kè batman":
{ “device”:”%NAME%”, “alive”:”%DATE% %TIME%”}
Sa a pral voye detanzantan yon mesaj TCP oswa UDP JSON bay sèvè espesifye a pou rapòte ke HALO a vivan nan moman ki endike a.