Software s HALO Smart sénsor API Software Dasar
Maju
Dokumén ieu ngajelaskeun grup fasilitas Sensor Halo Smart anu dikenal sacara koléktif salaku BASIC API, atanapi Antarmuka Pemrograman Aplikasi. Diskusi ieu dimaksudkeun pikeun dianggo ku programer atanapi integrator anu kabetot dina ngahijikeun hiji atanapi langkung HALO Smart Sensor (HALO) sareng komponén software atanapi sistem pihak ka-3 (non-IPVideo). Sacara umum, API HALO dimaksudkeun pikeun mindahkeun inpormasi sacara éfisién ti HALO ngaliwatan jaringan Ethernet konvensional ka program éksternal. Pikeun ngahontal tujuan ieu, API dibagi kana tilu bagian: Sambungan Soket Didorong Acara, Sambungan Soket Detak Jantung, sareng Data Acara URL. Antarbeungeut BACnet ogé hadir sareng katutupan dina dokumén anu misah.
Desain API
API dirancang nganggo format standar industri sapertos TCP/IP. HTTP, HTTPS, sareng JSON. Desain teu merlukeun téhnik husus atawa proprietary atawa perpustakaan bisa dipaké dina ngembangkeun program éksternal atawa aplikasi. API téh fléksibel tur bisa ngonpigurasi sarta diprogram pikeun nganteurkeun persis data diperlukeun tur dina ragam pang éfisiénna. Sacara rinci ngeunaan operasi unggal bagian di luhur katutupan dina bagian handap pituduh ieu.
Olahtalatah éksternal
fasilitas ieu dipaké pikeun nganteurkeun panggeuing atawa alarm jeung data Acara ka program éksternal, sistem VMS, server, jeung sajabana lamun hiji Acara dipicu (diatur). Pesen opsional ogé bisa diaktipkeun pikeun sinyal lamun hiji Acara dibereskeun (direset). Pangiriman ieu tiasa dilakukeun ka stop kontak TCP / IP atanapi server HTTP / S sacara real waktos. Aya sajumlah protokol anu tiasa dikonfigurasi sareng eusi anu tiasa disaluyukeun. Auténtikasi sareng énkripsi sayogi.
Ketug jajantung
Pesen keteg jajantung dikirim dina interval configurable (tinimbang nalika Kajadian dipicu) pikeun nyadiakeun bukti live / kasadiaan. Aranjeunna gaduh kamampuan anu sami sareng Olahtalatah Eksternal tapi biasana bakal dikonpigurasi pikeun ngandung inpormasi kaayaan umum tinimbang detil ngeunaan hiji kajadian anu tangtu.
Data Kajadian URL
Fasilitas ieu ngan sadia dina hiji NDA jeung ngan kudu dipake lamun program éksternal merlukeun aksés ka sagala tur sagala nilai Acara, ambang, jeung bandéra kaayaan. Data ieu umumna dicandak upami diperyogikeun ku program éksternal tapi henteu dina frékuénsi anu luhur pisan. Métode ieu umumna nyababkeun sababaraha latén nalika tingkat polling anu sederhana dianggo. Ongkos polling ilaharna dibasajankeun sakali per menit nepi ka sakali per 5 detik kalawan laju maksimum mutlak sakali per detik. Métode ieu ogé tiasa dianggo pikeun nyandak data pangrojong tambahan nalika Kajadian (waspada) ditampi.
Rincian Olahtalatah éksternal
Hiji bagian tina HALO web panganteur Pangintegrasi popup nyadiakeun keur konfigurasi tina sambungan pihak 3 tunggal dimana rupa nilai bisa dikirim ka stop kontak TCP jauh atawa HTTP / server HTTPS. Panyekel tempat (token) dianggo pikeun nyelapkeun nilai langsung kana téks anu dikirimkeun. Sanajan dilabélan "Olahtalatah éksternal," saluran ieu bisa dipaké pikeun ampir sagala kaperluan merlukeun pemicu acara nyata waktu, aktip dikirimkeun ku HALO. Susunan ieu cukup fleksibel sabab pilihan dina "Aksi" nangtukeun Acara HALO mana anu dikirimkeun ngaliwatan saluran ieu.
Dina modeu HTTP, Set jeung Reset Strings nyaéta URLs nu kudu diasupkeun tur formatna sakumaha diperlukeun ku server tujuan nu dipikahoyong. Widang Pamaké sareng Sandi tiasa dianggo pikeun auténtikasi. Tempo mode HTTP handap.
Dina modeu TCP, Setel sareng Reset String ngan ukur data tina hiji pesen anu dikirim ka soket TCP anu nampi. Éta bisa diformat sakumaha diperlukeun ku tujuan. Tujuanana ditetepkeun dina widang Alamat sareng Pelabuhan. Tempo TCP Mode handap.
Pikeun boh modeu, status tina pesen panganyarna dipintonkeun anu tiasa ngabantosan ngalereskeun sambungan atanapi masalah anu sanés. Anjeun tiasa nganggo tombol TEST Acara dina popup Tindakan pikeun maksa pesen:
Hurung/Pareuman Global pikeun Setel atanapi Reset kedah Hurung pikeun ngaktipkeun jinis-jinis pesen éta. Reset sering henteu dianggo sabab ngan ukur awal Acara anu dipikaresep, tapi éta tiasa rupa-rupa. Unggal Kajadian tiasa sacara mandiri netepkeun upami éta bakal nganggo Set atanapi Reset pesen dina pop-up Aksi. Tombol bola panon bakal nembongkeun ngagambarkeun kasar naon dikirim sanggeus substitusi keyword sarta pormat. Repeat Holdoff tiasa dianggo pikeun nga-throttle pesen anu sering ku cara ngalambatkeun sateuacan pesen anu sanés tiasa dikirim. Hal ieu dilakukeun sacara mandiri per Acara. HALO gaduh waktos tahan anu diwangun pikeun acara 15 detik pikeun nyegah kajadian deui gancang. Lamun hayang mastikeun teu leuwih ti 1 Kajadian tina tipe hiji dikirim per menit, Anjeun bisa nyetel Ulang Holdoff ka 60 (detik).
Rincian keteg jajantung
Pangiriman Detak Jantung fungsina sami sareng di luhur kecuali teu aya interaksi sareng halaman Aksi. Sabalikna, pangiriman Detak Jantung lumangsung sacara rutin sakumaha dikonpigurasi sareng lapangan Interval, Dina modeu HTTP, Set sareng Reset String mangrupikeun URLs nu kudu diasupkeun tur formatna sakumaha diperlukeun ku server tujuan nu dipikahoyong. Widang Pamaké sareng Sandi tiasa dianggo pikeun auténtikasi. Tempo mode HTTP handap.
Samentara tujuan utama Detak Jantung nyaéta pikeun masihan bukti kahirupan HALO Smart Sensor ka aplikasi jauh, pesen ieu ogé tiasa dianggo pikeun ngirimkeun sénsor anu dipilih atanapi inpormasi kaayaan Acara ayeuna. Mantanample luhur ngirimkeun parameter string panjang kalayan URL Éta kalebet nami Halo, seuseueurna nilai sénsor, sareng anu terakhir dipicu =% AKTIF% anu tiasa kosong atanapi daptar Kajadian anu ayeuna dipicu.
HTTP (jeung HTTPS) Mode
Senar Olahtalatah éksternal sareng Detak Jantung tiasa http: atanapi https: URLs sakumaha diperlukeun. Jalur sareng parameter tiasa diasupkeun upami diperyogikeun ku pangladén tujuan. Kecap konci sapertos %NAME% (Ngaran alat HALO) atanapi %EID% (ID Acara) tiasa diselapkeun upami diperyogikeun sareng bakal diganti ku data masing-masing nalika pesen dikirim. Daptar kecap konci anu biasa dianggo dipidangkeun pikeun rujukan gancang.
The URL jalur bisa ngandung kecap konci ogé parameter ka URL. Parameterna tiasa janten NAME=VALUE pasangan atanapi objek JSON, atanapi format khusus gumantung kana pangladén tujuan. Misalamples pikeun Olahtalatah Éksternal bakal ngawengku %EID% pikeun nunjukkeun Kajadian anu dipicu:
- 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 bisa nambahan %ACTIVE% (ayeuna dipicu Kajadian) atawa nilai sensor:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Nilai %SENSOR:…% nganggo nami anu aya dina judul kolom sensor beulah katuhu dina log evtYYYYMMDD.csv files. Aranjeunna biasana:
Lamun server tujuan prefers HTTP PUT atanapi POST tinimbang requests GET, anjeun tiasa awalan nu URL kalawan PUT: atanapi POST:. Sacara mandiri, anjeun tiasa nambihan payload JSON anu populer sareng seueur server ku nambihan kecap konci [JSONBODY] dituturkeun ku objék anu diformat JSON. Misalample:
PUT:https://server.com/event[JSONBODY]{“lokasi”:”%NAME%”,”acara”:”%EID%”}
The URL ngarojong alamat IP has (sareng IPv6) sareng port sareng pilihan sandi-pamaké, atanapi anjeun tiasa nganggo widang Pamaké sareng Sandi upami diperyogikeun janten pangladén tujuan pikeun metode auténtikasi sapertos Dasar atanapi Intisari:
https://username:password@123.321.123.321:9876/event…
Modeu TCP
Senar Olahtalatah éksternal sareng Detak Jantung ngan ukur kanggo data sabab widang Alamat sareng Pelabuhan netepkeun tujuan. Alamat ngadukung nami, IPv4 sareng IPv6.
String tiasa diformat sapertos porsi data tina seratan HTTP anu dijelaskeun di luhur, atanapi sakumaha anu diperyogikeun ku pangladén tujuan.
Examples pikeun Olahtalatah Éksternal bakal ngawengku %EID% pikeun nunjukkeun Kajadian anu dipicu:
lokasi=%NAME%,acara=%EID%
{“lokasi”:”:%NAME%”,”acara”:”%EID%”}
Examples for Heartbeat bisa nambahan %ACTIVE% (ayeuna dipicu Kajadian) atawa nilai sensor:
lokasi=%NAME%&Dipicu=%AKTIF%
{"lokasi":":%NAME%","NH3":%SENSOR:NH3%}
Kotak centang dina kolom "Integrasi Set" sareng "Integrasi Reset" nangtukeun Kajadian mana anu memicu ngirim. Langkung seueur ngeunaan setelan Kajadian sareng Aksi sayogi dina Pituduh Administrator HALO.
Pangiriman Pesen Acara JSON
Sababaraha pamekar langkung resep nampi data Acara anu diformat salaku JSON anu dilabélan diri standar industri tinimbang téks ASCII biasa sabab anu baheula langkung dipercaya sareng langkung gampang diurai. Dina HALO web Dina tab "Olahtalatah", anjeun tiasa nyayogikeun pesen JSON dina setélan "Olahtalatah Eksternal" "Setel String" sareng "Reset String" sareng dina "Ketukan Jantung" "Pesen."
Examples:
Setélan "Olahtalatah éksternal" Nyetél String:
{ “alat”:”%NAME%”, “acara”:”%EID%”, “alarm”:”enya” }
Ieu bakal ngirim pesen TCP atanapi UDP JSON tunggal ka server anu ditangtukeun ngalaporkeun nami alat anu ramah, nami acara sareng anu nembé ngamimitian.
Setélan "Olahtalatah éksternal" Reset String:
{ “alat”:”%NAME%”, “acara”:”%EID%”, “alarm”:”henteu” }
Ieu bakal ngirim pesen TCP atanapi UDP JSON tunggal ka server anu ditangtukeun ngalaporkeun nami alat anu ramah, nami acara sareng kaayaan éta parantos lirén.
Pesen "Ketug Jantung":
{ “alat”:”%NAME%”, “hirup”:”%DATE% %TIME%” }
Ieu périodik bakal ngirim pesen TCP atanapi UDP JSON ka server anu ditangtukeun ngalaporkeun yén HALO hirup dina waktos anu dituduhkeun.
Dokumén / Sumberdaya
 |
Software s HALO Smart sénsor API Software Dasar [pdf] Pituduh pamaké HALO Smart Sensor API Software Dasar |
