Programu ya Msingi ya API ya Kihisi Mahiri cha HALO
Mbele
Hati hii inafafanua kundi la vifaa vya Kihisi Mahiri cha Halo kinachojulikana kwa pamoja kama API YA MSINGI, au Kiolesura cha Kuandaa Programu. Mjadala huu unakusudiwa kutumiwa na watayarishaji programu au viunganishi ambao wangependa kuunganisha Kihisi Mahiri cha HALO (HALO) na vipengele au mifumo ya programu za watu wengine (zisizo za IPVideo). Kwa ujumla, API ya HALO imekusudiwa kuhamisha habari kwa ufanisi kutoka kwa HALO kupitia mtandao wa kawaida wa Ethernet hadi kwenye programu ya nje. Ili kutimiza lengo hili, API imegawanywa katika sehemu tatu: Muunganisho wa Soketi Inayoendeshwa na Tukio, Muunganisho wa Soketi ya Mapigo ya Moyo, na Data ya Tukio. URL. Kiolesura cha BACnet pia kipo na kimefunikwa katika hati tofauti.
Usanifu wa API
API imeundwa kwa kutumia miundo ya kiwango cha sekta kama vile TCP/IP. HTTP, HTTPS, na JSON. Muundo hauhitaji mbinu zozote maalum au za umiliki au maktaba ili zitumike katika uundaji wa programu au programu ya nje. API inaweza kunyumbulika na inaweza kusanidiwa na kuratibiwa ili kutoa data inayohitajika na kwa njia bora zaidi. Maelezo ya utendakazi wa kila moja ya sehemu zilizo hapo juu yametolewa katika sehemu zifuatazo za mwongozo huu.
Ujumbe wa Nje
Kituo hiki kinatumika kuwasilisha arifa au kengele na data ya Tukio kwa programu ya nje, mfumo wa VMS, seva, n.k. Tukio linapoanzishwa (limewekwa). Ujumbe wa hiari pia unaweza kuwashwa kutoa ishara Tukio linapofutwa (limewekwa upya). Uwasilishaji huu unaweza kutumwa kwa soketi ya TCP/IP au seva ya HTTP/S kwa wakati halisi. Kuna anuwai ya itifaki zinazoweza kusanidiwa na yaliyomo yanayoweza kubinafsishwa. Uthibitishaji na usimbaji fiche unapatikana.
Mapigo ya moyo
Ujumbe wa mapigo ya moyo hutumwa kwa muda unaoweza kusanidiwa (badala ya wakati Matukio yameanzishwa) ili kutoa uthibitisho wa kuishi/kupatikana. Zina uwezo mbalimbali sawa na Ujumbe wa Nje lakini kwa kawaida zinaweza kusanidiwa ili kuwa na maelezo ya jumla ya hali badala ya maelezo kuhusu tukio fulani.
Data ya Tukio URL
Kituo hiki kinapatikana tu chini ya NDA na inapaswa kutumika tu wakati programu ya nje inahitaji ufikiaji wa thamani zozote za Tukio, viwango na alama za serikali. Data hii kwa ujumla hutolewa inapohitajika na programu ya nje lakini si kwa masafa ya juu sana. Njia hii kwa ujumla huleta muda wa kusubiri wakati kiwango cha wastani cha upigaji kura kinapotumika. Viwango vya kawaida vya upigaji kura huanzia mara moja kwa dakika hadi mara moja kwa sekunde 5 na kiwango cha juu kabisa cha mara moja kwa sekunde. Mbinu hii pia inaweza kutumika kupata data ya ziada inayosaidia tukio (tahadhari) linapopokelewa.
Maelezo ya Ujumbe wa Nje
Sehemu ya HALO web kiolesura Ibukizi ya ujumuishaji hutoa usanidi wa muunganisho wa mtu mwingine ambapo thamani mbalimbali zinaweza kutumwa kwa soketi ya mbali ya TCP au seva ya HTTP/HTTPS. Vishikilia mahali (ishara) hutumiwa kuingiza maadili ya moja kwa moja kwenye maandishi yaliyopitishwa. Ingawa kimeandikwa "Ujumbe wa Nje," chaneli hii inaweza kutumika kwa takriban madhumuni yoyote yanayohitaji vichochezi vya Matukio vya wakati halisi, vinavyoletwa kikamilifu na HALO. Mpangilio huu unaweza kunyumbulika kabisa kwa sababu chaguo kwenye "Vitendo" huamua ni Matukio gani ya HALO yanayosambaza kupitia kituo hiki.
Katika hali ya HTTP, Mifuatano ya Kuweka na Upya ni URLambazo lazima ziingizwe na kuumbizwa kama inavyotakiwa na seva lengwa inayotakikana. Sehemu ya Mtumiaji na Nenosiri inaweza kutumika kwa uthibitishaji. Tazama hali ya HTTP hapa chini.
Katika hali ya TCP, Mifuatano ya Kuweka na Kuweka Upya ni data ya ujumbe mmoja tu unaotumwa kwenye tundu la kupokea la TCP. Zinaweza kuumbizwa inavyohitajika na lengwa. Marudio yamebainishwa katika sehemu za Anwani na Bandari. Tazama Njia ya TCP hapa chini.
Kwa hali yoyote, hali kutoka kwa ujumbe wa hivi majuzi zaidi huonyeshwa ambayo inaweza kusaidia ni kurekebisha muunganisho au matatizo mengine. Unaweza kutumia vitufe vya TEST TEST kwenye kidukizo cha Vitendo kulazimisha ujumbe:
Global Washa/Zima kwa Kuweka au Kuweka Upya lazima Iwashe ili kuwezesha aina hizo za ujumbe. Kuweka upya mara nyingi hakutumiwi kwa sababu tu mwanzo wa Tukio ndio unaovutia, lakini hiyo inaweza kutofautiana. Kila Tukio linaweza kubainisha kwa kujitegemea ikiwa litatumia Set au Ujumbe wa Kuweka Upya kwenye dirisha ibukizi la Vitendo. Vifungo vya mboni ya jicho vitaonyesha uwakilishi mbaya wa kile kinachotumwa baada ya ubadilishanaji wa maneno muhimu na umbizo. Kurudia Holdoff kunaweza kutumiwa kukandamiza ujumbe wa mara kwa mara kwa kuchelewesha kabla ya kutuma mwingine. Hii inafanywa kwa kujitegemea kwa Tukio. HALO ina muda uliojumuishwa wa kushikilia matukio ya sekunde 15 ili kuzuia uanzishaji tena wa haraka wa Matukio. Ikiwa ungetaka kuhakikisha kuwa hakuna Tukio 1 la aina linalotumwa kwa dakika, unaweza kuweka Kurudia Kushikilia hadi 60 (sekunde).
Maelezo ya mapigo ya moyo
Usambazaji wa Mapigo ya Moyo hufanya kazi kwa njia sawa na iliyo hapo juu isipokuwa kwamba hakuna mwingiliano na ukurasa wa Vitendo. Badala yake, maambukizi ya Mapigo ya Moyo hutokea mara kwa mara kama ilivyosanidiwa na uga wa Muda, Katika hali ya HTTP, Mifuatano ya Kuweka na Kuweka Upya ndio URLambazo lazima ziingizwe na kuumbizwa kama inavyotakiwa na seva lengwa inayotakikana. Sehemu ya Mtumiaji na Nenosiri inaweza kutumika kwa uthibitishaji. Tazama hali ya HTTP hapa chini.
Ingawa madhumuni ya msingi ya Mapigo ya Moyo ni kutoa uthibitisho wa uhai wa Kihisi Mahiri cha HALO kwa programu ya mbali, ujumbe huu unaweza pia kutumiwa kusambaza vihisi vilivyochaguliwa au maelezo ya sasa ya hali ya Tukio. Example hapo juu hutuma kigezo cha kamba ndefu na URL ambayo ni pamoja na jina la Halo, thamani nyingi za vitambuzi, na mwisho Triggered=%ACTIVE% ambayo inaweza kuwa tupu au orodha ya Matukio yaliyoanzishwa kwa sasa.
Hali ya HTTP (na HTTPS).
Mistari ya Ujumbe wa Nje na Mapigo ya Moyo inaweza kuwa http: au https: URLs kama inahitajika. Njia na vigezo vinaweza kuingizwa kama inavyohitajika na seva lengwa. Maneno muhimu kama %NAME% (jina la kifaa HALO) au %EID% (Kitambulisho cha tukio) yanaweza kuingizwa inapohitajika na badala yake yatawekwa data husika ujumbe unapotumwa. Orodha ya maneno muhimu yanayotumika huonyeshwa kwa marejeleo ya haraka.
The URL path inaweza kuwa na maneno muhimu pamoja na vigezo vya faili ya URL. Vigezo vinaweza kuwa NAME=VALUE jozi au kitu cha JSON, au umbizo maalum kulingana na seva lengwa. Kwa mfanoamples kwa Ujumbe wa Nje itajumuisha %EID% ili kuonyesha Tukio lililoanzisha:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples kwa Mapigo ya Moyo inaweza kuongeza %ACTIVE% (Matukio yanayoanzishwa kwa sasa) au thamani ya kihisi:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Thamani za %SENSOR:…% hutumia majina yanayopatikana katika vichwa vya safu wima ya vitambuzi vya mkono wa kulia katika kumbukumbu ya evtYYYYMMDD.csv files. Wao ni kawaida:
Ikiwa seva lengwa inapendelea HTTP PUT au POST badala ya maombi ya GET, unaweza kuweka kiambishi awali URL na PUT: au POST:. Kwa kujitegemea, unaweza kuongeza upakiaji wa JSON ambao ni maarufu kwa seva nyingi kwa kuongeza neno kuu la [JSONBODY] likifuatiwa na kipengee kilichoumbizwa na JSON. Kwa mfanoample:
PUT:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”tukio”:”%EID%”}
The URL inaauni anwani ya kawaida ya IP (na IPv6) na chaguo la bandari na nenosiri la mtumiaji, au unaweza kutumia sehemu za Mtumiaji na Nenosiri ikihitajika kuwa seva fikio kwa mbinu za uthibitishaji kama vile Msingi au Digest:
https://username:password@123.321.123.321:9876/event…
Njia ya TCP
Mifuatano ya Ujumbe wa Nje na Mapigo ya Moyo ni ya data tu kwani sehemu za Anwani na Bandari zinabainisha lengwa. Anwani inaauni majina, IPv4 na IPv6.
Mfuatano unaweza kuumbizwa kama sehemu za data za jumbe za HTTP zilizofafanuliwa hapo juu, au inavyotakiwa na seva lengwa.
Examples kwa Ujumbe wa Nje itajumuisha %EID% ili kuonyesha Tukio lililoanzisha:
eneo=%NAME%,tukio=%EID%
{“location”:”:%NAME%”,”tukio”:”%EID%”}
Examples kwa Mapigo ya Moyo inaweza kuongeza %ACTIVE% (Matukio yanayoanzishwa kwa sasa) au thamani ya kihisi:
location=%NAME%&Triggered=%ACTIVE%
{“mahali”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Visanduku vya kuteua katika safu wima za "Seti ya Ujumuishaji" na "Rudisha Uunganishaji" huamua ni Matukio gani yanaanzisha utumaji. Zaidi juu ya usanidi wa Matukio na Vitendo inapatikana katika Mwongozo wa Msimamizi wa HALO.
Uwasilishaji wa Jumbe za Tukio la JSON
Wasanidi wengine wanapendelea kupokea data ya Tukio iliyoumbizwa kama kiwango cha tasnia kinachojitambulisha kama JSON badala ya maandishi dhahiri ya ASCII kwani ya awali yanachanganuliwa kwa uhakika na kwa urahisi zaidi. Kwenye HALO web ukurasa wa kichupo cha "Ujumbe", unaweza kusambaza jumbe za JSON katika mipangilio ya "Ujumbe wa Nje" "Weka Mfuatano" na "Weka Upya Mfuatano" na katika "Mapigo ya Moyo" "Ujumbe."
Exampchini:
Mipangilio ya Mipangilio ya "Ujumbe wa Nje":
{“kifaa”:”%NAME%”, “tukio”:”%EID%”, “kengele”:”ndiyo” }
Hii itatuma ujumbe mmoja wa TCP au UDP JSON kwa seva maalum inayoripoti jina la kifaa rafiki, jina la tukio na kwamba kimeanza.
Mipangilio ya "Ujumbe wa Nje" Weka Upya Mfuatano:
{“kifaa”:”%NAME%”, “tukio”:”%EID%”, “kengele”:”hapana” }
Hii itatuma ujumbe mmoja wa TCP au UDP JSON kwa seva iliyobainishwa inayoripoti jina la kifaa rafiki, jina la tukio na kwamba hali sasa imekoma.
Ujumbe wa "Mapigo ya Moyo":
{“kifaa”:”%NAME%”, “hai”:”%DATE% %TIME%” }
Hii itatuma ujumbe wa TCP au UDP JSON mara kwa mara kwa seva maalum ikiripoti kuwa HALO iko hai kwa wakati ulioonyeshwa.
Nyaraka / Rasilimali
 |
Programu ya Msingi ya API ya Kihisi Mahiri cha HALO [pdf] Mwongozo wa Mtumiaji Programu ya Msingi ya API ya Kihisi Mahiri cha HALO |
