Mapulogalamu a HALO Smart Sensor API Basic Software
Patsogolo
Chikalatachi chikufotokoza za gulu la zida za Halo Smart Sensor zomwe zimadziwika kuti BASIC API, kapena Application Programming Interface. Zokambiranazi zapangidwa kuti zigwiritsidwe ntchito ndi olemba mapulogalamu kapena ophatikiza omwe ali ndi chidwi chophatikiza chimodzi kapena zingapo za HALO Smart Sensors (HALOs) ndi zigawo za pulogalamu ya 3rd (non-IPVideo) kapena machitidwe. Kawirikawiri, HALO API imafuna kusamutsa zambiri kuchokera ku HALO kudzera pa intaneti ya Ethernet kupita ku pulogalamu yakunja. Kuti mukwaniritse cholinga ichi, API yagawidwa m'magawo atatu: Kulumikizana kwa Socket Driven Socket, Heartbeat Socket Connection, ndi Event Data. URL. Mawonekedwe a BACnet aliponso ndikuphimba mu chikalata chosiyana.
API Design
API idapangidwa pogwiritsa ntchito mawonekedwe amakampani monga TCP/IP. HTTP, HTTPS, ndi JSON. Kukonzekera sikufuna njira zapadera kapena zaumwini kapena malaibulale kuti agwiritsidwe ntchito popanga pulogalamu yakunja kapena kugwiritsa ntchito. API ndi yosinthika ndipo imatha kukonzedwa ndikukonzedwa kuti ipereke ndendende zomwe zikufunika komanso m'njira yabwino kwambiri. Tsatanetsatane wa kagwiridwe ka ntchito ya gawo lirilonse la pamwambali likufotokozedwa mu zigawo zotsatirazi za bukhuli.
Mauthenga Akunja
Malowa amagwiritsidwa ntchito popereka zidziwitso kapena ma alarm ndi deta ya Zochitika ku pulogalamu yakunja, dongosolo la VMS, seva, ndi zina zotero pamene Chochitika chimayambitsa (chayikidwa). Mauthenga osasankha atha kuthandizidwanso kuti azitha kuwonetsa Chochitikacho chikachotsedwa (chakhazikitsidwanso). Kutumiza uku kumatha kupangidwa ndi socket ya TCP/IP kapena seva ya HTTP/S munthawi yeniyeni. Pali mitundu ingapo ya ma protocol omwe angasinthidwe okhala ndi zomwe mungakonde. Kutsimikizira ndi kubisa zilipo.
Kugunda kwa mtima
Mauthenga a kugunda kwamtima amatumizidwa panthawi yosinthika (m'malo mwa nthawi yomwe Zochitika zimayambika) kuti apereke umboni wakukhalapo / kupezeka. Ali ndi kuthekera kofanana ndi Mauthenga Akunja koma amakonzedwa kuti akhale ndi chidziwitso chambiri m'malo mofotokoza za chochitika china.
Zomwe Zachitika URL
Malowa amapezeka kokha pansi pa NDA ndipo ayenera kugwiritsidwa ntchito pokhapokha pulogalamu yakunja ikufuna kupeza zofunikira zonse za Zochitika, malire, ndi mbendera za boma. Deta iyi nthawi zambiri imatengedwa pakufunika ndi pulogalamu yakunja koma osati pafupipafupi kwambiri. Njira imeneyi nthawi zambiri imabweretsa kuchedwa pang'ono pamene mavoti akugwiritsidwa ntchito. Mavoti odziwika bwino amayambira kamodzi pa mphindi kufika kamodzi pa masekondi asanu ndi kuwirikiza kopambana kamodzi pa sekondi iliyonse. Njirayi ingagwiritsidwenso ntchito kupezanso zina zowonjezera pamene Chochitika (chidziwitso) chalandiridwa.
Tsatanetsatane wa Mauthenga Akunja
Chigawo cha HALO web interface Integration popup imapereka kasinthidwe ka kulumikizana kwa chipani chachitatu komwe zinthu zosiyanasiyana zitha kutumizidwa ku socket yakutali ya TCP kapena seva ya HTTP/HTTPS. Zosungira malo (zizindikiro) zimagwiritsidwa ntchito kuyika mayendedwe amoyo m'mawu otumizidwa. Ngakhale imatchedwa "Mauthenga Akunja," njira iyi imatha kugwiritsidwa ntchito pafupifupi chilichonse chomwe chimafuna zoyambitsa zochitika zenizeni, zoperekedwa mwachangu ndi HALO. Dongosololi ndi losinthika chifukwa zisankho pa "Zochita" zimatsimikizira kuti ndizochitika ziti za HALO zomwe zimafalitsidwa kudzera munjira iyi.
Mu HTTP mode, Set and Reset Strings ndi URLs zomwe ziyenera kulowetsedwa ndikusinthidwa momwe zimafunira ndi seva yomwe mukufuna. Malo Ogwiritsa Ntchito ndi Achinsinsi angagwiritsidwe ntchito kutsimikizira. Onani mawonekedwe a HTTP pansipa.
Mu mawonekedwe a TCP, Set and Reset Strings ndi data yokha ya uthenga umodzi womwe umatumizidwa ku socket ya TCP yolandira. Atha kusinthidwa momwe angafunikire ndi komwe mukupita. Kumeneko kumatchulidwa m'magawo a Adilesi ndi Port. Onani TCP Mode pansipa.
Mwanjira iliyonse, mawonekedwe a uthenga waposachedwa kwambiri amawonetsedwa omwe angathandize ndikukonza kulumikizana kapena zovuta zina. Mutha kugwiritsa ntchito mabatani a Event TEST pazithunzi za Actions kukakamiza uthenga:
Global On/Off for Set or Reset iyenera Kuyatsidwa kuti mauthenga amtunduwu azitha. Kukhazikitsanso sikumagwiritsidwa ntchito chifukwa kungoyambira kwa Chochitika ndikosangalatsa, koma kumatha kusiyana. Chochitika chilichonse chikhoza kufotokoza payekha ngati chidzagwiritsa ntchito Seti kapena Bwezerani uthenga pazithunzi za Actions. Mabatani a diso adzawonetsa chithunzithunzi choyipa cha zomwe zimatumizidwa pambuyo posintha mawu osakira ndikusintha. Kubwereza Holdoff kungagwiritsidwe ntchito kutsitsa mauthenga pafupipafupi pochedwetsa wina asanatumize. Izi zimachitika paokha pa Chochitika. HALO ili ndi nthawi yosungiramo zochitika za masekondi 15 kuti aletse kuyambiranso mwachangu kwa Zochitika. Ngati mukufuna kuwonetsetsa kuti chochitika chamtundu umodzi sichitumizidwa pamphindi, mutha kuyika Repeat Holdoff kukhala 1 (masekondi).
Tsatanetsatane wa kugunda kwa mtima
Kutumiza kwa Heartbeat kumagwira ntchito mofanana ndi zomwe zili pamwambazi kupatula kuti palibe kuyanjana ndi tsamba la Zochita. M'malo mwake, kufalitsa kwa Heartbeat kumachitika nthawi zonse monga momwe zimapangidwira ndi Interval field, Mu HTTP mode, Set and Reset Strings ndi URLs zomwe ziyenera kulowetsedwa ndikusinthidwa momwe zimafunira ndi seva yomwe mukufuna. Malo Ogwiritsa Ntchito ndi Achinsinsi angagwiritsidwe ntchito kutsimikizira. Onani mawonekedwe a HTTP pansipa.
Ngakhale kuti cholinga chachikulu cha Heartbeat ndi kupereka umboni wa moyo wa HALO Smart Sensor ku ntchito yakutali, uthenga uwu ukhoza kugwiritsidwanso ntchito potumiza masensa osankhidwa kapena chidziwitso chamakono cha Zochitika zamakono. Example pamwambapa amatumiza chingwe chachitali parameter ndi URL zomwe zikuphatikiza dzina la Halo, kuchuluka kwa ma sensor values, ndipo potsiriza Triggered=%ACTIVE% yomwe ingakhale yopanda kanthu kapena mndandanda wa Zochitika zomwe zayambika.
HTTP (ndi HTTPS) Mode
Mauthenga Akunja ndi Zingwe za Kugunda kwa Mtima zitha kukhala http: kapena https: URLs ngati pakufunika. Njira ndi magawo atha kulowetsedwa momwe angafunikire ndi seva yolowera. Mawu osakira ngati %NAME% (dzina la chipangizo cha HALO) kapena %EID% (Id ya chochitika) atha kuyika momwe angafunikire ndipo m'malo mwake adzasinthidwa ndi data ikatumizidwa. Mndandanda wa mawu osakira omwe amagwiritsidwa ntchito nthawi zambiri akuwonetsedwa kuti afufuze mwachangu.
The URL Njira imatha kukhala ndi mawu osakira komanso magawo amtundu wa URL. Zosinthazo zitha kukhala NAME=VALUE awiriawiri kapena chinthu cha JSON, kapena mawonekedwe otengera komwe akupita. Eksamples pa Mauthenga Akunja angaphatikizepo %EID% kuwonetsa Chochitika chomwe chayambitsa:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
ExampLes for Heartbeat ikhoza kuwonjezera %ACTIVE% (Zomwe zikuchitika pano) kapena mtengo wa sensor:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Ma %SENSOR:…% amagwiritsa ntchito mayina omwe akupezeka pamitu ya sensa ya kumanja pa log evtYYYYMMDD.csv files. Nthawi zambiri amakhala:
Ngati seva yopita imakonda HTTP PUT kapena POST m'malo mwa zopempha za GET, mutha kuyika patsogolo URL ndi PUT: kapena POST:. Payokha, mutha kuwonjezera malipiro a JSON omwe amadziwika ndi ma seva ambiri powonjezera [JSONBODY] mawu osakira otsatiridwa ndi chinthu chopangidwa ndi JSON. EksampLe:
IKANI:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”chochitika”:”%EID%”}
The URL imathandizira ma adilesi a IP (ndi IPv6) ndi madoko ndi mawu achinsinsi, kapena mutha kugwiritsa ntchito magawo a Ogwiritsa ndi Mawu achinsinsi ngati pakufunika kukhala seva yofikira njira zotsimikizira monga Basic kapena Digest:
https://username:password@123.321.123.321:9876/event…
Njira ya TCP
Zingwe za Mauthenga Akunja ndi Kugunda kwa Mtima ndi za data chabe popeza magawo a Adilesi ndi Madoko amafotokoza komwe akupita. Adilesi imathandizira mayina, IPv4 ndi IPv6.
Chingwecho chikhoza kupangidwa ngati magawo a data a mauthenga a HTTP omwe afotokozedwa pamwambapa, kapena monga momwe seva ikufunira.
Examples pa Mauthenga Akunja angaphatikizepo %EID% kuwonetsa Chochitika chomwe chayambitsa:
malo=%NAME%,zochitika=%EID%
{“location”:”:%NAME%”,”chochitika”:”%EID%”}
ExampLes for Heartbeat ikhoza kuwonjezera %ACTIVE% (Zomwe zikuchitika pano) kapena mtengo wa sensor:
malo=%NAME%&Triggered=%ACTIVE%
{“malo”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Mabokosi a "Integration Set" ndi "Integration Reset" amatsimikizira kuti ndi Zochitika ziti zomwe zimayambitsa kutumiza. Zambiri pakukhazikitsa Zochitika ndi Zochita zikupezeka mu Upangiri wa HALO Administrator.
Kutumiza Mauthenga a Zochitika za JSON
Madivelopa ena amakonda kulandira zidziwitso za Zochitika zojambulidwa ngati mulingo wamakampani omwe amadzitcha kuti JSON m'malo mokhala ndi mawu omveka bwino a ASCII popeza oyambawo amakhala odalirika komanso omasuliridwa mosavuta. Pa HALO web Tsamba la "Messaging", mutha kupereka mauthenga a JSON muzokonda za "Kutumiza Kwakunja" "Set String" ndi "Bwezeretsani Chingwe" komanso mu "Heartbeat" "Uthenga."
Exampzochepa:
Zokonda "Mauthenga Akunja" Ikani Chingwe:
{“chipangizo”:”%NAME%”, “chochitika”:”%EID%”, “alamu”:”inde”}
Izi zidzatumiza uthenga umodzi wa TCP kapena UDP JSON ku seva yotchulidwayo yomwe ikufotokoza dzina lachidziwitso chaubwenzi, dzina la chochitika ndi kuti izo zangoyamba kumene.
Zokonda "Mauthenga Akunja" Bwezeretsani Chingwe:
{“chipangizo”:”%NAME%”, “chochitika”:”%EID%”, “alamu”:”ayi”}
Izi zidzatumiza uthenga umodzi wa TCP kapena UDP JSON ku seva yotchulidwayo yomwe ikufotokoza dzina lachidziwitso chaubwenzi, dzina la chochitika komanso kuti chikhalidwecho chayima.
Uthenga wa "Moyo":
{“chipangizo”:”%NAME%”, “moyo”:”%DATE% %TIME%”}
Izi zidzatumiza uthenga wa TCP kapena UDP JSON nthawi ndi nthawi ku seva yotchulidwa kuti HALO ili ndi moyo pa nthawi yomwe yasonyezedwa.
Zolemba / Zothandizira
 |
Mapulogalamu a HALO Smart Sensor API Basic Software [pdf] Buku Logwiritsa Ntchito HALO Smart Sensor API Basic Software |
