Bogearraí s HALO Smart Sensor API Bogearraí Bunúsacha
Ar aghaidh
Déanann an doiciméad seo cur síos ar ghrúpa áiseanna an Halo Smart Braiteoir ar a dtugtar le chéile an BASIC API, nó Comhéadan Ríomhchláraithe Feidhmchláir. Tá an plé seo beartaithe le húsáid ag ríomhchláraitheoirí nó ag lánpháirtithe a bhfuil suim acu Braiteoirí Cliste HALO (HALOanna) amháin nó níos mó a chomhtháthú le comhpháirteanna nó córais bogearraí 3ú páirtí (neamh-IPVideo). Go ginearálta, tá sé beartaithe ag API HALO faisnéis a aistriú go héifeachtach ó HALO thar líonra traidisiúnta Ethernet chuig an gclár seachtrach. Chun an sprioc seo a bhaint amach, tá an API roinnte ina thrí chuid: Ceangal Soicéad Tiomáinte ag Imeacht, Ceangal Soicéad Heartbeat, agus Sonraí Imeachta URL. Tá comhéadan BACnet i láthair freisin agus clúdaithe i ndoiciméad ar leith.
Dearadh API
Tá an API deartha ag baint úsáide as formáidí caighdeánacha tionscail mar TCP/IP. HTTP, HTTPS, agus JSON. Ní éilíonn an dearadh go n-úsáidfí aon teicníochtaí nó leabharlanna speisialta nó dílseánaigh i bhforbairt an chláir nó an fheidhmchláir sheachtraigh. Tá an API solúbtha agus is féidir é a chumrú agus a ríomhchlárú chun na sonraí a theastaíonn a sheachadadh go beacht agus ar an mbealach is éifeachtaí. Clúdaítear sonraí oibríocht gach ceann de na hailt thuas sna hailt seo a leanas den treoir seo.
Teachtaireachtaí Seachtracha
Úsáidtear an áis seo chun foláirimh nó aláraim agus sonraí Imeachta a sheachadadh chuig clár seachtrach, córas VMS, freastalaí, etc. nuair a spreagtar Imeacht (a shocraítear é). Is féidir teachtaireachtaí roghnacha a chur in iúl freisin nuair a ghlanann Imeacht (athshocraítear é). Is féidir an seachadadh seo a dhéanamh chuig soicéad TCP/IP nó chuig freastalaí HTTP/S i bhfíor-am. Tá raon de phrótacail inchumraithe ann a bhfuil inneachar inoiriúnaithe orthu. Tá fíordheimhniú agus criptiú ar fáil.
Buille croí
Seoltar teachtaireachtaí buille croí ag eatraimh is féidir a chumrú (seachas nuair a spreagtar Imeachtaí) chun cruthúnas beo/infhaighteachta a sholáthar. Tá raon cumais chomhchosúil acu le Teachtaireachtaí Seachtracha ach de ghnáth dhéanfaí iad a chumrú chun faisnéis ghinearálta stáit a bheith iontu seachas sonraí faoi imeacht ar leith.
Sonraí Imeachta URL
Níl an áis seo ar fáil ach faoi ÚNM agus níor cheart í a úsáid ach amháin nuair a éilíonn an clár seachtrach rochtain ar aon agus ar gach luachanna Imeachta, tairseacha agus bratacha stáit. Go ginearálta, faightear na sonraí seo ar éileamh ón gclár seachtrach ach ní ar mhinicíocht an-ard. De ghnáth bíonn roinnt foighne ag baint leis an modh seo nuair a úsáidtear ráta measartha vótaíochta. Réimníonn gnáthrátaí vótaíochta ó uair amháin in aghaidh an nóiméid go dtí uair sa 5 shoicind le ráta uasta iomlán uair amháin in aghaidh an tsoicind. Is féidir an modh seo a úsáid freisin chun sonraí tacaíochta breise a fháil nuair a fhaightear Imeacht (foláireamh).
Sonraí na dTeachtaireachtaí Seachtracha
Cuid den HALO web Soláthraíonn aníos aníos Comhtháthaithe do chumraíocht nasc 3ú páirtí amháin inar féidir luachanna éagsúla a sheoladh chuig soicéad TCP cianda nó chuig freastalaí HTTP/HTTPS. Úsáidtear sealbhóirí áite (comharthaí) chun luachanna beo a chur isteach sa téacs tarchurtha. Cé go bhfuil an lipéad “Teachtaireachtaí Seachtrach,” is féidir an cainéal seo a úsáid le haghaidh beagnach aon chríche a éilíonn truicear imeachtaí fíor-ama, arna sheachadadh go gníomhach ag HALO. Tá an socrú seo solúbtha go leor toisc go gcinneann roghanna ar na “Gníomhartha” na hImeachtaí HALO a tharchuireann tríd an gcainéal seo.
I mód HTTP, is iad na Teaghráin Socraithe agus Athshocraigh an URLs a chaithfear a chur isteach agus a fhormáidiú de réir mar a éilíonn an freastalaí sprice atá ag teastáil. Is féidir réimse Úsáideora agus Pasfhocal a úsáid le haghaidh fíordheimhnithe. Féach mód HTTP thíos.
I mód TCP, níl sna Teaghráin Socraithe agus Athshocraigh ach sonraí teachtaireacht amháin a sheoltar chuig an soicéad TCP glactha. Is féidir iad a fhormáidiú mar is gá ag an gceann scríbe. Tá an ceann scríbe sonraithe sna réimsí Seoladh agus Port. Féach Mód TCP thíos.
Maidir le ceachtar den dá mhodh, taispeántar stádas ón teachtaireacht is déanaí, rud a d'fhéadfadh cabhrú le ceangal nó saincheisteanna eile a shocrú. D'fhéadfá na cnaipí TÁSTÁIL Imeachta ar an bpíosa aníos Actions a úsáid chun teachtaireacht a bhrú:
Caithfidh Domhanda Ar/Amach le haghaidh Socraithe nó Athshocraigh a bheith ar siúl chun na cineálacha sin teachtaireachtaí a chumasú. Is minic nach n-úsáidtear athshocrú toisc gur díol spéise é tosú Imeachta, ach is féidir leis sin a bheith éagsúil. Is féidir le gach Imeacht a shonrú go neamhspleách an úsáidfidh sé an teachtaireacht Set nó an teachtaireacht Athshocraigh ar an bpíosa Gníomhartha. Taispeánfaidh na cnaipí eyeball léiriú garbh ar an méid a sheoltar tar éis ionadú eochairfhocail agus formáidiú. Is féidir úsáid a bhaint as athsheoladh chun teachtaireachtaí minice a bhrú chun cinn trí mhoill a chur sular féidir ceann eile a sheoladh. Déantar é seo go neamhspleách in aghaidh na hImeachta. Tá am socraithe ionsuite ag HALO le haghaidh imeachtaí 15 soicind chun cosc a chur ar atógáil tapa Imeachtaí. Dá mba mhian leat a chinntiú nach seolfar níos mó ná 1 Imeacht de chineál in aghaidh an nóiméid, d’fhéadfá Athrá a choinneáil siar go 60 (soicind).
Sonraí buille croí
Feidhmíonn na tarchuir Heartbeat ar bhealach cosúil leis an méid thuas ach amháin nach bhfuil aon idirghníomhaíocht leis an leathanach Gníomhartha. Ina áit sin, tarlaíonn tarchur Heartbeat ar bhonn rialta mar atá cumraithe leis an réimse Eatramh, I mód HTTP, is iad na Teaghráin Socraigh agus Athshocraigh an URLs a chaithfear a chur isteach agus a fhormáidiú de réir mar a éilíonn an freastalaí sprice atá ag teastáil. Is féidir réimse Úsáideora agus Pasfhocal a úsáid le haghaidh fíordheimhnithe. Féach mód HTTP thíos.
Cé gurb é príomhchuspóir an Heartbeat cruthúnas saoil Braiteoir Cliste HALO a sholáthar d'fheidhmchlár cianda, is féidir an teachtaireacht seo a úsáid freisin chun braiteoirí roghnaithe nó faisnéis staid reatha Imeachta a tharchur. An seanample thuas seolann paraiméadar teaghrán fada leis an URL lena n-áirítear an t-ainm Halo, tromlach na luachanna braite, agus ar deireadh Triggered =% ACTIVE% a d'fhéadfadh a bheith folamh nó liosta Imeachtaí spreagtha faoi láthair.
Mód HTTP (agus HTTPS).
Is féidir le teaghráin Teachtaireachtaí Seachtracha agus Heartbeat a bheith http: nó https: URLs mar is gá. Is féidir cosán agus paraiméadair a chur isteach de réir mar is gá ag an bhfreastalaí ceann scríbe. Is féidir eochairfhocail ar nós %NAME% (ainm gléis HALO) nó %EID% (aitheantas imeachta) a chur isteach de réir mar is gá agus cuirfear na sonraí faoi seach ina n-ionad nuair a sheolfar an teachtaireacht. Taispeántar liosta de na heochairfhocail a úsáidtear go coitianta le haghaidh tagartha tapa.
Tá an URL Is féidir le cosán go bhfuil eochairfhocail chomh maith leis na paraiméadair chun an URL. Seans gur péirí NAME=VALUE nó réad JSON iad na paraiméadair, nó formáid shaincheaptha ag brath ar an bhfreastalaí sprice. examples le haghaidh Teachtaireachtaí Seachtracha bheadh %EID% san áireamh chun an tImeacht a spreag:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
Exampd'fhéadfadh les le haghaidh Heartbeat %ACTIVE% (Imeachtaí a spreagtar faoi láthair) nó luach braiteora a chur leis:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Úsáideann na luachanna % SENSOR:…% na hainmneacha a aimsítear sna ceannteidil cholúin bhraiteora ar dheis i loga evtYYYYYMMDD.csv files. Is iad seo a leanas de ghnáth:
Más fearr leis an bhfreastalaí ceann scríbe HTTP PUT nó POST seachas iarratais GET, is féidir leat an réimír URL le PUT: nó POST:. Go neamhspleách, is féidir leat pálasta JSON a bhfuil an-tóir air ag go leor freastalaithe a chur leis tríd an eochairfhocal [JSONBODY] a chur leis agus réad formáidithe JSON ina dhiaidh sin. example:
PUT:https://server.com/event[JSONBODY]{/“location”:”%NAME%”,”imeacht”:”%EID%”}
Tá an URL tacaíonn sé le gnáthsheoladh IP (agus IPv6) agus roghanna poirt agus pasfhocail úsáideora, nó is féidir leat na réimsí Úsáideora agus Pasfhocal a úsáid más gá a bheith mar an freastalaí cinn scríbe le haghaidh modhanna fíordheimhnithe mar Basic or Digest:
https://username:password@123.321.123.321:9876/event…
Mód TCP
Is le haghaidh sonraí amháin atá teaghráin Teachtaireachtaí Seachtracha agus Heartbeat ós rud é go sonraíonn na réimsí Seoladh agus Port an ceann scríbe. Tacaíonn an Seoladh le hainmneacha, IPv4 agus IPv6.
Is féidir an teaghrán a fhormáidiú cosúil leis na codanna sonraí de theachtaireachtaí HTTP a gcuirtear síos orthu thuas, nó mar a éilíonn an freastalaí sprice.
Examples le haghaidh Teachtaireachtaí Seachtracha bheadh %EID% san áireamh chun an tImeacht a spreag:
suíomh=%NAME%,imeacht=%EID%
{“suíomh”:”:%NAME%”, “imeacht”:”%EID%”}
Exampd'fhéadfadh les le haghaidh Heartbeat %ACTIVE% (Imeachtaí a spreagtar faoi láthair) nó luach braiteora a chur leis:
suíomh=%NAME%&Triosca=%ACTIVE%
{“suíomh”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
Cinneann ticbhoscaí sna colúin “Socrú Comhtháthaithe” agus “Athshocrú Comhtháthaithe” cé na himeachtaí a spreagann seoladh. Tá tuilleadh maidir le socrú Imeachtaí agus Gníomhartha ar fáil i dTreoir an Riarthóra HALO.
Seachadadh Teachtaireachtaí Imeachta JSON
Is fearr le roinnt forbróirí sonraí Imeachtaí formáidithe mar JSON féinlipéadaithe caighdeánach tionscail a fháil seachas gnáth-théacs ASCII mar go bhfuil an chéad cheann acu parsáilte ar bhealach níos iontaofa agus níos éasca. Ar an HALO web leathanach “Teachtaireachtaí”, is féidir leat teachtaireachtaí JSON a sholáthar i socruithe “Teachtaireachtaí Seachtrach” “Set Teaghrán” agus “Athshocraigh Teaghrán” agus sa “Heartbeat” “Teachtaireacht.”
Examples:
Teaghrán Socraithe Socruithe “Teachtaireachtaí Seachtracha”:
{ “gléas”:”%NAME%”, “imeacht”:”%EID%”, “aláram”:”tá” }
Seolfaidh sé seo teachtaireacht TCP nó UDP JSON amháin chuig an bhfreastalaí sonraithe ag tuairisciú ainm an ghléis chairdiúil, ainm an imeachta agus go bhfuil sé díreach tosaithe.
Teaghrán Athshocraigh Socruithe “Teachtaireachtaí Seachtracha”:
{ “gléas”:”%NAME%”, “imeacht”:”%EID%”, “aláram”:”níl” }
Seolfaidh sé seo teachtaireacht TCP nó UDP JSON amháin chuig an bhfreastalaí sonraithe ag tuairisciú ainm an ghléis chairdiúil, ainm an imeachta agus go bhfuil an riocht stoptha anois.
Teachtaireacht “Heartbeat”:
{ “gléas”: ”%NAME%”, “beo”:” %DATE% %TIME% ” }
Seolfaidh sé seo teachtaireacht TCP nó UDP JSON go tréimhsiúil chuig an bhfreastalaí sonraithe ag tuairisciú go bhfuil an HALO beo ag an am sonraithe.
Doiciméid / Acmhainní
 |
Bogearraí s HALO Smart Sensor API Bogearraí Bunúsacha [pdfTreoir Úsáideora Bogearraí Bunúsacha HALO Sensor API |
