Isoftware ye-HALO Smart Sensor API Basic Software
Phambili
Lo mbhalo uchaza iqoqo lezinsiza ze-Halo Smart Sensor eyaziwa ngokuhlangene ngokuthi i-BASIC API, noma i-Application Programming Interface. Le ngxoxo ihloselwe ukusetshenziswa ngabahleli bohlelo noma abahlanganisi abanentshisekelo yokuhlanganisa izinzwa ezihlakaniphile ze-HALO (ama-HALO) nezingxenye zesofthiwe zenkampani yangaphandle (okungezona i-IPVideo) noma amasistimu. Ngokuvamile, i-HALO API ihloselwe ukudlulisa ulwazi ngokuphumelelayo kusuka ku-HALO ngenethiwekhi evamile ye-Ethernet ohlelweni lwangaphandle. Ukuze ufeze lo mgomo, i-API ihlukaniswe yaba izigaba ezintathu: I-Event Driven Socket Connection, Heartbeat Socket Connection, kanye ne-Event Data. URL. I-interface ye-BACnet nayo ikhona futhi ihlanganiswe kudokhumenti ehlukile.
I-API Design
I-API yakhelwe kusetshenziswa amafomethi ajwayelekile embonini njenge-TCP/IP. I-HTTP, i-HTTPS, ne-JSON. Idizayini ayidingi amasu akhethekile noma okuphathelene noma imitapo yolwazi ukuze isetshenziswe ekuthuthukisweni kohlelo noma isicelo sangaphandle. I-API iyaguquguquka futhi ingalungiselelwa futhi ihlelwe ukuthi ilethe idatha edingekayo kanye nangendlela ephumelela kakhulu. Imininingwane yokusebenza kwesigaba ngasinye kulezi ezingenhla ifakwe ezigabeni ezilandelayo zalo mhlahlandlela.
Umlayezo Wangaphandle
Lesi sikhungo sisetshenziselwa ukuletha izexwayiso noma ama-alamu kanye nedatha yomcimbi kuhlelo lwangaphandle, isistimu ye-VMS, iseva, njll. uma Umcimbi ucushwa (usethiwe). Imilayezo yokuzithandela ingaphinda inikwe amandla ukuze isayine lapho Umcimbi usula (usethwa kabusha). Lokhu kulethwa kungenziwa kusokhethi ye-TCP/IP noma iseva ye-HTTP/S ngesikhathi sangempela. Kunohlu lwamaphrothokholi alungisekayo anokuqukethwe okwenziwa ngendlela oyifisayo. Ukufakazela ubuqiniso nokubethela kuyatholakala.
Ukushaya kwenhliziyo
Imilayezo yokushaya kwenhliziyo ithunyelwa ngesikhathi esilungisekayo (esikhundleni sokuthi uma Imicimbi icushwa) ukuze kunikezwe ubufakazi bokuphila/ukutholakala. Zinobubanzi obufanayo bamakhono njengeMilayezo Yangaphandle kodwa ngokuvamile zizolungiselelwa ukuthi ziqukathe ulwazi lwesifunda oluvamile kunemininingwane mayelana nomcimbi othile.
Idatha Yomcimbi URL
Lesi sikhungo sitholakala kuphela ngaphansi kwe-NDA futhi kufanele sisetshenziswe kuphela uma uhlelo lwangaphandle ludinga ukufinyelela kunoma yimaphi kanye nawo wonke amanani omcimbi, ama-threshold, namafulegi ezwe. Le datha ivamise ukubuyiswa ngokufunwa wuhlelo lwangaphandle kodwa hhayi ngefrikhwensi ephezulu kakhulu. Le ndlela ngokuvamile idala ukubambezeleka okuthile lapho kusetshenziswa izinga elincane lokuvota. Amazinga okuvota ajwayelekile aqala kanye ngomzuzu ukuya kanye ngamasekhondi angu-5 anenani eliphakeme eliphelele lokukodwa ngomzuzwana. Le ndlela ingase futhi isetshenziselwe ukubuyisa idatha eyengeziwe esekelayo lapho Isehlakalo (isexwayiso) sitholwa.
Imininingwane yangaphandle yomlayezo
Ingxenye ye-HALO web I-popup yokuhlanganisa ihlinzeka ngokucushwa koxhumano lwenkampani yangaphandle lapho amanani ahlukahlukene angathunyelwa kusokhethi ye-TCP ekude noma iseva ye-HTTP/HTTPS. Izibambi zendawo (amathokheni) zisetshenziselwa ukufaka amanani abukhoma embhalweni odlulisiwe. Nakuba sibhalwe ukuthi “Imilayezo Yangaphandle,” lesi siteshi singasetshenziselwa cishe noma iyiphi injongo edinga izingcupho zesikhathi sangempela zomcimbi, ezilethwa nge-HALO. Lolu hlelo luvumelana nezimo ngoba okukhethiwe kokuthi “Izenzo” kunquma ukuthi imiphi Imicimbi ye-HALO esakazwa ngalesi siteshi.
Kumodi ye-HTTP, i-Setha futhi Setha kabusha Izintambo ziyi- URLs okufanele ifakwe futhi ifomethwe njengoba kudingwa iseva yendawo oyifunayo. Inkambu yomsebenzisi nephasiwedi ingasetshenziselwa ukufakazela ubuqiniso. Bona imodi ye-HTTP ngezansi.
Kumodi ye-TCP, i-Setha futhi Setha Kabusha Izintambo kuphela idatha yomlayezo owodwa othunyelwa kusokhethi eyamukelayo ye-TCP. Angafomethwa njengoba kudingwa ngendawo okuyiwa kuyo. Indawo okuyiwa kuyo icaciswe ezinkambini zekheli kanye Nembobo. Bona Imodi ye-TCP ngezansi.
Kunoma iyiphi imodi, isimo esivela kumlayezo wakamuva siyaboniswa esingasiza ukulungisa uxhumano noma ezinye izinkinga. Ungasebenzisa izinkinobho ze-TEST yomcimbi ku-popup ye-Actions ukuze uphoqelele umlayezo:
I-Global On/Off Yokusetha noma Ukusetha Kabusha kufanele Kuvulwe ukuze lezo zinhlobo zemilayezo zinike amandla. Ukusetha kabusha ngokuvamile akusetshenziswa ngoba ukuqala komcimbi kuphela okuthakaselayo, kodwa lokho kungahluka. Umcimbi ngamunye ungacacisa ngokuzimela uma uzosebenzisa okuthi Setha noma umlayezo Wokusetha Kabusha ku-popup Yezenzo. Izinkinobho zenhlamvu yeso zizobonisa ukumelwa okuqinile kwalokho okuthunyelwa ngemva kokufaka esikhundleni samagama angukhiye nokufometha. I-Repeat Holdoff ingase isetshenziselwe ukucindezela imilayezo evamile ngokulibazisa ngaphambi kokuthi kuthunyelwe omunye. Lokhu kwenziwa ngokuzimela ngomcimbi ngamunye. I-HALO inesikhathi sokubamba esakhelwe ngaphakathi semicimbi yamasekhondi ayi-15 ukuvimbela ukuphinda kuqalwe kabusha kwemicimbi. Uma ubufuna ukuqinisekisa ukuthi akuthunyelwe Isehlakalo sohlobo esingaphezu ko-1 ngeminithi, ungasetha okuthi Phinda Ukubamba kube ngu-60 (amasekhondi).
Imininingwane yokushaya kwenhliziyo
I-Heartbeat transmissions isebenza ngendlela efanayo nalokhu okungenhla ngaphandle kokuthi akukho ukusebenzisana nekhasi le-Actions. Esikhundleni salokho, ukudluliswa kwe-Heartbeat kwenzeka njalo njengoba kulungiselelwe nenkambu ye-Interval, Kumodi ye-HTTP, i-Set and Reset Strings yizo. URLs okufanele ifakwe futhi ifomethwe njengoba kudingwa iseva yendawo oyifunayo. Inkambu yomsebenzisi nephasiwedi ingasetshenziselwa ukufakazela ubuqiniso. Bona imodi ye-HTTP ngezansi.
Nakuba inhloso eyinhloko ye-Heartbeat iwukunikeza ubufakazi bempilo ye-HALO Smart Sensor kuhlelo lokusebenza olukude, lo mlayezo ungase futhi usetshenziselwe ukudlulisa izinzwa ezikhethiwe noma ulwazi lwamanje lwesimo somcimbi. I-example ngenhla ithumela ipharamitha yeyunithi yezinhlamvu ende ne URL okuhlanganisa igama le-Halo, iningi lamanani enzwa, futhi okokugcina okuthi Triggered=%ACTIVE% okungase kungabi nalutho noma uhlu Lwezehlakalo ezicushiwe njengamanje.
Imodi ye-HTTP (ne-HTTPS).
Imiyalezo yangaphandle kanye neyunithi yezinhlamvu ze-Heartbeat ingaba ngu-http: noma i-https: URLs njengoba kudingeka. Indlela namapharamitha kungafakwa njengoba kudingwa iseva yendawo. Amagama angukhiye afana no-%NAME% (igama ledivayisi ye-HALO) noma %EID% (I-id yomcimbi) angafakwa njengoba kudingeka futhi azothathelwa indawo idatha ethile lapho umlayezo uthunyelwa. Uhlu lwamagama angukhiye asetshenziswa kakhulu aboniswa ukuze kusetshenziswe ireferensi ngokushesha.
I URL path ingaqukatha amagama angukhiye kanye namapharamitha ku- URL. Amapharamitha angase abe amapheya angu-NAME=VALUE noma into ye-JSON, noma ifomethi yangokwezifiso kuye ngeseva yendawo. ExampI-les Yokulayeza Kwangaphandle izofaka %EID% ukukhombisa Isehlakalo esiqalisile:
- 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 ingase yengeze %ACTIVE% (imicimbi ecushiwe njengamanje) noma inani lenzwa:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Amanani %SENSOR:…% asebenzisa amagama atholakala ezihlokweni zenzwa yesandla sokudla kulogi evtYYYYMMDD.csv files. Ngokuvamile ziyi:
Uma iseva yendawo ikhetha i-HTTP PUT noma i-POST esikhundleni sezicelo ze-GET, ungafaka isiqalo URL nge-PUT: noma THUMELA:. Ngokuzimela, ungakwazi ukwengeza inkokhelo ye-JSON edume ngamaseva amaningi ngokwengeza igama elingukhiye elithi [JSONBODY] lilandelwa into efomethwe i-JSON. Example:
PUT:https://server.com/event[JSONBODY]{“indawo”:”%NAME%”,”umcimbi”:”%EID%”}
I URL isekela ikheli le-IP elivamile (kanye ne-IPv6) kanye nembobo nezinketho zephasiwedi yomsebenzisi, noma ungasebenzisa izinkambu Zomsebenzisi Nephasiwedi uma kudingeka kube iseva yendawo yezindlela zokuqinisekisa ezifana ne-Basic or Digest:
https://username:password@123.321.123.321:9876/event…
Imodi ye-TCP
Umlayezo Wangaphandle kanye nezintambo ze-Heartbeat nje ezedatha njengoba izinkambu zekheli kanye Nembobo zicacisa indawo okuyiwa kuyo. Ikheli lisekela amagama, IPv4 kanye ne-IPv6.
Iyunithi yezinhlamvu ingafomethwa njengezingxenye zedatha yemilayezo ye-HTTP echazwe ngenhla, noma njengoba kudingwa iseva yendawo.
ExampI-les Yokulayeza Kwangaphandle izofaka %EID% ukukhombisa Isehlakalo esiqalisile:
indawo=%NAME%,isehlakalo=%EID%
{“indawo”:”:%NAME%”,”umcimbi”:”%EID%”}
ExampI-les ye-Heartbeat ingase yengeze %ACTIVE% (imicimbi ecushiwe njengamanje) noma inani lenzwa:
indawo=%NAME%&Triggered=%ACTIVE%
{“indawo”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Amabhokisi okuhlola kumakholomu athi “Isethi Yokuhlanganisa” kanye “Nokusetha Kabusha Ukuhlanganiswa” anquma ukuthi imiphi Imicimbi ebangela ukuthunyelwa. Okuningi ngokusetha Imicimbi Nezenzo kuyatholakala Kumhlahlandlela Womqondisi we-HALO.
Ukulethwa Kwemilayezo Yomcimbi we-JSON
Abanye onjiniyela bancamela ukuthola idatha yomcimbi efomethwe njengezinga lomkhakha elizilebula ngokuthi i-JSON kunombhalo we-ASCII ongenalutho njengoba owokuqala ucutshungulwa ngokuthembekile futhi kalula. Ku-HALO web ikhasi elithi “Imiyalezo”, ungahlinzeka ngemilayezo ye-JSON kokuthi “Imilayezo Yangaphandle” izilungiselelo “Setha Iyunithi Yezinhlamvu” kanye “Nesetha Kabusha Iyunithi Yezinhlamvu” naku-“Heartbeat” “Umlayezo.”
Exampkancane:
"Imilayezo Yangaphandle" Isetha Iyunithi Yezinhlamvu:
{“idivayisi”:”%NAME%”, “umcimbi”:”%EID%”, “i-alamu”:”yebo”}
Lokhu kuzothumela umlayezo owodwa we-TCP noma we-UDP JSON kuseva eshiwo ebika igama ledivayisi enobungane, igama lomcimbi nokuthi isanda kuqala.
Izilungiselelo "Zokulayeza Kwangaphandle" Setha Kabusha Iyunithi Yezinhlamvu:
{“idivayisi”:”%NAME%”, “umcimbi”:”%EID%”, “i-alamu”:”cha” }
Lokhu kuzothumela umlayezo owodwa we-TCP noma we-UDP JSON kuseva eshiwo ebika igama ledivayisi enobungane, igama lomcimbi nokuthi umbandela manje umile.
Umlayezo othi “Ukushaya kwenhliziyo”:
{“idivayisi”:”%NAME%”, “iyaphila”:”%DATE% %TIME%” }
Lokhu kuzothumela ngezikhathi ezithile umlayezo we-TCP noma we-UDP JSON kuseva ethile ebika ukuthi i-HALO iyaphila ngesikhathi esibonisiwe.
Amadokhumenti / Izinsiza
 |
Isoftware ye-HALO Smart Sensor API Basic Software [pdf] Umhlahlandlela Womsebenzisi I-HALO Smart Sensor API Basic Software |
