Bathar-bog s HALO Smart Sensor API Basic Software
Air adhart
Tha an sgrìobhainn seo a’ toirt cunntas air a’ bhuidheann de ghoireasan aig an Halo Smart Sensor ris an canar còmhla BASIC API, no Application Programming Interface. Tha an deasbad seo airson a chleachdadh le luchd-prògramaidh no integradairean aig a bheil ùidh ann a bhith ag amalachadh aon no barrachd HALO Smart Sensors (HALOn) le co-phàirtean no siostaman bathar-bog treas pàrtaidh (neo-IPVideo). San fharsaingeachd, tha an HALO API an dùil fiosrachadh a ghluasad gu h-èifeachdach bho HALO thairis air lìonra àbhaisteach Ethernet chun phrògram taobh a-muigh. Gus an amas seo a choileanadh, tha an API air a roinn ann an trì earrannan: Ceangal Socaid air a stiùireadh le Tachartas, Ceangal Socaid Heartbeat, agus Dàta Tachartas URL. Tha eadar-aghaidh BACnet cuideachd an làthair agus air a chòmhdach ann an sgrìobhainn air leth.
Dealbhadh API
Tha an API air a dhealbhadh a’ cleachdadh chruthan àbhaisteach gnìomhachais leithid TCP/IP. HTTP, HTTPS, agus JSON. Chan fheum an dealbhadh dòighean no leabharlannan sònraichte no seilbhe a bhith air an cleachdadh ann an leasachadh a’ phrògraim no an aplacaid a-muigh. Tha an API sùbailte agus faodar a rèiteachadh agus a phrògramadh gus an dàta a tha a dhìth a lìbhrigeadh agus anns an dòigh as èifeachdaiche. Tha mion-fhiosrachadh mu obrachadh gach aon de na h-earrannan gu h-àrd air a chòmhdach anns na h-earrannan a leanas den stiùireadh seo.
Teachdaireachdan a-muigh
Tha an goireas seo air a chleachdadh gus rabhaidhean no rabhaidhean agus dàta Tachartas a lìbhrigeadh gu prògram air an taobh a-muigh, siostam VMS, frithealaiche, msaa nuair a thèid Tachartas a phiobrachadh (air a shuidheachadh). Faodar teachdaireachdan roghainneil a chomasachadh cuideachd gus comharrachadh nuair a thèid Tachartas a ghlanadh (ath-shuidheachadh). Faodar an lìbhrigeadh seo a dhèanamh gu socaid TCP / IP no frithealaiche HTTP / S ann an àm fìor. Tha raon de phròtacalan rèiteachaidh ann le susbaint gnàthaichte. Tha dearbhadh agus crioptachadh ri fhaighinn.
Buille-cridhe
Bithear a’ cur teachdaireachdan buille-cridhe aig àm rèiteachaidh (an àite nuair a thèid tachartasan a bhrosnachadh) gus dearbhadh beò/ri fhaighinn a thoirt seachad. Tha an aon raon de chomasan aca ri Teachdaireachdan Taobh a-muigh ach mar as trice bhiodh iad air an rèiteachadh gus fiosrachadh stàite coitcheann a bhith ann seach mion-fhiosrachadh mu thachartas sònraichte.
Dàta Tachartas URL
Chan eil an goireas seo ri fhaighinn ach fo NDA agus cha bu chòir a chleachdadh ach nuair a dh’ fheumas am prògram bhon taobh a-muigh faighinn gu luachan Tachartas, stairsnich agus brataichean stàite. Tha an dàta seo mar as trice air fhaighinn air ais air iarrtas leis a’ phrògram bhon taobh a-muigh ach chan ann aig tricead glè àrd. Mar as trice bidh an dòigh seo a’ tighinn gu ìre nuair a thèid ìre bhòtaidh beag a chleachdadh. Bidh ìrean bhòtaidh àbhaisteach a’ dol bho aon uair sa mhionaid gu aon uair gach 5 diog le ìre iomlan as àirde de aon uair san diog. Faodar an dòigh seo a chleachdadh cuideachd gus dàta taic a bharrachd fhaighinn air ais nuair a gheibhear Tachartas (rabhaidh).
Mion-fhiosrachadh Teachdaireachdan Taobh a-muigh
Earrann den HALO web eadar-aghaidh Integration popup a’ solarachadh airson rèiteachadh aon cheangal 3mh pàrtaidh far am faodar diofar luachan a chuir gu socaid TCP iomallach no frithealaiche HTTP / HTTPS. Bithear a’ cleachdadh luchd-gleidhidh àite (tokens) gus luachan beò a chuir a-steach don teacsa tar-chuir. Ged a tha e air ainmeachadh mar “Teachdaireachdan Taobh a-muigh,” faodar an sianal seo a chleachdadh airson cha mhòr adhbhar sam bith a dh’ fheumas luchd-brosnachaidh tachartais fìor-ùine, air a lìbhrigeadh gu gnìomhach le HALO. Tha an rèiteachadh seo gu math sùbailte leis gu bheil taghaidhean air na “Gnìomhan” a’ dearbhadh dè na Tachartasan HALO a bhios a’ sgaoileadh tron t-sianal seo.
Ann am modh HTTP, is e na Strings Set and Reset Strings an URLs a dh'fheumas a bhith air an cur a-steach agus air an cruth mar a dh' fheumar leis an t-seirbheisiche ceann-uidhe a tha thu ag iarraidh. Faodar raon Cleachdaiche is Facal-faire a chleachdadh airson dearbhadh. Faic modh HTTP gu h-ìosal.
Ann am modh TCP, chan eil anns na Strings Set and Reset Strings ach dàta aon teachdaireachd a thèid a chuir chun t-socaid TCP a tha a’ faighinn. Faodaidh iad a bhith air an cruth mar a dh 'fheumar leis a' cheann-uidhe. Tha an ceann-uidhe air a shònrachadh anns na raointean Seòladh is Port. Faic Modh TCP gu h-ìosal.
Airson gach modh, tha inbhe bhon teachdaireachd as ùire air a thaisbeanadh a chuidicheas le bhith a’ càradh ceangal no cùisean eile. Dh’ fhaodadh tu na putanan TEST Tachartas a chleachdadh air uinneag na h-obrach Gnìomhan gus teachdaireachd a sparradh:
Feumaidh Global On / Off airson Set no Reset a bhith air adhart gus na seòrsaichean teachdaireachdan sin a chomasachadh. Gu tric chan eilear a’ cleachdadh ath-shuidheachadh oir is e dìreach toiseach Tachartas a tha inntinneach, ach faodaidh sin atharrachadh. Faodaidh gach Tachartas sònrachadh gu neo-eisimeileach an cleachd e an dàrna cuid an seata no an teachdaireachd Ath-shuidheachadh air popup Gnìomhan. Seallaidh na putanan ball-sùla riochdachadh garbh de na thèid a chuir às deidh luchd-ionaid prìomh fhaclan agus cruth. Faodar Repeat Holdoff a chleachdadh gus teachdaireachdan tric a thilgeil le bhith a’ cur dàil mus tèid fear eile a chuir. Tha seo air a dhèanamh gu neo-eisimeileach gach Tachartas. Tha ùine glacaidh stèidhichte aig HALO airson tachartasan de 15 diogan gus casg a chuir air tachartasan ath-thòiseachadh gu sgiobalta. Nam biodh tu airson dèanamh cinnteach nach tèid barrachd air 1 Tachartas de sheòrsa a chuir gach mionaid, dh’ fhaodadh tu Repeat Holdoff a shuidheachadh gu 60 (diogan).
Mion-fhiosrachadh buille cridhe
Bidh na tar-chuir Heartbeat ag obair ann an dòigh coltach ris na tha gu h-àrd ach nach eil eadar-obrachadh ann leis an duilleag Gnìomhan. An àite sin, bidh an tar-chuir Heartbeat a’ tachairt gu cunbhalach mar a tha e air a rèiteachadh leis an raon Eadar-amail, Ann am modh HTTP, is e na Strings Set and Reset Strings an URLs a dh'fheumas a bhith air an cur a-steach agus air an cruth mar a dh' fheumar leis an t-seirbheisiche ceann-uidhe a tha thu ag iarraidh. Faodar raon Cleachdaiche is Facal-faire a chleachdadh airson dearbhadh. Faic modh HTTP gu h-ìosal.
Ged is e prìomh adhbhar buille-cridhe dearbhadh beatha HALO Smart Sensor gu tagradh iomallach, faodar an teachdaireachd seo a chleachdadh cuideachd gus mothachairean taghte no fiosrachadh stàite Tachartas gnàthach a sgaoileadh. Tha an t-example gu h-àrd a 'cur paramadair sreang fhada leis an URL a tha a’ gabhail a-steach an t-ainm Halo, mòr-chuid de luachan mothachaidh, agus mu dheireadh Triggered=%ACTIVE% a dh’ fhaodadh a bhith falamh no liosta de thachartasan a tha air am piobrachadh an-dràsta.
Modh HTTP (agus HTTPS).
Faodaidh sreangan Teachdaireachdan Taobh a-muigh agus Heartbeat a bhith http: neo https: URLs mar a dh’ fheumar. Faodar slighe agus crìochan a chuir a-steach mar a dh ’fheumar leis an t-seirbheisiche ceann-uidhe. Gabhaidh prìomh fhaclan mar %NAME% (ainm inneal HALO) no %EID% (ID id) a chuir a-steach mar a dh’ fheumar agus thèid an dàta iomchaidh a chuir na àite nuair a thèid an teachdaireachd a chuir. Tha liosta de phrìomh fhaclan a chleachdar gu cumanta air an sealltainn airson iomradh sgiobalta.
Tha an URL faodaidh prìomh fhaclan a bhith anns an t-slighe a bharrachd air na paramadairean don URL. Dh’ fhaodadh gur e paidhrichean NAME=VALUE no oibseact JSON a th’ anns na paramadairean, no cruth gnàthaichte a-rèir an fhrithealaiche cinn-uidhe. Mar eisimpleirampbhiodh les airson Teachdaireachdan Taobh a-muigh a’ toirt a-steach %EID% gus an Tachartas a bhrosnaich:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Exampdh’ fhaodadh les airson Heartbeat % ACTIVE% (Tachartasan air am piobrachadh an-dràsta) no luach mothachaidh a chur ris:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Cleachdaidh na luachan % SENSOR:…% na h-ainmean a lorgar ann an cinn nan colbhan mothachaidh air an làimh dheis ann an loga evtYYYYMMDD.csv files. Mar as trice tha iad:
Mas fheàrr leis an t-seirbheisiche ceann-uidhe HTTP PUT no POST an àite iarrtasan GET, faodaidh tu an ro-leasachan URL le PUT : or POST :. Gu neo-eisimeileach, faodaidh tu uallach pàighidh JSON a chuir ris a tha a’ còrdadh ri mòran de luchd-frithealaidh le bhith a’ cur am prìomh fhacal [JSONBODY] ris agus an uairsin nì ann an cruth JSON. Mar eisimpleirample:
PUT:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”event”:”%EID%”}
Tha an URL a’ toirt taic do sheòladh IP àbhaisteach (agus IPv6) agus roghainnean port is facal-faire neach-cleachdaidh, no faodaidh tu na raointean Cleachdaiche is Facal-faire a chleachdadh ma tha feum air a bhith mar an t-seirbheisiche ceann-uidhe airson modhan dearbhaidh leithid Basic or Digest:
https://username:password@123.321.123.321:9876/event…
Modh TCP
Tha na sreathan Teachdaireachdan Taobh a-muigh agus Heartbeat dìreach airson dàta leis gu bheil na raointean Seòladh is Port a’ sònrachadh ceann-uidhe. Tha an Seòladh a’ toirt taic do dh’ ainmean, IPv4 agus IPv6.
Faodar an sreang a chruth mar na cuibhreannan dàta de theachdaireachdan HTTP a tha air am mìneachadh gu h-àrd, no mar a dh’ fheumas an t-seirbheisiche ceann-uidhe.
Exampbhiodh les airson Teachdaireachdan Taobh a-muigh a’ toirt a-steach %EID% gus an Tachartas a bhrosnaich:
location=%NAME%, tachartas=%EID%
{“location”:”:%NAME%”, “tachartas”:”%EID%”}
Exampdh’ fhaodadh les airson Heartbeat % ACTIVE% (Tachartasan air am piobrachadh an-dràsta) no luach mothachaidh a chur ris:
location=%NAME%&Triggered=%ACTIVE%
{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Bidh bogsaichean sgrùdaidh anns na colbhan “Integration Set” agus “Integration Reset” a’ dearbhadh dè na tachartasan a bhrosnaicheas cur. Tha barrachd mu shuidheachadh Tachartasan is Gnìomhan ri fhaighinn ann an Iùl rianadair HALO.
Lìbhrigeadh Teachdaireachdan Tachartas JSON
Is fheàrr le cuid de luchd-leasachaidh dàta Tachartas fhaighinn ann an cruth mar JSON fèin-leubail àbhaisteach gnìomhachais seach teacsa sìmplidh ASCII leis gu bheil a’ chiad fhear air a pharsadh nas earbsaiche agus nas fhasa. Air an HALO web duilleag “Teachdaireachdan”, faodaidh tu teachdaireachdan JSON a thoirt seachad ann an roghainnean “Teachdaireachdan Taobh a-muigh” “Set String” agus “Reset String” agus anns an “Heartbeat” “Teachdaireachd.”
Examples:
Suidhichidhean “Teachdaireachdan Taobh a-muigh” String String:
{ “inneal”: ”%NAME%”, “tachartas”: ”%EID%”, “alarm”: ”tha” }
Cuiridh seo aon teachdaireachd TCP no UDP JSON chun an fhrithealaiche ainmichte ag aithris ainm an inneal càirdeil, ainm an tachartais agus gu bheil e dìreach air tòiseachadh.
“Teachdaireachdan Taobh a-muigh” Suidhichidhean ath-shuidheachadh sreang:
{ “inneal”: ”%NAME%”, “tachartas”: ”%EID%”, “inneal-rabhaidh”: ”chan eil” }
Cuiridh seo aon teachdaireachd TCP no UDP JSON chun t-seirbheisiche ainmichte ag aithris ainm an inneal càirdeil, ainm an tachartais agus gu bheil an suidheachadh a-nis air stad.
Teachdaireachd “Heartbeat”:
{ “inneal”: ”%NAME%”, “beò”: “%DATE% %TIME%” }
Cuiridh seo bho àm gu àm teachdaireachd TCP no UDP JSON chun an fhrithealaiche ainmichte ag aithris gu bheil an HALO beò aig an àm ainmichte.
Sgrìobhainnean/Goireasan
 |
Bathar-bog s HALO Smart Sensor API Basic Software [pdfStiùireadh Cleachdaiche Bathar-bog bunaiteach HALO Smart Sensor API |
