ווייכווארג מיט HALO Smart Sensor API Basic Software

פֿאָרווערטס

דער דאָקומענט באשרייבט די גרופּע פון ​​פאַסילאַטיז פון די האַלאָ סמאַרט סענסאָר, קאַלעקטיוולי באקאנט ווי די BASIC API, אָדער אַפּפּליקאַטיאָן פּראָגראַממינג צובינד. די דיסקוסיע איז בדעה פֿאַר נוצן דורך פּראָוגראַמערז אָדער ינטאַגרייטערז וואָס זענען אינטערעסירט אין ינטאַגרייטינג איינער אָדער מער HALO סמאַרט סענסאָרס (HALOs) מיט 3rd פּאַרטיי (ניט-IPVideo) ווייכווארג קאַמפּאָונאַנץ אָדער סיסטעמען. אין אַלגעמיין, די HALO API איז בדעה צו אַריבערפירן אינפֿאָרמאַציע יפישאַנטלי פֿון HALO איבער אַ קאַנווענשאַנאַל עטהערנעט נעץ צו די פונדרויסנדיק פּראָגראַם. צו דערגרייכן דעם ציל, די אַפּי איז צעטיילט אין דריי סעקשאַנז: געשעעניש געטריבן סאָקקעט קאַנעקשאַן, העאַרטבעאַט סאָקקעט קאַנעקשאַן און געשעעניש דאַטן URL. BACnet צובינד איז אויך פאָרשטעלן און באדעקט אין אַ באַזונדער דאָקומענט.

API דיזיין

די אַפּי איז דיזיינד מיט ינדאַסטרי נאָרמאַל פֿאָרמאַטירונגען אַזאַ ווי TCP/IP. הטטפּ, הטטפּס און דזשסאָן. דער פּלאַן טוט נישט דאַרפן קיין ספּעציעלע אָדער פּראַפּרייאַטערי טעקניקס אָדער לייברעריז צו זיין געוויינט אין דער אַנטוויקלונג פון די פונדרויסנדיק פּראָגראַם אָדער אַפּלאַקיישאַן. די אַפּי איז פלעקסאַבאַל און קענען זיין קאַנפיגיערד און פּראָוגראַמד צו צושטעלן פּונקט די דאַטן פארלאנגט און אויף די מערסט עפעקטיוו שטייגער. די דעטאַילס פון די אָפּעראַציע פון ​​יעדער פון די אויבן סעקשאַנז זענען באדעקט אין די פאלגענדע סעקשאַנז פון דעם פירער.

פונדרויסנדיק מעסידזשינג

די מעכירעס איז געניצט צו צושטעלן אַלערץ אָדער אַלאַרמס און עווענט דאַטן צו אַ פונדרויסנדיק פּראָגראַם, VMS סיסטעם, סערווער, אאז"ו ו ווען אַ געשעעניש איז טריגערד (איז באַשטימט). אַפּשאַנאַל אַרטיקלען קענען אויך זיין ענייבאַלד צו סיגנאַל ווען אַ געשעעניש קלירז (איז באַשטעטיק). די עקספּרעס קענען זיין געמאכט צו אַ TCP / IP כאָלעל אָדער HTTP / S סערווער אין פאַקטיש צייט. עס איז אַ קייט פון קאָנפיגוראַבלע פּראָטאָקאָלס מיט קוסטאָמיזאַבלע אינהאַלט. אָטענטאַקיישאַן און ענקריפּשאַן זענען בנימצא.

העאַרטביט

העאַרטבעאַט אַרטיקלען זענען געשיקט מיט אַ קאַנפיגיעראַבאַל מעהאַלעך (אַנשטאָט ווען די געשעענישן זענען טריגערד) צו צושטעלן דערווייַז פון לעבן / אַוואַילאַביליטי. זיי האָבן אַ ענלעך קייט פון קייפּאַבילאַטיז ווי פונדרויסנדיק מעסידזשינג אָבער וואָלט טיפּיקלי זיין קאַנפיגיערד צו אַנטהאַלטן אַלגעמיין שטאַט אינפֿאָרמאַציע אלא ווי דעטאַילס וועגן אַ באַזונדער געשעעניש.

געשעעניש דאַטע URL

די מעכירעס איז בלויז בנימצא אונטער אַ NDA און זאָל זיין געוויינט בלויז ווען די פונדרויסנדיק פּראָגראַם ריקווייערז אַקסעס צו אַלע די וואַלועס, טרעשכאָולדז און שטאַט פלאַגס. די דאַטן זענען בכלל ריטריווד אויף פאָדערונג דורך די פונדרויסנדיק פּראָגראַם אָבער נישט אין אַ זייער הויך אָפטקייַט. דער אופֿן בכלל ינקריסיז עטלעכע לייטאַנסי ווען אַ באַשיידן פּאָללינג קורס איז געניצט. טיפּיש פּאָללינג רייץ קייט פון אַמאָל פּער מינוט צו אַמאָל פּער 5 סעקונדעס מיט אַן אַבסאָלוט מאַקסימום קורס פון אַמאָל פּער סעקונדע. דער אופֿן קענען אויך זיין געוויינט צו צוריקקריגן נאָך שטיצן דאַטן ווען אַ געשעעניש (פלינק) איז באקומען.

פונדרויסנדיק מעסידזשינג פרטים

א טייל פון די HALO web צובינד ינטעגראַטיאָן אויפֿשפּרינג גיט פֿאַר קאַנפיגיעריישאַן פון אַ איין 3rd פּאַרטיי פֿאַרבינדונג ווו פאַרשידן וואַלועס קענען זיין געשיקט צו אַ ווייַט טקפּ כאָלעל אָדער אַ הטטפּ / הטטפּס סערווער. אָרט האָלדערס (טאָקענס) זענען געניצט צו אַרייַנלייגן לעבן וואַלועס אין די טראַנסמיטטעד טעקסט. כאָטש מיט די נאָמען "פונדרויסנדיק מעסידזשינג," דעם קאַנאַל קענען זיין געוויינט פֿאַר כּמעט קיין ציל וואָס ריקווייערז פאַקטיש-צייט געשעעניש טריגערז, אַקטיוולי איבערגעגעבן דורך HALO. די אָרדענונג איז גאַנץ פלעקסאַבאַל ווייַל די סאַלעקשאַנז אויף די "אַקשאַנז" באַשטימען וואָס HALO events טראַנסמיסיע דורך דעם קאַנאַל.

אין הטטפּ מאָדע, די באַשטעטיק און באַשטעטיק סטרינגס זענען די URLs וואָס מוזן זיין אריין און פאָרמאַטטעד ווי פארלאנגט דורך די געבעטן דעסטיניישאַן סערווער. א באַניצער און שפּריכוואָרט פעלד קענען זיין געוויינט פֿאַר אָטענטאַקיישאַן. זען הטטפּ מאָדע אונטן.

אין טקפּ מאָדע, די באַשטעטיק און באַשטעטיק סטרינגס זענען בלויז די דאַטן פון אַ איין אָנזאָג וואָס איז געשיקט צו די ריסיווינג טקפּ כאָלעל. זיי קענען זיין פֿאָרמאַטירט ווי דארף דורך די דעסטיניישאַן. דער דעסטיניישאַן איז ספּעסיפיעד אין די אַדרעס און פּאָרט פעלדער. זען TCP מאָדע אונטן.

פֿאַר יעדער מאָדע, די סטאַטוס פון די לעצטע אָנזאָג איז געוויזן, וואָס קען העלפֿן צו פאַרריכטן קשר אָדער אנדערע ישוז. איר קען נוצן די Event TEST קנעפּלעך אויף די אַקטיאָנס אויפֿשפּרינג צו צווינגען אַ אָנזאָג:

גלאבאלע אויף / אַוועק פֿאַר באַשטעטיק אָדער באַשטעטיק מוזן זיין אויף צו געבן די טייפּס פון אַרטיקלען. באַשטעטיק איז אָפט נישט געניצט ווייַל בלויז די אָנסעט פון אַ געשעעניש איז פון אינטערעס, אָבער דאָס קען בייַטן. יעדער געשעעניש קענען ינדיפּענדאַנטלי ספּעציפיצירן אויב עס וועט נוצן אָדער די באַשטעטיק אָדער די באַשטעטיק אָנזאָג אויף די אַקטיאָנס אויפֿשפּרינג. די ייבאָל קנעפּלעך וועט ווייַזן אַ פּראָסט פאַרטרעטונג פון וואָס איז געשיקט נאָך קיווערד סאַבסטיטיושאַנז און פאָרמאַטטינג. איבערחזרן האָלדאָפף קענען ווערן גענוצט צו גערגל אָפט אַרטיקלען דורך פאַרהאַלטן איידער אן אנדער איינער קענען זיין געשיקט. דאָס איז געטאן ינדיפּענדאַנטלי פּער געשעעניש. HALO האט אַ געבויט-אין האַלטן צייט פֿאַר געשעענישן פון 15 סעקונדעס צו פאַרמייַדן גיך ריטריגערינג פון געשעענישן. אויב איר ווילט צו ענשור אַז ניט מער ווי 1 געשעעניש פון אַ טיפּ איז געשיקט פּער מינוט, איר קען שטעלן איבערחזרן האָלדאָפף צו 60 (סעקונדן).

כאַרטביט פרטים

די העאַרטבעאַט טראַנזמישאַנז פונקציאָנירן אין אַ ענלעך וועג צו די אויבן, אַחוץ אַז עס איז קיין ינטעראַקשאַן מיט די אַקטיאָנס בלאַט. אַנשטאָט, די העאַרטבעאַט טראַנסמיסיע אַקערז אויף אַ רעגולער יקער ווי קאַנפיגיערד מיט די ינטערוואַל פעלד, אין הטטפּ מאָדע, די באַשטעטיק און באַשטעטיק סטרינגס זענען די URLs וואָס מוזן זיין אריין און פאָרמאַטטעד ווי פארלאנגט דורך די געבעטן דעסטיניישאַן סערווער. א באַניצער און שפּריכוואָרט פעלד קענען זיין געוויינט פֿאַר אָטענטאַקיישאַן. זען הטטפּ מאָדע אונטן.

כאָטש די ערשטיק ציל פון די העאַרטבעאַט איז צו צושטעלן דערווייַז פון לעבן פון אַ HALO סמאַרט סענסאָר צו אַ ווייַט אַפּלאַקיישאַן, דעם אָנזאָג קענען אויך זיין געוויינט צו אַריבערפירן סעלעקטעד סענסאָרס אָדער קראַנט געשעעניש שטאַט אינפֿאָרמאַציע. די עקסample אויבן סענדז אַ לאַנג שטריקל פּאַראַמעטער מיט די URL וואָס כולל די האַלאָ נאָמען, אַ מערהייַט פון סענסער וואַלועס, און לעסאָף טריגערד =% אַקטיוו% וואָס קען זיין ליידיק אָדער אַ רשימה פון דערווייַל טריגערד געשעענישן.

הטטפּ (און הטטפּס) מאָדע

פונדרויסנדיק מעסידזשינג און העאַרטבעאַט סטרינגס קענען זיין http: אָדער https: URLס ווי דארף. וועג און פּאַראַמעטערס קענען זיין אריין ווי דארף דורך די דעסטיניישאַן סערווער. טערמינען ווי % NAME% (HALO מיטל נאָמען) אָדער %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%”}

Exampלייענען פֿאַר העאַרטבעאַט קען לייגן % ACTIVE% (דערווייַל טריגערד געשעענישן) אָדער אַ סענסער ווערט:

• https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
• https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
  די% סענסאָר: ...% וואַלועס נוצן די נעמען געפֿונען אין די רעכט סענסער זייַל כעדינגז אין evtYYYYMMDD.csv קלאָץ fileס. זיי זענען טיפּיקלי:

אויב דער דעסטיניישאַן סערווער פּראַפערז HTTP PUT אָדער POST אַנשטאָט פון באַקומען ריקוועס, איר קענען פּרעפיקס די URL מיט PUT: אָדער POST:. ינדיפּענדאַנטלי, איר קענען לייגן אַ JSON פּיילאָוד וואָס איז פאָלקס מיט פילע סערווערס דורך אַדינג די [JSONBODY] קיווערד נאכגעגאנגען דורך אַ JSON פאָרמאַטטעד כייפעץ. עקסampלאַ:
שטעלן: https://server.com/event[JSONBODY] {"location":"%NAME%","event":"%EID%"}
די URL שטיצט טיפּיש IP אַדרעס (און IPv6) און פּאָרט און באַניצער-פּאַראָל אָפּציעס, אָדער איר קענען נוצן די User און שפּריכוואָרט פעלדער אויב דארף זיין די דעסטיניישאַן סערווער פֿאַר אָטענטאַקיישאַן מעטהאָדס ווי באַסיק אָדער דיגעסט:
https://username:password@123.321.123.321:9876/event…

TCP מאָדע

פונדרויסנדיק מעסידזשינג און העאַרטבעאַט סטרינגס זענען בלויז פֿאַר דאַטן זינט די אַדרעס און פּאָרט פעלדער ספּעציפיצירן די דעסטיניישאַן. די אַדרעס שטיצט נעמען IPv4 און IPv6.
דער שטריקל קענען זיין פאָרמאַטטעד ווי די דאַטן פּאָרשאַנז פון הטטפּ אַרטיקלען דיסקרייבד אויבן, אָדער ווי פארלאנגט דורך די דעסטיניישאַן סערווער.
Exampליי פֿאַר פונדרויסנדיק מעסידזשינג וואָלט אַרייַננעמען % EID% צו אָנווייַזן די געשעעניש וואָס טריגערד:
אָרט=%NAME%, געשעעניש=%EID%
{"location":":%NAME%","event":"%EID%"}
Exampלייענען פֿאַר העאַרטבעאַט קען לייגן % ACTIVE% (דערווייַל טריגערד געשעענישן) אָדער אַ סענסער ווערט:
location=%NAME%&Triggered=%ACTIVE%
{"location":":%NAME%","NH3":%SENSOR:NH3%}

טשעקקבאָקסעס אין די "ינטעגראַטיאָן סעט" און "ינטעגראַטיאָן באַשטעטיק" שפאלטן באַשטימען וואָס געשעענישן צינגל שיקן. מער וועגן די סעטאַפּ פון געשעענישן און אַקשאַנז איז בנימצא אין די HALO אַדמיניסטראַטאָר ס גייד.

עקספּרעס פון JSON געשעעניש אַרטיקלען
עטלעכע דעוועלאָפּערס בעסער צו באַקומען עווענט דאַטן פאָרמאַטטעד ווי ינדאַסטרי נאָרמאַל זיך-לייבאַלד JSON אלא ווי קלאָר ASCII טעקסט, ווייַל די ערשטע איז מער רילייאַבלי און מער לייכט פּאַרסעד. אויף HALO web בלאַט "מעססאַגינג" קוויטל, איר קענען צושטעלן דזשסאָן אַרטיקלען אין "עקסטערנאַל מעסידזשינג" סעטטינגס "שטעלן שטריקל" און "באַשטעטיק שטריקל" און אין די "העאַרטביט" "מעסעדזש."

Examples:
"פונדרויסנדיק מעסידזשינג" סעטטינגס שטעלן שטריקל:

{"מכשיר":"%NAME%", "געשעעניש":"%EID%", "שרעק":"יאָ"}
דאָס וועט שיקן אַ איין TCP אָדער UDP JSON אָנזאָג צו די ספּעסיפיעד סערווער ריפּאָרטינג די פרייַנדלעך מיטל נאָמען, געשעעניש נאָמען און אַז עס פּונקט סטאַרטעד.

"פונדרויסנדיק מעסידזשינג" סעטטינגס באַשטעטיק שטריקל:
{"מכשיר":"%NAME%", "געשעעניש":"%EID%", "שרעק":"ניין" }
דאָס וועט שיקן אַ איין TCP אָדער UDP JSON אָנזאָג צו די ספּעסיפיעד סערווער ריפּאָרטינג די פרייַנדלעך מיטל נאָמען, געשעעניש נאָמען און אַז די צושטאַנד איז איצט סטאַפּט.

"האַרץביט" אָנזאָג:
{"מכשיר":"%NAME%", "לעבעדיג":"%DATE% %TIME%"}
דאָס וועט פּיריאַדיקלי שיקן אַ TCP אָדער UDP JSON אָנזאָג צו די ספּעסיפיעד סערווער ריפּאָרטינג אַז די HALO איז לעבעדיק אין די אנגעוויזן צייט.

דאָקומענטן / רעסאָורסעס

ווייכווארג מיט HALO Smart Sensor API Basic Software [pdfבאַניצער גייד HALO Smart Sensor API Basic Software

רעפערענצן

• באַניצער מאַנואַל