सॉफ्टवेअरचे HALO स्मार्ट सेन्सर API बेसिक सॉफ्टवेअर

पुढे

हा दस्तऐवज हेलो स्मार्ट सेन्सरच्या सुविधांच्या गटाचे वर्णन करतो जे एकत्रितपणे BASIC API, किंवा ऍप्लिकेशन प्रोग्रामिंग इंटरफेस म्हणून ओळखले जाते. ही चर्चा एक किंवा अधिक HALO स्मार्ट सेन्सर्स (HALO) तृतीय पक्षीय (गैर-IPVideo) सॉफ्टवेअर घटक किंवा प्रणालींसह एकत्रित करण्यात स्वारस्य असलेल्या प्रोग्रामर किंवा इंटिग्रेटरद्वारे वापरण्यासाठी आहे. सर्वसाधारणपणे, HALO API चा उद्देश HALO कडून पारंपारिक इथरनेट नेटवर्कवरून बाह्य प्रोग्राममध्ये माहिती कार्यक्षमतेने हस्तांतरित करणे आहे. हे ध्येय पूर्ण करण्यासाठी, API तीन विभागांमध्ये विभागले गेले आहे: इव्हेंट ड्रायव्हन सॉकेट कनेक्शन, हार्टबीट सॉकेट कनेक्शन आणि इव्हेंट डेटा URL. BACnet इंटरफेस देखील उपस्थित आहे आणि वेगळ्या दस्तऐवजात समाविष्ट आहे.

API डिझाइन

API हे TCP/IP सारखे उद्योग मानक स्वरूप वापरून डिझाइन केले आहे. HTTP, HTTPS आणि JSON. बाह्य प्रोग्राम किंवा ऍप्लिकेशनच्या विकासासाठी डिझाइनसाठी कोणत्याही विशेष किंवा मालकीचे तंत्र किंवा लायब्ररी वापरण्याची आवश्यकता नाही. API लवचिक आहे आणि आवश्यक असलेला डेटा अचूकपणे आणि सर्वात कार्यक्षम पद्धतीने वितरित करण्यासाठी कॉन्फिगर आणि प्रोग्राम केला जाऊ शकतो. वरील प्रत्येक विभागाच्या ऑपरेशनचे तपशील या मार्गदर्शकाच्या खालील विभागांमध्ये समाविष्ट केले आहेत.

बाह्य संदेशवहन

इव्हेंट ट्रिगर झाल्यावर (सेट केलेला) बाह्य प्रोग्राम, व्हीएमएस सिस्टम, सर्व्हर इत्यादींना अलर्ट किंवा अलार्म आणि इव्हेंट डेटा वितरित करण्यासाठी ही सुविधा वापरली जाते. इव्हेंट साफ झाल्यावर (रीसेट केला जातो) तेव्हा पर्यायी संदेश सिग्नल करण्यासाठी सक्षम केले जाऊ शकतात. हे वितरण रिअल टाइममध्ये TCP/IP सॉकेट किंवा HTTP/S सर्व्हरवर केले जाऊ शकते. सानुकूल करण्यायोग्य सामग्रीसह कॉन्फिगर करण्यायोग्य प्रोटोकॉलची श्रेणी आहे. प्रमाणीकरण आणि एन्क्रिप्शन उपलब्ध आहेत.

हृदयाचे ठोके

थेट/उपलब्धतेचा पुरावा देण्यासाठी हार्टबीट संदेश कॉन्फिगर करण्यायोग्य अंतराने पाठवले जातात (इव्हेंट ट्रिगर केले जातात त्याऐवजी). त्यांच्याकडे बाह्य संदेशवहन सारख्या क्षमतांची श्रेणी आहे परंतु विशिष्ट इव्हेंटच्या तपशीलाऐवजी सामान्य स्थितीची माहिती समाविष्ट करण्यासाठी कॉन्फिगर केली जाईल.

इव्हेंट डेटा URL

ही सुविधा फक्त NDA अंतर्गत उपलब्ध आहे आणि जेव्हा बाह्य प्रोग्रामला कोणत्याही आणि सर्व इव्हेंट मूल्ये, थ्रेशहोल्ड आणि राज्य ध्वजांमध्ये प्रवेश आवश्यक असेल तेव्हाच वापरला जावा. हा डेटा सामान्यत: बाह्य प्रोग्रामद्वारे मागणीनुसार पुनर्प्राप्त केला जातो परंतु उच्च वारंवारतेवर नाही. जेव्हा माफक मतदान दर वापरला जातो तेव्हा ही पद्धत सामान्यतः काही विलंब करते. ठराविक मतदान दर प्रति मिनिट एकदा ते प्रति 5 सेकंदात एकदा आणि कमाल कमाल दर प्रति सेकंदात एकदा असतो. इव्हेंट (सूचना) प्राप्त झाल्यावर अतिरिक्त समर्थन डेटा पुनर्प्राप्त करण्यासाठी देखील ही पद्धत वापरली जाऊ शकते.

बाह्य संदेशन तपशील

HALO चा एक विभाग web इंटरफेस इंटिग्रेशन पॉपअप एकाच तृतीय पक्ष कनेक्शनच्या कॉन्फिगरेशनसाठी प्रदान करते जेथे रिमोट TCP सॉकेट किंवा HTTP/HTTPS सर्व्हरवर विविध मूल्ये पाठविली जाऊ शकतात. प्लेस होल्डर (टोकन्स) प्रसारित मजकूरात थेट मूल्ये घालण्यासाठी वापरले जातात. जरी "बाह्य संदेशवहन" असे लेबल असले तरी, हे चॅनेल HALO द्वारे सक्रियपणे वितरित केलेल्या रिअल टाइम इव्हेंट ट्रिगर्स आवश्यक असलेल्या जवळजवळ कोणत्याही हेतूसाठी वापरले जाऊ शकते. ही व्यवस्था खूपच लवचिक आहे कारण "क्रिया" वरील निवडी या चॅनेलद्वारे कोणते HALO कार्यक्रम प्रसारित करतात हे निर्धारित करतात.

HTTP मोडमध्ये, सेट आणि रीसेट स्ट्रिंग आहेत URLs प्रविष्ट करणे आवश्यक आहे आणि इच्छित गंतव्य सर्व्हरच्या आवश्यकतेनुसार स्वरूपित केले पाहिजे. प्रमाणीकरणासाठी वापरकर्ता आणि पासवर्ड फील्ड वापरला जाऊ शकतो. खाली HTTP मोड पहा.

TCP मोडमध्‍ये, Set and Reset Strings हा केवळ एका संदेशाचा डेटा असतो जो प्राप्त करणार्‍या TCP सॉकेटला पाठवला जातो. ते गंतव्यस्थानाद्वारे आवश्यकतेनुसार स्वरूपित केले जाऊ शकतात. गंतव्य पत्ता आणि पोर्ट फील्डमध्ये निर्दिष्ट केले आहे. खाली TCP मोड पहा.

एकतर मोडसाठी, सर्वात अलीकडील संदेशातील स्थिती प्रदर्शित केली जाते जी कनेक्शन किंवा इतर समस्यांचे निराकरण करण्यात मदत करू शकते. संदेश सक्ती करण्यासाठी तुम्ही क्रिया पॉपअपवरील इव्हेंट चाचणी बटणे वापरू शकता:

अशा प्रकारचे संदेश सक्षम करण्यासाठी सेट किंवा रीसेटसाठी ग्लोबल ऑन/ऑफ चालू असणे आवश्यक आहे. रीसेट अनेकदा वापरले जात नाही कारण केवळ इव्हेंटची सुरुवात स्वारस्यपूर्ण असते, परंतु ते बदलू शकते. प्रत्येक इव्हेंट स्वतंत्रपणे निर्दिष्ट करू शकतो की तो क्रिया पॉपअपवर सेट किंवा रीसेट संदेश वापरेल. नेत्रगोलक बटणे कीवर्ड प्रतिस्थापन आणि स्वरूपनानंतर काय पाठवले जाते याचे ढोबळ प्रतिनिधित्व प्रदर्शित करेल. रिपीट होल्डऑफचा वापर वारंवार येणारे संदेश पाठवण्याआधी उशीर करून थ्रोटल करण्यासाठी केला जाऊ शकतो. हे प्रति इव्हेंट स्वतंत्रपणे केले जाते. HALO कडे 15 सेकंदांच्या इव्हेंटसाठी अंगभूत होल्ड टाइम आहे जेणेकरुन इव्हेंटचे जलद रीट्रिगर होऊ नये. प्रति मिनिट 1 पेक्षा जास्त इव्हेंट पाठवला जात नाही याची खात्री करायची असल्यास, तुम्ही रिपीट होल्डऑफ 60 (सेकंद) वर सेट करू शकता.

हृदयाचा ठोका तपशील

हार्टबीट ट्रान्समिशन वरील प्रमाणेच कार्य करते शिवाय क्रिया पृष्ठाशी कोणताही परस्परसंवाद नाही. त्याऐवजी, इंटरव्हल फील्डसह कॉन्फिगर केल्याप्रमाणे हार्टबीट ट्रान्समिशन नियमितपणे होते, HTTP मोडमध्ये, सेट आणि रीसेट स्ट्रिंग आहेत URLs प्रविष्ट करणे आवश्यक आहे आणि इच्छित गंतव्य सर्व्हरच्या आवश्यकतेनुसार स्वरूपित केले पाहिजे. प्रमाणीकरणासाठी वापरकर्ता आणि पासवर्ड फील्ड वापरला जाऊ शकतो. खाली HTTP मोड पहा.

हार्टबीटचा प्राथमिक उद्देश रिमोट ऍप्लिकेशनला HALO स्मार्ट सेन्सरच्या जीवनाचा पुरावा प्रदान करणे हा आहे, हा संदेश निवडक सेन्सर किंवा वर्तमान इव्हेंट स्थिती माहिती प्रसारित करण्यासाठी देखील वापरला जाऊ शकतो. माजीampवरील le सह एक लांब स्ट्रिंग पॅरामीटर पाठवते URL ज्यामध्ये हॅलो नाव, बहुसंख्य सेन्सर मूल्ये आणि शेवटी ट्रिगर केलेले=%ACTIVE% समाविष्ट आहे जे रिक्त असू शकते किंवा सध्या ट्रिगर केलेल्या इव्हेंटची सूची.

HTTP (आणि HTTPS) मोड

बाह्य संदेशवहन आणि हार्टबीट स्ट्रिंग http: किंवा https: असू शकतात. URLs आवश्यकतेनुसार. गंतव्य सर्व्हरद्वारे आवश्यकतेनुसार पथ आणि पॅरामीटर्स प्रविष्ट केले जाऊ शकतात. %NAME% (HALO डिव्हाइसचे नाव) किंवा %EID% (इव्हेंट आयडी) सारखे कीवर्ड आवश्यकतेनुसार घातले जाऊ शकतात आणि संदेश पाठवल्यावर संबंधित डेटासह बदलले जातील. द्रुत संदर्भासाठी सामान्यतः वापरल्या जाणार्‍या कीवर्डची सूची दर्शविली जाते.
द URL path मध्ये कीवर्ड तसेच पॅरामीटर्स असू शकतात 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%”}

Exampहार्टबीटसाठी लेस % 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 पेलोड जोडू शकता जे बर्‍याच सर्व्हरमध्ये लोकप्रिय आहे [JSONBODY] कीवर्ड नंतर JSON स्वरूपित ऑब्जेक्ट जोडून. उदाampले:
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हार्टबीटसाठी लेस % ACTIVE% (सध्या ट्रिगर केलेले इव्हेंट) किंवा सेन्सर मूल्य जोडू शकते:
स्थान=%NAME%&Triggered=%ACTIVE%
{“स्थान”:”:%NAME%”,”NH3”:%सेन्सर:NH3%}

“एकत्रीकरण सेट” आणि “एकीकरण रीसेट” स्तंभांमधील चेकबॉक्सेस कोणत्या इव्हेंट्स पाठवण्यास ट्रिगर करतात हे निर्धारित करतात. इव्हेंट आणि कृतींच्या सेटअपवर अधिक माहिती HALO प्रशासकाच्या मार्गदर्शकामध्ये उपलब्ध आहे.

JSON इव्हेंट संदेशांचे वितरण
काही विकासक साध्या ASCII मजकुराऐवजी उद्योग मानक स्व-लेबल केलेला JSON म्हणून स्वरूपित केलेला इव्हेंट डेटा प्राप्त करण्यास प्राधान्य देतात कारण पूर्वीचा अधिक विश्वासार्ह आणि अधिक सहजपणे पार्स केला जातो. HALO वर web पृष्ठ "मेसेजिंग" टॅबवर, तुम्ही "बाह्य संदेशन" सेटिंग्ज "सेट स्ट्रिंग" आणि "स्ट्रिंग रीसेट करा" आणि "हार्टबीट" "संदेश" मध्ये JSON संदेश देऊ शकता.

Exampलेस:
"बाह्य संदेशन" सेटिंग्ज सेट स्ट्रिंग:

{ “डिव्हाइस”:”%NAME%”, “इव्हेंट”:”%EID%”, “अलार्म”:”होय” }
हे निर्दिष्ट सर्व्हरला एकच TCP किंवा UDP JSON संदेश पाठवेल जे अनुकूल डिव्हाइसचे नाव, इव्हेंटचे नाव आणि ते नुकतेच सुरू झाले आहे.

"बाह्य संदेशन" सेटिंग्ज रीसेट स्ट्रिंग:
{ “डिव्हाइस”:”%NAME%”, “इव्हेंट”:”%EID%”, “गजर”:”नाही” }
हे निर्दिष्ट सर्व्हरला एकच TCP किंवा UDP JSON संदेश पाठवेल जे अनुकूल डिव्हाइसचे नाव, इव्हेंटचे नाव आणि स्थिती आता थांबली आहे.

"हृदयाचे ठोके" संदेश:
{ “डिव्हाइस”:”%NAME%”, “जिवंत”:”%DATE% %TIME%” }
हे ठराविक सर्व्हरला ठराविक वेळेस HALO जिवंत असल्याचा अहवाल देणारा TCP किंवा UDP JSON संदेश पाठवेल.

कागदपत्रे / संसाधने

सॉफ्टवेअरचे HALO स्मार्ट सेन्सर API बेसिक सॉफ्टवेअर [pdf] वापरकर्ता मार्गदर्शक HALO स्मार्ट सेन्सर API बेसिक सॉफ्टवेअर

संदर्भ

• वापरकर्ता मॅन्युअल