Software's HALO Smart Sensor API Basic Software
Pamberi
Gwaro iri rinotsanangura boka rezvivakwa zveHalo Smart Sensor inozivikanwa pamwe chete seBASIC API, kana Application Programming Interface. Iyi hurukuro inotarisirwa kushandiswa nevagadziri vepurogiramu kana vanobatanidza vanofarira kubatanidza imwe kana kupfuura HALO Smart Sensors (HALOs) ne 3rd party (isina-IPVideo) software components kana masisitimu. Kazhinji, iyo HALO API inoitirwa kuendesa ruzivo zvakanaka kubva kuHALO pamusoro peyakajairika Ethernet network kune yekunze chirongwa. Kuti uite chinangwa ichi, API yakakamurwa kuita zvikamu zvitatu: Chiitiko Inotyairwa Socket Connection, Heartbeat Socket Connection, uye Chiitiko Data. URL. BACnet interface iripo zvakare uye yakavharwa mune imwe gwaro.
API Dhizaini
Iyo API yakagadzirwa uchishandisa maindasitiri akajairwa mafomati akadai seTCP/IP. HTTP, HTTPS, uye JSON. Iyo dhizaini haidi chero akakosha kana evaridzi matekiniki kana maraibhurari kuti ashandiswe mukuvandudza kwechirongwa chekunze kana application. Iyo API inochinjika uye inogona kugadzirwa uye kurongwa kuti ibudise iyo data inodiwa uye nenzira inoshanda zvakanyanya. Tsanangudzo yekushanda kwechimwe nechimwe chezvikamu zviri pamusoro zvakafukidzwa muzvikamu zvinotevera zvegwaro rino.
Kutumira Meseji Yekunze
Iyi nzvimbo inoshandiswa kuendesa zviziviso kana maalarm uye Chiitiko data kune chirongwa chekunze, VMS system, sevha, nezvimwewo kana Chiitiko chatangwa (chakaiswa). Mameseji anosarudzika anogona zvakare kugoneswa kusaina kana Chiitiko chadzima (chakaiswa patsva). Kuendesa uku kunogona kuitwa kune TCP/IP socket kana HTTP/S server munguva chaiyo. Kune huwandu hwemaprotocol anogadziriswa ane customizable zvirimo. Kusimbisa uye encryption zviripo.
Kurova kwemoyo
Mameseji ekurohwa kwemoyo anotumirwa panguva inogadziriswa (panzvimbo yekuti kana Zviitiko zvatangwa) kupa humbowo hwekurarama/kuwanikwa. Ivo vane huwandu hwakafanana hwekugona seKunze Messaging asi hunowanzo gadziridzwa kuti ive neruzivo rwenyika pane kuti ruzivo nezve chimwe chiitiko.
Chiitiko Data URL
Iyi nzvimbo inongowanikwa pasi pe NDA uye inofanirwa kushandiswa chete kana chirongwa chekunze chichida kuwana chero uye ese Chiitiko kukosha, zvikumbaridzo, uye mireza yenyika. Iyi data inowanzotorwa painodiwa nechirongwa chekunze asi kwete pamhepo yakanyanya. Iyi nzira inowanzounza imwe latency kana mwero wekuvhota wakapfava uchishandiswa. Miyero yekuvhotera yakajairika inotangira paminiti imwe kusvika kamwe pamasekondi mashanu ine chiyero chakakwana chekupfuura kamwe pasekondi. Iyi nzira inogona zvakare kushandiswa kudzoreredza imwe inotsigira data kana Chiitiko (chenjedzo) chagamuchirwa.
Zvekunze zveMessaging
Chikamu cheHALO web interface Kubatanidza popup inopa kugadziridzwa kweimwe yechitatu bato yekubatanidza uko akasiyana siyana anogona kutumirwa kune iri kure TCP socket kana HTTP/HTTPS server. Zvibatiso zvenzvimbo (tokens) zvinoshandiswa kuisa mhenyu muzvinyorwa zvinofambiswa. Kunyangwe yakanyorwa kuti "Kunze Messaging," chiteshi ichi chinogona kushandiswa kunenge chero chinangwa chinoda nguva chaiyo Chiitiko chinokonzeresa, chinounzwa nesimba neHALO. Kurongeka uku kunochinjika nekuti sarudzo dziri pa "Zviito" dzinotarisa kuti ndezvipi HALO Zviitiko zvinofambisa kuburikidza neiyi chiteshi.
MuHTTP modhi, iyo Set uye Reset Strings ndiyo URLs iyo inofanirwa kuiswa uye kurongeka sezvinodiwa neaida nzvimbo server. Mushandisi uye Password ndima inogona kushandiswa kuratidza chokwadi. Ona HTTP modhi pazasi.
MuTCP mode, Set uye Reset Strings inongova data yeshoko rimwe chete rinotumirwa kune rinogamuchira TCP socket. Dzinogona kufomatidzwa sezvinodiwa nenzvimbo. Nzvimbo yekuenda inotsanangurwa muKero uye Port minda. Ona TCP Mode pazasi.
Kune chero modhi, chimiro kubva kune yazvino meseji inoratidzwa iyo inogona kubatsira kugadzirisa kubatana kana zvimwe zvinhu. Unogona kushandisa mabhatani eChiitiko TEST paActions popup kumanikidza meseji:
Global On/Off for Set or Reset inofanira kunge Yakabatidzwa kuti igonese marudzi iwayo emameseji. Reset kazhinji haishandiswe nekuti chete kutanga kweChiitiko ndiko kufarira, asi izvo zvinogona kusiyana. Chiitiko chega chega chinogona kuzvimiririra kutsanangura kana chichizoshandisa iyo Seti kana Reset meseji paActions popup. Iwo mabhatani ebhora reziso anozoratidza kumiririra kwakakasharara kwezvinotumirwa mushure me keyword substitution uye fomati. Dzokorora Holdoff inogona kushandiswa kutenderedza mameseji kazhinji nekunonoka imwe isati yatumirwa. Izvi zvinoitwa zvakazvimiririra pane Chiitiko. HALO ine yakavakirwa-mukati nguva yezviitiko zve15 masekondi kudzivirira kukurumidza kudzoreredza kweZviitiko. Kana iwe waida kuona kuti haipfuure 1 Chiitiko cherudzi chinotumirwa paminiti, unogona kuseta Repeat Holdoff kusvika makumi matanhatu (masekondi).
Kurova kwemoyo mashoko
The Heartbeat transmissions inoshanda nenzira yakafanana kune iri pamusoro kunze kwekuti hapana kupindirana neActions peji. Pane kudaro, iyo Heartbeat kutapurirana kunoitika nguva nenguva sekugadziriswa neInterval field, MuHTTP modhi, iyo Set uye Reset Strings ndiwo. URLs iyo inofanirwa kuiswa uye kurongeka sezvinodiwa neaida nzvimbo server. Mushandisi uye Password ndima inogona kushandiswa kuratidza chokwadi. Ona HTTP modhi pazasi.
Kunyange zvazvo chinangwa chekutanga cheHeartbeat chiri chekupa humbowo hwehupenyu hweHALO Smart Sensor kune kure kure application, iyi meseji inogona kushandiswawo kuendesa masensa akasarudzwa kana ikozvino Chiitiko state ruzivo. The example pamusoro inotumira tambo refu paramende ne URL izvo zvinosanganisira zita reHalo, ruzhinji rwe sensor values, uye pekupedzisira Triggered=% ACTIVE% iyo inogona kunge isina kana runyorwa rwezvino kukonzeresa Zviitiko.
HTTP (uye HTTPS) Mode
Ekunze Messaging uye Heartbeat tambo dzinogona kuva http: kana https: URLs sezvinodiwa. Nzira uye paramita zvinogona kuiswa sezvinodiwa neserver yekuenda. Mazwi akakosha akaita se%NAME% (HALO mudziyo zita) kana %EID% (Chiitiko id) anogona kuiswa sezvinodiwa uye anotsiviwa nedata rakasiyana kana meseji yatumirwa. Rondedzero yemazwi anonyanya kushandiswa anoratidzwa kuti utarise nekukurumidza.
The URL nzira inogona kuve nemazwi akakosha pamwe nemaparamita kune iyo URL. Maparameta anogona kunge ari NAME=VALUE mapeya kana chinhu cheJSON, kana chimiro chetsika zvichienderana nekwarinoenda server. ExampLes yeKunze Messaging inosanganisira %EID% kuratidza Chiitiko chakonzeresa:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
ExampLes yeKurova Kwemoyo inogona kuwedzera %ACTIVE% (zviri kukonzerwa Zviitiko) kana kukosha kwe sensor:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Iyo %SENSOR:…% makoshero anoshandisa mazita anowanikwa mumusoro wekurudyi sensor column mu evtYYYYMMDD.csv log files. Vanowanzova:
Kana sevha yekuenda ichida HTTP PUT kana POST pachinzvimbo cheGET zvikumbiro, unogona kutanga URL nePUT: kana POST:. Wakazvimiririra, unogona kuwedzera JSON payload inofarirwa nemaseva mazhinji nekuwedzera [JSONBODY] kiyi kiyi inoteverwa neJSON yakarongwa chinhu. Example:
ISA:https://server.com/event[JSONBODY]{“nzvimbo”:”%NAME%”,”chiitiko”:”%EID%”}
The URL inotsigira yakajairika IP kero (uye IPv6) uye chiteshi uye mushandisi-password sarudzo, kana iwe unogona kushandisa Mushandisi nePasiwedhi minda kana ichidikanwa kuve iyo yekuenda server yenzira dzechokwadi seBasic kana Digest:
https://username:password@123.321.123.321:9876/event…
TCP Mode
Ekunze Messaging uye Heartbeat tambo ndezve data chete sezvo Kero nePort minda inotsanangura kwainoenda. Iyo Kero inotsigira mazita, IPv4 uye IPv6.
Tambo yacho inogona kuumbwa sezvikamu zve data zveHTTP mameseji anotsanangurwa pamusoro, kana sezvinodiwa nesevha yekuenda.
ExampLes yeKunze Messaging inosanganisira %EID% kuratidza Chiitiko chakonzeresa:
nzvimbo=%NAME%,chiitiko=%EID%
{“nzvimbo”:”:%NAME%”,”chiitiko”:”%EID%”}
ExampLes yeKurova Kwemoyo inogona kuwedzera %ACTIVE% (zviri kukonzerwa Zviitiko) kana kukosha kwe sensor:
nzvimbo=%NAME%&Triggered=%ACTIVE%
{“nzvimbo”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Mabhokisi ekutarisa mu "Integration Set" uye "Integration Reset" makoramu anotarisisa kuti ndezvipi Zviitiko zvinokonzeresa kutumira. Zvimwe pane kuseta kweZviitiko uye Zviito zviripo muHALO Administrator's Guide.
Kuendeswa kweJSON Chiitiko Meseji
Vamwe vanogadzira vanosarudza kugashira Chiitiko dhata yakarongedzerwa seindasitiri yakajairwa yega-yakanyorwa kuti JSON pane yakajeka ASCII mameseji sezvo ekutanga ari akavimbika uye nyore kupepetwa. Pamusoro peHALO web peji "Messaging" tab, unogona kupa mameseji eJSON mu "External Messaging" marongero "Set String" uye "Reset String" uye mu "Heartbeat" "Mharidzo."
Exampzvishoma:
"Kunze Messaging" Settings Seta tambo:
{“mudziyo”:”%NAME%”, “chiitiko”:”%EID%”, “alarm”:”hongu”}
Izvi zvinotumira imwechete TCP kana UDP JSON meseji kune yakatsanangurwa sevha ichishuma zita rehushamwari remudziyo, zita rechiitiko uye kuti ichangotanga.
"Kunze Messaging" Settings Reset String:
{“mudziyo”:”%NAME%”, “chiitiko”:”%EID%”,“alarm”:”kwete”}
Izvi zvinotumira imwechete TCP kana UDP JSON meseji kune yakatsanangurwa sevha ichishuma zita rehushamwari remudziyo, zita rechiitiko uye kuti mamiriro akamira.
"Kurova kwemoyo" Message:
{“mudziyo”:”%NAME%”, “mupenyu”:”%DATE% %TIME%”}
Izvi zvichapota zvichitumira TCP kana UDP JSON meseji kune yakatsanangurwa sevha ichishuma kuti HALO irimupenyu panguva yakatarwa.
Zvinyorwa / Zvishandiso
 |
Software's HALO Smart Sensor API Basic Software [pdf] Bhuku reMushandisi HALO Smart Sensor API Basic Software |
