የሶፍትዌር s HALO ስማርት ዳሳሽ API መሰረታዊ ሶፍትዌር

ወደፊት

ይህ ሰነድ በአጠቃላይ BASIC API ወይም Application Programming Interface በመባል የሚታወቀውን የHalo Smart Sensor መገልገያዎችን ቡድን ይገልጻል። ይህ ውይይት አንድ ወይም ከዚያ በላይ HALO Smart Sensors (HALOs) ከ3ኛ ወገን (IPVideo ያልሆኑ) የሶፍትዌር ክፍሎች ወይም ሲስተሞች ጋር ለማዋሃድ ለሚፈልጉ ፕሮግራመሮች ወይም integrators ለመጠቀም የታሰበ ነው። በአጠቃላይ የ HALO ኤፒአይ መረጃን ከ HALO በተለምዷዊ የኤተርኔት ኔትወርክ ወደ ውጫዊ ፕሮግራም በብቃት ለማስተላለፍ የታሰበ ነው። ይህንን ግብ ለማሳካት ኤፒአይ በሶስት ክፍሎች የተከፈለ ነው፡ የክስተት Driven Socket Connection፣ Heartbeat Socket Connection እና Event Data URL. የ BACnet በይነገጽ እንዲሁ አለ እና በተለየ ሰነድ ውስጥ ተሸፍኗል።

የኤፒአይ ንድፍ

ኤፒአይ የተነደፈው እንደ TCP/IP ያሉ የኢንዱስትሪ ደረጃ ቅርጸቶችን በመጠቀም ነው። HTTP፣ HTTPS እና JSON ዲዛይኑ ምንም አይነት ልዩ ወይም የባለቤትነት ቴክኒኮችን ወይም ቤተ-መጻሕፍትን ለውጫዊ ፕሮግራሙ ወይም አፕሊኬሽኑ ልማት አይፈልግም። ኤፒአይ ተለዋዋጭ ነው እና የሚፈለገውን ውሂብ በትክክል ለማቅረብ እና በጣም ቀልጣፋ በሆነ መልኩ ሊዋቀር እና ሊዘጋጅ ይችላል። የእያንዳንዳቸው ከላይ ያሉት ክፍሎች አሠራሮች ዝርዝር በዚህ መመሪያ በሚቀጥሉት ክፍሎች ተሸፍኗል።

ውጫዊ መልእክት

ይህ ተቋም አንድ ክስተት ሲቀሰቀስ (ሲዘጋጅ) ወደ ውጫዊ ፕሮግራም፣ ቪኤምኤስ ሲስተም፣ አገልጋይ፣ ወዘተ ማንቂያዎችን ወይም ማንቂያዎችን እና የክስተት ውሂብን ለማድረስ ይጠቅማል። የአማራጭ መልእክቶች አንድ ክስተት ሲጸዳ (እንደገና ሲጀመር) ምልክት እንዲያደርጉ ሊነቁ ይችላሉ። ይህ ማድረስ ወደ TCP/IP ሶኬት ወይም HTTP/S አገልጋይ በቅጽበት ሊደረግ ይችላል። ሊበጁ የሚችሉ ይዘቶች ያሉት ብዙ ሊዋቀሩ የሚችሉ ፕሮቶኮሎች አሉ። ማረጋገጫ እና ምስጠራ ይገኛሉ።

የልብ ምት

የቀጥታ/ተገኝነት ማረጋገጫ ለማቅረብ የልብ ምት መልዕክቶች ሊዋቀር በሚችል የጊዜ ክፍተት (ክስተቶች ሲቀሰቀሱ ሳይሆን) ይላካሉ። እንደ ውጫዊ መልእክት ተመሳሳይ የችሎታዎች ክልል አሏቸው ነገርግን ስለ አንድ ክስተት ዝርዝር መረጃ ሳይሆን አጠቃላይ የግዛት መረጃ እንዲይዝ ይዋቀራል።

የክስተት ውሂብ URL

ይህ መገልገያ የሚገኘው በኤንዲኤ ስር ብቻ ሲሆን ውጫዊ ፕሮግራሙ ማንኛውንም እና ሁሉንም የክስተት እሴቶችን፣ ገደቦችን እና የግዛት ባንዲራዎችን ማግኘት ሲፈልግ ብቻ ነው ጥቅም ላይ መዋል ያለበት። ይህ መረጃ በአጠቃላይ በውጫዊ ፕሮግራሙ በፍላጎት የተገኘ ነው ነገር ግን በጣም ከፍተኛ በሆነ ድግግሞሽ አይደለም። ይህ ዘዴ በአጠቃላይ መጠነኛ የድምፅ አሰጣጥ መጠን ጥቅም ላይ ሲውል የተወሰነ መዘግየትን ያስከትላል። የተለመዱ የድምጽ መስጫ ዋጋዎች በደቂቃ ከአንድ ጊዜ እስከ አንድ ጊዜ በ 5 ሰከንድ በከፍተኛው ከፍተኛ መጠን በሰከንድ አንድ ጊዜ ይደርሳሉ። ይህ ዘዴ አንድ ክስተት (ማንቂያ) ሲደርስ ተጨማሪ ደጋፊ መረጃዎችን ለማውጣት ጥቅም ላይ ሊውል ይችላል።

የውጭ መልእክት ዝርዝሮች

የ HALO ክፍል web የበይነገጽ ውህደት ብቅ ባይ የተለያዩ እሴቶችን ወደ የርቀት TCP ሶኬት ወይም ኤችቲቲፒ/ኤችቲቲፒኤስ አገልጋይ የሚላኩበት ነጠላ የሶስተኛ ወገን ግንኙነትን ያቀርባል። የቦታ መያዣዎች (ቶከኖች) በሚተላለፈው ጽሑፍ ውስጥ የቀጥታ እሴቶችን ለማስገባት ያገለግላሉ። ምንም እንኳን ይህ ቻናል “የውጭ መልእክት” የሚል መለያ ቢደረግለትም ፣ ምንም እንኳን ይህ ቻናል እውነተኛ ጊዜ ለሚፈልግ ለማንኛውም ዓላማ ሊያገለግል ይችላል ። ይህ ዝግጅት በጣም ተለዋዋጭ ነው ምክንያቱም በ"እርምጃዎች" ላይ ያሉ ምርጫዎች የትኞቹ የ HALO Events በዚህ ቻናል እንደሚተላለፉ ይወስናሉ።

በኤችቲቲፒ ሁነታ፣ ገመዱን አዘጋጅ እና ዳግም ማስጀመር እነዚህ ናቸው። URLበሚፈለገው የመድረሻ አገልጋይ በሚፈለገው መልኩ መግባት እና መቀረጽ ያለበት። የተጠቃሚ እና የይለፍ ቃል መስክ ለማረጋገጫ ጥቅም ላይ ሊውል ይችላል። የኤችቲቲፒ ሁነታን ከዚህ በታች ይመልከቱ።

በTCP ሁነታ፣ ሴቲንግ እና ዳግም ማስጀመር ሕብረቁምፊዎች ወደ ተቀባዩ TCP ሶኬት የተላከ የአንድ መልእክት ውሂብ ብቻ ናቸው። በመድረሻው እንደ አስፈላጊነቱ ሊቀረጹ ይችላሉ. መድረሻው በአድራሻ እና በፖርት መስኮች ውስጥ ተገልጿል. የTCP ሁነታን ከዚህ በታች ይመልከቱ።

ለሁለቱም ሁነታ፣ ግንኙነትን ወይም ሌሎች ጉዳዮችን ለማስተካከል የሚረዳ በጣም የቅርብ ጊዜ መልእክት ሁኔታ ይታያል። መልእክት ለማስገደድ የክስተት ሙከራ አዝራሮችን በድርጊት ብቅ ባይ ላይ መጠቀም ትችላለህ፡-

እነዚያን የመልእክት ዓይነቶች ለማንቃት ዓለም አቀፍ ማብራት/ማጥፋት ለማዋቀር ወይም ዳግም ለማስጀመር መብራት አለበት። ዳግም ማስጀመር ብዙ ጊዜ ጥቅም ላይ አይውልም ምክንያቱም የክስተቱ ጅምር ብቻ ትኩረት የሚስብ ነው፣ ግን ያ ሊለያይ ይችላል። እያንዳንዱ ክስተት በድርጊት ብቅ ባይ ላይ የሴቱን ወይም የዳግም ማስጀመሪያውን መልእክት ይጠቀም እንደሆነ ለብቻው መግለጽ ይችላል። የዐይን ኳስ አዝራሮች ከቁልፍ ቃል ምትክ እና ቅርጸት በኋላ የሚላኩትን ግምታዊ ውክልና ያሳያሉ። ድገም Holdoff ሌላ ከመላኩ በፊት በማዘግየት ተደጋጋሚ መልዕክቶችን ለማፈን ሊያገለግል ይችላል። ይህ በእያንዳንዱ ክስተት በተናጥል ይከናወናል። HALO የዝግጅቶች ፈጣን ዳግም መቀስቀስን ለመከላከል ለ15 ሰከንድ ዝግጅቶች አብሮ የተሰራ የማቆያ ጊዜ አለው። የአንድ ዓይነት ክስተት በደቂቃ ከ 1 ያልበለጠ መሆኑን ማረጋገጥ ከፈለጉ፣ Repeat Holdoff ን ወደ 60 (ሰከንድ) ማቀናበር ይችላሉ።

የልብ ምት ዝርዝሮች

የልብ ምት ስርጭቶች ከላይ ከተጠቀሱት ጋር ተመሳሳይ በሆነ መንገድ ይሰራሉ ​​ከተግባሮች ገጽ ጋር ምንም ግንኙነት ከሌለ በስተቀር። በምትኩ፣ የልብ ምት ስርጭቱ ከኢንተርቫል መስክ ጋር እንደተዋቀረ በመደበኛነት ይከሰታል፣ በኤችቲቲፒ ሁነታ፣ ሴቲንግ እና ዳግም ማስጀመር ሕብረቁምፊዎች ናቸው። URLበሚፈለገው የመድረሻ አገልጋይ በሚፈለገው መልኩ መግባት እና መቀረጽ ያለበት። የተጠቃሚ እና የይለፍ ቃል መስክ ለማረጋገጫ ጥቅም ላይ ሊውል ይችላል። የኤችቲቲፒ ሁነታን ከዚህ በታች ይመልከቱ።

የልብ ምት ዋና አላማ የHALO Smart Sensor የህይወት ማረጋገጫን ለርቀት አፕሊኬሽን ማቅረብ ቢሆንም፣ ይህ መልእክት የተመረጡ ሴንሰሮችን ወይም ወቅታዊውን የክስተት ሁኔታ መረጃ ለማስተላለፍም ሊያገለግል ይችላል። የቀድሞample above ከ ጋር ረጅም የሕብረቁምፊ መለኪያ ይልካል URL የ Halo ስምን፣ አብዛኞቹን ዳሳሽ እሴቶችን እና በመጨረሻ የተቀሰቀሰ=%ACTIVE% ባዶ ሊሆን የሚችል ወይም በአሁኑ ጊዜ የተቀሰቀሱ ክስተቶች ዝርዝር ያካትታል።

HTTP (እና HTTPS) ሁነታ

ውጫዊ መልእክት እና የልብ ምት ሕብረቁምፊዎች http: ወይም https ሊሆኑ ይችላሉ: URLs እንደ አስፈላጊነቱ. ዱካ እና መለኪያዎች በመድረሻ አገልጋይ እንደ አስፈላጊነቱ ሊገቡ ይችላሉ። እንደ %NAME% (HALO device name) ወይም %EID% (የክስተት መታወቂያ) ያሉ ቁልፍ ቃላት እንደ አስፈላጊነቱ ሊገቡ ይችላሉ እና መልዕክቱ ሲላክ በየራሳቸው ዳታ ይተካሉ። ለፈጣን ማጣቀሻ በብዛት ጥቅም ላይ የዋሉ ቁልፍ ቃላት ዝርዝር ይታያል።
የ URL ዱካ ቁልፍ ቃላቶችን እና መለኪያዎችን ሊይዝ ይችላል። URL. መለኪያዎቹ NAME=VALUE ጥንዶች ወይም የJSON ነገር ወይም በመድረሻ አገልጋይ ላይ በመመስረት ብጁ ቅርጸት ሊሆኑ ይችላሉ። ምሳሌampየሚከተለውን ክስተት ለማመልከት ለውጫዊ መልእክት %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%}
  የ% ሴንሰር፡…% እሴቶች በevtYYYMMDD.csv ምዝግብ ማስታወሻ ውስጥ በቀኝ-እጅ ዳሳሽ አምድ ርዕሶች ላይ የሚገኙትን ስሞች ይጠቀማሉ። fileኤስ. በተለምዶ፡-

የመዳረሻ አገልጋይ ከGET ጥያቄዎች ይልቅ HTTP PUT ወይም POSTን የሚመርጥ ከሆነ ቅድመ ቅጥያውን ማድረግ ይችላሉ። URL በ PUT: ወይም በPOST:: በነጻነት፣ የ[JSONBODY] ቁልፍ ቃሉን በJSON የተቀረፀ ነገር በማከል በብዙ አገልጋዮች ዘንድ ተወዳጅ የሆነውን የJSON ክፍያ ማከል ይችላሉ። ምሳሌampላይ:
PUT:https://server.com/event[JSONBODY]{"ቦታ"፡"%NAME%"፣ክስተት"፡"%EID%"}
የ URL የተለመደ የአይፒ አድራሻ (እና IPv6) እና የወደብ እና የተጠቃሚ-ይለፍ ቃል አማራጮችን ይደግፋል ወይም እንደ መሰረታዊ ወይም ዳይጄስት ያሉ የማረጋገጫ ዘዴዎች የመዳረሻ አገልጋዩ አስፈላጊ ከሆነ የተጠቃሚ እና የይለፍ ቃል መስኮችን መጠቀም ይችላሉ፡
https://username:password@123.321.123.321:9876/event…

TCP ሁነታ

የአድራሻ እና የወደብ መስኮቹ መድረሻውን ስለሚገልጹ ውጫዊ መልእክት እና የልብ ምት ሕብረቁምፊዎች ለመረጃ ብቻ ናቸው. አድራሻው IPv4 እና IPv6 ስሞችን ይደግፋል።
ሕብረቁምፊው ከላይ እንደተገለጹት የኤችቲቲፒ መልእክቶች የውሂብ ክፍሎች ወይም በመድረሻ አገልጋይ በሚፈለገው መልኩ ሊቀረጽ ይችላል።
Exampየሚከተለውን ክስተት ለማመልከት ለውጫዊ መልእክት %EID% ያካትታል፡-
አካባቢ=%NAME%፣ክስተት=%EID%
{"ቦታ":":%NAME%","ክስተት":"%EID%"}
Examples for Heartbeat %ACTIVE% (በአሁኑ ጊዜ የተቀሰቀሱ ክስተቶች) ወይም የዳሳሽ እሴት ሊጨምር ይችላል።
አካባቢ=%NAME%&ተቀሰቀሰ=%ACTIVE%
{"ቦታ":":%NAME%","NH3":%ሴንስር:NH3%}

በ"ውህደት ስብስብ" እና "ውህደት ዳግም ማስጀመር" አምዶች ውስጥ ያሉ አመልካች ሳጥኖች የትኛዎቹ ክስተቶች ለመላክ እንደሚያስነሱ ይወስናሉ። ስለ ዝግጅቶች እና ድርጊቶች ማዋቀር ተጨማሪ በ HALO አስተዳዳሪ መመሪያ ውስጥ ይገኛል።

የJSON ክስተት መልዕክቶች ማድረስ
አንዳንድ ገንቢዎች የክስተት ውሂብን በኢንዱስትሪ ደረጃ በራስ-የተሰየመ JSON መቀበልን ይመርጣሉ።የቀድሞው ይበልጥ አስተማማኝ እና በቀላሉ የሚተነተን። በ HALO ላይ web በገጽ “መልእክት” ትር የJSON መልእክቶችን በ “ውጫዊ መልእክት” መቼቶች “ሕብረቁምፊ አዘጋጅ” እና “ሕብረቁምፊን ዳግም አስጀምር” እና በ “የልብ ምት” “መልእክት” ውስጥ ማቅረብ ይችላሉ።

Exampያነሰ፡
"ውጫዊ መልእክት" ቅንጅቶች ሕብረቁምፊ:

{"መሣሪያ":"%NAME%", "ክስተት":"%EID%", "ማንቂያ":"አዎ" }
ይህ አንድ ነጠላ TCP ወይም UDP JSON መልእክት ወደ ተጠቀሰው አገልጋይ ወዳጃዊ የመሣሪያ ስም፣ የክስተት ስም እና አሁን እንደጀመረ ሪፖርት ያደርጋል።

"ውጫዊ መልእክት" ቅንጅቶች ሕብረቁምፊን ዳግም ያስጀምሩ:
{"መሣሪያ":"%NAME%", "ክስተት":"%EID%", "ማንቂያ":"አይ" }
ይህ ወዳጃዊ የመሳሪያውን ስም፣ የክስተት ስም እና ሁኔታው ​​አሁን እንደቆመ የሚገልጽ ነጠላ TCP ወይም UDP JSON መልእክት ለተጠቀሰው አገልጋይ ይልካል።

"የልብ ምት" መልእክት;
{"መሣሪያ":"%NAME%", "ሕያው":"%DATE% %TIME%"}
ይሄ HALO በተጠቀሰው ጊዜ በህይወት እንዳለ የሚዘግብ የTCP ወይም UDP JSON መልእክት ለተጠቀሰው አገልጋይ በየጊዜው ይልካል።

ሰነዶች / መርጃዎች

የሶፍትዌር s HALO ስማርት ዳሳሽ API መሰረታዊ ሶፍትዌር [pdf] የተጠቃሚ መመሪያ HALO Smart Sensor API መሰረታዊ ሶፍትዌር

ዋቢዎች

• የተጠቃሚ መመሪያ