Нармафзори HALO Smart Sensor API Software Basic
Ба пеш
Ин ҳуҷҷат гурӯҳи иншооти Halo Smart Sensor-ро тавсиф мекунад, ки ба таври дастаҷамъӣ бо номи BASIC API ё Интерфейси барномасозии барнома маълум аст. Ин муҳокима барои истифода аз ҷониби барномасозон ё интеграторҳо пешбинӣ шудааст, ки ба ҳамгироии як ё якчанд сенсорҳои Smart HALO (HALO) бо ҷузъҳо ё системаҳои нармафзори тарафи сеюм (ғайри IPVideo) таваҷҷӯҳ доранд. Умуман, HALO API барои интиқоли самараноки иттилоот аз HALO тавассути шабакаи анъанавии Ethernet ба барномаи беруна пешбинӣ шудааст. Барои ноил шудан ба ин ҳадаф, 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 сатрҳои Танзим ва Reset инҳоянд URLs, ки бояд тибқи талаби сервери таъиноти дилхоҳ ворид ва формат карда шаванд. Майдони корбар ва парол метавонад барои тасдиқи аутентификатсия истифода шавад. Ба ҳолати HTTP нигаред.
Дар реҷаи TCP сатрҳои Танзим ва аз нав барқароркунӣ танҳо маълумоти як паёме мебошанд, ки ба васлаки TCP-и қабулкунанда фиристода мешаванд. Онҳоро мувофиқи зарурати таъинот формат кардан мумкин аст. Ҷои таъинот дар майдонҳои Суроға ва Порт муайян карда мешавад. Ба режими TCP дар зер нигаред.
Барои ҳар ду режим, ҳолати паёми охирин нишон дода мешавад, ки метавонад барои ҳалли пайвастшавӣ ё дигар мушкилот кӯмак кунад. Шумо метавонед тугмаҳои TEST Event-ро дар равзанаи Амалҳо барои маҷбур кардани паём истифода баред:
Global On/Off for Set or Reset бояд фаъол бошад, то ин намуди паёмҳоро фаъол созад. Бозсозӣ аксар вақт истифода намешавад, зеро танҳо фарорасии Ҳодиса ҷолиб аст, аммо он метавонад фарқ кунад. Ҳар як Ҳодиса метавонад мустақилона муайян кунад, ки оё он паёми Танзим ё Reset -ро дар равзанаи Амалҳо истифода хоҳад кард. Тугмаҳои гарави чашм тасвири ноҳамвори он чизеро, ки пас аз иваз кардани калимаҳои калидӣ ва форматкунӣ фиристода мешаванд, нишон медиҳанд. Repeat Holdoff метавонад барои қатъ кардани паёмҳои зуд-зуд тавассути таъхир пеш аз фиристодани паёми дигар истифода шавад. Ин дар як Ҳодиса мустақилона анҷом дода мешавад. HALO дорои вақти дарунсохт барои рӯйдодҳои 15 сония барои пешгирии дубора оғоз кардани рӯйдодҳо мебошад. Агар шумо хоҳед, ки дар як дақиқа на бештар аз 1 Ҳодисаи навъи фиристодашударо таъмин кунед, шумо метавонед Боздошти такрориро ба 60 (сония) муқаррар кунед.
Тафсилоти набзи дил
Интиқоли набзи дил ба таври шабеҳ ба гуфтаҳои боло амал мекунад, ба истиснои он ки ҳеҷ гуна ҳамкорӣ бо саҳифаи амалҳо вуҷуд надорад. Ба ҷои ин, интиқоли Набзи дил ба таври мунтазам сурат мегирад, ки бо майдони Фосила танзим карда шудааст, Дар ҳолати HTTP, Сатрҳои Танзим ва Reset инҳоянд URLs, ки бояд тибқи талаби сервери таъиноти дилхоҳ ворид ва формат карда шаванд. Майдони корбар ва парол метавонад барои тасдиқи аутентификатсия истифода шавад. Ба ҳолати HTTP нигаред.
Ҳангоме ки ҳадафи аслии Heartbeat ин пешниҳоди исботи ҳаёти сенсори Smart HALO ба замимаи дурдаст аст, ин паём инчунин метавонад барои интиқоли сенсорҳои интихобшуда ё иттилооти ҷории Ҳодиса истифода шавад. собиқample дар боло як параметри сатри дарозро бо URL ки номи Halo, аксарияти арзишҳои сенсорро дар бар мегиранд ва дар охир Триггершуда=%ФАЪОЛ%, ки метавонанд холӣ бошанд ё рӯйхати Ҳодисаҳои дар айни замон андохташуда.
Ҳолати HTTP (ва HTTPS).
Сатрҳои паёмнависии беруна ва набзи дил метавонанд http: ё https: URLба қадри зарурӣ. Роҳ ва параметрҳоро мувофиқи зарурати сервери таъинот ворид кардан мумкин аст. Калимаҳои калидӣ ба монанди %NAME% (номи дастгоҳи HALO) ё %EID% (ID-и рӯйдод) метавонанд ҳангоми зарурат ворид карда шаванд ва ҳангоми фиристодани паём бо маълумоти мувофиқ иваз карда мешаванд. Рӯйхати калимаҳои маъмулан истифодашаванда барои истинодҳои зуд нишон дода шудаанд.
Дар URL роҳ метавонад калимаҳои калидӣ ва инчунин параметрҳоро дар бар гирад URL. Параметрҳо метавонанд ҷуфтҳои NAME=VALUE ё объекти JSON ё формати фармоишӣ вобаста ба сервери таъинотӣ бошанд. Мисолamples барои Паёмнависии беруна %EID% -ро дар бар мегирад, то Ҳодисаеро, ки ба вуҷуд овард:
- 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 метавонад %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]{“location”:”%NAME%”,”event”:”%EID%”}
Дар URL суроғаи маъмулии IP (ва IPv6) ва имконоти порт ва пароли корбарро дастгирӣ мекунад ё шумо метавонед майдонҳои Корбар ва Рамзро истифода баред, агар лозим бошад, сервери таъинот барои усулҳои аутентификатсия ба монанди Basic ё Digest бошад:
https://username:password@123.321.123.321:9876/event…
Ҳолати TCP
Сатрҳои паёмнависии беруна ва тапиши дил танҳо барои маълумот мебошанд, зеро майдонҳои Суроға ва Порт макони таъинотро муайян мекунанд. Суроға номҳоро дастгирӣ мекунад, IPv4 ва IPv6.
Сатр метавонад ба монанди қисмҳои додаҳои паёмҳои HTTP дар боло тавсиф карда шавад ё тавре ки сервери таъинот талаб карда мешавад.
Examples барои Паёмнависии беруна %EID% -ро дар бар мегирад, то Ҳодисаеро, ки ба вуҷуд овард:
макон=%NAME%, воқеа=%EID%
{“location”:”:%NAME%”,”event”:”%EID%”}
Examples for Heartbeat метавонад %ACTIVE% (Ҳодисаҳои дар айни замон фаъолшуда) ё арзиши сенсорро илова кунад:
макон=%NAME%&Triggered=%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%” }
Ин мунтазам ба сервери мушаххас паёми TCP ё UDP JSON мефиристад, ки дар бораи зинда будани HALO дар вақти муайяншуда гузориш медиҳад.
Ҳуҷҷатҳо / Сарчашмаҳо
 |
Нармафзори HALO Smart Sensor API Software Basic [pdf] Дастури корбар HALO Smart Sensor API Software Basic |
