BOSE Work Rest API ilovasi
Kirish
Bose Videobar qurilmalari tarmoqni boshqarish va monitoring qilish uchun vakillik holatini uzatish ilova dasturlash interfeysini (REST API) qo‘llab-quvvatlaydi. Ushbu qo'llanmada Videobar qurilmalarida REST API-ni yoqish va sozlash bo'yicha ko'rsatmalar berilgan va u qo'llab-quvvatlanadigan o'zgaruvchilar va operatsiyalarning batafsil tavsifini taqdim etadi.
Konfiguratsiya elementlari va operatsiyalari quyidagi toifalarga guruhlangan:
- tizimi
- xulq-atvor
- usb
- audio
- kamera
- audiofreymlash
- bluetooth
- tarmoq (VBl)
- Wi-fi
- telemetriya (VBl)
API buyrug'iga havola bo'limi har bir ob'ekt uchun quyidagi ma'lumotlarni taqdim etadi:
- Nomi/Ta'rifi Ob'ektning nomi va undan foydalanish tavsifi.
- Amallar Ob'ektda bajarilishi mumkin bo'lgan harakatlar. Harakat mumkin
- quyidagilardan biri yoki bir nechtasi bo'lsin: olish, qo'yish, o'chirish, joylashtirish.
- Qiymatlar diapazoni Ob'ekt uchun qabul qilinadigan qiymatlar.
- Standart qiymat Ob'ektning standart qiymati. Bu qurilmani zavod parametrlariga qaytarganingizda foydalaniladigan qiymatdir.
Barcha qiymatlar satrlar sifatida ko'rsatilgan.
Savdo belgisi haqida eslatmalar
- Bose, Bose Work va Videobar Bose korporatsiyasining savdo belgilaridir.
- "Bluetooth" so'z belgisi va logotiplari Bluetooth SIG, Inc.ga tegishli ro'yxatdan o'tgan savdo belgilaridir va bunday belgilardan Bose Corporation tomonidan har qanday foydalanish litsenziya ostida.
- HDMI atamasi HDMI Licensing Administrator, Inc kompaniyasining savdo belgisi yoki roʻyxatdan oʻtgan savdo belgisidir.
- Boshqa barcha savdo belgilari tegishli egalarining mulki hisoblanadi.
Maxfiylik ma'lumotlari
Maxfiyligingiz Bose uchun muhim, shuning uchun biz shaxsiy maʼlumotlaringizni qanday toʻplashimiz, foydalanishimiz, oshkor qilishimiz, uzatishimiz va saqlashimizni qamrab oladigan Maxfiylik siyosatini ishlab chiqdik.
MA'LUMOTLARINGIZGA QANDAY ISHLAB CHIQARISHIMIZNI TUSHUNISH UCHUN MAZBURIYLIK SIYoSATINI DIQQAT BILAN O'QING. AGAR SIZ BU MAXFIYLIK SIYOSOSATIGA RAZI BO'LMASANGIZ, ILTIMOS XIZMATLARDAN FOYDALANMANG.
REST API-ni yoqish va sozlash
Qurilmada REST API ga kirishni yoqish uchun Bose Work Configuration ilovasidan, Bose Work Management ilovasidan yoki Web UI. Tarmoq> API sozlamalariga kiring. APIga kirishni yoqing va API foydalanuvchi nomi va parolini belgilang. REST API buyruqlaridan foydalanish uchun sizga ushbu API hisob maʼlumotlari kerak boʻladi. Qo'shimcha ma'lumot uchun ilovaning foydalanuvchi qo'llanmalariga murojaat qiling.
REST API sinovdan o'tkazilmoqda
Videobar REST API ni qurilmaga o‘rnatilgan Swagger OpenAPI interfeysi yordamida sinab ko‘rishingiz mumkin. Ushbu interfeysga kirish uchun Videobar simli yoki WiFi interfeysi orqali IP tarmog'iga ulangan bo'lishi kerak va sizning asosiy kompyuteringiz bir xil tarmoqda yoki HTTPS orqali qurilmaga kira oladigan tarmoqda bo'lishi kerak.
Kompyuteringizni USB interfeysi orqali Videobar-ga ulang. Bose Work Configuration ilovasini ishga tushiring va administrator boshqaruviga kirish uchun tizimga kiring. Tarmoq > API sahifasini tanlang va havolani bosing:
REST API hujjatlari (Web Foydalanuvchi interfeysi)
Agar siz qurilmaga USB orqali ulanmagan bo'lsangiz va shaxsiy kompyuteringiz bitta tarmoqda bo'lsa, quyidagi manzilga o'tish orqali brauzeringiz orqali REST API-ga kirishingiz mumkin:
https://<videobar-ip-address>/doc-api
REST API buyruqlari
Videobar REST API interfeysi qo'llab-quvvatlanadigan to'rtta HTTP usulining har birida buyruq identifikatorlaridan foydalanadi: olish, qo'yish, o'chirish va joylashtirish.
Quyida to'rtta usulning tavsifi, undan keyin har bir buyruq uchun qo'llab-quvvatlanadigan usullarni tavsiflovchi jadval keltirilgan.
OLISH
"Get" usuli bitta buyruq identifikatorini yoki bir nechta vergul bilan ajratilgan identifikatorni qabul qiladi. Misol uchunample, audio.micMute holatini olish uchun, buyruq ID hisoblanadi 2. The URL shunga o'xshash:
https://192.168.1.40/api?query=2
Javob tanasi quyidagicha bo'lib, "O" qiymati mikrofonning ovozi o'chirilganligini bildiradi:
{“2”: {“holat”: “muvaffaqiyat”, “qiymat”: “0”}}
Bir nechta qiymatlarni so'rash uchun bir nechta buyruq identifikatorlarini vergul bilan ajrating. Misol uchunampBuning uchun audio.micMute (ID=2) va system.firmwareVersion (ID=l6) uchun so'rov yuborishingiz mumkin:
https://192.168.1.40/api?query=2,16
Eslatma: Bir nechta identifikatorlar orasidagi bo'shliqlarni qo'shmang.
Natija quyidagicha bo'ladi:
{“2”: {“holat”: “muvaffaqiyat”, “qiymat”: “0”}, “16”: {“holat”: “muvaffaqiyat”, “qiymat”: “1.2.13_fd6cc0e”}}
PUT
"Qo'yish" buyrug'i JSON asosiy formatidan foydalanadi, kaliti "ma'lumotlar" va qiymat ID: qiymat juftlari.
Misol uchunample, audio.loudspeakerVolume (ID=3) ni 39 ga o‘rnatish uchun “https://192.168.1.40/api” korpusi:
{“maʼlumotlar”:”{“3″:”39″}”}
Javob:
{“3”: {“holat”: “muvaffaqiyat”, “kod”: “0xe000”}}
Mana sobiqampbir nechta qiymatlarni o'rnatish:
{“maʼlumotlar”:”{“2″:”1″,”3″:”70″}”}
Javob:
{“2”: {“holat”: “muvaffaqiyat”, “kod”: “0xe000”}, “3”: {“holat”: “muvaffaqiyat”, “kod”: “0xe000”}}
Javob "kod" qiymatlari quyidagilardan biri bo'lishi mumkin:
- 0xe000: Muvaffaqiyatli
- 0xe001: Muvaffaqiyat - qiymat o'zgarmadi
- 0xe002: Xato - yaroqsiz xususiyat
- 0xe003: Xato - xususiyat qiymati noto'g'ri
- 0xe004 : Xato - yaroqsiz xususiyat harakati
- 0xe005: Xato - Xabar noto'g'ri tuzilgan
- 0xe006: Xato - Kirish rad etildi
POST
"Post" "qo'yish" ga o'xshaydi va mikrofon ovozini o'chirish va karnay ovozini yuqori/pasaytirish kabi harakatlar uchun ishlatiladi. Siz buyruq identifikatorini belgilaysiz va qiymat uchun bo'sh qatordan foydalanasiz.
Misol uchunample, karnay ovozini bir marta oshirish uchun audio.loudspeakerVolumeUp (ID=4) dan quyidagi asosiy formatda foydalaning:
{“maʼlumotlar”:”{“4″:””}”}
Javob organi:
{“4”: {“holat”: “muvaffaqiyat”, “kod”: “0xe000”}}
Mumkin bo'lgan javob "kod" qiymatlari PUT buyrug'i uchun sanab o'tilgan qiymatlar bilan bir xil.
OʻCHIRISH
"O'chirish" buyrug'i formati "olish" ga o'xshaydi va javob tanasi "qo'yish" ga o'xshaydi. O'chirishdan foydalanish qiymatni standart holatga qaytaradi.
Misol uchunample, audio.karnay tovushini (ID=3) standart qiymatiga o'rnatish uchun URL shunga o'xshash:
https://192.168.1.40/api?delete=3
Javob organi:
{“3”: {“holat”: “muvaffaqiyat”, “kod”: “0xe000”}}
Yangi qiymatni olish uchun "olish" ni chiqarishingiz kerak bo'ladi, bu holda bu 50 ga teng. Masalan.ampga:
Buyruq:
https://192.168.1.40/api?query=3
Javob:
{“3”: {“holat”: “muvaffaqiyat”, “qiymat”: “50”}}
Mumkin bo'lgan javob "kod" qiymatlari PUT buyrug'i uchun sanab o'tilgan qiymatlar bilan bir xil
Videobar REST API buyruqlar ma'lumotnomasi
| Ism / Tavsif | Harakatlar | Cmd ID | Qadriyatlar diapazoni | Standart qiymat |
| system.reboot
Tizimni qayta ishga tushiradi. |
post | 32 | Yoʻq | Yoʻq |
| system.serialNumber
Qurilmaning seriya raqami. |
olish | 10 | ip
(17 belgi) |
ooooooxoooooooxx |
| system.firmwareVersion
Qurilmada ishlaydigan proshivka versiyasi. Bu tizim proshivkasini yangilashda avtomatik ravishda o'rnatiladi. |
olish | 16 | ip
(1-16 belgi) |
0.0.0 |
| tizim.model
Ushbu qurilma modeli. |
olish | D6 | ip
(1-22 belgi) |
O'rnatilmagan |
| system.name
Uni noyob tarzda aniqlash uchun qurilma nomi. |
o'chirishni qo'ying | 25 | ip
(1-22 belgi) |
O'rnatilmagan |
| tizim.xona
Qurilmaning xona joylashuvi |
o'chirishni qo'ying | 26 | ip
(0-128 belgi) |
O'rnatilmagan |
| tizim.qavat
Qurilmaning qavatdagi joylashuvi. |
o'chirishni qo'ying | 27 | ip
(0-128 belgi) |
O'rnatilmagan |
| tizim.bino
Qurilmaning qurilish joyi. |
o'chirishni qo'ying | 28 | ip
(0-128 belgi) |
O'rnatilmagan |
| system.gpiMuteStatus (VBl)
GPI ovozsiz holati (yoqish/o'chirish). |
olish | C7 | 110 | (VBl da qo'llab-quvvatlanadi) 0 |
| system.maxOccupance
Qurilmaning xona maksimal bandligi. |
o'chirishni qo'ying | DF | ip
(0-128 belgi) |
O'rnatilmagan |
| davranış.ethernetEnabled (VBl)
Tizim Ethernet interfeysini yoqadi/o'chiradi. |
o'chirishni qo'ying | 38 | 110 | (VBl da qo'llab-quvvatlanadi) 1 |
| davranış.bluetoothEnabled
Bluetooth tizimini yoqadi/o'chiradi. |
o'chirishni qo'ying | 3A | 110 | 1 |
| davranış.wifiEnabled
Tizim Wi-Fi-ni yoqadi/o'chiradi. |
o'chirishni qo'ying | 3B | 110 | 1 |
| davranış.hdmiEnabled (VBl)
HDMI-ni yoqadi/o'chiradi. |
o'chirishni qo'ying | C9 | 110 | (VBl da qo'llab-quvvatlanadi) 0 |
| usb.connectionStatus
USB kabeliga ulanish holati; 0 o'chirilganda. |
olish | 36 | 110 | 0 |
| usb.callStatus
Tizimning USB portiga ulangan xostdan qo'ng'iroq holati. |
olish | 37 | 110 | 0 |
| audio.micMute
Tizim mikrofonining ovozini o'chiradi/yoqadi. |
qo'ying | 2 | 110 | 0 |
| audio.micMuteToggle
Tizim mikrofonining ovozini o'chirish holatini o'zgartiradi. |
post | 15 | Yoʻq | Yoʻq |
| Ism / Tavsif | Harakatlar | Cmd ID | Qadriyatlar diapazoni | Standart qiymat |
| audio.loudspeakerMute
Tizim karnayining ovozini o'chiradi/o'chiradi. |
post | 34 | Yoʻq | Yoʻq |
| audio.loudspeakerMuteToggle
Tizim karnayining ovozini o'chirish holatini o'zgartiradi. |
post | 34 | Yoʻq | Yoʻq |
| audio.loudspeakerOvoz balandligi
Tizim karnayining ovoz balandligini o'rnatadi. |
o'chirishni qo'ying | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
Tizim karnayining ovozini bir qadamga oshiradi. |
post | 4 | Yoʻq | Yoʻq |
| audio.loudspeakerVolume Down
Tizim karnayining ovozini bir qadam pasaytiradi. |
post | 5 | Yoʻq | Yoʻq |
| kamera.zoom
Kameraning joriy kattalashtirish qiymati. |
o'chirishni qo'ying | 6 | 1-10 | 1 |
| kamera.pan
Kameraning joriy panorama qiymati. |
o'chirishni qo'ying | 7 | -10-10 | 0 |
| kamera.tilt
Kameraning joriy egilish qiymati. |
o'chirishni qo'ying | 8 | -10-10 | 0 |
| kamera. kattalashtirish
Kamerani bir qadam kattalashtiradi. |
post | 9 | Yoʻq | Yoʻq |
| camera.zoomOut
Kamerani bir qadam kattalashtiradi. |
post | OA | Yoʻq | Yoʻq |
| kamera.pan Chapga
Kamerani bir qadam orqaga suradi. |
post | OB | Yoʻq | Yoʻq |
| kamera.pan To'g'ri
Kamerani bir qadamga siljitadi. |
post | oc | Yoʻq | Yoʻq |
| camera.tiltUp
Kamerani bir qadam yuqoriga buradi. |
post | OD | Yoʻq | Yoʻq |
| camera.tiltDown
Kamerani bir qadam pastga buradi. |
post | OE | Yoʻq | Yoʻq |
| camera.homePreset
Panoramani kattalashtirish tartibida kamera uyi oldindan oʻrnatilgan |
o'chirishni qo'ying | 56 | 0 01 | |
| camera.firstPreset
Kamera birinchi navbatda panoramani egish masshtabida oldindan o'rnatilgan. |
o'chirishni qo'ying | 57 | 0 01 | |
| kamera.soniya Oldindan oʻrnatilgan
Panoramani kattalashtirish tartibida kamera ikkinchi oldindan oʻrnatilgan. |
o'chirishni qo'ying | 58 | 0 01 | |
| camera.savePresetHome
Joriy PTZ qiymatlarini oldindan o'rnatilgan uyga saqlaydi. |
post | 12 | Yoʻq | Yoʻq |
| camera.savePresetFirst
Joriy PTZ qiymatlarini birinchi oldindan o'rnatilganga saqlaydi. |
post | 17 | Yoʻq | Yoʻq |
| camera.savePresetSecond
Joriy PTZ qiymatlarini ikkinchi oldindan o'rnatilganga saqlaydi. |
post | 18 | Yoʻq | Yoʻq |
| Ism / Tavsif | Harakatlar | Cmd ID | Qadriyatlar diapazoni | Standart qiymat |
| kamera.qo‘llash ActivePreset
PTZ sozlamalariga faol oldindan o'rnatishni qo'llaydi. |
post | OF | Yoʻq | Yoʻq |
| kamera.faol Oldindan oʻrnatilgan
Bu faol oldindan o'rnatilgan. Esda tutingki, kamera ishga tushirilganda yoki qayta ishga tushirilganda faol oldindan o'rnatilgan sozlamalar Bosh sahifaga o'rnatiladi. |
o'chirishni qo'ying | 13 | 11213 | 1 |
| kamera.holat
Kamera holati. Faol bo'lsa, kamera videoni uzatadi. Faol bo'lmaganda, kamera translatsiya qilmaydi. Yangilash paytida kamera proshivkani yangilamoqda. |
olish | 60 | faolI nofaolI yangilash | harakatsiz |
| autoframing.holat
Kamerani avtomatik kadrlash funksiyasini yoqing/o‘chiring. |
o'chirishni qo'ying | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Ulanish holatini yoqish/o‘chirishdan o‘chirish/yoqish holatiga o‘tkazing. |
post | C6 | Yoʻq | Yoʻq |
| bluetooth.pairingState
Bluetooth ulanish holati. Yoqilgan holat qurilma bilan belgilangan vaqt oralig'ida ulanish imkonini beradi. Ulanish oralig'i tugagach, holat o'chiriladi. |
qo'ying | 14 | 110 | 0 |
| bluetooth.state
Bluetooth va BLE holati. Yoqilgan holat Bluetooth va BLE yoqilganligini bildiradi; o'chirilgan holat Bluetooth va BLE o'chirilganligini bildiradi. |
olish | 67 | 110 | 0 |
| bluetooth.juftlangan
Ulangan qurilma nomi. |
olish | 6A | ip
(0-128 belgi) |
O'rnatilmagan |
| bluetooth.ulangan
Ulangan qurilma ulanish holati. |
olish | 6B | 110 | 0 |
| bluetooth.streamState
Bluetooth oqim holati. |
olish | C2 | 110 | 0 |
| bluetooth.callState
Bluetooth qo'ng'irog'i holati. |
olish | 6C | 110 | 0 |
| bluetooth.disconnect
Bluetooth qurilmasini uzing. |
post | E4 | 11213 | Yoʻq |
| network.dhcpState
DHCP holati. DHCP holati yoqilgan bo'lsa, tarmoq DHCP orqali sozlanadi. DHCP holati o'chirilgan bo'lsa, statik qiymatlar ishlatiladi. |
o'chirishni qo'ying | 74 | 110 | 1 |
| network.ip (VBl)
DHCP holati o'chirilganda statik IP manzili. |
o'chirishni qo'ying | 75 | (VBl da qo'llab-quvvatlanadi) 0.0.0.0 | |
| tarmoq.state (VBl)
Ethernet modulining holati. |
olish | 7F | bema'ni muvaffaqiyatsizlik!
assotsiatsiyaI konfiguratsiyasiI tayyorI uzing! onlayn |
(VBl da qo'llab-quvvatlanadi) tayyor |
| Ism / Tavsif | Harakatlar | Cmd ID | Qadriyatlar diapazoni | Standart qiymat |
| network.mac (VBl)
LAN interfeysining MAC manzili. |
olish | 80 | (VBl da qo'llab-quvvatlanadi) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP holati. DHCP holati yoqilganda, WiFi DHCP orqali sozlanadi. DHCP holati o'chirilgan bo'lsa, statik qiymatlar ishlatiladi. |
o'chirishni qo'ying | Al | 110 | 1 |
| wifi.ip
DHCP holati o'chirilganda statik IP manzili. |
o'chirishni qo'ying | A2 | 0.0.0.0 | |
| wifi.mac
WiFi interfeysining MAC manzili. |
olish | AC | 00:00:00:00:00:00 | |
| wifi.state
WiFi modulining holati. |
olish | BO | bema'ni muvaffaqiyatsizlik!
assotsiatsiyaI konfiguratsiyasiI tayyorI uzing! onlayn |
bo'sh |
| telemetry.peopleCount (VBl)
Kamerani avtomatik ramkalash algoritmi tomonidan hisoblangan odamlar soni. |
o'chirishni qo'ying | DA | 0-99 | (VBl da qo'llab-quvvatlanadi) 0 |
| telemetriya.peoplePresent (VBl)
Kamera avtomatik ramkalash algoritmi tomonidan har qanday odam aniqlanganda to'g'ri. |
o'chirishni qo'ying | DC | 110 | (VBl da qo'llab-quvvatlanadi) 0 |
Hujjatlar / manbalar
 |
BOSE Work Rest API ilovasi [pdf] Foydalanuvchi uchun qoʻllanma Ish, dam olish API, ilova, ish dam olish API ilovasi |
