Programinė įranga HALO Smart Sensor API pagrindinė programinė įranga
Pirmyn
Šiame dokumente aprašoma „Halo Smart Sensor“ įrenginių grupė, bendrai vadinama BASIC API arba taikomųjų programų programavimo sąsaja. Ši diskusija skirta programuotojams ar integratoriams, norintiems integruoti vieną ar daugiau HALO išmaniųjų jutiklių (HALO) su trečiosios šalies (ne IPVideo) programinės įrangos komponentais ar sistemomis. Apskritai HALO API skirta efektyviam informacijos perdavimui iš HALO per įprastą Ethernet tinklą į išorinę programą. Kad būtų pasiektas šis tikslas, API suskirstyta į tris dalis: įvykiais pagrįstas lizdo ryšys, širdies plakimo lizdo ryšys ir įvykių duomenys. URL. BACnet sąsaja taip pat yra ir aprašyta atskirame dokumente.
API dizainas
API sukurta naudojant standartinius pramonės formatus, tokius kaip TCP/IP. HTTP, HTTPS ir JSON. Dizainas nereikalauja jokių specialių ar patentuotų metodų ar bibliotekų, kurios būtų naudojamos kuriant išorinę programą ar taikomąją programą. API yra lanksti, ją galima konfigūruoti ir užprogramuoti taip, kad būtų pateikti tiksliai reikalingi duomenys ir efektyviausiu būdu. Išsami informacija apie kiekvieno iš aukščiau paminėtų skyrių veikimą pateikiama tolesniuose šio vadovo skyriuose.
Išoriniai pranešimai
Ši priemonė naudojama perspėjimams arba pavojaus signalams ir įvykių duomenims pristatyti į išorinę programą, VMS sistemą, serverį ir pan., kai įvykis suaktyvinamas (nustatytas). Taip pat galima įjungti pasirenkamus pranešimus, kurie signalizuoja, kai įvykis išvalomas (nustatytas iš naujo). Šis pristatymas gali būti pristatytas į TCP/IP lizdą arba HTTP/S serverį realiuoju laiku. Yra daugybė konfigūruojamų protokolų su tinkinamu turiniu. Galimas autentifikavimas ir šifravimas.
Širdies plakimas
Širdies plakimo pranešimai siunčiami konfigūruojamu intervalu (o ne tada, kai suaktyvinami įvykiai), kad būtų pateiktas tiesioginio / pasiekiamumo įrodymas. Jie turi panašias galimybes kaip išoriniai pranešimai, tačiau paprastai yra sukonfigūruoti taip, kad juose būtų bendroji būsenos informacija, o ne informacija apie konkretų įvykį.
Renginio duomenys URL
Ši priemonė pasiekiama tik pagal NDA ir turėtų būti naudojama tik tada, kai išorinei programai reikalinga prieiga prie visų įvykių verčių, slenksčių ir būsenų žymų. Šiuos duomenis paprastai nuskaito išorinė programa, bet ne labai dažnai. Šis metodas paprastai patiria tam tikrą delsą, kai naudojamas nedidelis apklausos dažnis. Įprasti apklausų dažniai svyruoja nuo vieno karto per minutę iki vieno per 5 sekundes, o absoliutus maksimalus dažnis yra kartą per sekundę. Šis metodas taip pat gali būti naudojamas norint gauti papildomus pagalbinius duomenis, kai gaunamas įvykis (perspėjimas).
Išsami informacija apie išorinius pranešimus
HALO dalis web Interfeiso iššokantis langas suteikia galimybę konfigūruoti vieną trečiosios šalies ryšį, kuriame įvairios reikšmės gali būti siunčiamos į nuotolinį TCP lizdą arba HTTP/HTTPS serverį. Vietų laikikliai (žetonai) naudojami tiesioginėms reikšmėms įterpti į perduodamą tekstą. Nors šis kanalas pažymėtas kaip „Išorinis pranešimų siuntimas“, šis kanalas gali būti naudojamas beveik bet kokiam tikslui, kuriam reikia realiojo laiko įvykių aktyviklių, kuriuos aktyviai teikia HALO. Šis išdėstymas yra gana lankstus, nes „Veiksmų“ pasirinkimai nustato, kurie HALO įvykiai perduodami šiuo kanalu.
HTTP režimu Set ir Reset eilutės yra URLs, kuriuos reikia įvesti ir suformatuoti taip, kaip to reikalauja norimas paskirties serveris. Vartotojo ir slaptažodžio laukas gali būti naudojamas autentifikavimui. Žr. toliau pateiktą HTTP režimą.
TCP režimu Set ir Reset Strings yra tik vieno pranešimo, siunčiamo į priimantįjį TCP lizdą, duomenys. Jie gali būti suformatuoti pagal poreikį pagal paskirties vietą. Paskirties vieta nurodoma laukuose Adresas ir Prievadas. Žiūrėkite žemiau esantį TCP režimą.
Bet kuriuo režimu rodoma naujausio pranešimo būsena, kuri gali padėti išspręsti ryšio ar kitas problemas. Galite naudoti įvykių TEST mygtukus, esančius iššokančiame veiksmų lange, norėdami priversti pranešimą:
Visuotinis įjungimas / išjungimas, skirtas nustatyti arba iš naujo nustatyti, turi būti įjungtas, kad būtų galima įjungti tokio tipo pranešimus. Atstatymas dažnai nenaudojamas, nes domina tik įvykio pradžia, tačiau tai gali skirtis. Kiekvienas įvykis gali savarankiškai nurodyti, ar jis naudos pranešimą Nustatyti arba Atstatyti iššokančiame lange Veiksmai. Akies obuolio mygtukai parodys apytikslę informaciją apie tai, kas siunčiama pakeitus raktinius žodžius ir suformatavus. Repeat Holdoff gali būti naudojamas dažniems pranešimams sustabdyti, atidedant, kol bus galima išsiųsti kitą. Tai atliekama atskirai kiekvienam įvykiui. HALO turi įmontuotą 15 sekundžių įvykių sulaikymo laiką, kad būtų išvengta greito įvykių pakartotinio paleidimo. Jei norite užtikrinti, kad per minutę būtų išsiųstas ne daugiau kaip 1 tokio tipo įvykis, galite nustatyti Repeat Holdoff į 60 (sekundžių).
Širdies plakimo detalės
Širdies plakimo perdavimas veikia panašiai kaip aukščiau, išskyrus tai, kad nėra jokios sąveikos su veiksmų puslapiu. Vietoj to, širdies plakimas perduodamas reguliariai, kaip sukonfigūruota lauke Intervalas. HTTP režimu Set ir Reset eilutės yra URLs, kuriuos reikia įvesti ir suformatuoti taip, kaip to reikalauja norimas paskirties serveris. Vartotojo ir slaptažodžio laukas gali būti naudojamas autentifikavimui. Žr. toliau pateiktą HTTP režimą.
Nors pagrindinis širdies plakimo tikslas yra pateikti HALO Smart Sensor gyvavimo įrodymą nuotolinei programai, šis pranešimas taip pat gali būti naudojamas perduodant pasirinktus jutiklius arba esamos įvykio būsenos informaciją. Buvęsample aukščiau siunčia ilgos eilutės parametrą su URL kurie apima Halo pavadinimą, daugumą jutiklio reikšmių ir galiausiai Triggered=%ACTIVE%, kuris gali būti tuščias arba šiuo metu suaktyvintų įvykių sąrašas.
HTTP (ir HTTPS) režimas
Išorinės pranešimų siuntimo ir širdies plakimo eilutės gali būti http: arba https: URLs kaip reikia. Jei reikia, paskirties serveris gali įvesti kelią ir parametrus. Raktažodžiai, pvz., %NAME% (HALO įrenginio pavadinimas) arba %EID% (įvykio ID), gali būti įterpti pagal poreikį ir bus pakeisti atitinkamais duomenimis, kai pranešimas bus išsiųstas. Greitai nuorodai pateikiamas dažniausiai naudojamų raktinių žodžių sąrašas.
The URL kelyje gali būti raktinių žodžių ir parametrų į URL. Parametrai gali būti NAME=VALUE poros arba JSON objektas arba tinkintas formatas, atsižvelgiant į paskirties serverį. PvzampIšorinio pranešimų siuntimo lesuose būtų %EID%, kad būtų nurodytas įvykis, kuris suaktyvino:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples for Heartbeat gali pridėti %ACTIVE% (šiuo metu suaktyvinti įvykiai) arba jutiklio reikšmę:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Vertės %SENSOR:…% naudoja pavadinimus, esančius dešiniajame jutiklio stulpelių antraštėse evtYYYYMMDD.csv žurnale files. Paprastai jie yra:
Jei paskirties serveris teikia pirmenybę HTTP PUT arba POST, o ne GET užklausoms, galite priešdėlį URL su PUT: arba POST:. Nepriklausomai galite pridėti JSON naudingą apkrovą, kuri yra populiari daugelyje serverių, pridėdami raktinį žodį [JSONBODY], po kurio eina JSON formato objektas. PvzampLe:
PUT:https://server.com/event[JSONBODY]{"vietovė":"%NAME%","įvykis":"%EID%"}
The URL palaiko įprastą IP adresą (ir IPv6) ir prievado bei vartotojo slaptažodžio parinktis arba, jei reikia, galite naudoti laukus Vartotojas ir Slaptažodis būti paskirties serveriu autentifikavimo metodams, pvz., Basic arba Digest:
https://username:password@123.321.123.321:9876/event…
TCP režimas
Išorinės pranešimų ir širdies plakimo eilutės yra skirtos tik duomenims, nes laukuose Adresas ir Prievadas nurodo paskirties vietą. Adresas palaiko pavadinimus, IPv4 ir IPv6.
Eilutę galima suformatuoti kaip anksčiau aprašytų HTTP pranešimų duomenų dalis arba kaip reikalauja paskirties serveris.
ExampIšorinio pranešimų siuntimo lesuose būtų %EID%, kad būtų nurodytas įvykis, kuris suaktyvino:
vieta=%NAME%, įvykis=%EID%
{"vieta":":%NAME%","įvykis":"%EID%"}
Examples for Heartbeat gali pridėti %ACTIVE% (šiuo metu suaktyvinti įvykiai) arba jutiklio reikšmę:
location=%NAME%&Triggered=%ACTIVE%
{"vieta":":%NAME%","NH3":%SENSOR:NH3%}
Stulpeliuose „Integravimo rinkinys“ ir „Integravimo nustatymas iš naujo“ esantys žymimieji laukeliai nustato, kurie įvykiai suaktyvina siuntimą. Daugiau apie įvykių ir veiksmų sąranką rasite HALO administratoriaus vadove.
JSON įvykių pranešimų pristatymas
Kai kurie kūrėjai nori gauti įvykių duomenis, suformatuotus kaip pramonės standarto JSON, o ne paprastą ASCII tekstą, nes pirmasis yra patikimiau ir lengviau išanalizuojamas. HALO web Puslapio skirtuke „Pranešimai“, galite pateikti JSON pranešimus „Išorinio pranešimo“ nustatymuose „Nustatyti eilutę“ ir „Atstatyti eilutę“ bei „Širdies plakimo“ „Pranešimas“.
Exampmažiau:
„Išorinių pranešimų“ nustatymų rinkinio eilutė:
{ "įrenginys":"%NAME%", "įvykis":"%EID%", "žadintuvas":"taip" }
Į nurodytą serverį bus išsiųstas vienas TCP arba UDP JSON pranešimas, pranešantis apie patogų įrenginio pavadinimą, įvykio pavadinimą ir tai, kad jis ką tik prasidėjo.
„Išorinių pranešimų“ nustatymų iš naujo nustatymo eilutė:
{ "įrenginys":"%NAME%", "įvykis":"%EID%", "aliarmas":"ne" }
Į nurodytą serverį bus nusiųstas vienas TCP arba UDP JSON pranešimas, pranešantis apie patogų įrenginio pavadinimą, įvykio pavadinimą ir kad būsena dabar sustabdyta.
Širdies plakimo žinutė:
{ "įrenginys":"%NAME%", "gyvas":"%DATE% %TIME%" }
Tai periodiškai į nurodytą serverį siųs TCP arba UDP JSON pranešimą, pranešantį, kad nurodytu laiku HALO veikia.
Dokumentai / Ištekliai
 |
Programinė įranga HALO Smart Sensor API pagrindinė programinė įranga [pdfVartotojo vadovas HALO Smart Sensor API pagrindinė programinė įranga |
