Програм хангамжийн HALO Smart Sensor API үндсэн програм хангамж
Урагшаа
Энэхүү баримт бичиг нь BASIC API буюу Хэрэглээний програмчлалын интерфэйс гэж нэрлэгддэг Halo Smart Sensor-ийн бүлгүүдийг тодорхойлдог. Энэхүү хэлэлцүүлгийг гуравдагч талын (IPVideo бус) програм хангамжийн бүрэлдэхүүн хэсэг эсвэл системтэй нэг буюу хэд хэдэн HALO ухаалаг мэдрэгчийг (HALO) нэгтгэх сонирхолтой програмистууд эсвэл интеграторуудад ашиглахад зориулагдсан болно. Ерөнхийдөө HALO API нь ердийн Ethernet сүлжээгээр дамжуулан HALO-ээс гадаад программ руу мэдээллийг үр дүнтэй дамжуулах зорилготой юм. Энэ зорилгод хүрэхийн тулд API нь үйл явдалд тулгуурласан залгуур холболт, зүрхний цохилтын залгуурын холболт, үйл явдлын өгөгдөл гэсэн гурван хэсэгт хуваагдана. URL. BACnet интерфэйс нь бас байдаг бөгөөд тусдаа баримт бичигт тусгагдсан байдаг.
API дизайн
API нь TCP/IP зэрэг салбарын стандарт форматыг ашиглан бүтээгдсэн. HTTP, HTTPS болон JSON. Дизайн нь гадны програм эсвэл програмыг боловсруулахад ашиглах тусгай болон өмчийн техник, санг ашиглах шаардлагагүй. API нь уян хатан бөгөөд шаардлагатай өгөгдлийг яг хамгийн үр ашигтайгаар хүргэхийн тулд тохируулж, програмчлах боломжтой. Дээрх хэсгүүдийн үйл ажиллагааны дэлгэрэнгүй мэдээллийг энэхүү гарын авлагын дараах хэсгүүдэд тусгасан болно.
Гадаад мессеж
Энэ байгууламж нь үйл явдал идэвхжсэн (тохируулсан) үед гадаад программ, VMS систем, сервер гэх мэтэд дохиолол, дохиолол болон Үйл явдлын өгөгдлийг хүргэхэд ашиглагддаг. Үйл явдал арилах (дахин тохируулах) үед дохио өгөх нэмэлт мессежүүдийг идэвхжүүлж болно. Энэ хүргэлтийг TCP/IP залгуур эсвэл HTTP/S серверт бодит цаг хугацаанд хийж болно. Өөрчлөн тохируулж болох агуулга бүхий олон тооны тохируулж болох протоколууд байдаг. Баталгаажуулалт болон шифрлэлт боломжтой.
Зүрхний цохилт
Зүрхний цохилтын мессежийг тохируулж болох интервалаар илгээдэг (Үйл явдал өдөөх үед биш) амьд/боломжтой эсэхийг нотлох. Эдгээр нь гадаад мессежийнхтэй ижил төстэй боломжуудтай боловч тодорхой үйл явдлын талаарх дэлгэрэнгүй мэдээллийг бус ерөнхий төлөвийн мэдээллийг агуулсан байхаар тохируулагдсан байдаг.
Үйл явдлын өгөгдөл URL
Энэ хэрэгслийг зөвхөн NDA-ийн дагуу ашиглах боломжтой бөгөөд зөвхөн гадаад программ нь Үйл явдлын бүх утга, босго, муж улсын тугуудад хандах шаардлагатай үед л ашиглагдах ёстой. Энэ өгөгдлийг ерөнхийдөө гадны программ хүсэлтээр авдаг боловч тийм ч өндөр давтамжтайгаар авдаггүй. Энэ арга нь санал хураалтын дундаж хувь хэмжээг ашиглах үед ерөнхийдөө тодорхой хэмжээний хоцрогдол үүсгэдэг. Санал хураалтын ердийн хувь хэмжээ нь минут тутамд нэгээс 5 секундэд нэг удаа, үнэмлэхүй дээд хурд нь секундэд нэг удаа байна. Энэ аргыг Үйл явдал (сэрэмжлүүлэг) хүлээн авах үед нэмэлт туслах өгөгдлийг олж авахад ашиглаж болно.
Гадаад мессежийн дэлгэрэнгүй
HALO-ийн хэсэг web интерфэйс Интеграцийн попап нь алсын TCP залгуур эсвэл HTTP/HTTPS сервер рүү янз бүрийн утгыг илгээх боломжтой нэг гуравдагч талын холболтын тохиргоог хийдэг. Дамжуулсан текстэд амьд утгыг оруулахын тулд газар эзэмшигчид (жетон) ашигладаг. Хэдийгээр "Гадаад мессеж" гэсэн шошготой ч энэ сувгийг HALO-ийн идэвхтэй хүргэсэн бодит цагийн үйл явдлын триггер шаарддаг бараг бүх зорилгоор ашиглаж болно. "Үйлдэл" дээрх сонголтууд нь энэ сувгаар ямар HALO үйл явдлууд дамжихыг тодорхойлдог тул энэ зохицуулалт нэлээд уян хатан юм.
HTTP горимд Set болон Reset мөрүүд нь URLs-г хүссэн серверийн шаардлагын дагуу оруулж, форматлах ёстой. Баталгаажуулахын тулд Хэрэглэгч болон Нууц үгийн талбарыг ашиглаж болно. HTTP горимыг доороос үзнэ үү.
TCP горимд Set болон Reset Strings нь зөвхөн хүлээн авагч TCP залгуур руу илгээгдсэн нэг мессежийн өгөгдөл юм. Тэдгээрийг зорьсон газарт шаардлагатай бол форматлаж болно. Очих газрыг Хаяг болон Порт талбарт зааж өгсөн болно. TCP горимыг доороос үзнэ үү.
Аль ч горимын хувьд холболт болон бусад асуудлыг засахад туслах хамгийн сүүлийн мессежийн статусыг харуулах болно. Та үйлдлүүд гарч ирэх цонхон дээрх Event TEST товчлууруудыг ашиглан мессежийг хүчээр илгээж болно:
Эдгээр төрлийн мессежийг идэвхжүүлэхийн тулд тохируулах эсвэл дахин тохируулахын тулд Глобал асаах/унтраах нь асаалттай байх ёстой. Зөвхөн үйл явдлын эхлэл нь сонирхолтой байдаг тул дахин тохируулахыг ихэвчлэн ашигладаггүй, гэхдээ энэ нь өөр байж болно. Үйл явдал бүр нь Үйлдлийн цонхон дээрх Set эсвэл Reset мессежийг ашиглах эсэхийг бие даан зааж өгч болно. Нүдний алимны товчлуурууд нь түлхүүр үг солих, хэлбэршүүлсний дараа илгээгдсэн зүйлийн бүдүүлэг дүрслэлийг харуулах болно. Repeat Holdoff-ийг өөр мессеж илгээхээс өмнө хойшлуулах замаар ойр ойрхон мессежийг багасгахад ашиглаж болно. Энэ нь үйл явдал тус бүрээр бие даан хийгддэг. HALO нь үйл явдлуудыг хурдан өдөөхөөс урьдчилан сэргийлэхийн тулд 15 секундын хугацаатай үйл явдлуудыг саатуулдаг. Хэрэв та минутанд 1-ээс илүүгүй төрлийн үйл явдал илгээхийг хүсч байвал давталтыг 60 (секунд) болгож тохируулж болно.
Зүрхний цохилтын дэлгэрэнгүй мэдээлэл
Зүрхний цохилтын дамжуулалт нь дээрхтэй төстэй байдлаар ажилладаг бөгөөд зөвхөн Үйлдлийн хуудастай ямар ч харилцан үйлчлэл байхгүй. Үүний оронд Зүрхний цохилтын дамжуулалт нь интервалын талбарт тохируулагдсаны дагуу тогтмол явагддаг. HTTP горимд Тохируулах болон Дахин тохируулах мөрүүд нь URLs-г хүссэн серверийн шаардлагын дагуу оруулж, форматлах ёстой. Баталгаажуулахын тулд Хэрэглэгч болон Нууц үгийн талбарыг ашиглаж болно. HTTP горимыг доороос үзнэ үү.
Heartbeat-ийн үндсэн зорилго нь HALO Smart Sensor-ийн ашиглалтын баталгааг алсын хэрэглээний программд өгөх явдал боловч энэ мессежийг сонгосон мэдрэгч эсвэл одоогийн үйл явдлын төлөвийн мэдээллийг дамжуулахад ашиглаж болно. эксampДээрх le нь урт мөрийн параметрийг илгээдэг URL Мэдрэгчийн утгуудын дийлэнх хэсэг болох Halo нэр, хамгийн сүүлд нь хоосон байж болох Triggered=%ACTIVE% эсвэл одоогоор өдөөгдсөн үйл явдлын жагсаалтыг багтаасан болно.
HTTP (болон HTTPS) горим
Гадаад мессеж болон зүрхний цохилтын мөр нь http: эсвэл https байж болно: URLшаардлагатай бол. Зорилтот серверээс шаардлагатай бол зам болон параметрүүдийг оруулж болно. %NAME% (HALO төхөөрөмжийн нэр) эсвэл %EID% (Үйл явдлын id) гэх мэт түлхүүр үгсийг шаардлагатай бол оруулах боломжтой бөгөөд мессежийг илгээх үед холбогдох мэдээллээр солигдох болно. Түгээмэл хэрэглэгддэг түлхүүр үгсийн жагсаалтыг хурдан лавлах зорилгоор харуулав.
The URL зам нь түлхүүр үг болон параметрүүдийг агуулж болно URL. Параметрүүд нь NAME=VALUE хос эсвэл JSON объект эсвэл очих серверээс хамааран өөрчлөн тохируулсан формат байж болно. Жишээ ньampГадны зурваст зориулсан les-д %EID% орно:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
ExampHeartbeat-д зориулсан les нь %ACTIVE% (одоогоор өдөөгдсөн үйл явдлууд) эсвэл мэдрэгчийн утгыг нэмж болно:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
%SENSOR:…% утгууд нь evtYYYYMMDD.csv бүртгэлийн баруун гар талын мэдрэгчийн баганын гарчигт байгаа нэрийг ашигладаг. fileс. Тэдгээр нь ихэвчлэн:
Хэрэв очих сервер нь GET хүсэлтийн оронд HTTP PUT эсвэл POST-ыг илүүд үздэг бол та угтвар тавьж болно URL PUT: эсвэл POST:. Та [JSONBODY] түлхүүр үг, дараа нь JSON форматтай объектыг нэмснээр олон серверт түгээмэл байдаг JSON ачааллыг бие даан нэмж болно. Жишээ ньampле:
PUT:https://server.com/event[JSONBODY]{“байршил”:”%NAME%”,”event”:”%EID%”}
The URL ердийн IP хаяг (болон IPv6) болон порт болон хэрэглэгчийн нууц үгийн сонголтуудыг дэмждэг, эсвэл шаардлагатай бол Хэрэглэгч болон Нууц үгийн талбаруудыг Basic эсвэл Digest гэх мэт нэвтрэлт таних аргуудын хувьд очих сервер болгон ашиглаж болно:
https://username:password@123.321.123.321:9876/event…
TCP горим
Хаяг болон Порт талбарууд нь очих газрыг зааж өгсөн тул гадаад мессеж болон зүрхний цохилтын мөрүүд нь зөвхөн өгөгдөлд зориулагдсан болно. Хаяг нь IPv4 болон IPv6 нэрийг дэмждэг.
Уг мөрийг дээр дурдсан HTTP мессежийн өгөгдлийн хэсэг эсвэл очих серверийн шаардлагын дагуу форматлаж болно.
ExampГадны зурваст зориулсан les-д %EID% орно:
байршил=%NAME%,үйл явдал=%EID%
{“байршил”:”:%NAME%”,”үйл явдал”:”%EID%”}
ExampHeartbeat-д зориулсан les нь %ACTIVE% (одоогоор өдөөгдсөн үйл явдлууд) эсвэл мэдрэгчийн утгыг нэмж болно:
байршил=%NAME%&Өдөөгдсөн=%ACTIVE%
{“байршил”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
"Интеграцийн багц" болон "Интеграцийн дахин тохируулах" баганад байгаа тэмдэглэгээ нь ямар үйл явдал илгээхийг өдөөж байгааг тодорхойлдог. Үйл явдал болон Үйлдлүүдийн тохиргооны талаарх дэлгэрэнгүй мэдээллийг HALO администраторын гарын авлагаас авах боломжтой.
JSON үйл явдлын мессежийг хүргэх
Зарим хөгжүүлэгчид энгийн ASCII текст биш харин салбарын стандарт өөрөө шошготой JSON хэлбэрээр форматлагдсан үйл явдлын өгөгдлийг хүлээн авахыг илүүд үздэг, учир нь эхнийх нь илүү найдвартай, илүү хялбар задлан шинжилдэг. HALO дээр web "Мессеж" хуудасны "Гадаад мессеж" тохиргооны "Мөр тохируулах" болон "Зүрхний цохилт" "Мессеж" хэсэгт JSON мессежийг оруулах боломжтой.
Examples:
"Гадаад мессеж" тохиргооны мөр:
{ “төхөөрөмж”:”%NAME%”, “үйл явдал”:”%EID%”, “сэрүүлэг”:”тийм” }
Энэ нь төхөөрөмжийн нэр, үйл явдлын нэр, дөнгөж эхэлж байгааг мэдээлэх ганц TCP эсвэл UDP JSON мессежийг заасан сервер рүү илгээх болно.
"Гадаад мессеж" тохиргоог дахин тохируулах мөр:
{ “төхөөрөмж”:”%NAME%”, “үйл явдал”:”%EID%”, “сэрүүлэг”:”үгүй” }
Энэ нь төхөөрөмжийн нэр, үйл явдлын нэр, нөхцөл одоо зогссон тухай мэдээлэх нэг TCP эсвэл UDP JSON мессежийг заасан сервер рүү илгээх болно.
"Зүрхний цохилт" мессеж:
{ “төхөөрөмж”:”%NAME%”, “амьд”:”%DATE% %TIME%” }
Энэ нь заасан сервер рүү HALO-г заасан цагт амьд байгаа тухай мэдээлэх TCP эсвэл UDP JSON мессежийг үе үе илгээх болно.
Баримт бичиг / нөөц
 |
Програм хангамжийн HALO Smart Sensor API үндсэн програм хангамж [pdf] Хэрэглэгчийн гарын авлага HALO Smart Sensor API үндсэн програм хангамж |
