سافٽ ويئر جو HALO Smart Sensor API بنيادي سافٽ ويئر

اڳتي

هي دستاويز هيلو اسمارٽ سينسر جي سهولتن جي گروپ کي بيان ڪري ٿو جيڪو مجموعي طور تي BASIC API، يا ايپليڪيشن پروگرامنگ انٽرفيس جي نالي سان سڃاتو وڃي ٿو. هي بحث پروگرامرز يا انٽيگريٽرز جي استعمال لاءِ آهي جيڪي هڪ يا وڌيڪ HALO اسمارٽ سينسرز (HALOs) کي ٽئين پارٽي (غير IPVideo) سافٽ ويئر حصن يا سسٽم سان ضم ڪرڻ ۾ دلچسپي رکن ٿا. عام طور تي، HALO API جو مقصد HALO کان روايتي ايٿرنيٽ نيٽ ورڪ ذريعي ٻاهرين پروگرام ڏانهن معلومات کي موثر طريقي سان منتقل ڪرڻ آهي. هن مقصد کي پورو ڪرڻ لاءِ، API کي ٽن حصن ۾ ورهايو ويو آهي: ايونٽ ڊرائيوين ساکٽ ڪنيڪشن، هارٽ بيٽ ساکٽ ڪنيڪشن، ۽ ايونٽ ڊيٽا. URL. BACnet انٽرفيس پڻ موجود آهي ۽ هڪ الڳ دستاويز ۾ ڍڪيل آهي.

API ڊيزائن

API صنعت جي معياري فارميٽ جهڙوڪ TCP/IP استعمال ڪندي ٺهيل آهي. HTTP، HTTPS، ۽ JSON. ڊزائن کي ڪنهن خاص يا ملڪيت جي ٽيڪنڪ يا لائبريرين جي ضرورت نه آهي جيڪا ٻاهرين پروگرام يا ايپليڪيشن جي ترقي ۾ استعمال ڪئي وڃي. API لچڪدار آهي ۽ ترتيب ڏئي سگهجي ٿو ۽ پروگرام ڪري سگهجي ٿو صحيح طور تي گهربل ڊيٽا پهچائڻ لاءِ ۽ تمام موثر انداز ۾. مٿين حصن مان هر هڪ جي آپريشن جا تفصيل هن گائيڊ جي هيٺين حصن ۾ ڍڪيل آهن.

خارجي پيغام

هي سهولت الرٽ يا الارم ۽ ايونٽ ڊيٽا کي ٻاهرين پروگرام، VMS سسٽم، سرور وغيره تائين پهچائڻ لاءِ استعمال ڪيو ويندو آهي جڏهن ڪو واقعو شروع ٿئي ٿو (سيٽ ڪيو ويو آهي). اختياري پيغام پڻ فعال ٿي سگھن ٿا سگنل ڏيڻ لاءِ جڏهن ڪو واقعو صاف ٿئي ٿو (ري سيٽ ڪيو ويو آهي). هي ترسيل هڪ TCP/IP ساکٽ يا HTTP/S سرور تي حقيقي وقت ۾ ٿي سگهي ٿو. ڪسٽمائيزبل مواد سان ترتيب ڏيڻ واري پروٽوڪول جي هڪ حد آهي. تصديق ۽ انڪوشن موجود آهن.

دل جي ڌڙڪن

دل جي ڌڙڪن جا پيغام موڪليا ويندا آهن ترتيب ڏيڻ واري وقفي تي (جڏهن واقعا شروع ٿيڻ بدران) جيو/ دستيابي جو ثبوت مهيا ڪرڻ لاءِ. انهن وٽ صلاحيتون هڪ جهڙيون هونديون آهن جيئن ته خارجي پيغام پهچائڻ، پر عام طور تي ترتيب ڏني ويندي ته عام رياستي معلومات تي مشتمل هجي بجاءِ ڪنهن خاص واقعي جي تفصيل جي.

واقعي جي ڊيٽا URL

اها سهولت صرف هڪ NDA تحت موجود آهي ۽ صرف ان وقت استعمال ٿيڻ گهرجي جڏهن ٻاهرين پروگرام کي ڪنهن به ۽ سڀني واقعن جي قدرن، حدن ۽ رياستي پرچمن تائين رسائي جي ضرورت هجي. هي ڊيٽا عام طور تي خارجي پروگرام جي طلب تي حاصل ڪئي ويندي آهي پر تمام گهڻي تعدد تي نه. اهو طريقو عام طور تي ڪجهه دير سان لڳندو آهي جڏهن هڪ معمولي پولنگ جي شرح استعمال ڪئي ويندي آهي. عام پولنگ جي شرح هڪ ڀيرو في منٽ کان هڪ ڀيرو في 5 سيڪنڊن جي حد تائين هڪ ڀيرو في سيڪنڊ جي مطلق وڌ ۾ وڌ شرح سان. اهو طريقو پڻ استعمال ڪري سگهجي ٿو اضافي حمايت واري ڊيٽا کي ٻيهر حاصل ڪرڻ لاءِ جڏهن هڪ واقعو (الرٽ) وصول ڪيو وڃي.

خارجي پيغام جا تفصيل

HALO جو هڪ حصو web انٽرفيس انٽيگريشن پاپ اپ هڪ واحد 3rd پارٽي ڪنيڪشن جي ترتيب ڏيڻ لاءِ مهيا ڪري ٿو جتي مختلف قدرن کي ريموٽ TCP ساکٽ يا HTTP/HTTPS سرور ڏانهن موڪلي سگهجي ٿو. جڳھ ھولڊر (ٽوڪن) استعمال ڪيا ويندا آھن لائيو قدر داخل ڪرڻ لاءِ منتقل ٿيل متن ۾. جيتوڻيڪ ”بيروني پيغام رسائي“ جو ليبل لڳل آهي، هي چينل لڳ ڀڳ ڪنهن به مقصد لاءِ استعمال ٿي سگهي ٿو، جنهن لاءِ حقيقي وقت جي واقعي جي شروعات جي ضرورت آهي، HALO پاران فعال طور تي پهچايو ويو آهي. اهو بندوبست ڪافي لچڪدار آهي ڇاڪاڻ ته چونڊون ”ايڪشن“ تي طئي ڪنديون آهن ته هيلو واقعا هن چينل ذريعي منتقل ٿين ٿا.

HTTP موڊ ۾، سيٽ ۽ ري سيٽ اسٽرنگ آهن URLs جيڪي گهربل منزل سرور جي ضرورت مطابق داخل ۽ فارميٽ ٿيڻ گهرجن. تصديق لاءِ استعمال ڪندڙ ۽ پاسورڊ فيلڊ استعمال ڪري سگهجي ٿو. هيٺ HTTP موڊ ڏسو.

TCP موڊ ۾، سيٽ ۽ ري سيٽ اسٽرنگ صرف هڪ واحد پيغام جو ڊيٽا آهي جيڪو وصول ڪندڙ TCP ساکٽ ڏانهن موڪليو ويو آهي. انهن کي ترتيب ڏئي سگهجي ٿو جيئن ضرورت جي منزل. منزل ائڊريس ۽ پورٽ فيلڊز ۾ ڄاڻايل آهي. هيٺ ڏسو TCP موڊ.

ڪنهن به موڊ لاءِ، تازي پيغام مان اسٽيٽس ڏيکاريل آهي جيڪا مدد ڪري سگهي ٿي ڪنيڪشن يا ٻين مسئلن کي درست ڪرڻ ۾. توھان استعمال ڪري سگھوٿا ايونٽ ٽيسٽ بٽڻون ايڪشن پاپ اپ تي زبردستي پيغام ڏيڻ لاءِ:

انهن قسمن جي پيغامن کي فعال ڪرڻ لاءِ گلوبل آن/آف سيٽ يا ري سيٽ ڪرڻ لازمي آهي. ري سيٽ اڪثر استعمال نه ڪيو ويندو آهي ڇاڪاڻ ته صرف هڪ واقعي جي شروعات دلچسپي جي آهي، پر اهو مختلف ٿي سگهي ٿو. هر واقعو آزاديءَ سان بيان ڪري سگھي ٿو ته ڇا اھو استعمال ڪندو سيٽ يا ري سيٽ پيغام عملن جي پاپ اپ تي. اکين جي بال جا بٽڻ ڏيکاريندا آھن ھڪڙي نموني نمائندگي جيڪا موڪليل لفظن جي متبادل ۽ فارميٽنگ کان پوءِ. ورجائي هولڊ آف کي استعمال ڪري سگھجي ٿو بار بار پيغامن کي ڇڪڻ لاءِ دير ڪرڻ کان اڳ ٻيو ڪو موڪلڻ. اهو هر واقعي جي آزاديء سان ڪيو ويندو آهي. HALO واقعن جي تيزيءَ سان ٻيهر ٿيڻ کان روڪڻ لاءِ 15 سيڪنڊن جي واقعن لاءِ تعمير ٿيل وقت رکي ٿو. جيڪڏهن توهان پڪ ڪرڻ چاهيو ته هڪ قسم جو 1 واقعو في منٽ کان وڌيڪ نه موڪليو وڃي، توهان سيٽ ڪري سگهو ٿا ريپيٽ هولڊ آف کي 60 (سيڪنڊ).

دل جي ڌڙڪن تفصيل

دل جي ڌڙڪن جي ٽرانسميشن مٿي ڏنل طريقي سان ڪم ڪري ٿي سواءِ ان جي ته عملن واري صفحي سان ڪو به رابطو نه آهي. ان جي بدران، دل جي ڌڙڪن جي ٽرانسميشن باقاعده بنيادن تي ٿيندي آهي جيئن وقفي واري فيلڊ سان ترتيب ڏنل آهي، HTTP موڊ ۾، سيٽ ۽ ري سيٽ اسٽرنگ آهن URLs جيڪي گهربل منزل سرور جي ضرورت مطابق داخل ۽ فارميٽ ٿيڻ گهرجن. تصديق لاءِ استعمال ڪندڙ ۽ پاسورڊ فيلڊ استعمال ڪري سگهجي ٿو. هيٺ HTTP موڊ ڏسو.

جڏهن ته دل جي ڌڙڪن جو بنيادي مقصد هڪ ريموٽ ايپليڪيشن کي HALO اسمارٽ سينسر جي زندگي جو ثبوت مهيا ڪرڻ آهي، اهو پيغام پڻ استعمال ڪري سگهجي ٿو چونڊيل سينسر يا موجوده واقعي جي حالت جي معلومات کي منتقل ڪرڻ لاء. سابقampمٿي ڏنل هڪ ڊگهو اسٽرنگ پيرا ميٽر موڪلي ٿو جنهن سان URL جنهن ۾ هيلو جو نالو، سينسر جي اڪثريت جي قيمت، ۽ آخر ۾ ٽرگرڊ =٪ ايڪٽيو٪ شامل آهن جيڪي خالي ٿي سگهن ٿا يا هن وقت ٽرگر ٿيل واقعن جي فهرست.

HTTP (۽ HTTPS) موڊ

ٻاهرين پيغام رسائڻ ۽ دل جي ڌڙڪن جون تارون http: يا https: ٿي سگهن ٿيون. URLضرورت مطابق s. منزل سرور پاران ضرورت مطابق رستو ۽ پيرا ميٽر داخل ڪري سگھجن ٿا. %NAME% (HALO ڊوائيس جو نالو) يا %EID% (واقعي جي سڃاڻپ) جهڙا ڪي ورڊ ضرورت مطابق داخل ڪري سگھجن ٿا ۽ پيغام موڪلڻ تي لاڳاپيل ڊيٽا سان تبديل ڪيا ويندا. جلدي حوالي لاءِ عام طور تي استعمال ٿيندڙ ڪي ورڊز جي هڪ فهرست ڏيکاري وئي آهي.
جي URL رستو ۾ ڪي ورڊز ۽ پيرا ميٽرز شامل ٿي سگھن ٿا 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%”}

Examples for Heartbeat شامل ٿي سگھي ٿو %ACTIVE% (في الحال شروع ٿيل واقعا) يا هڪ سينسر قدر:

• https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
• https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
  %SENSOR:…% قدر استعمال ڪن ٿا نالن کي ساڄي هٿ سينسر ڪالمن جي عنوانن ۾ مليا evtYYYYMMDD.csv لاگ ۾ fileايس. اهي عام طور تي آهن:

جيڪڏهن منزل سرور GET درخواستن جي بدران HTTP PUT يا POST کي ترجيح ڏئي ٿو، ته توهان اڳياڙي ڪري سگهو ٿا URL PUT: يا POST: سان. آزاد طور تي، توهان هڪ JSON پيل لوڊ شامل ڪري سگهو ٿا جيڪو ڪيترن ئي سرورن ۾ مشهور آهي [JSONBODY] ڪي ورڊ شامل ڪندي JSON فارميٽ ٿيل آبجيڪٽ سان. مثال طور.ampاليزي:
PUT:https://server.com/event[JSONBODY]{“مقام”:”%NAME%”,”event”:”%EID%”}
جي URL عام IP پتي (۽ IPv6) ۽ پورٽ ۽ يوزر پاسورڊ آپشنز کي سپورٽ ڪري ٿو، يا جيڪڏهن ضرورت هجي ته توهان يوزر ۽ پاسورڊ فيلڊز استعمال ڪري سگهو ٿا جيڪڏهن بنيادي يا ڊائجسٽ وانگر تصديق جي طريقن لاءِ منزل سرور بڻجي سگهو ٿا:
https://username:password@123.321.123.321:9876/event…

TCP موڊ

خارجي پيغام ۽ دل جي ڌڙڪن جون تارون صرف ڊيٽا لاءِ آهن ڇو ته ايڊريس ۽ پورٽ فيلڊز منزل جي وضاحت ڪن ٿا. ايڊريس نالن، IPv4 ۽ IPv6 کي سپورٽ ڪري ٿو.
اسٽرنگ کي فارميٽ ڪري سگھجي ٿو جيئن مٿي بيان ڪيل HTTP پيغامن جي ڊيٽا حصن وانگر، يا جيئن منزل سرور جي گھربل آھي.
Exampخارجي پيغامن لاءِ les ۾ شامل هوندو %EID% انهي واقعي کي ظاهر ڪرڻ لاءِ جيڪو شروع ٿيو:
جڳھ =٪ NAME٪، واقعي =٪ EID٪
{"مقام":":%NAME%","ايونٽ":"%EID%"}
Examples for Heartbeat شامل ٿي سگھي ٿو %ACTIVE% (في الحال شروع ٿيل واقعا) يا هڪ سينسر قدر:
جڳھ = % NAME % ۽ محرڪ = % ACTIVE
{"مقام":":%NAME%","NH3":%سينسر:NH3%}

"انٽيگريشن سيٽ" ۽ "انٽيگريشن ري سيٽ" ڪالمن ۾ چيڪ بڪس اهو طئي ڪندا آهن ته ڪهڙا واقعا موڪلڻ شروع ڪن ٿا. واقعن ۽ عملن جي سيٽ اپ تي وڌيڪ HALO ايڊمنسٽريٽر جي گائيڊ ۾ موجود آهي.

JSON واقعي جي پيغامن جي ترسيل
ڪجھ ڊولپرز ايونٽ ڊيٽا حاصل ڪرڻ کي ترجيح ڏيندا آھن جيئن صنعت جي معياري خود ليبل ٿيل JSON بجاءِ سادي ASCII ٽيڪسٽ جيئن اڳوڻو وڌيڪ معتبر ۽ وڌيڪ آساني سان پارس ڪيو ويو آھي. 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 سمارٽ سينسر API بنيادي سافٽ ويئر

حوالو

• استعمال ڪندڙ دستي