මෘදුකාංගයේ HALO Smart Sensor API මූලික මෘදුකාංගය

ඉදිරියට

මෙම ලේඛනය මූලික API හෝ යෙදුම් ක්‍රමලේඛන අතුරුමුහුණත ලෙස හැඳින්වෙන Halo Smart Sensor හි පහසුකම් සමූහය විස්තර කරයි. මෙම සාකච්ඡාව තුන්වන පාර්ශ්ව (IPVideo නොවන) මෘදුකාංග සංරචක හෝ පද්ධති සමඟ HALO Smart Sensors (HALOs) එකක් හෝ කිහිපයක් ඒකාබද්ධ කිරීමට උනන්දුවක් දක්වන ක්‍රමලේඛකයින් හෝ ඒකාබද්ධ කරන්නන් විසින් භාවිතා කිරීම සඳහා අදහස් කෙරේ. සාමාන්‍යයෙන්, HALO API අදහස් කරන්නේ HALO වෙතින් සම්ප්‍රදායික ඊතර්නෙට් ජාලයක් හරහා බාහිර වැඩසටහනට තොරතුරු කාර්යක්ෂමව මාරු කිරීමයි. මෙම ඉලක්කය සපුරා ගැනීම සඳහා, API කොටස් තුනකට බෙදා ඇත: Event Driven Socket Connection, Heartbeat Socket Connection, සහ Event Data 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 මාදිලියේදී, Set සහ Reset Strings යනු වේ URLඅවශ්‍ය ගමනාන්ත සේවාදායකයට අවශ්‍ය පරිදි ඇතුළත් කර සංයුති කළ යුතුය. සත්‍යාපනය සඳහා පරිශීලක සහ මුරපද ක්ෂේත්‍රයක් භාවිතා කළ හැක. පහත HTTP මාදිලිය බලන්න.

TCP මාදිලියේදී, Set සහ Reset Strings යනු ලබන TCP සොකට් එකට යවන තනි පණිවිඩයක දත්ත පමණි. ගමනාන්තයට අවශ්‍ය පරිදි ඒවා ෆෝමැට් කළ හැක. ගමනාන්තය ලිපිනය සහ වරාය ක්ෂේත්‍රවල දක්වා ඇත. පහත TCP මාදිලිය බලන්න.

එක් ආකාරයක් සඳහා, සම්බන්ධතාවය හෝ වෙනත් ගැටළු නිරාකරණය කිරීමට උපකාර කළ හැකි නවතම පණිවිඩයේ තත්ත්වය දර්ශනය වේ. පණිවිඩයක් බල කිරීමට ඔබට ක්‍රියා උත්පතනයේ ඇති Event TEST බොත්තම් භාවිතා කළ හැක:

එම ආකාරයේ පණිවිඩ සබල කිරීමට Global On/Off for Set හෝ Reset ක්‍රියාත්මක විය යුතුය. සිදුවීමක ආරම්භය පමණක් උනන්දුවක් දක්වන නිසා යළි පිහිටුවීම බොහෝ විට භාවිතා නොවේ, නමුත් එය වෙනස් විය හැක. සෑම සිදුවීමකටම එය ක්‍රියා උත්පතනයේ සකසන්න හෝ යළි පිහිටුවීමේ පණිවිඩය භාවිතා කරන්නේද යන්න ස්වාධීනව සඳහන් කළ හැක. අක්ෂි බොත්තම් මූල පද ආදේශ කිරීම් සහ හැඩතල ගැන්වීමෙන් පසුව යවන දේ පිළිබඳ දළ නිරූපණයක් පෙන්වනු ඇත. තවත් එකක් යැවීමට පෙර ප්‍රමාද කිරීමෙන් නිතර එන පණිවිඩ තෙරපීම සඳහා Repeat Holdoff භාවිතා කළ හැක. මෙය එක් සිදුවීමක් අනුව ස්වාධීනව සිදු කෙරේ. සිදුවීම් වේගයෙන් නැවත ක්‍රියාත්මක වීම වැලැක්වීම සඳහා HALO හට තත්පර 15ක සිදුවීම් සඳහා ගොඩනඟන ලද රඳවා ගැනීමේ කාලයක් ඇත. මිනිත්තුවකට වර්ගයක සිදුවීම් 1කට වඩා නොයැවීම සහතික කිරීමට ඔබට අවශ්‍ය නම්, ඔබට Repeat Holdoff 60 (තත්පර) ලෙස සැකසිය හැක.

හෘද ස්පන්දන විස්තර

හෘද ස්පන්දන සම්ප්‍රේෂණ ක්‍රියා කරන්නේ ක්‍රියා පිටුව සමඟ කිසිදු අන්තර්ක්‍රියාවක් නොමැති බව හැර ඉහත ආකාරයට සමාන ආකාරයකටය. ඒ වෙනුවට, හෘද ස්පන්දන සම්ප්‍රේෂණය කාලාන්තර ක්ෂේත්‍රය සමඟ වින්‍යාස කර ඇති පරිදි නිතිපතා සිදු වේ, HTTP ප්‍රකාරයේදී, Set සහ Reset Strings යනු URLඅවශ්‍ය ගමනාන්ත සේවාදායකයට අවශ්‍ය පරිදි ඇතුළත් කර සංයුති කළ යුතුය. සත්‍යාපනය සඳහා පරිශීලක සහ මුරපද ක්ෂේත්‍රයක් භාවිතා කළ හැක. පහත HTTP මාදිලිය බලන්න.

Heartbeat හි මූලික අරමුණ දුරස්ථ යෙදුමකට HALO Smart Sensor එකක ආයු කාලය පිළිබඳ සාක්ෂි සැපයීම වන අතර, මෙම පණිවිඩය තෝරාගත් සංවේදක හෝ වත්මන් සිදුවීම් තත්ත්වය පිළිබඳ තොරතුරු සම්ප්‍රේෂණය කිරීමටද භාවිතා කළ හැක. හිටපුample ඉහතින් දිගු තන්තු පරාමිතියක් යවයි URL එයට Halo නම, සංවේදක අගයන්ගෙන් බහුතරයක් සහ අවසාන වශයෙන් Triggered=%ACTIVE% හිස් විය හැකි හෝ දැනට ක්‍රියාරම්භක සිදුවීම් ලැයිස්තුවක් ඇතුළත් වේ.

HTTP (සහ HTTPS) මාදිලිය

බාහිර පණිවිඩ යැවීම සහ හෘද ස්පන්දන තන්තු http: හෝ https: විය හැක. URLඅවශ්ය පරිදි s. ගමනාන්ත සේවාදායකයට අවශ්‍ය පරිදි මාර්ගය සහ පරාමිති ඇතුළත් කළ හැක. %NAME% (HALO උපාංගයේ නම) හෝ %EID% (සිදුවීම් හැඳුනුම්පත) වැනි මූල පද අවශ්‍ය පරිදි ඇතුළත් කළ හැකි අතර පණිවිඩය යවන විට අදාළ දත්ත සමඟ ප්‍රතිස්ථාපනය වේ. ඉක්මන් යොමුව සඳහා බහුලව භාවිතා වන මූල පද ලැයිස්තුවක් පෙන්වයි.
ද URL path හි මූල පද මෙන්ම පරාමිති ද අඩංගු විය හැක URL. පරාමිති NAME=VALUE යුගල හෝ JSON වස්තුවක් හෝ ගමනාන්ත සේවාදායකය මත පදනම්ව අභිරුචි ආකෘතියක් විය හැකිය. උදාampබාහිර පණිවිඩ යැවීම සඳහා les %EID% ක්‍රියාරම්භ කළ සිදුවීම දැක්වීමට ඇතුළත් වේ:

• https://server.com/event/%NAME%/%EID%
• https://server.com/event?location=%NAME%&event=%EID%
• https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}

Exampහෘද ස්පන්දනය සඳහා les %ACTIVE% (දැනට අවුලුවන සිදුවීම්) හෝ සංවේදක අගයක් එක් කළ හැකිය:

• https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
• https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
  %SENSOR:...% අගයන් evtYYYYMMDD.csv ලොගයේ දකුණු පස සංවේදක තීරු සිරස්තලවල ඇති නම් භාවිතා කරයි files. ඒවා සාමාන්යයෙන්:

ගමනාන්ත සේවාදායකය GET ඉල්ලීම් වෙනුවට HTTP PUT හෝ POST කැමති නම්, ඔබට උපසර්ගය කළ හැක URL PUT: හෝ POST: සමඟ. ස්වාධීනව, ඔබට [JSONBODY] මූල පදය සහ JSON ආකෘතිගත වස්තුවක් එකතු කිරීමෙන් බොහෝ සේවාදායකයන් අතර ජනප්‍රිය JSON ගෙවීමක් එක් කළ හැකිය. උදාampලෙ:
PUT:https://server.com/event[JSONBODY]{"ස්ථානය":"%NAME%""සිද්ධිය":"%EID%"}
ද URL සාමාන්‍ය IP ලිපිනය (සහ IPv6) සහ වරාය සහ පරිශීලක-මුරපද විකල්ප සඳහා සහය දක්වයි, නැතහොත් ඔබට අවශ්‍ය නම්, මූලික හෝ ඩයිජෙස්ට් වැනි සත්‍යාපන ක්‍රම සඳහා ගමනාන්ත සේවාදායකය ලෙස පරිශීලක සහ මුරපද ක්ෂේත්‍ර භාවිතා කළ හැක:
https://username:password@123.321.123.321:9876/event…

TCP මාදිලිය

ලිපිනය සහ වරාය ක්ෂේත්‍ර ගමනාන්තය සඳහන් කරන බැවින් බාහිර පණිවිඩ යැවීම සහ හෘද ස්පන්දන තන්තු දත්ත සඳහා පමණි. ලිපිනය නම්, IPv4 සහ IPv6 සඳහා සහය දක්වයි.
ඉහත විස්තර කර ඇති HTTP පණිවිඩවල දත්ත කොටස් මෙන් හෝ ගමනාන්ත සේවාදායකයට අවශ්‍ය පරිදි තන්තුව ආකෘතිගත කළ හැක.
Exampබාහිර පණිවිඩ යැවීම සඳහා les %EID% ක්‍රියාරම්භ කළ සිදුවීම දැක්වීමට ඇතුළත් වේ:
ස්ථානය=%NAME%,සිද්ධිය=%EID%
{“ස්ථානය”:”:%NAME%”,”සිද්ධිය”:”%EID%”}
Exampහෘද ස්පන්දනය සඳහා les %ACTIVE% (දැනට අවුලුවන සිදුවීම්) හෝ සංවේදක අගයක් එක් කළ හැකිය:
ස්ථානය=%NAME%&Triggered=%ACTIVE%
{“ස්ථානය”:”:%NAME%”,”NH3”:%SENSOR:NH3%}

"Integration Set" සහ "Integration Reset" තීරු වල ඇති පිරික්සුම් කොටු මඟින් යැවීමට ප්‍රේරණය කරන සිදුවීම් තීරණය කරයි. සිදුවීම් සහ ක්‍රියා සැකසීම පිළිබඳ වැඩි විස්තර 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 මූලික මෘදුකාංගය [pdf] පරිශීලක මාර්ගෝපදේශය HALO Smart Sensor API මූලික මෘදුකාංගය

යොමු කිරීම්

• පරිශීලක අත්පොත