Software na HALO Smart Sensor API Basic Software
Gaba
Wannan takaddar tana bayyana rukunin wuraren Halo Smart Sensor wanda aka sani tare da BASIC API, ko Interface Programming Interface. An yi nufin wannan tattaunawar don amfani da masu shirye-shirye ko masu haɗawa waɗanda ke da sha'awar haɗa ɗaya ko fiye da HALO Smart Sensors (HALOs) tare da ɓangarori ko tsarin software na ɓangare na uku (marasa IPVideo). Gabaɗaya, HALO API an yi niyya don canja wurin bayanai da kyau daga HALO akan hanyar sadarwar Ethernet ta al'ada zuwa shirin waje. Don cim ma wannan burin, API ɗin ya kasu kashi uku: Haɗin Socket Driven Event, Connection Socket Socket, da Event Data URL. BACnet interface yana nan kuma an rufe shi a cikin wani takarda daban.
API Design
An ƙirƙira API ɗin ta amfani da daidaitattun tsarin masana'antu kamar TCP/IP. HTTP, HTTPS, da JSON. Zane baya buƙatar kowane fasaha na musamman ko na mallakar mallaka ko ɗakunan karatu da za a yi amfani da su wajen haɓaka shirin ko aikace-aikacen waje. API ɗin yana da sassauƙa kuma ana iya daidaita shi kuma a tsara shi don isar da ainihin bayanan da ake buƙata kuma a cikin mafi inganci. An rufe cikakkun bayanai game da aikin kowane ɓangaren da ke sama a cikin sassan wannan jagorar.
Saƙon Waje
Ana amfani da wannan wurin don isar da faɗakarwa ko ƙararrawa da bayanan abubuwan zuwa shirin waje, tsarin VMS, uwar garken, da sauransu lokacin da aka kunna wani abu (an saita). Hakanan za'a iya kunna saƙon zaɓi don yin sigina lokacin da wani abu ya share (an sake saitawa). Ana iya yin wannan isarwa zuwa soket na TCP/IP ko sabar HTTP/S a ainihin lokacin. Akwai kewayon ƙa'idodi masu daidaitawa tare da abubuwan da za a iya daidaita su. Akwai tabbaci da ɓoyewa.
bugun zuciya
Ana aika saƙon bugun zuciya a tazara mai daidaitawa (maimakon lokacin da aka kunna abubuwan da suka faru) don ba da tabbacin rayuwa/samuwa. Suna da nau'ikan iyawa iri ɗaya kamar Saƙon Waje amma yawanci za'a saita su don ƙunsar bayanan jaha gaba ɗaya maimakon cikakkun bayanai game da wani taron.
Bayanan Halittu URL
Wannan wurin yana samuwa ne kawai a ƙarƙashin NDA kuma yakamata a yi amfani da shi kawai lokacin da shirin na waje yana buƙatar samun dama ga kowane da duk ƙimar abubuwan da suka faru, ƙofa, da tutocin jihohi. Gabaɗaya ana dawo da wannan bayanan bisa buƙata ta shirin waje amma ba a mitar mai yawa ba. Wannan hanyar gabaɗaya tana haifar da ɗan jinkiri lokacin da aka yi amfani da matsakaicin adadin zaɓe. Matsakaicin adadin kada kuri'a yana daga sau ɗaya a minti daya zuwa sau ɗaya a cikin daƙiƙa 5 tare da madaidaicin ƙimar sau ɗaya a cikin daƙiƙa guda. Hakanan za'a iya amfani da wannan hanyar don dawo da ƙarin bayanan tallafi lokacin da aka karɓi wani abu (jijjiga).
Bayanin Saƙon Waje
Wani sashe na HALO web Interface Haɗin kai yana ba da tsari na haɗin ƙungiya ɗaya na uku inda za'a iya aika dabi'u iri-iri zuwa soket na TCP mai nisa ko sabar HTTP/HTTPS. Ana amfani da masu riƙe wuri (alamu) don saka ƙimar rayuwa cikin rubutun da aka watsa. Ko da yake an yi wa lakabi da "Saƙon Waje," ana iya amfani da wannan tashar don kusan kowane dalili da ke buƙatar abubuwan da suka faru na ainihin lokaci, wanda HALO ke bayarwa. Wannan tsari yana da sauƙin sassauƙa saboda zaɓin da ke kan “Ayyukan” suna tantance abubuwan da HALO ke watsa ta wannan tashar.
A cikin yanayin HTTP, Saiti da Sake saitin saitin sune URLs wanda dole ne a shigar da kuma tsara shi kamar yadda ake buƙata ta uwar garken inda ake so. Ana iya amfani da filin mai amfani da kalmar wucewa don tantancewa. Duba yanayin HTTP a ƙasa.
A yanayin TCP, Saita da Sake saitin saitin bayanai ne kawai na saƙo ɗaya da aka aika zuwa soket na TCP mai karɓa. Ana iya tsara su kamar yadda ake buƙata ta wurin manufa. An kayyade wurin zuwa a cikin adireshi da filayen tashar jiragen ruwa. Duba Yanayin TCP a ƙasa.
Ga kowane yanayi, matsayi daga saƙon kwanan nan yana nunawa wanda zai iya taimakawa shine gyara haɗin gwiwa ko wasu batutuwa. Kuna iya amfani da maɓallan TEST na Event akan buƙatun Ayyuka don tilasta saƙo:
Kunnawa/Kashe Duniya don Saita ko Sake saitin dole ne a Kunna don kunna waɗannan nau'ikan saƙonnin. Sake saitin sau da yawa ba a amfani da shi saboda farkon abin da ya faru ne kawai abin sha'awa, amma hakan na iya bambanta. Kowane lamari na iya ƙayyade kansa idan zai yi amfani da Saiti ko Sake saitin saƙon akan faɗuwar Ayyuka. Maɓallan ƙwallon ido za su nuna ƙaƙƙarfan wakilci na abin da aka aika bayan musanya keyword da tsarawa. Ana iya amfani da Maimaita Holdoff don murƙushe saƙonni akai-akai ta jinkirta kafin a iya aika wani. Ana yin wannan ne da kansa ta kowace Biki. HALO yana da ginannen lokacin riƙewa don abubuwan da suka faru na daƙiƙa 15 don hana saurin sakewa na abubuwan da suka faru. Idan kuna son tabbatar da cewa ba a aika da abu sama da 1 na nau'in abu ba a cikin minti daya, zaku iya saita Maimaita Holdoff zuwa 60 (dakika).
Bayanin bugun zuciya
Watsawar bugun zuciya tana aiki ta hanya mai kama da na sama sai dai babu wani mu'amala da shafin Ayyuka. Madadin haka, watsawar bugun zuciya yana faruwa akai-akai kamar yadda aka tsara tare da filin Interval, A cikin yanayin HTTP, Saita da Sake saitin igiyoyi sune URLs wanda dole ne a shigar da kuma tsara shi kamar yadda ake buƙata ta uwar garken inda ake so. Ana iya amfani da filin mai amfani da kalmar wucewa don tantancewa. Duba yanayin HTTP a ƙasa.
Yayin da ainihin manufar bugun zuciya shine samar da tabbacin rayuwar HALO Smart Sensor zuwa aikace-aikacen nesa, ana iya amfani da wannan saƙon don isar da zaɓaɓɓun firikwensin ko bayanin yanayin Halin halin yanzu. The example sama yana aika madaidaicin kirtani mai tsayi tare da URL wanda ya haɗa da sunan Halo, yawancin ƙimar firikwensin, kuma a ƙarshe An Ƙarfafawa =% ACTIVE% wanda zai iya zama fanko ko jerin abubuwan da aka jawo a halin yanzu.
HTTP (da HTTPS) Yanayin
Saƙon waje da igiyoyin bugun zuciya na iya zama http: ko https: URLs kamar yadda ake bukata. Ana iya shigar da hanya da sigogi kamar yadda ake buƙata ta uwar garken manufa. Za'a iya shigar da kalmomi kamar %NAME% (sunan na'urar HALO) ko % EID% (Id Event) kamar yadda ake buƙata kuma za'a musanya su da bayanai daban-daban lokacin da aka aika saƙon. Ana nuna jerin kalmomin da aka saba amfani da su don tunani cikin sauri.
The URL hanya na iya ƙunsar kalmomi masu mahimmanci da ma'auni zuwa ga URL. Ma'auni na iya zama NAME=VALUE nau'i-nau'i ko wani abu JSON, ko tsari na al'ada ya danganta da uwar garken manufa. Exampdon Saƙon Waje zai haɗa da % EID% don nuna Lamarin da ya jawo:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples don bugun zuciya na iya ƙara % ACTIVE% (Abubuwan da suka jawo a halin yanzu) ko ƙimar firikwensin:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Ƙimar % SENSOR:… % suna amfani da sunaye da aka samo a cikin taken shafi na firikwensin hannun dama a cikin log ɗin evtYYYYMMDD.csv files. Yawanci su ne:
Idan uwar garken manufa ta fi son HTTP PUT ko POST maimakon buƙatun GET, za ku iya yin prefixing URL tare da PUT: ko POST:. Kai tsaye, zaku iya ƙara kayan aikin JSON wanda ya shahara da sabobin yawa ta hanyar ƙara kalmar [JSONBODY] da wani abu da aka tsara na JSON ya biyo baya. Exampda:
PUT:https://server.com/event[JSONBODY]{"wuri":"%NAME%", taron":"%EID%"}
The URL yana goyan bayan adireshin IP na al'ada (da IPv6) da tashar jiragen ruwa da zaɓuɓɓukan kalmar sirri, ko zaka iya amfani da filayen Mai amfani da kalmar wucewa idan an buƙata zama uwar garken manufa don hanyoyin tantancewa kamar Basic ko Digest:
https://username:password@123.321.123.321:9876/event…
Yanayin TCP
Saƙon waje da igiyoyin bugun zuciya don bayanai ne kawai tun da adireshi da filayen tashar jiragen ruwa sun ƙayyade wurin da ake nufi. Adireshin yana goyan bayan sunaye, IPv4 da IPv6.
Za a iya tsara kirtani kamar sassan bayanan saƙon HTTP da aka kwatanta a sama, ko kamar yadda uwar garken manufa ta buƙata.
Exampdon Saƙon Waje zai haɗa da % EID% don nuna Lamarin da ya jawo:
location=%NAME%, event=%EID%
{"wuri":":%NAME%"," taron":"%EID%"}
Examples don bugun zuciya na iya ƙara % ACTIVE% (Abubuwan da suka jawo a halin yanzu) ko ƙimar firikwensin:
wuri =% NAME%&Tsarin =% ACTIVE%
{"wuri":":%NAME%","NH3":%SENSOR:NH3%}
Akwatunan rajista a cikin ginshiƙan “Sake saitin Haɗin kai” da “Sake saitin Haɗin kai” suna tantance waɗanne abubuwan da suka faru ke jawo aikawa. Ana samun ƙarin akan saitin abubuwan da suka faru da Ayyuka a cikin Jagorar Mai Gudanarwa ta HALO.
Isar da Saƙonnin Taron JSON
Wasu masu haɓakawa sun fi son karɓar bayanan taron da aka tsara azaman ma'aunin masana'antu mai lakabin JSON da kansa maimakon rubutu na ASCII na fili kamar yadda tsohon ya fi dogaro da sauƙin fassarori. Na HALO web shafin "Saƙonni" shafin, za ka iya samar da saƙonnin JSON a cikin "Saƙon Waje" saituna "Sai saitin" da "Sake saita saitin" kuma a cikin "Heartbeat" "Saƙo."
Exampda:
Saitin Saitin "Saƙon Waje":
{"na'urar":"% NAME%", "lawali":"%EID%", "ararrawa":"yes"}
Wannan zai aika saƙon TCP guda ɗaya ko UDP JSON zuwa keɓaɓɓen uwar garken yana ba da rahoton sunan na'urar abokantaka, sunan taron da kuma cewa yanzu ya fara.
"Saƙon Waje" Saitunan Sake saita Saituna:
{"na'urar":"%NAME%", "lawali":"%EID%", "alam":"a'a"}
Wannan zai aika saƙon TCP guda ɗaya ko UDP JSON zuwa keɓaɓɓen uwar garken yana ba da rahoton sunan na'urar abokantaka, sunan taron da kuma cewa yanayin ya tsaya yanzu.
Sakon "Heartbeat":
{"na'ura":"%NAME%", "mai rai":"%DATE% %TIME%"}
Wannan zai aika lokaci-lokaci saƙon TCP ko UDP JSON zuwa ƙayyadadden rahoton sabar cewa HALO yana raye a lokacin da aka nuna.
Takardu / Albarkatu
 |
Software na HALO Smart Sensor API Basic Software [pdf] Jagorar mai amfani HALO Smart Sensor API Basic Software |
