אפליקציית BOSE Work Rest API
מָבוֹא
התקני Bose Videobar תומכים בממשק תכנות יישומים להעברת מצב ייצוגי (REST API) לניהול וניטור רשת. מדריך זה מספק הוראות להפעלה והגדרה של REST API במכשירי Videobar, והוא מספק תיאור מפורט של המשתנים והפעולות הנתמכים.
פריטי תצורה ופעולות מקובצים בקטגוריות הבאות:
- מַעֲרֶכֶת
- הִתְנַהֲגוּת
- usb
- שֶׁמַע
- מַצלֵמָה
- מסגור אודיו
- Bluetooth
- רשת (VBl)
- wifi
- טלמטריה (VBl)
סעיף הפקודת API מספק את המידע הבא עבור כל אובייקט:
- שם/תיאור שם החפץ ותיאור השימוש בו.
- פעולות פעולות שניתן לבצע על האובייקט. הפעולה יכולה
- להיות אחד או יותר מהבאים: לקבל, לשים, למחוק, לפרסם.
- טווח ערכים ערכים מקובלים עבור האובייקט.
- ערך ברירת מחדל ערך ברירת מחדל של האובייקט. זהו הערך המשמש אם אתה מחזיר את המכשיר לברירות המחדל של היצרן.
כל הערכים מצוינים כמחרוזות.
הודעות על סימנים מסחריים
- Bose, Bose Work ו-Videobar הם סימנים מסחריים של Bose Corporation.
- סימן המילה והלוגו של Bluetooth הם סימנים מסחריים רשומים בבעלות Bluetooth SIG, Inc. וכל שימוש בסימנים כאלה על ידי Bose Corporation הוא ברישיון.
- המונח HDMI הוא סימן מסחרי או סימן מסחרי רשום של HDMI Licensing Administrator, Inc.
- כל שאר הסימנים המסחריים הם רכושם של בעליהם בהתאמה.
מידע פרטיות
הפרטיות שלך חשובה ל-Bose ולכן פיתחנו מדיניות פרטיות המכסה כיצד אנו אוספים, משתמשים, חושפים, מעבירים ומאחסנים את המידע האישי שלך.
אנא קרא את מדיניות הפרטיות הזו בעיון כדי להבין כיצד אנו מטפלים במידע שלך. אם אינך מסכים למדיניות פרטיות זו, נא אל תשתמש בשירותים.
הפעלה והגדרה של REST API
כדי לאפשר גישה ל-REST API במכשיר, השתמש באפליקציית Bose Work Configuration, באפליקציית Bose Work Management או Web ממשק משתמש. גש להגדרות רשת > API. אפשר גישת API וציין שם משתמש וסיסמה של API. תזדקק לאישורי API אלה כדי להשתמש בכל אחת מפקודות REST API. אנא עיין במדריכי המשתמש של היישום לקבלת מידע נוסף.
בדיקת REST API
אתה יכול לבדוק את Videobar REST API באמצעות ממשק Swagger OpenAPI המוטמע במכשיר. כדי לגשת לממשק זה, ה-Videobar חייב להיות מחובר לרשת IP באמצעות ממשק קווי או WiFi, והמחשב המארח שלך חייב להיות באותה רשת או רשת שיכולה לגשת למכשיר באמצעות HTTPS.
חבר את המחשב לסרגל הווידאו באמצעות ממשק ה-USB. הפעל את אפליקציית Bose Work Configuration והיכנס כדי לגשת לפקדי ניהול. בחר בדף רשת > API ולחץ על הקישור:
תיעוד REST API (Web ממשק משתמש)
אם אינך מחובר למכשיר באמצעות USB והמחשב שלך נמצא באותה רשת, תוכל לגשת אל REST API דרך הדפדפן שלך על ידי גלישה לכתובת הבאה:
https://<videobar-ip-address>/doc-api
פקודות API של REST
ממשק Videobar REST API משתמש במזהי פקודות בכל אחת מארבע שיטות ה-HTTP הנתמכות: קבל, הצב, מחק ופרסם.
להלן תיאור של ארבע השיטות ולאחר מכן טבלה המתארת את השיטות הנתמכות עבור כל אחת מהפקודות.
לְקַבֵּל
שיטת "גט" מקבלת מזהה פקודה בודד או מספר מזהים מופרדים בפסיקים. למשלample, כדי לקבל את מצב audio.micMute, מזהה הפקודה הוא 2. The URL הוא כזה:
https://192.168.1.40/api?query=2
גוף התגובה הוא כדלקמן, עם ערך "O" המציין שהמיקרופון אינו מושתק:
{"2": {"status": "success", "value": "0"}}
כדי לבצע שאילתה עבור ערכים מרובים, הפרד מזהי פקודות מרובים באמצעות פסיק. למשלampאתה יכול לשאול עבור audio.micMute (ID=2) ו-system.firmwareVersion (ID=l6) כך:
https://192.168.1.40/api?query=2,16
הערה: אל תכלול רווחים בין מספר מזהים.
התוצאה תהיה:
{“2”: {“status”: “success”, “value”: “0”}, “16”: {“status”: “success”, “value”: “1.2.13_fd6cc0e”}}
לָשִׂים
פקודת "put" משתמשת בפורמט גוף JSON כאשר המפתח הוא "נתונים" והערך הוא ID:value pars.
למשלample, כדי להגדיר את audio.loudspeakerVolume (ID=3) ל-39, הגוף "https://192.168.1.40/ api" הוא:
{“data”:”{“3″:”39″}”}
התגובה היא:
{"3": {"status": "success", "code": "0xe000"}}
הנה אקסampהגדרת מספר ערכים:
{“data”:”{“2″:”1″,”3″:”70″}”}
התגובה היא:
{"2": {"status": "success", "code": "0xe000"}, "3": {"status": "success", "code": "0xe000"}}
ערכי "קוד" תגובה יכולים להיות כל אחד מהבאים:
- 0xe000 : הצלחה
- 0xe001 : הצלחה - אין שינוי בערך
- 0xe002: שגיאה - מאפיין לא חוקי
- 0xe003 : שגיאה - ערך מאפיין לא חוקי
- 0xe004 : שגיאה - פעולת מאפיין לא חוקית
- 0xe005 : שגיאה - הודעה שגויה
- 0xe006: שגיאה - הגישה נדחתה
שֶׁלְאַחַר
"פוסט" דומה ל"שים" ומשמש לפעולות, כגון החלפת השתקת המיקרופון ועוצמת הקול של הרמקול. אתה מציין את מזהה הפקודה ומשתמש במחרוזת ריקה עבור הערך.
למשלample, כדי להגביר את עוצמת הקול של הרמקול סימון אחד, השתמש ב-audio.loudspeakerVolumeUp (ID=4) עם פורמט הגוף כך:
{“data”:”{“4″:””}”}
גוף התגובה הוא:
{"4": {"status": "success", "code": "0xe000"}}
ערכי "קוד" התגובה האפשריים זהים לאלה הרשומים עבור פקודת PUT.
לִמְחוֹק
פורמט הפקודה "מחק" דומה ל"קבל", וגוף התגובה דומה ל"שים". שימוש במחיקה יחזיר את הערך לברירת המחדל שלו.
למשלample, כדי להגדיר את עוצמת הקול של audio.loudspeaker (ID=3) לערך ברירת המחדל שלו, ה URL הוא כזה:
https://192.168.1.40/api?delete=3
גוף התגובה הוא:
{"3": {"status": "success", "code": "0xe000"}}
תצטרך להנפיק "גט" כדי לאחזר את הערך החדש, שבמקרה זה הוא 50. למשלampעל:
פְּקוּדָה:
https://192.168.1.40/api?query=3
תְגוּבָה:
{"3": {"status": "success", "value": "50"}}
ערכי "קוד" התגובה האפשריים זהים לאלה הרשומים עבור פקודת PUT
עיון בפקודה של REST API של סרגל וידאו
| שם/תיאור | פעולות | Cmd ID | טווח ערכים | ערך ברירת מחדל |
| system.reboot
מאתחל את המערכת. |
שֶׁלְאַחַר | 32 | לא | לא |
| system.serialNumber
מספר סידורי של המכשיר. |
לְקַבֵּל | 10 | חוּט
(17 תווים) |
אוווווווווווווווווווווו |
| system.firmwareVersion
גרסת הקושחה הפועלת במכשיר. זה מוגדר באופן אוטומטי בעת שדרוג קושחת המערכת. |
לְקַבֵּל | 16 | חוּט
(1-16 תווים) |
0.0.0 |
| מודל המערכת
דגם של מכשיר זה. |
לְקַבֵּל | D6 | חוּט
(1-22 תווים) |
לא מוכן |
| system.name
שם המכשיר כך שניתן לזהותו באופן ייחודי. |
להכניס למחוק | 25 | חוּט
(1-22 תווים) |
לא מוכן |
| מערכת.חדר
מיקום החדר של המכשיר |
להכניס למחוק | 26 | חוּט
(0-128 תווים) |
לא מוכן |
| system.floor
מיקום קומה של המכשיר. |
להכניס למחוק | 27 | חוּט
(0-128 תווים) |
לא מוכן |
| בניית מערכות
מיקום הבנייה של המכשיר. |
להכניס למחוק | 28 | חוּט
(0-128 תווים) |
לא מוכן |
| system.gpiMuteStatus (VBl)
מצב השתקת GPI (מופעל/כבוי). |
לְקַבֵּל | C7 | 110 | (נתמך ב-VBl) 0 |
| system.maxOccupancy
תפוסה מקסימלית בחדר של המכשיר. |
להכניס למחוק | DF | חוּט
(0-128 תווים) |
לא מוכן |
| behavior.ethernetEnabled (VBl)
הפעלה/כיבוי של ממשק ה-Ethernet של המערכת. |
להכניס למחוק | 38 | 110 | (נתמך ב-VBl) 1 |
| behaviour.bluetoothEnabled
מפעיל/מכבה את מערכת ה-Bluetooth. |
להכניס למחוק | 3A | 110 | 1 |
| behaviour.wifiEnabled
מפעיל/מכבה את ה-WiFi של המערכת. |
להכניס למחוק | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
מפעיל/מכבה את ה-HDMI. |
להכניס למחוק | C9 | 110 | (נתמך ב-VBl) 0 |
| usb.connectionStatus
מצב חיבור כבל USB; 0 כאשר מנותקים. |
לְקַבֵּל | 36 | 110 | 0 |
| usb.callStatus
מצב השיחה מהמארח המחובר ליציאת ה-USB של המערכת. |
לְקַבֵּל | 37 | 110 | 0 |
| audio.micMute
השתקה/ביטול השתקה של מיקרופון המערכת. |
לשים | 2 | 110 | 0 |
| audio.micMuteToggle
מחליף את מצב ההשתקה של מיקרופון המערכת. |
שֶׁלְאַחַר | 15 | לא | לא |
| שם/תיאור | פעולות | Cmd ID | טווח ערכים | ערך ברירת מחדל |
| audio.loudspeakerMute
השתקה/ביטול השתקה של רמקול המערכת. |
שֶׁלְאַחַר | 34 | לא | לא |
| audio.loudspeakerMuteToggle
מחליף את מצב ההשתקה של רמקול המערכת. |
שֶׁלְאַחַר | 34 | לא | לא |
| audio.loudspeakerVolume
מגדיר את עוצמת הקול של רמקול המערכת. |
להכניס למחוק | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
מגביר את עוצמת הקול של רמקול המערכת בצעד אחד. |
שֶׁלְאַחַר | 4 | לא | לא |
| audio.loudspeakerVolumeDown
מקטין את עוצמת הקול של רמקול המערכת בצעד אחד. |
שֶׁלְאַחַר | 5 | לא | לא |
| camera.zoom
ערך הזום הנוכחי של המצלמה. |
להכניס למחוק | 6 | 1-10 | 1 |
| camera.pan
ערך הפאן הנוכחי של המצלמה. |
להכניס למחוק | 7 | -10-10 | 0 |
| camera.tilt
ערך ההטיה הנוכחי של המצלמה. |
להכניס למחוק | 8 | -10-10 | 0 |
| camera.zoom In
מגדיל את המצלמה בצעד אחד. |
שֶׁלְאַחַר | 9 | לא | לא |
| camera.zoomOut
מגדיל את המצלמה בצעד אחד. |
שֶׁלְאַחַר | OA | לא | לא |
| camera.pan שְׁמֹאל
מצלמת מחבתות נותרה בצעד אחד. |
שֶׁלְאַחַר | OB | לא | לא |
| camera.pan יָמִינָה
מצלמת מחבתות ממש בצעד אחד. |
שֶׁלְאַחַר | oc | לא | לא |
| camera.tiltUp
מטה את המצלמה למעלה בצעד אחד. |
שֶׁלְאַחַר | OD | לא | לא |
| camera.tiltDown
מטה את המצלמה מטה בצעד אחד. |
שֶׁלְאַחַר | OE | לא | לא |
| camera.homePreset
מצלמה ביתית מוגדרת מראש בסדר זום הטיית פאן |
להכניס למחוק | 56 | 0 01 | |
| camera.firstPreset
המצלמה מוגדרת מראש לראשונה בסדר זום של הטיית פאן. |
להכניס למחוק | 57 | 0 01 | |
| הגדרה מראש של camera.second
מצלמה שנייה מוגדרת מראש בסדר זום הטיית פאן. |
להכניס למחוק | 58 | 0 01 | |
| camera.savePresetHome
שומר להגדרה הביתית מראש את ערכי ה-PTZ הנוכחיים. |
שֶׁלְאַחַר | 12 | לא | לא |
| camera.savePresetFirst
שומר להגדרה הראשונה מראש את ערכי ה-PTZ הנוכחיים. |
שֶׁלְאַחַר | 17 | לא | לא |
| camera.savePresetSecond
שומר להגדרה השניה את ערכי ה-PTZ הנוכחיים. |
שֶׁלְאַחַר | 18 | לא | לא |
| שם/תיאור | פעולות | Cmd ID | טווח ערכים | ערך ברירת מחדל |
| מצלמה.החל ActivePreset
מחיל את הקביעה הפעילה על הגדרות ה-PTZ. |
שֶׁלְאַחַר | OF | לא | לא |
| מצלמה.פעילה מוגדר מראש
זוהי ההגדרה הפעילה מראש. שים לב, בעת הפעלה או הפעלה מחדש של המצלמה, ההגדרה הפעילה מוגדרת כבית. |
להכניס למחוק | 13 | 11213 | 1 |
| מצלמה.מצב
מצב המצלמה. כשהמצלמה פעילה, המצלמה מזרימה וידאו. כאשר לא פעיל, המצלמה אינה זורמת. בעת שדרוג, המצלמה משדרגת קושחה. |
לְקַבֵּל | 60 | שדרוג פעילי לא פעיל | לֹא פָּעִיל |
| autoframing.state
הפעל/כבה את תכונת הצילום האוטומטי של המצלמה. |
להכניס למחוק | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
החלף את מצב ההתאמה מהפעלה/כיבוי לכבוי/מופעל. |
שֶׁלְאַחַר | C6 | לא | לא |
| bluetooth.pairingState
מצב התאמת Bluetooth. מצב מופעל יאפשר התאמה עם המכשיר לפרק זמן קבוע. לאחר סיום מרווח ההתאמה, המצב ישתנה לכבוי. |
לשים | 14 | 110 | 0 |
| bluetooth.state
מצב בלוטות' ו-BLE. מצב מופעל יציין ש-Bluetooth ו-BLE מופעלים; המצב כבוי יציין שה-Bluetooth ו-BLE כבויים. |
לְקַבֵּל | 67 | 110 | 0 |
| bluetooth.paired
שם המכשיר המותאם. |
לְקַבֵּל | 6A | חוּט
(0-128 תווים) |
לא מוכן |
| bluetooth.מחוברים
מצב חיבור המכשיר המותאם. |
לְקַבֵּל | 6B | 110 | 0 |
| bluetooth.streamState
סטטוס סטרימינג של Bluetooth. |
לְקַבֵּל | C2 | 110 | 0 |
| bluetooth.callState
מצב שיחת Bluetooth. |
לְקַבֵּל | 6C | 110 | 0 |
| bluetooth.ניתוק
נתק מכשיר בלוטות'. |
שֶׁלְאַחַר | E4 | 11213 | לא |
| network.dhcpState
מצב DHCP. כאשר מצב DHCP מופעל, הרשת תוגדר באמצעות DHCP. כאשר מצב DHCP כבוי, נעשה שימוש בערכים סטטיים. |
להכניס למחוק | 74 | 110 | 1 |
| network.ip (VBl)
כתובת IP סטטית כאשר מצב DHCP כבוי. |
להכניס למחוק | 75 | (נתמך ב-VBl) 0.0.0.0 | |
| network.state (VBl)
מצב מודול האתרנט. |
לְקַבֵּל | 7F | כישלון סרק!
אסוציאציהI configurationI readyI לְנַתֵק! באינטרנט |
(נתמך ב-VBl) מוכן |
| שם/תיאור | פעולות | Cmd ID | טווח ערכים | ערך ברירת מחדל |
| network.mac (VBl)
כתובת MAC של ממשק ה-LAN. |
לְקַבֵּל | 80 | (נתמך ב-VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
מצב DHCP. כאשר מצב DHCP מופעל, WiFi יוגדר באמצעות DHCP. כאשר מצב DHCP כבוי, נעשה שימוש בערכים סטטיים. |
להכניס למחוק | Al | 110 | 1 |
| wifi.ip
כתובת IP סטטית כאשר מצב DHCP כבוי. |
להכניס למחוק | A2 | 0.0.0.0 | |
| wifi.mac
כתובת MAC של ממשק ה-WiFi. |
לְקַבֵּל | AC | 00:00:00:00:00:00 | |
| wifi.state
מצב מודול ה-WiFi. |
לְקַבֵּל | BO | כישלון סרק!
אסוציאציהI configurationI readyI לְנַתֵק! באינטרנט |
לְהִתְבַּטֵל |
| telemetry.peopleCount (VBl)
מספר האנשים שנספר על ידי אלגוריתם הצילום האוטומטי של המצלמה. |
להכניס למחוק | DA | 0-99 | (נתמך ב-VBl) 0 |
| telemetry.peoplePresent (VBl)
נכון כאשר אנשים זוהו על ידי אלגוריתם הצילום האוטומטי של המצלמה. |
להכניס למחוק | DC | 110 | (נתמך ב-VBl) 0 |
מסמכים / משאבים
 |
אפליקציית BOSE Work Rest API [pdfמדריך למשתמש Work, Rest API, App, Work Rest API App |
