Software s HALO Smart Sensor API Basic Software
Tsoela pele
Tokomane ena e hlalosa sehlopha sa lisebelisoa tsa Halo Smart Sensor tse tsejoang ka kakaretso e le BASIC API, kapa Application Programming Interface. Puisano ena e reretsoe ho sebelisoa ke baetsi ba mananeo kapa bahokahanyi ba nang le thahasello ea ho kopanya HALO Smart Sensors (HALOs) e le 'ngoe kapa tse ngata tse nang le likarolo tsa software tsa 3rd (non-IPVideo) kapa litsamaiso. Ka kakaretso, HALO API e reretsoe ho fetisetsa boitsebiso ka katleho ho tloha HALO holim'a marang-rang a tloaelehileng a Ethernet ho ea lenaneong la kantle. Ho fihlela sepheo sena, API e arotsoe likarolo tse tharo: Event Driven Socket Connection, Heartbeat Socket Connection, le Event Data. URL. BACnet segokanyimmediamentsi sa sebolokigolo e boetse e teng 'me e koahetsoe ka tokomane ka thoko.
Moralo oa API
API e etselitsoe ho sebelisa mekhoa e tloaelehileng ea indasteri e kang TCP/IP. HTTP, HTTPS, le JSON. Moralo ha o hloke mekhoa kapa lilaebrari tse khethehileng kapa tsa thepa hore li sebelisoe ho nts'etsopele ea lenaneo kapa ts'ebeliso ea kantle. API e khona ho feto-fetoha le maemo 'me e ka hlophisoa le ho hlophisoa ho fana ka lintlha tse hlokahalang le ka mokhoa o sebetsang ka ho fetisisa. Lintlha tsa ts'ebetso ea karolo e 'ngoe le e' ngoe ea likarolo tse ka holimo li hlalositsoe likarolong tse latelang tsa tataiso ena.
Melaetsa ea kantle
Sebaka sena se sebelisetsoa ho fana ka litlhokomeliso kapa li-alarm le data ea Ketsahalo ho lenaneo la kantle, tsamaiso ea VMS, seva, joalo-joalo ha Ketsahalo e qalisoa (e behiloe). Melaetsa ea boikhethelo e ka boela ea fuoa monyetla oa ho bontša ha Ketsahalo e hlakoloa (e setiloe bocha). Tlhahiso ena e ka etsoa ho sokete ea TCP/IP kapa seva sa HTTP/S ka nako ea nnete. Ho na le mefuta e mengata ea li-protocol tse ka hlophisoang tse nang le litaba tse ka khonehang. Netefatso le encryption lia fumaneha.
Ho otla ha pelo
Melaetsa ea ho otla ha pelo e romelloa ka nako e lokiselitsoeng (ho fapana le ha Liketsahalo li qala) ho fana ka bopaki ba ho phela/teng. Ba na le mefuta e fapaneng ea bokhoni bo tšoanang le ea Melaetsa ea Kantle empa hangata e tla hlophisoa hore e be le litaba tse akaretsang tsa boemo ho fapana le lintlha tse mabapi le ketsahalo e itseng.
Lintlha tsa Ketsahalo URL
Setsi sena se fumaneha feela tlas'a NDA mme se lokela ho sebelisoa feela ha lenaneo la kantle le hloka phihlello ho litekanyetso tsohle tsa Ketsahalo, menyako, le lifolakha tsa naha. Lintlha tsena ka kakaretso li khutlisoa ka tlhokahalo ke lenaneo la kantle empa eseng ka maqhubu a phahameng haholo. Mokhoa ona hangata o tlisa latency e itseng ha ho sebelisoa sekhahla se itekanetseng sa likhetho. Litefiso tse tloaelehileng tsa likhetho li tloha hang ka motsotso ho isa hang ka metsotsoana e 5 ka sekhahla se felletseng sa hang ka motsotsoana. Mokhoa ona o ka boela oa sebelisoa ho fumana lintlha tse ling tse tšehetsang ha Ketsahalo (temoso) e amoheloa.
Lintlha tsa kantle tsa melaetsa
Karolo ea HALO web interface Integration popup e fana ka tlhophiso ea khokahano ea mokha oa boraro moo litekanyetso tse fapaneng li ka romelloang ho sokete e hole ea TCP kapa seva sa HTTP/HTTPS. Lits'oants'o tsa libaka (li-tokens) li sebelisetsoa ho kenya litekanyetso tse phelang ka har'a mongolo o fetisitsoeng. Le hoja e ngotsoe "Melaetsa ea Kantle," mocha ona o ka sebelisoa hoo e batlang e le morero ofe kapa ofe o hlokang nako ea sebele Lihloliloeng tsa Ketsahalo, tse fanoang ka mafolofolo ke HALO. Tokisetso ena e feto-fetoha le maemo hobane likhetho ho "Liketso" li khetholla hore na ke Liketsahalo life tsa HALO li fetisa mocha ona.
Ka mokhoa oa HTTP, li-Set and Reset Strings ke tsona URLs e tlamehang ho kengoa le ho hlophisoa joalo ka ha ho hlokoa ke seva e lakatsehang ea moo e eang teng. Sebaka sa Mosebelisi le Phasewete se ka sebelisoa bakeng sa netefatso. Sheba mokhoa oa HTTP ka tlase.
Ka mokhoa oa TCP, Likhoele tsa ho Beha le ho Etsa Botjha ke data feela ea molaetsa o le mong o rometsoeng ho sokete ea TCP e amohelang. Li ka hlophisoa kamoo ho hlokahalang sebakeng seo u eang ho sona. Sebaka seo u eang ho sona se hlalositsoe libakeng tsa Aterese le Boema-kepe. Sheba Mokhoa oa TCP ka tlase.
Bakeng sa mofuta ofe kapa ofe, boemo ba molaetsa oa morao-rao bo hlahisoa bo ka thusang ke ho lokisa khokahano kapa litaba tse ling. U ka sebelisa likonopo tsa TEST tsa Ketsahalo ho popup ea Actions ho qobella molaetsa:
Global On/Off bakeng sa Seta kapa Reset e tlameha ho Buloa ho nolofalletsa mefuta eo ea melaetsa. Hangata, ho seta bocha ha ho sebelisoe hobane ketsahalo e khahlang feela, empa hoo ho ka fapana. Ketsahalo e 'ngoe le e' ngoe e ka itlhalosa ka bo eona hore na e tla sebelisa Set kapa molaetsa oa Reset ho "Actions popup". Likonopo tsa leihlo la mahlo li tla bonts'a kemelo e thata ea se rometsoeng ka mor'a ho fetola mantsoe a sehlooho le ho fometa. Repeat Holdoff e ka sebelisoa ho theola melaetsa khafetsa ka ho lieha pele o mong o ka romeloa. Sena se etsoa ka boikemelo ka Ketsahalo. HALO e na le nako ea ho ts'oara liketsahalo tsa metsotsoana ea 15 ho thibela ho khutla ka potlako ha Liketsahalo. Haeba u ne u batla ho etsa bonnete ba hore ketsahalo e fetang 1 ea mofuta o romelloa ka motsotso, u ne u ka seta Repeat Holdoff ho 60 (metsotsoana).
Lintlha tsa ho otla ha pelo
Phetiso ea Heartbeat e sebetsa ka tsela e ts'oanang le e ka holimo ntle le hore ha ho na tšebelisano le leqephe la Liketso. Sebakeng seo, phetisetso ea Heartbeat e etsahala khafetsa joalo ka ha e hlophisitsoe le sebaka sa Interval, Ka mokhoa oa HTTP, Likhoele tsa Set le Reset ke tsona. URLs e tlamehang ho kengoa le ho hlophisoa joalo ka ha ho hlokoa ke seva e lakatsehang ea moo e eang teng. Sebaka sa Mosebelisi le Phasewete se ka sebelisoa bakeng sa netefatso. Sheba mokhoa oa HTTP ka tlase.
Le hoja morero o ka sehloohong oa Heartbeat ke ho fana ka bopaki ba bophelo ba HALO Smart Sensor ho sesebelisoa se hōle, molaetsa ona o ka boela oa sebelisoa ho fetisetsa li-sensor tse khethiloeng kapa tlhahisoleseding ea boemo ba ketsahalo ea hona joale. Example ka holimo o romela khoele e telele parameter le URL tse kenyelletsang lebitso la Halo, bongata ba li-sensor values, 'me qetellong Triggered=%ACTIVE% e ka bang lefeela kapa lethathamo la Liketsahalo tse hlahisitsoeng hajoale.
HTTP (le HTTPS) Mokhoa
Melaetsa ea kantle le likhoele tsa ho otla ha pelo e ka ba http: kapa https: URLs kamoo ho hlokahalang. Tsela le liparamente li ka kengoa kamoo ho hlokahalang ho tsoa ho seva ea moo e eang teng. Mantsoe a bohlokoa joalo ka %NAME% (lebitso la sesebelisoa sa HALO) kapa %EID% (Id ya ketsahalo) a ka kenngoa ha ho hlokahala 'me a tla nkeloa sebaka ke lintlha tse fapaneng ha molaetsa o romelloa. Lethathamo la mantsoe a bohlokoa a sebelisoang hangata a bontšoa bakeng sa litšupiso tse potlakileng.
The URL tsela e ka ba le mantsoe a bohlokoa hammoho le liparamente ho URL. Mekhatlo e ka 'na ea e-ba NAME=VALUE lipara kapa ntho ea JSON, kapa mokhoa o tloaelehileng ho itšetlehile ka seva ea sebaka seo u eang ho sona. Examples bakeng sa Melaetsa e Ntle e tla kenyelletsa %EID% ho bontša Ketsahalo e bakiloeng ke:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
ExampLes bakeng sa Pelo ea Pelo e ka eketsa %ACTIVE% (Liketsahalo tse ntseng li hlahisoa hajoale) kapa boleng ba kutlo:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
The %SENSOR:…% boleng bo sebelisa mabitso a fumanoang likholomong tsa kutlo tse ka letsohong le letona ho evtYYYYMMDD.csv log files. Hangata ke:
Haeba seva sa moo se eang teng se khetha HTTP PUT kapa POST sebakeng sa likopo tsa GET, o ka etsa prefix URL ka PUT: kapa POST:. Ka boikemelo, o ka eketsa moputso oa JSON o ratoang ke li-server tse ngata ka ho kenya [JSONBODY] lentsoe la sehlooho le lateloang ke ntho e hlophisitsoeng ea JSON. ExampLe:
BEHA:https://server.com/event[JSONBODY]{“sebaka”:”%NAME%”,”ketsahalo”:”%EID%”}
The URL e ts'ehetsa aterese e tloaelehileng ea IP (le IPv6) le likhetho tsa boema-kepe le li-password tsa mosebelisi, kapa u ka sebelisa libaka tsa Mosebelisi le Phasewete ha ho hlokahala e be seva sa moo u eang teng bakeng sa mekhoa ea netefatso joalo ka Basic kapa Digest:
https://username:password@123.321.123.321:9876/event…
Mokhoa oa TCP
Melaetsa ea kantle le ho otla ha pelo ke tsa data feela kaha masimo a Aterese le Port a totobatsa moo ho eang teng. Aterese e tšehetsa mabitso, IPv4 le IPv6.
Khoele e ka hlophisoa joalo ka likarolo tsa data tsa melaetsa ea HTTP e hlalositsoeng kaholimo, kapa joalo ka ha ho hlokoa ke seva ea moo e eang.
Examples bakeng sa Melaetsa e Ntle e tla kenyelletsa %EID% ho bontša Ketsahalo e bakiloeng ke:
sebaka=%NAME%, ketsahalo=%EID%
{“sebaka”:”:%NAME%”,”ketsahalo”:”%EID%”}
ExampLes bakeng sa Pelo ea Pelo e ka eketsa %ACTIVE% (Liketsahalo tse ntseng li hlahisoa hajoale) kapa boleng ba kutlo:
sebaka=%NAME%&Triggered=%ACTIVE%
{“sebaka”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Mabokose a ho "Integration Set" le "Integration Reset" a khetha hore na ke Liketsahalo life tse qalang ho romelloa. Tse ling mabapi le ho hlophisoa ha Liketsahalo le Liketso li fumaneha ho Tataiso ea Tsamaiso ea HALO.
Phano ea Melaetsa ea Ketsahalo ea JSON
Bahlahisi ba bang ba khetha ho amohela datha ea Ketsahalo e hlophisitsoeng joalo ka maemo a indasteri a ipakileng a le JSON ho fapana le mongolo o hlakileng oa ASCII kaha oa pele o ka tšeptjoa ebile o aroloa habonolo. Ka HALO web leqepheng la "Melaetsa", o ka fana ka melaetsa ea JSON ho "Melaetsa ea Kantle" litlhophiso tsa "Set String" le "Reset String" le ho "Heartbeat" "Molaetsa."
Examphanyane:
Litlhophiso tsa "Melaetsa ea Kantle":
{“sesebelisoa”:”%NAME%”, “ketsahalo”:”%EID%”, “alamo”:”ee” }
Sena se tla romella molaetsa o le mong oa TCP kapa UDP JSON ho seva e boletsoeng e tlalehang lebitso la sesebelisoa se mosa, lebitso la ketsahalo le hore e sa tsoa qala.
Litlhophiso tsa "Melaetsa ea Kantle" Seta Khoele bocha:
{“sesebelisoa”:”%NAME%”, “ketsahalo”:”%EID%”, “alamo”:”no” }
Sena se tla romela molaetsa o le mong oa TCP kapa UDP JSON ho seva se boletsoeng se tlalehang lebitso la sesebelisoa sa botsoalle, lebitso la ketsahalo le hore boemo bo se bo emisitse.
Molaetsa "Ho otla ha pelo":
{“sesebelisoa”:”%NAME%”, “phela”:”%DATE% %TIME%”}
Sena se tla romela molaetsa oa TCP kapa UDP JSON nako le nako ho seva se boletsoeng se tlaleha hore HALO e phela ka nako e bontšitsoeng.
Litokomane / Lisebelisoa
 |
Software s HALO Smart Sensor API Basic Software [pdf] Bukana ea Mosebelisi HALO Smart Sensor API Basic Software |
