Software s HALO Smart Sensor API Basic Software
Tom ntej
Cov ntaub ntawv no piav qhia txog cov pab pawg ntawm cov chaw ntawm Halo Smart Sensor hu ua BASIC API, lossis Application Programming Interface. Qhov kev sib tham no yog tsim los siv los ntawm cov programmers lossis cov neeg koom ua ke uas xav koom ua ke ib lossis ntau dua HALO Smart Sensors (HALOs) nrog 3rd party (tsis yog IPVideo) software Cheebtsam lossis cov tshuab. Feem ntau, HALO API yog npaj los hloov cov ntaub ntawv zoo los ntawm HALO dhau ib qho kev sib txuas Ethernet mus rau lwm qhov kev pab cuam. Txhawm rau ua kom tiav lub hom phiaj no, API tau muab faib ua peb ntu: Kev Sib Tham Tsav Tsheb Sib Tw, Kev Sib Txuas Lub Plawv Lub Plawv, thiab Cov Ntaub Ntawv Txheej Txheem URL. BACnet interface kuj tseem muaj thiab muaj nyob rau hauv ib daim ntawv cais.
API Tsim
API yog tsim los siv cov qauv kev lag luam xws li TCP / IP. HTTP, HTTPS, thiab JSON. Tus qauv tsim tsis tas yuav muaj cov txheej txheem tshwj xeeb lossis cov tswv cuab lossis cov tsev qiv ntawv los siv rau hauv kev txhim kho cov txheej txheem sab nraud lossis daim ntawv thov. API yog hloov tau thiab tuaj yeem tsim kho thiab tsim kho kom xa cov ntaub ntawv raws nraim qhov xav tau thiab ua tau zoo tshaj plaws. Cov ntsiab lus ntawm kev ua haujlwm ntawm txhua ntu saum toj no muaj nyob rau hauv ntu hauv qab no ntawm phau ntawv qhia no.
Kev xa xov sab nraud
Qhov chaw no yog siv los xa cov ntawv ceeb toom lossis lub tswb thiab cov ntaub ntawv xwm txheej mus rau lwm qhov kev pab cuam, VMS system, server, thiab lwm yam. thaum muaj xwm txheej tshwm sim (teeb tsa). Cov lus xaiv tau kuj tseem tuaj yeem qhib rau lub teeb liab thaum qhov xwm txheej tshem tawm (yog rov pib dua). Qhov kev xa tuaj no tuaj yeem ua rau TCP / IP qhov (socket) lossis HTTP / S server hauv lub sijhawm. Nws muaj ntau yam kev cai raws tu qauv nrog cov ntsiab lus customizable. Authentication thiab encryption muaj.
Lub plawv dhia
Cov lus ntawm lub plawv dhia yog xa mus rau lub sijhawm teeb tsa (tshwj tsis yog thaum cov xwm txheej tshwm sim) los muab pov thawj ntawm kev nyob / muaj. Lawv muaj cov peev txheej zoo sib xws li Kev Xa Xov Sab Nraud tab sis feem ntau yuav raug teeb tsa kom muaj cov ntaub ntawv xov xwm hauv xeev ntau dua li cov ntsiab lus hais txog ib qho xwm txheej.
Cov ntaub ntawv xwm txheej URL
Qhov chaw no tsuas yog muaj nyob rau hauv NDA thiab tsuas yog yuav tsum tau siv thaum qhov kev pab cuam sab nraud yuav tsum tau nkag mus rau ib qho thiab tag nrho Cov Txheej Txheem Txheej Txheem, qhov pib, thiab lub xeev chij. Cov ntaub ntawv no feem ntau muab rov qab rau ntawm qhov kev thov los ntawm cov kev pab cuam sab nraud tab sis tsis yog nyob rau ntawm qhov ntau zaus. Txoj kev no feem ntau tshwm sim qee qhov latency thaum siv tus nqi pov npav me me. Cov kev xaiv tsa ib txwm muaj txij li ib zaug hauv ib feeb mus rau ib zaug hauv 5 vib nas this nrog tus nqi siab tshaj plaws ntawm ib zaug ib ob. Txoj kev no tseem tuaj yeem siv los khaws cov ntaub ntawv txhawb nqa ntxiv thaum muaj xwm txheej ( ceeb toom) tau txais.
Sab nraud Messaging cov ntsiab lus
Ib ntu ntawm HALO web interface Integration popup muab rau kev teeb tsa ntawm ib qho kev sib txuas ntawm 3rd tog uas muaj ntau yam txiaj ntsig tuaj yeem xa mus rau qhov chaw taws teeb TCP lossis HTTP / HTTPS server. Qhov chaw tuav (tokens) yog siv los ntxig qhov tseem ceeb rau hauv cov ntawv xa mus. Txawm hais tias sau tias "Kev Xa Xov Sab Nraud," cov channel no tuaj yeem siv rau yuav luag txhua lub hom phiaj uas xav tau lub sijhawm tiag tiag tshwm sim, ua haujlwm nquag xa los ntawm HALO. Qhov kev npaj no hloov pauv tau yooj yim vim tias kev xaiv ntawm "Kev Ua Haujlwm" txiav txim siab qhov twg HALO Txheej xwm kis tau los ntawm cov channel no.
Hauv HTTP hom, Teeb thiab Reset Strings yog qhov URLs uas yuav tsum tau nkag mus thiab formatted raws li xav tau los ntawm qhov xav tau qhov chaw server. Ib tus neeg siv thiab tus password tuaj yeem siv rau kev lees paub. Saib HTTP hom hauv qab no.
Nyob rau hauv TCP hom, Teeb thiab Reset Strings tsuas yog cov ntaub ntawv ntawm ib qho lus uas raug xa mus rau qhov tau txais TCP qhov (socket). Lawv tuaj yeem raug formatted raws li qhov xav tau los ntawm qhov chaw. Lub hom phiaj yog teev nyob rau hauv Chaw Nyob thiab Chaw nres nkoj. Saib TCP Hom hauv qab no.
Rau ob hom, cov xwm txheej los ntawm cov lus tsis ntev los no tau tshwm sim uas tuaj yeem pab kho kev sib txuas lossis lwm yam teeb meem. Koj tuaj yeem siv qhov Event TEST nyees khawm ntawm Cov Haujlwm popup los yuam cov lus:
Ntiaj teb no On/Off rau Teem los yog Reset yuav tsum nyob rau kom pab tau cov hom lus. Rov pib dua feem ntau tsis siv vim tias tsuas yog qhov pib ntawm Ib qho xwm txheej txaus siab, tab sis qhov ntawd tuaj yeem sib txawv. Txhua qhov xwm txheej tuaj yeem piav qhia nws tus kheej yog tias nws yuav siv qhov teeb tsa lossis cov lus rov pib dua ntawm Cov Haujlwm popup. Cov nyees khawm lub qhov muag yuav tso tawm qhov sawv cev ntxhib ntawm qhov xa mus tom qab hloov lo lus tseem ceeb thiab formatting. Rov ua dua Holdoff tuaj yeem siv los cuam tshuam cov lus nquag los ntawm kev ncua ua ntej lwm tus tuaj yeem xa. Qhov no yog ua los ntawm nws tus kheej rau qhov xwm txheej. HALO muaj lub sijhawm tuav lub sijhawm rau cov xwm txheej ntawm 15 vib nas this los tiv thaiv kev rov tshwm sim sai ntawm Cov Txheej Txheem. Yog tias koj xav kom tsis pub ntau tshaj 1 Kev tshwm sim ntawm ib hom xa mus rau ib feeb, koj tuaj yeem teem sijhawm rov ua dua Holdoff rau 60 (thib ob).
Cov ntsiab lus ntawm lub plawv dhia
Lub Heartbeat transmissions ua haujlwm zoo ib yam li saum toj no tshwj tsis yog tias tsis muaj kev cuam tshuam nrog nplooj ntawv Ua Haujlwm. Hloov chaw, lub plawv dhia kis tau tus mob tshwm sim tsis tu ncua raws li configured nrog lub Interval teb, nyob rau hauv HTTP hom, lub teeb thiab Reset Strings yog lub URLs uas yuav tsum tau nkag mus thiab formatted raws li xav tau los ntawm qhov xav tau qhov chaw server. Ib tus neeg siv thiab tus password tuaj yeem siv rau kev lees paub. Saib HTTP hom hauv qab no.
Thaum lub hom phiaj tseem ceeb ntawm Heartbeat yog muab pov thawj ntawm lub neej ntawm HALO Smart Sensor rau daim ntawv thov chaw taws teeb, cov lus no tuaj yeem siv los xa cov sensors xaiv lossis cov ntaub ntawv xwm txheej tam sim no hauv xeev. Cov example saum toj no xa ib txoj hlua ntev parameter nrog rau URL uas suav nrog Halo lub npe, feem ntau ntawm qhov ntsuas qhov tseem ceeb, thiab thaum kawg Triggered =% ACTIVE% uas tuaj yeem khoob lossis cov npe ntawm cov xwm txheej tam sim no tshwm sim.
HTTP (thiab HTTPS) hom
Sab nraud Messaging thiab Heartbeat hlua tuaj yeem yog http: lossis https: URLs raws li xav tau. Txoj kev thiab tsis tuaj yeem nkag tau raws li qhov xav tau los ntawm cov neeg rau zaub mov qhov chaw. Cov lus tseem ceeb xws li %NAME% (HALO lub npe ntaus ntawv) lossis %EID% (Event id) tuaj yeem muab tso rau raws li xav tau thiab yuav raug hloov nrog cov ntaub ntawv ntsig txog thaum xa lus. Ib daim ntawv teev cov ntsiab lus uas nquag siv tau qhia rau kev siv ceev.
Cov URL txoj kev tuaj yeem muaj cov ntsiab lus tseem ceeb nrog rau cov kev txwv rau URL. Cov tsis tuaj yeem yog NAME=VALUE khub lossis JSON khoom, lossis hom kev cai nyob ntawm tus neeg rau zaub mov lo lus uas peb. Examples rau Sab Nraud Messaging yuav suav nrog %EID% los qhia txog qhov xwm txheej uas tshwm sim:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples rau Heartbeat yuav ntxiv % ACTIVE% (tam sim no tshwm sim Cov Txheej Txheem) lossis tus nqi sensor:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Tus %SENSOR:…% qhov tseem ceeb siv cov npe pom nyob rau sab xis-tes sensor kab ntawv hauv evtYYYYMMDD.csv cav files. Lawv feem ntau yog:
Yog hais tias tus neeg rau zaub mov qhov chaw nyiam HTTP PUT lossis POST es tsis txhob tau txais kev thov, koj tuaj yeem ua ntej qhov URL nrog PUT: lossis POST:. Kev ywj pheej, koj tuaj yeem ntxiv JSON payload uas nrov nrog ntau lub servers los ntawm kev ntxiv [JSONBODY] lo lus tseem ceeb ua raws li JSON hom khoom. Example:
PUT:https://server.com/event[JSONBODY]{"location":"%NAME%","event":"%EID%"}
Cov URL txhawb nqa tus IP chaw nyob (thiab IPv6) thiab chaw nres nkoj thiab tus neeg siv-tus password xaiv, lossis koj tuaj yeem siv Cov Neeg Siv thiab Tus password yog tias xav tau yog tus neeg rau zaub mov lo lus uas peb rau kev lees paub zoo li Basic lossis Digest:
https://username:password@123.321.123.321:9876/event…
TCP Mode
Sab nraud Messaging thiab Heartbeat strings tsuas yog rau cov ntaub ntawv txij li qhov chaw nyob thiab chaw nres nkoj qhia qhov chaw nyob. Qhov Chaw Nyob txhawb cov npe, IPv4 thiab IPv6.
Cov hlua tuaj yeem tsim tau zoo li cov ntaub ntawv feem ntawm HTTP cov lus piav qhia saum toj no, lossis raws li qhov xav tau los ntawm cov neeg rau zaub mov qhov chaw.
Examples rau Sab Nraud Messaging yuav suav nrog %EID% los qhia txog qhov xwm txheej uas tshwm sim:
qhov chaw =%NAME%, xwm txheej=%EID%
{“chaw nyob”:”:%NAME%”,”event”:”%EID%”}
Examples rau Heartbeat yuav ntxiv % ACTIVE% (tam sim no tshwm sim Cov Txheej Txheem) lossis tus nqi sensor:
qhov chaw=%NAME%&Triggered=%ACTIVE%
{"chaw nyob":":%NAME%","NH3":%SENSOR:NH3%}
Checkboxes hauv "Integration Set" thiab "Integration Reset" kem txiav txim seb qhov xwm txheej twg ua rau xa. Ntau ntxiv ntawm kev teeb tsa Cov Txheej Txheem thiab Kev Ua Haujlwm yog muaj nyob rau hauv HALO Tus Thawj Coj Cov Lus Qhia.
Kev xa ntawm JSON Event Messages
Qee cov neeg tsim khoom nyiam kom tau txais cov ntaub ntawv Event formatted raws li kev lag luam tus kheej-labeled JSON es tsis yog cov ntawv ASCII dawb li cov qub tau ntseeg tau ntau dua thiab yooj yim parsed. Hauv HALO web nplooj ntawv "Messaging" tab, koj tuaj yeem muab JSON cov lus nyob rau hauv "Sab nraud Messaging" chaw "Set String" thiab "Reset String" thiab hauv "Heartbeat" "Message."
Examples:
"Sab nraud Messaging" Chaw Teeb Kab:
{ “device”:”%NAME%”, “event”:”%EID%”, “alarm”:”yog” }
Qhov no yuav xa ib qho TCP lossis UDP JSON cov lus rau cov neeg rau zaub mov tshwj xeeb tshaj tawm cov khoom siv phooj ywg, lub npe tshwm sim thiab nws nyuam qhuav pib.
“Sab nraud Messaging” Nqis Pib dua txoj hlua:
{ “device”:”%NAME%”, “event”:”%EID%”, “alarm”:”no” }
Qhov no yuav xa ib qho TCP lossis UDP JSON cov lus rau cov neeg rau zaub mov tshwj xeeb tshaj tawm cov khoom siv phooj ywg, lub npe tshwm sim thiab qhov xwm txheej tam sim no tau tso tseg.
"Lub plawv dhia" Message:
{ “device”:”%NAME%”, “alive”:”%DATE% %TIME%” }
Qhov no yuav xa ib ntus xa TCP lossis UDP JSON cov lus rau cov neeg rau zaub mov qhia tias HALO tseem muaj sia nyob ntawm lub sijhawm qhia.
Cov ntaub ntawv / Cov ntaub ntawv
 |
Software s HALO Smart Sensor API Basic Software [ua pdf] Cov neeg siv phau ntawv qhia HALO Ntse Sensor API Basic Software |
