Софтвер ХАЛО Смарт Сенсор АПИ Основни софтвер
Напред
Овај документ описује групу објеката Хало паметног сензора познатих под заједничким називом БАСИЦ АПИ, или интерфејс за програмирање апликације. Ова дискусија је намењена програмерима или интеграторима који су заинтересовани за интеграцију једног или више ХАЛО паметних сензора (ХАЛО) са софтверским компонентама или системима треће стране (не-ИПВидео). Генерално, ХАЛО АПИ је намењен за ефикасан пренос информација са ХАЛО-а преко конвенционалне Етхернет мреже до екстерног програма. Да би се постигао овај циљ, АПИ је подељен у три одељка: Евент Дривен Соцкет Цоннецтион, Хеартбеат Соцкет Цоннецтион и Евент Дата URL. БАЦнет интерфејс је такође присутан и покривен у посебном документу.
АПИ дизајн
АПИ је дизајниран коришћењем индустријских стандардних формата као што је ТЦП/ИП. ХТТП, ХТТПС и ЈСОН. Дизајн не захтева никакве посебне или власничке технике или библиотеке које ће се користити у развоју екстерног програма или апликације. АПИ је флексибилан и може се конфигурисати и програмирати да испоручи тачно потребне податке и на најефикаснији начин. Детаљи о раду сваког од горњих одељака су покривени у следећим одељцима овог водича.
Екстерне поруке
Ова могућност се користи за испоруку упозорења или аларма и података о догађајима екстерном програму, ВМС систему, серверу итд. када се догађај активира (подешава). Опционе поруке се такође могу омогућити да сигнализирају када се догађај избрише (ресетује). Ова испорука се може извршити на ТЦП/ИП соцкет или ХТТП/С сервер у реалном времену. Постоји низ конфигурабилних протокола са прилагодљивим садржајем. Доступне су аутентификација и шифровање.
Откуцај срца
Поруке откуцаја срца се шаљу у интервалу који се може подесити (уместо када се догађаји покрећу) да би се пружио доказ уживо/доступности. Имају сличан опсег могућности као и екстерне поруке, али би обично биле конфигурисане да садрже опште информације о стању, а не детаље о одређеном догађају.
Подаци о догађајима URL
Ова могућност је доступна само под НДА и требало би да се користи само када спољни програм захтева приступ било којој или свим вредностима догађаја, праговима и ознакама стања. Ове податке генерално преузима екстерни програм на захтев, али не веома често. Овај метод генерално изазива одређено кашњење када се користи скромна стопа гласања. Типичне стопе гласања крећу се од једном у минути до једном у 5 секунди са апсолутном максималном стопом од једном у секунди. Овај метод се такође може користити за преузимање додатних пратећих података када се прими Догађај (упозорење).
Детаљи о спољним порукама
Део ХАЛО-а web Интерфејс Интеграциони искачући прозор обезбеђује конфигурацију једне везе треће стране где се различите вредности могу послати на удаљени ТЦП сокет или ХТТП/ХТТПС сервер. Држачи места (токени) се користе за уметање живих вредности у пренет текст. Иако је означен као „Спољна размена порука“, овај канал се може користити за скоро све сврхе које захтевају окидаче догађаја у реалном времену, које активно испоручује ХАЛО. Овај аранжман је прилично флексибилан јер одабири на „Радње“ одређују који ХАЛО догађаји се преносе кроз овај канал.
У ХТТП режиму, низови за постављање и ресетовање су URLс које се мора унети и форматирати како то захтева жељени одредишни сервер. За аутентификацију се може користити поље за корисника и лозинку. Погледајте ХТТП режим испод.
У ТЦП режиму, низови за подешавање и ресетовање су само подаци једне поруке која се шаље на ТЦП утичницу која прима. Могу се форматирати по потреби одредишта. Одредиште је наведено у пољима Адреса и Порт. Погледајте ТЦП режим у наставку.
За оба режима, приказује се статус из најновије поруке што може помоћи у поправљању везе или другим проблемима. Можете користити дугмад ТЕСТ догађаја у искачућем прозору Радње да бисте наметнули поруку:
Глобално укључивање/искључивање за Сет или Ресет мора бити укључено да би се омогућиле те врсте порука. Ресетовање се често не користи јер је интересантан само почетак Догађаја, али то може да варира. Сваки догађај може независно одредити да ли ће користити или Постави или Ресетуј поруку у искачућем прозору Радње. Дугмад за очне јабучице ће приказати груби приказ онога што се шаље након замена кључних речи и форматирања. Репеат Холдофф се може користити за смањење честих порука одлагањем пре него што се још једна може послати. Ово се ради независно по догађају. ХАЛО има уграђено време задржавања за догађаје од 15 секунди да спречи брзо поновно покретање догађаја. Ако желите да обезбедите да се не шаље више од 1 догађаја неког типа у минути, можете да подесите понављање задржавања на 60 (секунди).
Детаљи откуцаја срца
Преноси откуцаја срца функционишу на сличан начин као и горе, осим што нема интеракције са страницом Акције. Уместо тога, пренос откуцаја срца се дешава редовно како је конфигурисано у пољу Интервал. У ХТТП режиму, низови Сет и Ресет су URLс које се мора унети и форматирати како то захтева жељени одредишни сервер. За аутентификацију се може користити поље за корисника и лозинку. Погледајте ХТТП режим испод.
Иако је примарна сврха Хеартбеат-а да пружи доказ о животу ХАЛО паметног сензора удаљеној апликацији, ова порука се такође може користити за пренос одабраних сензора или информација о тренутном стању догађаја. Бившиampле изнад шаље параметар дугачког низа са URL који укључују Хало име, већину вредности сензора и на крају Триггеред=%АЦТИВЕ% који може бити празан или списак тренутно покренутих догађаја.
ХТТП (и ХТТПС) режим
Екстерни стрингови за размену порука и откуцаји срца могу бити хттп: или хттпс: URLс по потреби. Одредишни сервер може да унесе путању и параметре по потреби. Кључне речи као што су %НАМЕ% (назив ХАЛО уређаја) или %ЕИД% (ИД догађаја) се могу уметнути по потреби и биће замењене одговарајућим подацима када се порука пошаље. За брзу референцу приказана је листа најчешће коришћених кључних речи.
Тхе URL путања може да садржи кључне речи као и параметре за URL. Параметри могу бити парови НАМЕ=ВРЕДНОСТ или ЈСОН објекат или прилагођени формат у зависности од одредишног сервера. Прampдатотеке за спољну размену порука би укључивале %ЕИД% да би означиле догађај који је покренуо:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Exampлесови за откуцаје срца могу додати %АЦТИВЕ% (тренутно покренути догађаји) или вредност сензора:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Вредности %СЕНСОР:…% користе имена која се налазе у заглављима колона десног сензора у евиденцији евтГГГГММДД.цсв fileс. Они су обично:
Ако одредишни сервер преферира ХТТП ПУТ или ПОСТ уместо ГЕТ захтева, можете да додате префикс URL са ПУТ: или ПОСТ:. Независно, можете додати ЈСОН корисни терет који је популаран на многим серверима додавањем кључне речи [ЈСОНБОДИ] праћене ЈСОН форматираним објектом. Прampле:
ПУТ:хттпс://сервер.цом/евент[ЈСОНБОДИ]{“лоцатион”:”%НАМЕ%”,”евент”:”%ЕИД%”}
Тхе URL подржава типичне ИП адресе (и ИПв6) и опције порта и корисничке лозинке, или можете користити поља Усер и Пассворд ако је потребно да буду одредишни сервер за методе провјере аутентичности као што су Басиц или Дигест:
https://username:password@123.321.123.321:9876/event…
ТЦП режим
Екстерне поруке и стрингови откуцаја срца служе само за податке пошто поља Адреса и Порт наводе одредиште. Адреса подржава имена, ИПв4 и ИПв6.
Стринг се може форматирати као делови података у ХТТП порукама описаним горе, или како то захтева одредишни сервер.
Exampдатотеке за спољну размену порука би укључивале %ЕИД% да би означиле догађај који је покренуо:
локација=%НАМЕ%,догађај=%ЕИД%
{“лоцатион”:”:%НАМЕ%”,”евент”:”%ЕИД%”}
Exampлесови за откуцаје срца могу додати %АЦТИВЕ% (тренутно покренути догађаји) или вредност сензора:
локација=%НАМЕ%&Триггеред=%АЦТИВЕ%
{“лоцатион”:”:%НАМЕ%”,”НХ3”:%СЕНСОР:НХ3%}
Поља за потврду у колонама „Сет интеграције“ и „Ресетовање интеграције“ одређују који догађаји покрећу слање. Више о подешавању догађаја и радњи доступно је у ХАЛО Администраторском водичу.
Испорука ЈСОН порука о догађајима
Неки програмери више воле да примају податке о догађајима форматиране као индустријски стандардни самоозначени ЈСОН, а не обичан АСЦИИ текст јер је први поузданији и лакше рашчлањен. На ХАЛО-у web на картици „Поруке“, можете да унесете ЈСОН поруке у подешавањима „Спољне поруке“ „Подеси стринг“ и „Ресетуј стринг“ и у „Поруци“ „Откуцај срца“.
Exampлес:
Стринг подешавања подешавања „Спољне поруке“:
{ “уређај”:”%НАМЕ%”, “догађај”:”%ЕИД%”, “аларм”:”да” }
Ово ће послати једну ТЦП или УДП ЈСОН поруку одређеном серверу са извештајем о пријатељском називу уређаја, називу догађаја и да је управо започео.
Стринг за ресетовање подешавања „Спољне поруке“:
{ “уређај”:”%НАМЕ%”, “догађај”:”%ЕИД%”, “аларм”:”не” }
Ово ће послати једну ТЦП или УДП ЈСОН поруку наведеном серверу са извештајем о пријатељском називу уређаја, називу догађаја и да је услов сада заустављен.
Порука „откуцај срца“:
{ “уређај”:”%НАМЕ%”, “жив”:”%ДАТЕ% %ТИМЕ%” }
Ово ће периодично слати ТЦП или УДП ЈСОН поруку наведеном серверу са извештајем да је ХАЛО жив у назначено време.
Документи / Ресурси
 |
Софтвер ХАЛО Смарт Сенсор АПИ Основни софтвер [пдф] Упутство за кориснике Основни софтвер ХАЛО Смарт Сенсор АПИ |
