Isoftware s HALO Smart Sensor API Basic Software
Phambili
Olu xwebhu luchaza iqela lezixhobo ze-Halo Smart Sensor eyaziwa ngokudibeneyo njenge-BASIC API, okanye i-Application Programming Interface. Le ngxoxo ihloselwe ukusetyenziswa ngabaprogram okanye abahlanganisi abanomdla wokudibanisa enye okanye ngaphezulu kwe-HALO Smart Sensors (HALOs) kunye ne-3rd party (non-IPVideo) amacandelo esoftware okanye iinkqubo. Ngokubanzi, i-HALO API ihlose ukudlulisa ulwazi ngokufanelekileyo kwi-HALO ngaphaya kwenethiwekhi ye-Ethernet yesiqhelo kwinkqubo yangaphandle. Ukufezekisa le njongo, i-API ihlulwe ibe ngamacandelo amathathu: i-Event Driven Socket Connection, i-Heartbeat Socket Connection, kunye neDatha yoMcimbi. URL. Ujongano lweBACnet lukwakhona kwaye lugutyungelwe kuxwebhu olwahlukileyo.
Uyilo lwe-API
I-API yenzelwe ukusebenzisa iifomati ezisemgangathweni zeshishini ezifana ne-TCP / IP. HTTP, HTTPS, kunye neJSON. Uyilo alufuni naziphi na iindlela ezikhethekileyo okanye zobunini okanye amathala eencwadi ukuba asetyenziswe kuphuhliso lweprogram yangaphandle okanye isicelo. I-API iguquguquka kwaye inokulungiswa kwaye icwangciswe ukuba inikezele ngokuthe ngqo idatha efunekayo kwaye ngendlela efanelekileyo kakhulu. Iinkcukacha zokusebenza kwecandelo ngalinye kula angasentla zichazwe kula macandelo alandelayo esi sikhokelo.
uMyalezo waNgaphandle
Olu ncedo lusetyenziselwa ukuhambisa izilumkiso okanye ii-alamu kunye neenkcukacha zeSigigaba kwiprogram yangaphandle, inkqubo yeVMS, iseva, njl. Imiyalezo ekhethwayo inokuthi yenziwe ukuba inike umqondiso xa uMnyhadala ucinyiwe (usetwa ngokutsha). Olu nikezelo lunokwenziwa kwisokhethi ye-TCP/IP okanye iseva ye-HTTP/S ngexesha langempela. Kukho uluhlu lweeprothokholi ezilungiselelwayo ezinemixholo enokwenziwa ngokwezifiso. Uqinisekiso kunye noguqulelo oluntsonkothileyo luyafumaneka.
Ukubetha kwentliziyo
Imiyalezo yokubetha kwentliziyo ithunyelwa ngesithuba esilungiselelwayo (endaweni yokuba xa iziganeko ziqhutywa) ukunika ubungqina bokuphila/ukufumaneka. Banoluhlu lwezakhono ezifanayo njengoThunyelo lwaNgaphandle kodwa ngokuqhelekileyo luza kuqwalaselwa ukuba luqulathe ulwazi lwelizwe ngokubanzi kuneenkcukacha malunga nesiganeko esithile.
Idatha yesiganeko URL
Olu ncedo lufumaneka kuphela phantsi kwe-NDA kwaye kufuneka lusetyenziswe kuphela xa inkqubo yangaphandle ifuna ukufikelela kuyo nayiphi na kunye nawo onke amaxabiso oMnyhadala, imiqobo, kunye neeflegi zikarhulumente. Le datha ifunyanwa ngokubanzi ngokufunwa yinkqubo yangaphandle kodwa hayi kwifrikhwensi ephezulu kakhulu. Le ndlela ngokubanzi ibangela ukubambezeleka okuthile xa kusetyenziswa ireyithi yokuvota ethobekileyo. Amazinga okuvota aqhelekileyo aqala kanye ngomzuzu ukuya kubekanye ngesekondi ezi-5 kunye nowona mlinganiselo uphezulu kanye ngesekhondi. Le ndlela ingasetyenziselwa ukubuyisela idatha eyongezelelweyo exhasayo xa isiganeko (isilumkiso) sifunyenwe.
Iinkcukacha zoMyalezo wangaphandle
Icandelo le-HALO web ujongano Udibaniso oluzivelelayo lubonelela ngoqwalaselo loqhagamshelo lweqela lesithathu apho amaxabiso ahlukeneyo anokuthunyelwa kwindawo ekude ye-TCP okanye kwiseva ye-HTTP/HTTPS. Izibambi zendawo (iithokheni) zisetyenziselwa ukufaka amaxabiso aphilayo kumbhalo ogqithisiweyo. Nangona ibhalwe "Imiyalezo yaNgaphandle," eli jelo linokusetyenziswa phantse kuyo nayiphi na injongo efuna ixesha lokwenyani izibambi zezehlo, ezihanjiswa ngenkuthalo yi-HALO. Olu lungiselelo lubhetyebhetye kakhulu kuba okukhethiweyo kwi-"Actions" kumisela ukuba yeyiphi iMinyhadala ye-HALO ethunyelwa ngeli jelo.
Kwimo ye-HTTP, i-Seta kunye nokuSeta kwakhona iMitya yi URLs ekufuneka ifakwe kwaye ifomathwe njengoko ifunwa ngumncedisi wendawo efunwayo. Indawo yomsebenzisi kunye negama lokugqithisa lingasetyenziselwa ukuqinisekiswa. Jonga imo ye-HTTP ngezantsi.
Kwimo ye-TCP, i-Set and Reset Strings yidatha yomyalezo owodwa othunyelwa kwi-socket ye-TCP efumanayo. Zinokufomathwa njengoko zifuneka kwindawo ekuyiwa kuyo. Indawo ekuyiwa kuyo ichaziwe kwidilesi yeDilesi nakwiZibuko. Jonga iModi ye-TCP ngezantsi.
Kuyo nayiphi na indlela, isimo esisuka kowona myalezo wamva nje siyaboniswa enokunceda ukulungisa uxhulumaniso okanye eminye imiba. Ungasebenzisa iSigigaba TEST amaqhosha kwiZenzo ezivelelayo ukunyanzela umyalezo:
IGlobal On/Cime ukuSeta okanye ukuSeta ngokutsha kufuneka Vula ukuze ezo ndidi zemiyalezo zisebenze. Ukuseta kwakhona akusoloko kusetyenziswa kuba kukuqala koMnyhadala kuphela okunomdla, kodwa oko kunokwahluka. Isiganeko ngasinye singachaza ngokuzimeleyo ukuba sizakusebenzisa nokuba Seta okanye Seta kwakhona umyalezo kwi-Actions popup. Amaqhosha e-eyeball aya kubonisa ukubonakaliswa okukrakra koko kuthunyelwe emva kokutshintshwa kwegama elingundoqo kunye nokufomatha. Ukuphinda-phinda iHoldoff inokusetyenziselwa ukucinezela imiyalezo rhoqo ngokulibazisa ngaphambi kokuba kuthunyelwe omnye. Oku kwenziwa ngokuzimeleyo ngeSiganeko ngasinye. I-HALO inexesha elakhelwe ngaphakathi lokubamba imicimbi yemizuzwana ye-15 ukuthintela ukubuyiswa ngokukhawuleza kweZiganeko. Ukuba ubufuna ukuqinisekisa ukuba akukho Isiganeko esi-1 sohlobo esithunyelwayo ngomzuzu, ungaseta Phinda ubambe ku-60 (imizuzwana).
Iinkcukacha zokubetha kwentliziyo
I-Heartbeat transmissions isebenza ngendlela efanayo nalapha ngasentla ngaphandle kokuba akukho ukusebenzisana kwiphepha leZenzo. Endaweni yoko, ukuhanjiswa kwe-Heartbeat kwenzeka rhoqo njengoko kuqwalaselwe nge-Interval field, Kwimo ye-HTTP, i-Set and Reset Strings URLs ekufuneka ifakwe kwaye ifomathwe njengoko ifunwa ngumncedisi wendawo efunwayo. Indawo yomsebenzisi kunye negama lokugqithisa lingasetyenziselwa ukuqinisekiswa. Jonga imo ye-HTTP ngezantsi.
Nangona injongo ephambili ye-Heartbeat kukubonelela ubungqina bobomi be-HALO Smart Sensor kwisicelo esikude, lo myalezo ungasetyenziselwa ukuhambisa i-sensor ezikhethiweyo okanye ulwazi lwangoku loMcimbi welizwe. Example ngasentla ithumela iparameter yomtya omde nge URL equka igama le-Halo, uninzi lwamaxabiso oluvo, kwaye okokugqibela I- Triggered=% ACTIVE% enokungabinanto okanye uluhlu lweziganeko eziqhutywayo ngoku.
Imowudi yeHTTP (kunye neHTTPS).
Imiyalezo yangaphandle kunye neentambo zeHeartbeat zingaba yi-http: okanye i-https: URLs njengoko kufuneka. Indlela kunye neeparamitha zingangenwa njengoko zifunwa ngumncedisi wendawo. Amagama angundoqo afana ne-%NAME% (igama lesixhobo se-HALO) okanye i-%EID% (Isazisi somsitho) anokufakwa njengoko kufuneka kwaye endaweni yakhe kuya kufakwa iinkcukacha ezithile xa umyalezo uthunyelwa. Uluhlu lwamagama angundoqo asetyenziswa ngokuqhelekileyo aboniswa ngokukhawuleza.
I URL umendo ungaqulatha amagama angundoqo kunye neeparameters kwi URL. Iiparamitha zinokuba NAME=VALUE ngababini okanye into ye-JSON, okanye ifomati yesiko ngokuxhomekeke kumncedisi wendawo. Eksamples yoMyalezo waNgaphandle ingaquka i-%EID% ukubonisa iSiganeko esiqhamkileyo:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Exampi-les ye-HeartBeat inokongeza i-% ACTIVE% (iziganeko ezikhoyo ngoku) okanye ixabiso loluvo:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
I-%SENSOR:...% amaxabiso asebenzisa amagama afunyenwe kwisihloko sekholamu yoluvo lwasekunene kwilog evtYYYYMMDD.csv files. Ngokuqhelekileyo ngaba:
Ukuba umncedisi wendawo ukhetha i-HTTP PUT okanye i-POST endaweni yezicelo zeGET, ungenza isimaphambili URL nge PUT: okanye POST:. Ngokuzimeleyo, unokongeza umthamo we-JSON ohlawulwayo odumileyo kwiiseva ezininzi ngokongeza igama elingundoqo elithi [JSONBODY] lilandelwa yinto efomathiweyo ye-JSON. Eksample:
BEKA:https://server.com/event[JSONBODY]{“indawo”:”%NAME%”,”isiganeko”:”%EID%”}
I URL ixhasa idilesi yesiqhelo ye IP (kunye ne IPv6) kunye nezibuko kunye nomsebenzisi-igama lokugqitha, okanye ungasebenzisa uMsebenzisi kunye nomhlaba wePasssword ukuba kufuneka ibe ngumncedisi wendawo ekuyiwa kuyo iindlela zoqinisekiso njengeSiseko okanye iDigest:
https://username:password@123.321.123.321:9876/event…
Imowudi ye-TCP
Imitya yoMyalezo waNgaphandle kunye neBeth yentliziyo zezedatha nje ukusukela ukuba idilesi kunye neendawo zeSibuko zichaza indawo ekuyiwa kuyo. Idilesi ixhasa amagama, IPv4 kunye ne IPv6.
Umtya unokufomathwa njengezahlulo zedatha yemiyalezo yeHTTP echazwe ngasentla, okanye njengoko ifunwa ngumncedisi wendawo.
Examples yoMyalezo waNgaphandle ingaquka i-%EID% ukubonisa iSiganeko esiqhamkileyo:
indawo=%NAME%,umcimbi=%EID%
{“indawo”:”:%NAME%”,”umsitho”:”%EID%”}
Exampi-les ye-HeartBeat inokongeza i-% ACTIVE% (iziganeko ezikhoyo ngoku) okanye ixabiso loluvo:
indawo=%NAME%&Triggered=%ACTIVE%
{“indawo”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Iibhokisi zokukhangela kwi-"Iseti yoHlanganiso" kunye nekholamu "yokuseta ngokutsha ukuHlanganisa" imisela ukuba yeyiphi iMisitho eqalisa ukuthumela. Okungakumbi malunga nokusekwa kweMicimbi kunye neZenzo kufumaneka kwi-HALO Administrator's Guide.
Ukuhanjiswa kweMiyalezo yoMnyhadala weJSON
Abanye abaphuhlisi bakhetha ukufumana iData yoMsitho efomathiweyo njengomgangatho woshishino ozibhala ngokwawo nge-JSON kunesicatshulwa esicacileyo se-ASCII njengoko esokuqala sithembekile kwaye sicazululwa ngokulula. Kwi-HALO web iphepha elithi "Imiyalezo", unganikezela ngemiyalezo ye-JSON kwisetingi "yokuThunyelwa kwaNgaphandle" kwaye "Seta umtya" kunye "noSetha kwakhona umtya" kunye nakwi "Heartbeat" "Umyalezo."
Exampngaphantsi:
"Umyalezo Wangaphandle" Useto lweSetingi:
{“isixhobo”:”%NAME%”, “isiganeko”:”%EID%”, “i-alarm”:”ewe”}
Oku kuya kuthumela umyalezo omnye we-TCP okanye we-UDP JSON kwiseva ekhankanyiweyo echaza igama lesixhobo sobuhlobo, igama lesiganeko kunye nokuba isanda kuqala.
"Umyalezo Wangaphandle" useta ngokutsha umtya:
{“isixhobo”:”%NAME%”, “isiganeko”:”%EID%”,“i-alarm”:”hayi”}
Oku kuya kuthumela umyalezo omnye we-TCP okanye we-UDP JSON kwiseva ekhankanyiweyo echaza igama lesixhobo esinobubele, igama lesiganeko kwaye imeko iyekile ngoku.
“Ukubetha kwentliziyo”:
{“isixhobo”:”%NAME%”, “siyaphila”:”%DATE% %TIME%”}
Oku kuya kuthumela rhoqo i-TCP okanye i-UDP JSON umyalezo kwiseva echaziweyo echaza ukuba i-HALO iyaphila ngexesha elibonisiweyo.
Amaxwebhu / Izibonelelo
 |
Isoftware s HALO Smart Sensor API Basic Software [pdf] Isikhokelo somsebenzisi HALO Smart Sensor API Basic Software |
