Software s HALO Smart Sensọ API Ipilẹ Software
Siwaju
Iwe yii ṣapejuwe ẹgbẹ awọn ohun elo ti Halo Smart Sensor ti a mọ ni apapọ bi API BASIC, tabi Ni wiwo Eto Ohun elo. Ifọrọwọrọ yii jẹ ipinnu fun lilo nipasẹ awọn pirogirama tabi awọn oluṣepọ ti o nifẹ lati ṣepọ ọkan tabi diẹ sii HALO Smart Sensors (HALOs) pẹlu awọn paati sọfitiwia ẹni kẹta (ti kii ṣe IPVideo) tabi awọn ọna ṣiṣe. Ni gbogbogbo, HALO API ti pinnu lati gbe alaye lọna ti o munadoko lati HALO lori nẹtiwọọki Ethernet ti aṣa si eto ita. Lati ṣaṣeyọri ibi-afẹde yii, API ti pin si awọn apakan mẹta: Asopọ Socket Driven Iṣẹlẹ, Asopọ Socket Heartbeat, ati Data Iṣẹlẹ URL. BACnet ni wiwo tun wa ati ki o bo ni iwe lọtọ.
API Design
API jẹ apẹrẹ nipa lilo awọn ọna kika boṣewa ile-iṣẹ bii TCP/IP. HTTP, HTTPS, ati JSON. Apẹrẹ ko nilo eyikeyi pataki tabi awọn imọ-ẹrọ ohun-ini tabi awọn ile-ikawe lati ṣee lo ninu idagbasoke eto ita tabi ohun elo. API jẹ rọ ati pe o le tunto ati siseto lati fi gangan data ti o nilo ati ni ọna ti o munadoko julọ. Awọn alaye ti isẹ ti ọkọọkan awọn apakan ti o wa loke ni a bo ni awọn apakan atẹle ti itọsọna yii.
Ifiranṣẹ Ita
Ile-iṣẹ yii ni a lo lati fi awọn itaniji tabi awọn itaniji ranṣẹ ati data Iṣẹlẹ si eto ita, eto VMS, olupin, ati bẹbẹ lọ nigbati iṣẹlẹ kan ba fa (ti ṣeto). Awọn ifiranšẹ iyan tun le mu ṣiṣẹ lati ṣe ifihan agbara nigbati Iṣẹlẹ ba ti kuro (ti tunto). Ifijiṣẹ yii le ṣe si iho TCP/IP tabi olupin HTTP/S ni akoko gidi. Orisirisi awọn ilana atunto wa pẹlu awọn akoonu isọdi. Ijeri ati fifi ẹnọ kọ nkan wa.
Okan lu
Awọn ifiranṣẹ lilu ọkàn ni a fi ranṣẹ ni aarin atunto (dipo igba ti Awọn iṣẹlẹ nfa) lati pese ẹri ti ifiwe/wiwa. Wọn ni iru awọn agbara ti o jọra bi Fifiranṣẹ Ita ṣugbọn yoo jẹ atunto nigbagbogbo lati ni alaye ipinlẹ gbogbogbo ju awọn alaye nipa iṣẹlẹ kan pato.
Data Iṣẹlẹ URL
Ohun elo yii wa labẹ NDA nikan ati pe o yẹ ki o lo nikan nigbati eto ita ba nilo iraye si eyikeyi ati gbogbo awọn iye Iṣẹlẹ, awọn iloro, ati awọn asia ipinlẹ. A gba data yii ni gbogbogbo lori ibeere nipasẹ eto ita ṣugbọn kii ṣe ni igbohunsafẹfẹ giga pupọ. Ọna yii ni gbogbo igba fa aisimi diẹ nigbati o ba lo oṣuwọn idibo iwọntunwọnsi. Awọn oṣuwọn idibo deede wa lati ẹẹkan fun iṣẹju kan si ẹẹkan fun iṣẹju-aaya 5 pẹlu iwọn ti o pọju pipe ti ẹẹkan fun iṣẹju-aaya. Ọna yii tun le ṣee lo lati gba awọn alaye atilẹyin afikun pada nigbati iṣẹlẹ (gbigbọn) ti gba.
Awọn alaye Ifiranṣẹ ita
A apakan ti HALO web Agbejade Integration ni wiwo pese fun iṣeto ni asopọ ẹgbẹ kẹta kan nibiti awọn iye oriṣiriṣi le ti firanṣẹ si iho TCP latọna jijin tabi olupin HTTP/HTTPS. Awọn imudani aaye (awọn ami-ami) ni a lo lati fi awọn iye laaye sinu ọrọ ti a firanṣẹ. Botilẹjẹpe ti a pe ni “Fifiranṣẹ Ita,” ikanni yii le ṣee lo fun fere eyikeyi idi ti o nilo akoko gidi Awọn okunfa iṣẹlẹ, ti fi agbara mu nipasẹ HALO. Eto yii jẹ irọrun pupọ nitori awọn yiyan lori “Awọn iṣe” pinnu iru Awọn iṣẹlẹ HALO ntan nipasẹ ikanni yii.
Ni ipo HTTP, Ṣeto ati Awọn okun Tunto ni URLs ti o gbọdọ wa ni titẹ ati tito akoonu bi o ṣe nilo nipasẹ olupin opin irin ajo ti o fẹ. Olumulo ati aaye Ọrọigbaniwọle le ṣee lo fun ijẹrisi. Wo ipo HTTP ni isalẹ.
Ni ipo TCP, Ṣeto ati Awọn okun Tunto jẹ data nikan ti ifiranṣẹ kan ti o firanṣẹ si iho TCP ti ngba. Wọn le ṣe ọna kika bi o ṣe nilo nipasẹ ibi-ajo. Awọn nlo ni pato ninu awọn aaye adirẹsi ati Port. Wo Ipo TCP ni isalẹ.
Fun boya ipo, ipo lati ifiranṣẹ to ṣẹṣẹ julọ ti han eyiti o le ṣe iranlọwọ ni atunṣe asopọ tabi awọn ọran miiran. O le lo awọn bọtini TEST Iṣẹlẹ lori agbejade Awọn iṣe lati fi ipa mu ifiranṣẹ kan:
Ni agbaye Tan/Pa fun Ṣeto tabi Tunto gbọdọ wa ni Tan-an lati mu iru awọn ifiranṣẹ yẹn ṣiṣẹ. Tunto kii ṣe lo nigbagbogbo nitori ibẹrẹ iṣẹlẹ nikan ni iwulo, ṣugbọn iyẹn le yatọ. Iṣẹlẹ kọọkan le ni ominira pato boya yoo lo boya Ṣeto tabi ifiranṣẹ atunto lori igarun Awọn iṣe. Awọn bọtini oju oju yoo ṣe afihan aṣoju ti o ni inira ti ohun ti a firanṣẹ lẹhin awọn iyipada Koko ati ọna kika. Tun Holdoff le ṣee lo lati fa awọn ifiranṣẹ loorekoore silẹ nipasẹ idaduro ṣaaju ki o to fi ọkan miiran ranṣẹ. Eyi ni a ṣe ni ominira fun Iṣẹlẹ. HALO ni akoko idaduro ti a ṣe sinu fun awọn iṣẹlẹ ti awọn aaya 15 lati ṣe idiwọ isọdọtun iyara ti Awọn iṣẹlẹ. Ti o ba fẹ lati rii daju pe ko ju 1 Iṣẹlẹ ti iru kan ranṣẹ fun iṣẹju kan, o le ṣeto Tun Holdoff si 60 (aaya).
Awọn alaye lilu ọkàn
Awọn gbigbe Heartbeat ṣiṣẹ ni ọna ti o jọra si oke ayafi pe ko si ibaraenisepo pẹlu oju-iwe Awọn iṣe. Dipo, gbigbe Heartbeat waye ni igbagbogbo bi a ti tunto pẹlu aaye Interval, Ni ipo HTTP, Ṣeto ati Awọn okun Tunto jẹ URLs ti o gbọdọ wa ni titẹ ati tito akoonu bi o ṣe nilo nipasẹ olupin opin irin ajo ti o fẹ. Olumulo ati aaye Ọrọigbaniwọle le ṣee lo fun ijẹrisi. Wo ipo HTTP ni isalẹ.
Lakoko ti idi akọkọ ti Heartbeat ni lati pese ẹri ti igbesi aye ti HALO Smart Sensor si ohun elo latọna jijin, ifiranṣẹ yii tun le lo lati atagba awọn sensọ ti a yan tabi alaye ipo iṣẹlẹ lọwọlọwọ. Awọn example loke rán a gun okun paramita pẹlu awọn URL iyẹn pẹlu orukọ Halo, pupọ julọ awọn iye sensọ, ati nikẹhin Mafa =% ACTIVE% eyiti o le jẹ ofo tabi atokọ ti Awọn iṣẹlẹ ti nfa lọwọlọwọ.
HTTP (ati HTTPS) Ipo
Fifiranṣẹ ita ati awọn gbolohun ọrọ Heartbeat le jẹ http: tabi https: URLs bi ti nilo. Ona ati awọn paramita le wa ni titẹ bi o ṣe nilo nipasẹ olupin opin irin ajo. Awọn ọrọ-ọrọ bii % NAME% (orukọ ẹrọ HALO) tabi % EID% (ID iṣẹlẹ) ni a le fi sii bi o ṣe nilo ati pe yoo rọpo pẹlu data onisọtọ nigbati ifiranṣẹ naa ba ranṣẹ. Atokọ awọn koko-ọrọ ti o wọpọ ni a fihan fun itọkasi ni iyara.
Awọn URL ona le ni awọn koko bi daradara bi awọn paramita si awọn URL. Awọn paramita le jẹ NAME=VALUE orisii tabi ohun JSON kan, tabi ọna kika aṣa ti o da lori olupin ti nlo. ExampFun Ifiranṣẹ Ita yoo pẹlu % EID% lati tọka si Iṣẹlẹ ti o fa:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Examples fun Heartbeat le ṣafikun% ACTIVE% (Awọn iṣẹlẹ ti nfa lọwọlọwọ) tabi iye sensọ kan:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Awọn iye % SENSOR:…% lo awọn orukọ ti a rii ni awọn akọle ọwọ-ọna sensọ ọwọ ọtun ni log evtYYYYMMDD.csv files. Wọn jẹ deede:
Ti olupin ibi-ajo naa ba fẹran HTTP PUT tabi POST dipo awọn ibeere GET, o le ṣaju iṣaaju naa URL pẹlu PUT: tabi POST:. Ni ominira, o le ṣafikun fifuye isanwo JSON eyiti o jẹ olokiki pẹlu ọpọlọpọ awọn olupin nipa fifi ọrọ-ọrọ [JSONBODY] kun pẹlu ohun ti a ṣe agbekalẹ JSON kan. Example:
PUT:https://server.com/event[JSONBODY]{"ipo":"%NAME%",iṣẹlẹ":"%EID%"}
Awọn URL ṣe atilẹyin adiresi IP aṣoju (ati IPv6) ati ibudo ati awọn aṣayan ọrọ igbaniwọle olumulo, tabi o le lo olumulo ati awọn aaye Ọrọigbaniwọle ti o ba nilo olupin opin irin ajo fun awọn ọna ijẹrisi bii Ipilẹ tabi Digest:
https://username:password@123.321.123.321:9876/event…
Ipo TCP
Fifiranṣẹ itagbangba ati awọn gbolohun ọrọ Heartbeat jẹ fun data nikan niwon Adirẹsi ati awọn aaye ibudo pato opin irin ajo naa. Adirẹsi naa ṣe atilẹyin awọn orukọ, IPv4 ati IPv6.
Okun naa le ṣe ọna kika bii awọn ipin data ti awọn ifiranṣẹ HTTP ti a ṣalaye loke, tabi bi olupin ti nlo.
ExampFun Ifiranṣẹ Ita yoo pẹlu % EID% lati tọka si Iṣẹlẹ ti o fa:
ipo=%NAME%,iṣẹlẹ=%EID%
{"ipo":":%NAME%","iṣẹlẹ":"%EID%"}
Examples fun Heartbeat le ṣafikun% ACTIVE% (Awọn iṣẹlẹ ti nfa lọwọlọwọ) tabi iye sensọ kan:
ipo=% NAME%&O nfa =%ACTIVE%
{"ipo":":%NAME%","NH3":%SENSOR:NH3%}
Awọn apoti ayẹwo ni “Ṣeto Iṣọkan” ati awọn ọwọn “Idapọ Atunto” pinnu iru Awọn iṣẹlẹ ti nfa fifiranṣẹ. Diẹ sii lori iṣeto Awọn iṣẹlẹ ati Awọn iṣe wa ninu Itọsọna Alakoso HALO.
Ifijiṣẹ Awọn ifiranṣẹ Iṣẹlẹ JSON
Diẹ ninu awọn olupilẹṣẹ fẹ lati gba data Iṣẹlẹ ti a ṣe ọna kika bi boṣewa ile-iṣẹ ti ara ẹni ti ara ẹni JSON kuku ju ọrọ ASCII lasan nitori ti iṣaaju jẹ igbẹkẹle diẹ sii ati ni irọrun diẹ sii. Lori HALO web oju-iwe “Fifiranṣẹ” taabu, o le pese awọn ifiranṣẹ JSON ni “Fifiranṣẹ ita” awọn eto “Ṣeto Okun” ati “Okun Tunto” ati ninu “Heartbeat” “Ifiranṣẹ.”
Example:
“Fifiranṣẹ ita” Eto Okun Eto:
{"Ẹrọ":"%NAME%", "iṣẹlẹ":"%EID%", "itaniji":"bẹẹni"}
Eyi yoo firanṣẹ TCP ẹyọkan tabi ifiranṣẹ UDP JSON si olupin ti a sọ pato ti o jabo orukọ ẹrọ ore, orukọ iṣẹlẹ ati pe o kan bẹrẹ.
“Fifiranṣẹ ita” Awọn eto atunto okun:
{"Ẹrọ":"%NAME%", "iṣẹlẹ":"%EID%", "itaniji":"rara"}}
Eyi yoo firanṣẹ TCP kan tabi ifiranṣẹ UDP JSON kan si olupin ti a ti sọ pato ti o jabo orukọ ẹrọ ore, orukọ iṣẹlẹ ati pe ipo naa ti duro ni bayi.
Ifiranṣẹ "Iru ọkan":
{"Ẹrọ":"%NAME%", "laaye":"%DATE% %TIME%"}
Eyi yoo fi ifiranṣẹ TCP tabi UDP JSON ranṣẹ lorekore si ijabọ olupin ti a sọ pe HALO wa laaye ni akoko itọkasi.
Awọn iwe aṣẹ / Awọn orisun
 |
Software s HALO Smart Sensọ API Ipilẹ Software [pdf] Itọsọna olumulo HALO Smart Sensọ API Ipilẹ Software |
