Polokalama s HALO Smart Sensor API Polokalama Fa'avae
I luma
O lenei pepa o loʻo faʻamatalaina ai le vaega o fale o le Halo Smart Sensor e taʻua faʻatasi o le BASIC API, poʻo le Application Programming Interface. O lenei talanoaga e fa'amoemoe e fa'aoga e le au fai polokalame po'o tagata tu'ufa'atasi o lo'o naunau e tu'ufa'atasia se tasi pe sili atu HALO Smart Sensors (HALOs) fa'atasi ma vaega lona tolu (non-IPVideo) polokalame po'o faiga. I se tulaga lautele, o le HALO API o loʻo faʻamoemoe e faʻafeiloaʻi faʻamatalaga lelei mai le HALO i luga o se fesoʻotaʻiga Ethernet masani i le polokalame fafo. Ina ia ausia lenei sini, ua vaevaeina le API i ni vaega se tolu: Fesoʻotaʻiga Socket Driven Socket, Socket Socket Heartbeat, ma Faʻamatalaga Faʻamatalaga. URL. O lo'o iai fo'i fa'aoga BACnet ma ufiufi i se isi pepa.
API Design
O le API ua mamanuina e faʻaaoga ai tulaga faʻapitoa tau pisinisi e pei ole TCP/IP. HTTP, HTTPS, ma JSON. O le mamanu e le mana'omia ni faiga fa'apitoa po'o ni faiga fa'apitoa po'o ni faletusi e fa'aoga i le atina'eina o le polokalame i fafo po'o le fa'aoga. O le API e fetuutuunai ma e mafai ona faʻatulagaina ma faʻapolokalameina e tuʻuina atu tonu faʻamatalaga manaʻomia ma i le auala sili ona lelei. O faʻamatalaga o le faʻaogaina o vaega taʻitasi o loʻo i luga o loʻo aofia i vaega o loʻo mulimuli mai o lenei taʻiala.
Feau i fafo
O lenei nofoaga e faʻaaogaina e tuʻuina atu ai faʻasalalauga poʻo faʻailo ma faʻamatalaga Faʻamatalaga i se polokalame i fafo, VMS system, server, ma isi mea pe a faʻaosoina se Mea (faʻatulagaina). E mafai fo'i ona fa'agasolo fe'au fa'apitoa e fa'ailo pe a fa'amama se Mea na tupu (ua toe setiina). O lenei tiliva e mafai ona faia i le TCP/IP socket po'o le HTTP/S server ile taimi moni. O lo'o i ai le tele o fa'atonuga fa'atonu fa'atasi ai ma mea fa'apitoa. O lo'o avanoa le fa'amaoniga ma le fa'ailoga.
Tata o le fatu
O fe'au o le tātā o le fatu e lafo i se vaitaimi e mafai ona fetuutuuna'i (nai lo le taimi e fa'aosoina ai Mea e tutupu) e tu'u mai ai fa'amaoniga o le ola/avanoa. E iai fo'i le tele o latou agava'a e pei o Fe'au i fafo ae e masani lava ona fa'atulaga e aofia ai fa'amatalaga lautele o le setete nai lo fa'amatalaga e uiga i se mea fa'apitoa.
Fa'amatalaga o mea na tutupu URL
O lenei nofoaga e na'o avanoa i lalo ole NDA ma e tatau ona fa'aoga pe a mana'omia e le polokalame i fafo le avanoa i so'o se mea ma mea taua uma o le Mea na tupu, tulaga, ma fu'a a le setete. O nei fa'amaumauga e masani lava ona toe maua mai pe a mana'omia e le polokalame i fafo ae le o se fa'atelega tele. O lenei metotia e masani ona fa'atupu ai sina fa'aletonu pe a fa'aogaina se faiga palota. Ole fua faatatau masani ole palota e amata mai ile tasi ile minute ile tasi ile 5 sekone ma le maualuga ole fua ole tasi ile sekone. E mafai fo'i ona fa'aoga lenei metotia e toe maua mai ai fa'amatalaga lagolago fa'aopoopo pe a maua se Mea (talatala).
Fa'amatalaga Feau i fafo
O se vaega o le HALO web interface Fa'apipi'i fa'apipi'i e tu'uina atu mo le fa'atulagaina o se feso'ota'iga 3rd party e tasi e mafai ona lafo atu fa'atauga eseese i se socket TCP mamao po'o se HTTP/HTTPS server. O lo'o fa'aogaina fa'ailoga (fa'ailoga) e fa'apipi'i ai fa'atauga ola i totonu o tusitusiga fa'asalalau. E ui ina fa'aigoaina "Fe'au i fafo," e mafai ona fa'aogaina lenei alavai mo toetoe lava o so'o se fa'amoemoe e mana'omia ai taimi moni fa'aoso Mea, fa'aolaina e le HALO. O lenei fa'atulagaga e fai si fetu'una'i ona o filifiliga i luga o le "Actions" e iloa ai po'o fea HALO Events e fa'asalalau atu i lenei alalaupapa.
I le HTTP mode, o le Seti ma Toe Seti Strings o le URLs e tatau ona fa'aofi ma fa'atulagaina e pei ona mana'omia e le 'au'aunaga e mana'omia. E mafai ona fa'aogaina se fa'aoga ma upu fa'ataga mo le fa'amaoni. Va'ai le faiga HTTP i lalo.
I le TCP mode, o le Set and Reset Strings ua na o faʻamatalaga o se feʻau e tasi e lafo i le TCP socket. E mafai ona fa'atulagaina pe a mana'omia e le nofoaga. O le taunuuga o loʻo faʻamaonia i le tuatusi ma le Taulaga fanua. Va'ai le TCP Mode i lalo.
Mo so'o se faiga, o lo'o fa'aalia le tulaga mai le fe'au sili ona lata mai e mafai ona fesoasoani i le fa'amautuina o feso'ota'iga po'o isi fa'afitauli. E mafai ona e fa'aogaina le mea e fai TEST fa'amau i luga o le Fa'aaliga fa'aalia e fa'amalosi ai se fe'au:
Global On/Off for Set or Reset e tatau ona Ki ina ia mafai ai na ituaiga o feʻau. Toe fa'afou e masani ona le fa'aaogaina ona e na'o le amataga o se Mea e fiafia i ai, ae e mafai ona fesuisuiai. E mafai e mea na tutupu ta'ito'atasi ona fa'ama'oti mai pe fa'aaoga le Seti po'o le Toe Fa'atonu fe'au i luga o le fa'aaliga Fa'atino. O fa'amau mata mata o le a fa'aalia se fa'atusa mata'utia o mea e lafo pe a mae'a fa'aliliu upu ma fa'asologa. Toe fai Holdoff e mafai ona fa'aoga e fa'ato'a fe'avea'i fe'au e ala i le fa'atuai a'o le'i tu'uina atu se isi fe'au. E faia tuto'atasi ile Event. O le HALO o lo'o iai le taimi fa'amautu mo mea e tutupu i le 15 sekone e taofia ai le vave fa'aosoina o mea na tutupu. Afai e te manaʻo e faʻamautinoa e le sili atu ma le 1 Mea na tupu o se ituaiga e lafo i minute, e mafai ona e seti le Toe Faʻaauau i le 60 (sekona).
Fa'amatalaga o le tātā o le fatu
O le fa'aliliuga o le Heartbeat e fa'agaoioi i se auala fa'apena e pei ona ta'ua i luga se'i vagana ai e leai se feso'ota'iga ma le itulau Gaioiga. Nai lo lena, o le faʻasalalauga o le Heartbeat e tupu i taimi masani e pei ona faʻapipiʻiina ma le Interval field, I le HTTP mode, o le Seti ma Toe Seti Strings o le URLs e tatau ona fa'aofi ma fa'atulagaina e pei ona mana'omia e le 'au'aunaga e mana'omia. E mafai ona fa'aogaina se fa'aoga ma upu fa'ataga mo le fa'amaoni. Va'ai le faiga HTTP i lalo.
E ui o le autu autu o le Heartbeat o le tuʻuina atu lea o faʻamaoniga o le ola o le HALO Smart Sensor i se faʻaoga mamao, e mafai foi ona faʻaoga lenei feʻau e faʻasalalau ai masini filifilia poʻo faʻamatalaga o mea o loʻo i ai nei. O le example luga e auina atu se parakalafa manoa umi ma le URL e aofia ai le igoa Halo, le tele o mea taua o le sensor, ma mulimuli ane Triggered=%ACTIVE% lea e mafai ona gaogao poʻo se lisi o mea na tupu nei.
HTTP (ma le HTTPS) Faiga
Feau i fafo ma manoa tata o le fatu e mafai ona http: poʻo https: URLs pe a mana'omia. E mafai ona fa'aofi le ala ma fa'amaufa'ailoga pe a mana'omia e le 'au'aunaga o lo'o i ai. O upu autu pei o le %NAME% (HALO device name) po'o le %EID% (Event id) e mafai ona fa'aofi pe a mana'omia ma o le a suia i fa'amaumauga ta'itasi pe a lafo le fe'au. O lo'o fa'aalia se lisi o fa'aupuga e masani ona fa'aoga mo fa'amatalaga vave.
O le URL ala e mafai ona i ai upu autu faʻapea foʻi ma faʻamaufaʻailoga i le URL. O fa'amaufa'ailoga atonu o NAME=VALUE pa'aga po'o se mea JSON, po'o se fa'asologa masani e fa'atatau i le mea e alu i ai. Examples mo Feau i fafo e aofia ai le %EID% e faʻaalia ai le mea na tupu na faʻaosoina:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples mo le Tata o le fatu e mafai ona fa'aopoopo %ACTIVE% (mea fa'atupu i le taimi nei) po'o se tau fa'alogo:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
O le %SENSOR:...% fa'atatau e fa'aoga ai igoa o lo'o maua i le itu taumatau o fa'aulutala koluma i le evtYYYYMMDD.csv log files. E masani lava:
Afai e mana'o le 'au'aunaga o lo'o i ai i le HTTP PUT po'o le POST nai lo GET talosaga, e mafai ona e fa'amuamua le URL ma le PUT: poʻo le POST:. Tuto'atasi, e mafai ona e fa'aopoopoina se uta JSON lea e ta'uta'ua i le tele o sapalai e ala i le fa'aopoopoina o le upu [JSONBODY] sosoo ai ma se mea fa'atulagaina JSON. ExampLe:
TUU:https://server.com/event[JSONBODY]{“nofoaga”:”%NAME%”,”event”:”%EID%”}
O le URL lagolagoina le tuatusi IP masani (ma le IPv6) ma le taulaga ma le faʻaoga-faʻaoga filifiliga, pe mafai ona e faʻaogaina le User ma le Password fields pe a manaʻomia e avea ma faʻaumau taunuʻuga mo metotia faʻamaonia e pei o le Basic poʻo le Digest:
https://username:password@123.321.123.321:9876/event…
TCP Mode
Feau i fafo ma le Tata o le fatu e na'o mo fa'amatalaga talu ai o le tuatusi ma le Taulaga o lo'o fa'amaonia ai le mea e alu i ai. E lagolagoina e le tuatusi igoa, IPv4 ma IPv6.
O le manoa e mafai ona faʻapipiʻiina e pei o vaega o faʻamatalaga o feʻau HTTP o loʻo faʻamatalaina i luga, pe pei ona manaʻomia e le 'auʻaunaga o loʻo i ai.
Examples mo Feau i fafo e aofia ai le %EID% e faʻaalia ai le mea na tupu na faʻaosoina:
nofoaga=%NAME%,mea na tupu=%EID%
{“nofoaga”:”:%NAME%”,”mea na tupu”:”%EID%”}
Examples mo le Tata o le fatu e mafai ona fa'aopoopo %ACTIVE% (mea fa'atupu i le taimi nei) po'o se tau fa'alogo:
nofoaga=%NAME%&Triggered=%ACTIVE%
{“nofoaga”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
O pusa siaki i koluma o le "Integration Set" ma le "Integration Reset" e iloa ai po o fea mea na tutupu e fa'aosoina ai le lafo. O lo'o maua nisi mea i le fa'atulagaina o Mea na tutupu ma Gaioiga i le HALO Administrator's Guide.
Tuuina atu o JSON Event Messages
O nisi atia'e e mana'o e maua fa'amaumauga o mea na tutupu e fa'aigoaina e le tagata lava ia JSON nai lo le fa'amatalaga ASCII e pei o le mea muamua e sili atu ona fa'atuatuaina ma faigofie ona fa'avasega. I luga ole HALO web itulau "Messaging" tab, e mafai ona e tuʻuina atu JSON feʻau i le "Faʻamatalaga Faʻamatalaga" faʻatulagaina "Set String" ma le "Reset String" ma i le "Heartbeat" "Message."
Examples:
"Fe'au i fafo" Seti Seti Fa'amau:
{ “mea faigaluega”:”%NAME%”, “mea na tupu”:”%EID%”, “alarm”:”ioe” }
O le a auina atu se feau TCP poʻo UDP JSON se tasi i le 'auʻaunaga faʻapitoa e lipotia le igoa o le masini faauo, igoa o mea na tupu ma na faatoa amata.
“Feau i fafo” Fa'atonu Toe Seti Fa'amau:
{ “mea faigaluega”:”%NAME%”, “mea na tupu”:”%EID%”, “alarm”:”leai” }
O le a auina atu se feau TCP poʻo UDP JSON se tasi i le 'auʻaunaga faʻapitoa e lipotia le igoa o le masini faauo, igoa o mea na tutupu ma ua taofia nei le tulaga.
Savali “Tati le fatu”:
{ “mea faigaluega”:”%NAME%”, “ola”:”%DATE% %TIME%” }
O le a auina atu i lea taimi ma lea taimi se TCP poʻo le UDP JSON feʻau i le 'auʻaunaga faʻamaonia e lipotia mai o loʻo ola le HALO i le taimi faʻaalia.
Pepa / Punaoa
 |
Polokalama s HALO Smart Sensor API Polokalama Fa'avae [pdf] Taiala mo Tagata Fa'aoga HALO Smart Sensor API Polokalama Fa'avae |
