د سافټویر HALO سمارټ سینسر API اساسی سافټویر کارونکي لارښود

منځپانګې پټول

1 د سافټویر د HALO سمارټ سینسر API اساسی سافټویر

2 مخکی

7 د بهرني پیغام رسولو توضیحات

8 د زړه ټکان توضیحات

9 HTTP (او HTTPS) حالت

د سافټویر د HALO سمارټ سینسر API اساسی سافټویر

مخکی

دا سند د هیلو سمارټ سینسر تاسیساتو ګروپ تشریح کوي چې په ټولیز ډول د BASIC API یا د غوښتنلیک برنامې انٹرفیس په نوم پیژندل کیږي. دا بحث د پروګرام کونکو یا ادغام کونکو لخوا د کارولو لپاره دی چې د دریمې ډلې (غیر IP ویډیو) سافټویر اجزاو یا سیسټمونو سره د یو یا ډیرو HALO سمارټ سینسرونو (HALOs) ادغام سره علاقه لري. په عموم کې، د HALO API موخه دا ده چې معلومات په اغیزمنه توګه د HALO څخه د دودیز ایترنیټ شبکې له لارې بهرني پروګرام ته انتقال کړي. د دې هدف د ترسره کولو لپاره، API په دریو برخو ویشل شوی دی: د پیښې چلول ساکټ اتصال، د زړه د ساکټ اتصال، او د پیښې ډاټا 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 حالت کې، سیټ او ری سیٹ تارونه دي URLs چې باید داخل شي او د مطلوب منزل سرور لخوا د اړتیا سره سم فارمیټ شي. د یو کارن او پټنوم ساحه د تصدیق لپاره کارول کیدی شي. لاندې HTTP حالت وګورئ.

په TCP حالت کې، Set او Reset Strings یوازې د یو پیغام ډاټا دي چې د ترلاسه کونکي TCP ساکټ ته لیږل کیږي. دوی د منزل لخوا د اړتیا سره سم فارمیټ کیدی شي. منزل په پته او پورټ ساحو کې مشخص شوی. لاندې د TCP حالت وګورئ.

د دواړو حالتونو لپاره، د وروستي پیغام څخه وضعیت ښکاره کیږي کوم چې کولی شي د اتصال یا نورو مسلو حل کولو کې مرسته وکړي. تاسو کولی شئ د پیغام د جبري کولو لپاره د عمل پاپ اپ کې د پیښې ازموینې بټن وکاروئ:

د سیټ یا ری سیٹ لپاره ګلوبل آن/بند باید د دې ډول پیغامونو فعالولو لپاره فعال وي. ری سیٹ اکثرا نه کارول کیږي ځکه چې یوازې د پیښې پیل د علاقې وړ دی ، مګر دا توپیر کولی شي. هره پیښه کولی شي په خپلواکه توګه مشخص کړي که دا به د عمل پاپ اپ کې سیټ یا ریسیټ پیغام وکاروي. د سترګو بټن به د هغه څه یوه لنډه نمایندګي ښکاره کړي چې د کلیدي کلمې بدیل او فارمیټ کولو وروسته لیږل کیږي. د تکرار هولډ آف د یو بل لیږلو دمخه په ځنډولو سره د مکرر پیغامونو د وهلو لپاره کارول کیدی شي. دا د هرې پیښې په خپلواکه توګه ترسره کیږي. HALO د 15 ثانیو پیښو لپاره جوړ شوی وخت لري ترڅو د پیښو ګړندۍ بیا پیل کیدو مخه ونیسي. که تاسو غواړئ ډاډ ترلاسه کړئ چې په یوه دقیقه کې له 1 څخه ډیر پیښه نه لیږل کیږي ، تاسو کولی شئ د تکرار هولډ آف 60 (ثانوي) ته وټاکئ.

د زړه ټکان توضیحات

د زړه ضربان لیږدونه د پورتنۍ برخې په څیر فعالیت کوي پرته له دې چې د عمل پاڼې سره هیڅ تعامل شتون نلري. پرځای یې، د زړه ضربان لیږد په منظم ډول ترسره کیږي لکه څنګه چې د وقفې ساحې سره ترتیب شوی، په HTTP حالت کې، سیټ او ری سیٹ تارونه دي. URLs چې باید داخل شي او د مطلوب منزل سرور لخوا د اړتیا سره سم فارمیټ شي. د یو کارن او پټنوم ساحه د تصدیق لپاره کارول کیدی شي. لاندې HTTP حالت وګورئ.

پداسې حال کې چې د زړه بټ اصلي هدف د لیرې غوښتنلیک ته د HALO سمارټ سینسر د ژوند ثبوت چمتو کول دي ، دا پیغام د ټاکل شوي سینسرونو یا اوسني پیښې حالت معلوماتو لیږدولو لپاره هم کارول کیدی شي. د پخوانيample پورته د سره اوږد تار پیرامیټر لیږي URL په دې کې د هیلو نوم، د سینسر ډیری ارزښتونه شامل دي، او په پای کې Triggered=%ACTIVE% چې کیدای شي خالي وي یا د اوسني پیل شوي پیښو لیست.

HTTP (او HTTPS) حالت

بهرني پیغامونه او د زړه ضربان تارونه کیدی شي http: یا https: URLد اړتیا په صورت کې. لاره او پیرامیټونه د منزل سرور لخوا د اړتیا سره سم داخل کیدی شي. کلیدي کلمې لکه %NAME% (HALO وسیلې نوم) یا %EID٪ (ایونټ id) د اړتیا سره سم داخل کیدی شي او د اړوندو معلوماتو سره به بدل شي کله چې پیغام لیږل کیږي. د عامو کارول شویو کلیمو لیست د چټک حوالې لپاره ښودل شوي.
د URL path کولی شي کلیدي کلمې او همدارنګه پیرامیټرې ولري URL. پیرامیټونه ممکن NAME=VALUE جوړه یا د JSON څیز وي، یا د منزل سرور پورې اړه لري دودیز بڼه. Exampد بهرني پیغام رسولو لپاره به د %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: سره. په خپلواکه توګه، تاسو کولی شئ د JSON پیلوډ اضافه کړئ کوم چې د JSON فارمیټ شوي اعتراض وروسته د [JSONBODY] کلیمې اضافه کولو سره د ډیری سرورونو سره مشهور دی. ExampLe:
PUT:https://server.com/event[JSONBODY]{"location":"%NAME%","event":"%EID%"}
د URL د عادي IP پتې (او IPv6) او د پورټ او کارن پاسورډ اختیارونو ملاتړ کوي ، یا تاسو کولی شئ د کارونکي او پټنوم ساحې وکاروئ که اړتیا وي د اصلي یا ډایجیسټ په څیر د تصدیق میتودونو لپاره د منزل سرور وي:
https://username:password@123.321.123.321:9876/event…

د TCP حالت

د بهرني پیغام رسولو او د زړه ضربان تارونه یوازې د معلوماتو لپاره دي ځکه چې د ادرس او پورټ ساحې منزل مشخص کوي. پته د نومونو، IPv4 او IPv6 ملاتړ کوي.
سټرینګ د HTTP پیغامونو ډیټا برخو په څیر فارمیټ کیدی شي چې پورته تشریح شوي، یا لکه څنګه چې د منزل سرور لخوا اړتیا وي.
Exampد بهرني پیغام رسولو لپاره به د %EID٪ شامل وي ترڅو هغه پیښه په ګوته کړي چې پیل شوې:
ځای=%NAME%، پیښه=%EID%
{"موقعیت":":%NAME%","پیښه":"%EID%"}
Exampد زړه ضربان لپاره les % ACTIVE (اوس مهال رامینځته شوي پیښې) یا د سینسر ارزښت اضافه کولی شي:
ځای=%NAME%&Triggered=%فعال%
{"موقعیت":":%NAME%","NH3":%سینسر:NH3%}

د "انټریشن سیټ" او "انټیګریشن ری سیٹ" کالمونو کې چیک باکسونه ټاکي چې کومې پیښې د لیږلو لامل کیږي. د پیښو او عملونو تنظیم کولو په اړه نور د HALO د مدیر لارښود کې شتون لري.

د JSON پیښې پیغامونو تحویلول
ځینې پراختیا کونکي غوره کوي چې د پیښې ډیټا ترلاسه کړي د صنعت معیاري ځان لیبل شوي JSON په توګه د ساده ASCII متن په پرتله فارمیټ شوي ځکه چې پخوانی خورا معتبر او په اسانۍ سره تجزیه شوی. په HALO کې web پاڼه "پیغام رسولو" ټب کې، تاسو کولی شئ د JSON پیغامونه د "بهرني پیغام رسولو" ترتیباتو "Set String" او "Reset String" او "Heartbeat" "پیغام" کې وړاندې کړئ.

Examples:
د "بهرني پیغام رسولو" تنظیمات سیټ سټرینګ:

{ "وسیلې":"%NAME%"، "پیښه":"%EID٪"، "الارم":"هو" }
دا به ټاکل شوي سرور ته یو واحد TCP یا UDP JSON پیغام واستوي چې د دوستانه وسیلې نوم ، د پیښې نوم او دا چې دا اوس پیل شوی راپور ورکوي.

د "بهرني پیغام رسولو" تنظیمات ری سیٹ سټرینګ:
{ “وسیلې”:”%NAME%”، “پیښه”:”%EID%”، “الارم”:”نه” }
دا به ټاکل شوي سرور ته یو واحد TCP یا UDP JSON پیغام واستوي چې د دوستانه وسیلې نوم ، د پیښې نوم او دا چې حالت اوس بند شوی راپور ورکوي.

د "زړه ټکان" پیغام:
{ "وسیله":"%NAME%"، "ژوندی":"%DATE% %TIME%" }
دا به په دوره توګه د TCP یا UDP JSON پیغام مشخص شوي سرور ته واستوي راپور ورکوي چې HALO په ټاکل شوي وخت کې ژوندی دی.