Ngwa ngwa HALO Smart Sensọ API Basic Software
Gawa n'ihu
Akwụkwọ a na-akọwa otu akụrụngwa nke Halo Smart Sensor mara mkpokọta dị ka BASIC API, ma ọ bụ Ngwa Mmemme Interface. Ezubere mkparita ụka a maka ndị mmemme ma ọ bụ ndị mmekọ nwere mmasị ijikọ HALO Smart Sensors (HALOs) yana akụrụngwa akụrụngwa ma ọ bụ sistemụ nke atọ (na-abụghị IPVideo). N'ozuzu, HALO API bu n'obi ibufe ozi nke ọma site na HALO n'elu netwọk Ethernet nke na-emekarị na mmemme mpụga. Iji mezuo ebumnuche a, e kewara API na ngalaba atọ: Njikọ Socket Driven Event, Njikọ Socket Heartbeat, na Data Omume. URL. BACnet interface dịkwa ma kpuchie ya na akwụkwọ dị iche.
Nhazi API
Emebere API site na iji usoro ọkọlọtọ ụlọ ọrụ dịka TCP/IP. HTTP, HTTPS na JSON. Nhazi ahụ anaghị achọ ụzọ ọ bụla pụrụ iche ma ọ bụ nke nwe ya ma ọ bụ ụlọ akwụkwọ ọbá akwụkwọ ka ejiri mee ihe na mmepe nke mmemme ma ọ bụ ngwa mpụga. API na-agbanwe agbanwe ma nwee ike ịhazi ya na hazie ya iji wepụta kpọmkwem data achọrọ yana n'ụzọ kacha arụ ọrụ nke ọma. A na-ekpuchi nkọwa nke ọrụ nke akụkụ ọ bụla dị n'elu na akụkụ ndị a nke ntuziaka a.
Ozi Mpụga
A na-eji ụlọ ọrụ a na-ebuga ọkwa ma ọ bụ mkpu na data Omume na mmemme mpụga, sistemụ VMS, ihe nkesa, wdg mgbe emere emume (edozi). Enwere ike ịnyekwa ozi nhọrọ ka ọ gosi mgbe emume kpochapụrụ (tọgharịrị). Enwere ike ịnyefe nnyefe a na oghere TCP/IP ma ọ bụ sava HTTP/S ozugbo. Enwere usoro nhazi usoro nwere ọdịnaya enwere ike ịhazi ya. Nyocha na nzuzo dị.
Obi mgbawa
A na-eziga ozi obi mgbawa n'oge nhazi (kama mgbe emelitere ihe omume) iji nye akaebe nke ịdị ndụ/dị adị. Ha nwere ụdị ikike dị ka Ozi Mpụga mana a ga-ahazi ya ka ọ nwee ozi steeti izugbe karịa nkọwa gbasara otu mmemme.
Data mmemme URL
Ihe owuwu a dị naanị n'okpuru NDA ma ekwesịrị iji ya naanị mgbe mmemme mpụga chọrọ ịnweta ụkpụrụ omume niile, ọnụ ụzọ na ọkọlọtọ steeti. A na-eweghachite data a n'ọtụtụ oge site na mmemme mpụga mana ọ bụghị n'ogo dị elu. Usoro a na-ebutekarị obere oge mgbe ejiri obere ntụli aka mee ihe. Ọnụego ịtụ vootu a na-ahụkarị na-adị site na otu nkeji ruo otu ugboro n'ime sekọnd 5 yana oke kacha otu ugboro kwa nkeji. Enwere ike iji usoro a weghachite data nkwado agbakwunyere mgbe enwetara mmemme (ọmụma).
Nkọwa ozi mpụga
Akụkụ nke HALO web interface mbanye mbanye na-enye maka nhazi nke otu njikọ nke atọ ebe enwere ike iziga ụkpụrụ dị iche iche na oghere TCP dịpụrụ adịpụ ma ọ bụ ihe nkesa HTTP/HTTPS. A na-eji ihe njide (token) tinye ụkpụrụ ndụ n'ime ederede ebufere. Ọ bụ ezie na akpọrọ "Izi ozi Mpụga," enwere ike iji ọwa a maka ihe fọrọ nke nta ka ọ bụrụ ebumnuche ọ bụla na-achọ ihe omume ozugbo, nke HALO na-ebuga ya. Nhazi a na-agbanwe nke ọma n'ihi na nhọrọ ndị dị na "Actions" na-ekpebi ihe omume HALO na-ebufe site na ọwa a.
Na ọnọdụ HTTP, Set na Tọgharịa eriri bụ URLs nke a ga-abanyerịrị na hazie dịka ihe nkesa ebe achọrọ chọrọ. Enwere ike iji mpaghara onye ọrụ na okwuntughe maka nyocha. Lee ọnọdụ HTTP n'okpuru.
Na ọnọdụ TCP, Set na Tọgharịa eriri bụ naanị data nke otu ozi ezigara na oghere TCP na-anata. Enwere ike ịhazi ha dịka achọrọ site na ebe ebe a na-aga. A kọwapụtara ebe a na-aga na ngalaba Adreesị na ọdụ ụgbọ mmiri. Lee ọnọdụ TCP n'okpuru.
Maka ụdị ọ bụla, a na-egosipụta ọkwa sitere na ozi kacha ọhụrụ nke nwere ike inye aka na-edozi njikọ ma ọ bụ nsogbu ndị ọzọ. Ị nwere ike iji bọtịnụ Omume Omume na mmanye omume ịmanye ozi:
Gbanyụọ ma ọ bụ gbanyụọ zuru ụwa ọnụ maka ịtọ ma ọ bụ Tọgharia ga-agbanyerịrị iji mee ụdị ozi ndị ahụ. A naghị ejikarị nrụpụta n'ihi na naanị mmalite ihe omume bụ mmasị, mana nke ahụ nwere ike ịdị iche. Omume ọ bụla nwere ike ịkọwapụta onwe ya ma ọ ga-eji ma Tọọ ma ọ bụ ozi Tọgharia na mmapụta omume. Bọtịnụ bọọlụ anya ga-egosipụta nhụsianya siri ike nke ihe ezitere ma dochie mkpụrụokwu na nhazi. Enwere ike iji Holdoff emegharị ugboro ugboro site na igbu oge tupu enwee ike izipu nke ọzọ. A na-eme nke a n'onwe ya maka mmemme. HALO nwere oge njide arụnyere maka ihe omume nke sekọnd iri na ise iji gbochie iweghachite mmemme ngwa ngwa. Ọ bụrụ na ịchọrọ ịhụ na ezipụghị ihe omume otu ụdị 15 kwa nkeji, ị nwere ike ịtọ Repeat Holdoff na 1 (sekọnd).
Nkọwa obi obi
Mgbasa ozi obi obi na-arụ ọrụ n'otu ụzọ ahụ dị n'elu ma e wezụga na ọ nweghị mmekọrịta na ibe omume. Kama, nnyefe Heartbeat na-eme kwa oge dịka ahaziri ya na mpaghara Interval, Na ọnọdụ HTTP, Set na Reset Strings bụ URLs nke a ga-abanyerịrị na hazie dịka ihe nkesa ebe achọrọ chọrọ. Enwere ike iji mpaghara onye ọrụ na okwuntughe maka nyocha. Lee ọnọdụ HTTP n'okpuru.
Ọ bụ ezie na ebumnuche bụ isi nke Heartbeat bụ ịnye ihe akaebe nke ndụ nke HALO Smart Sensor na ngwa dịpụrụ adịpụ, enwere ike iji ozi a bufee sensọ ahọpụtara ma ọ bụ ozi steeti ihe omume ugbu a. The example n'elu na-eziga oke eriri ogologo na nke URL nke ahụ gụnyere aha Halo, ọtụtụ ụkpụrụ ihe mmetụta, yana n'ikpeazụ kpalitere =% ACTIVE% nke nwere ike ịbụ ihe efu ma ọ bụ ndepụta nke ihe omume akpalite ugbu a.
Ụdị HTTP (na HTTPS).
Ozi Mpụga na eriri obi obi nwere ike ịbụ http: ma ọ bụ https: URLs dị ka achọrọ. Enwere ike itinye ụzọ na paramita dị ka mkpa nke ihe nkesa na-aga. Enwere ike itinye mkpụrụokwu dị ka %NAME% (aha ngwaọrụ HALO) ma ọ bụ % EID% (Id mmemme) dịka achọrọ ma were data dị iche iche dochie ya mgbe ezigara ozi ahụ. A na-egosi ndepụta nke isiokwu ndị a na-ejikarị maka ntụnye aka ngwa ngwa.
Nke URL ụzọ nwere ike ịnwe mkpụrụokwu yana paramita na URL. Ihe ndị a nwere ike ịbụ NAME=VALUE ụzọ abụọ ma ọ bụ ihe JSON, ma ọ bụ usoro omenala dabere na sava ebe aga. Ọpụampmaka ozi Mpụga ga-agụnye %EID% iji gosi mmemme kpalitere:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples maka Heartbeat nwere ike ịgbakwunye % ACTIVE% (Ememe eme ugbu a) ma ọ bụ uru sensọ:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Ụkpụrụ % SENSOR:…% na-eji aha ndị ahụ dị na isi kọlụm sensọ aka nri na log evtYYYYMMDD.csv files. Ha na-abụkarị:
Ọ bụrụ na ihe nkesa na-aga na-ahọrọ HTTP PUT ma ọ bụ POST kama GET arịrịọ, ị nwere ike prefix URL ya na PUT: ma ọ bụ POST:. N'onwe ya, ị nwere ike ịgbakwunye ụgwọ ọrụ JSON nke na-ewu ewu n'ọtụtụ sava site na ịtinye mkpụrụokwu [JSONBODY] nke ihe nhazi JSON na-esote. ỌpụampLe:
PUT:https://server.com/event[JSONBODY]{"ebe":"%NAME%",mmemme":"%EID%"}
Nke URL na-akwado adreesị IP na-ahụkarị (na IPv6) na ọdụ ụgbọ mmiri na nhọrọ paswọọdụ onye ọrụ, ma ọ bụ ịnwere ike iji mpaghara njirimara na paswọọdụ ma ọ bụrụ na ọ dị mkpa ka ọ bụrụ ihe nkesa na-aga maka ụzọ nyocha dị ka Basic ma ọ bụ Digest:
https://username:password@123.321.123.321:9876/event…
Ụdị TCP
Ozi Mpụga na eriri obi nkụja bụ naanị maka data ebe ọ bụ na ebe adreesị na ọdụ ụgbọ mmiri na-akọwapụta ebe a na-aga. Adreesị ahụ na-akwado aha, IPv4 na IPv6.
Enwere ike ịhazi eriri ahụ dị ka akụkụ data nke ozi HTTP akọwara n'elu, ma ọ bụ dị ka ihe nkesa na-aga chọrọ.
Exampmaka ozi Mpụga ga-agụnye %EID% iji gosi mmemme kpalitere:
ebe =% NAME%, omume =%EID%
{"ebe":":%NAME%","mmemme":"%EID%"}
Examples maka Heartbeat nwere ike ịgbakwunye % ACTIVE% (Ememe eme ugbu a) ma ọ bụ uru sensọ:
ọnọdụ =% NAME%& kpalitere =% ACTIVE%
{"ebe":":%NAME%","NH3":%SENSOR:NH3%}
Igbe nlele dị na kọlụm “Ntụgharị Ntugharị” na “Mmekọrịta Tọgharia” na-ekpebi ihe Omume na-akpalite izipu. Ihe ndị ọzọ na nhazi ihe omume na omume dị na ntuziaka onye nchịkwa HALO.
Nbufe ozi mmemme JSON
Ụfọdụ ndị mmepe na-ahọrọ ịnata data mmemme ahaziri dị ka ọkọlọtọ ụlọ ọrụ ejiri aka ya kpọọ JSON karịa ederede ASCII dị larịị dịka nke mbụ bụ nke a pụrụ ịdabere na ya na nke dị mfe karị. Na HALO web ibe "Izi ozi" taabụ, ị nwere ike ịnye ozi JSON na "Izi ozi Mpụga" ntọala "Tọgharịa eriri" na "Tọgharịa eriri" yana na "Heartbeat" "Ozi."
Examples:
Ntọala ntọala “ozi mpụga” eriri:
{"ngwaọrụ":"%NAME%", "mmemme":"%EID%", "mkpu":"ee"}
Nke a ga-eziga otu ozi TCP ma ọ bụ UDP JSON na sava akọwapụtara nke na-akọ aha ngwaọrụ enyi, aha mmemme na na ọ malitere.
Eriri Tọgharia “ozi mpụga”:
{"ngwaọrụ":"%NAME%", "mmemme":"%EID%", "mkpu":"Mba"}}
Nke a ga-eziga otu ozi TCP ma ọ bụ UDP JSON na sava akọwapụtara nke na-akọ aha ngwaọrụ enyi, aha mmemme yana na ọnọdụ akwụsịla ugbu a.
Ozi "Obi obi":
{"ngwaọrụ":"%NAME%", "ndụ":"%DATE% %TIME%"}
Nke a ga-eziga ozi TCP ma ọ bụ UDP JSON kwa oge na ozi nkesa akọwapụtara na HALO dị ndụ n'oge egosipụtara.
Akwụkwọ / akụrụngwa
 |
Ngwa ngwa HALO Smart Sensọ API Basic Software [pdf] Ntuziaka onye ọrụ HALO Smart Sensọ API Ngwanrọ ntọala |
