I-BOSE Work Rest API App
Isingeniso
Amadivayisi we-Bose Videobar asekela isixhumi esibonakalayo sohlelo lokudlulisa isicelo sombuso (REST API) sokuphathwa nokuqapha kwenethiwekhi. Lo mhlahlandlela unikeza imiyalelo yokuvumela nokumisa i-REST API kumadivayisi ebha yevidiyo, futhi inikeza incazelo enemininingwane yezinto eziguquguqukayo ezisekelwayo.
Izinto zokucushwa nokusebenza kuhlanganiswe kulezi zigaba:
- uhlelo
- ukuziphatha
- usb
- umsindo
- ikhamera
- i-audioframing
- bluetooth
- inethiwekhi (VBl)
- i-wifi
- i-telemetry (VBl)
Isigaba se-API Command Reference sinikeza ulwazi olulandelayo lwento ngayinye:
- Igama/Incazelo Igama lento nencazelo yokusetshenziswa kwayo.
- Izenzo Izenzo ezingenziwa entweni. Isenzo singakwazi
- kube okukodwa noma ngaphezulu kokulandelayo: thola, beka, susa, thumela.
- Ububanzi Bamanani Amanani amukelekayo ento.
- Inani elizenzakalelayo Inani elizenzakalelayo lento. Leli inani elisetshenziswayo uma ubuyisela idivayisi kokumisiwe kwasembonini.
Wonke amanani acaciswe njengeyunithi yezinhlamvu.
Izaziso Zophawu
- I-Bose, i-Bose Work, ne-Videobar yizimpawu zokuthengisa ze-Bose Corporation.
- I-Bluetooth” uphawu lwegama namalogo yizimpawu zokuthengisa ezibhalisiwe eziphethwe yi-Bluetooth SIG, Inc. futhi noma yikuphi ukusetshenziswa kwalezo zimpawu yi-Bose Corporation kungaphansi kwelayisensi.
- Igama elithi HDMI wuphawu lokuhweba noma wuphawu lokuhweba olubhalisiwe lwe-HDMI Licensing Administrator, Inc.
- Zonke ezinye izimpawu zokuhweba ziyimpahla yabanikazi bazo.
Ulwazi Lobumfihlo
Ubumfihlo bakho bubalulekile ku-Bose ngakho-ke sisungule Inqubomgomo Yobumfihlo ehlanganisa indlela esiqoqa ngayo, sisebenzisa, sidalula, sidlulisa, futhi sigcina kanjani imininingwane yakho siqu.
SICELA UYIFUNDE KAHLE LENQUBOMGOMO YOBUMFIHLO UKUZE UQONDE INDLELA ESILUPHATHA NGAYO ULWAZI LAKHO. UMA UNGAVUMELANI NALE NQUBOMGOMO YOBUMFIHLO, SICELA UNGAZISEBENZISI IZINKONZO.
Inika amandla futhi Ilungiselela i-REST API
Ukuze unike amandla ukufinyelela ku-REST API kudivayisi, sebenzisa uhlelo lokusebenza lwe-Bose Work Configuration, uhlelo lokusebenza lwe-Bose Work Management, noma Web I-UI. Finyelela Inethiwekhi> izilungiselelo ze-API. Nika amandla ukufinyelela kwe-API futhi ucacise igama lomsebenzisi nephasiwedi ye-API. Uzodinga lezi zimpawu ze-API ukuze usebenzise noma yimiphi imiyalo ye-REST API. Sicela ubhekisele kumhlahlandlela womsebenzisi wohlelo lokusebenza ukuze uthole ulwazi olwengeziwe.
Ihlola i-REST API
Ungahlola i-Videobar REST API ngokusebenzisa isixhumi esibonakalayo se-Swagger OpenAPI esishumekwe kudivayisi. Ukuze ufinyelele lesi sixhumanisi i-Videobar kufanele ixhunywe kunethiwekhi ye-IP ngesixhumi esibonakalayo esinezintambo noma se-WiFi, futhi i-PC yakho yomsingathi kufanele ibe kunethiwekhi efanayo noma inethiwekhi engafinyelela idivayisi nge-HTTPS.
Xhuma i-PC yakho kubha yevidiyo usebenzisa isixhumi esibonakalayo se-USB. Qala uhlelo lokusebenza lwe-Bose Work Configuration bese ungena ngemvume ukuze ufinyelele izilawuli zokuphatha. Khetha Inethiwekhi > ikhasi le-API bese uchofoza isixhumanisi:
I-REST API Documentation (Web I-UI)
Uma ungaxhunyiwe kudivayisi nge-USB futhi i-PC yakho ikunethiwekhi efanayo, ungafinyelela i-REST API ngesiphequluli sakho ngokuphequlula ekhelini elilandelayo:
https://<videobar-ip-address>/doc-api
I-REST API Commands
Isixhumi esibonakalayo se-Videobar REST API sisebenzisa ama-ID womyalo endleleni ngayinye kwezine ze-HTTP ezisekelwayo: thola, beka, susa, futhi uthumele.
Ngezansi kunencazelo yezindlela ezine ezilandelwa yithebula elichaza izindlela ezisekelwe kumyalelo ngamunye.
THOLA
Indlela "thola" yamukela i-ID yomyalo owodwa noma ama-ID amaningi ahlukaniswe ngamakhoma. Okwesiboneloample, ukuze uthole isimo se-audio.micMute, i-ID yomyalo ithi 2. I URL kunjena:
https://192.168.1.40/api?query=2
Umzimba wokuphendula umi kanje, onenani elithi “O” elibonisa ukuthi imakrofoni ayithulisiwe:
{“2”: {“isimo”: “impumelelo”, “value”: “0”}}
Ukuze ubuze ngamavelu amaningi, hlukanisa ama-ID omyalo amaningi ngokhefana. OkwesiboneloampNokho, ungase ubuze i-audio.micMute (ID=2) ne-system.firmwareVersion (ID=l6) kanje:
https://192.168.1.40/api?query=2,16
Qaphela: Ungafaki izikhala phakathi kwama-ID amaningi.
Umphumela uzoba:
{“2”: {“isimo”: “impumelelo”, “inani”: “0”}, “16”: {“isimo”: “impumelelo”, “inani”: “1.2.13_fd6cc0e”}}
PUT
Umyalo othi "beka" usebenzisa ifomethi yomzimba we-JSON ukhiye othi "idatha" futhi inani elithi ID:value pairs.
Okwesiboneloample, ukusetha i-audio.loudspeakerVolume (ID=3) ibe ngu-39, umzimba othi “https://192.168.1.40/ api” uthi:
{“idatha”:”{“3″:”39″}”}
Impendulo ithi:
{“3”: {“status”: “success”, “code”: “0xe000”}}
Nansi i-example kusetha amanani amaningi:
{“idatha”:”{“2″:”1″,”3″:”70″}”}
Impendulo ithi:
{“2”: {“status”: “success”, “code”: “0xe000”}, “3”: {“status”: “success”, “code”: “0xe000”}}
Amanani "ikhodi" yempendulo angaba yinoma yikuphi kokulandelayo:
- 0xe000 : Impumelelo
- 0xe001 : Impumelelo - Akukho ukuguqulwa kwenani
- 0xe002 : Iphutha - Impahla engavumelekile
- 0xe003 : Iphutha - Inani lesakhiwo elingavumelekile
- 0xe004 : Iphutha - Isenzo sesakhiwo esingavumelekile
- 0xe005 : Iphutha - Umlayezo awulungile
- 0xe006 : Iphutha - Ukufinyelela kunqatshiwe
THUMELA
“Okuthunyelwe” kufana nokuthi “beka” futhi kusetshenziselwa izenzo, njengokuguqula ukuthulisa imakrofoni kanye nevolumu yesipika iye phezulu/ephansi. Ucacisa i-ID yomyalo futhi usebenzise iyunithi yezinhlamvu engenalutho yenani.
Okwesiboneloample, ukuze ukhuphule ivolumu yesipika umaka owodwa, sebenzisa i-audio.loudspeakerVolumeUp (ID=4) ngefomethi yomzimba kanje:
{“idatha”:”{“4″:””}”}
Umzimba wokuphendula uthi:
{“4”: {“status”: “success”, “code”: “0xe000”}}
Amanani angaba khona “ekhodi” afana nalawo asohlwini lomyalo we-PUT.
SUSA
Ifomethi yomyalo "susa" ifana nethi "thola", futhi umzimba wokuphendula ufana nokuthi "beka". Ukusebenzisa okuthi delete kuzosetha inani libuyele kokumisiwe kwalo.
Okwesiboneloample, ukusetha ivolumu yesipikha somsindo (ID=3) enanini layo elimisiwe, i URL kunjena:
https://192.168.1.40/api?delete=3
Umzimba wokuphendula uthi:
{“3”: {“status”: “success”, “code”: “0xe000”}}
Uzodinga ukuthi ukhiphe okuthi “thola” ukuze ubuyise inani elisha, kuleli cala elingu-50. Example:
Umyalo:
https://192.168.1.40/api?query=3
Impendulo:
{“3”: {“isimo”: “impumelelo”, “value”: “50”}}
Amanani angaba khona “ekhodi” afana nalawo asohlwini lomyalo we-PUT
I-Videobar REST API Command Reference
| Igama/ Incazelo | Izenzo | Cmd ID | Uhla Lwamagugu | Inani elizenzakalelayo |
| isistimu.qalisa kabusha
Iqalisa kabusha isistimu. |
okuthunyelwe | 32 | N/A | N/A |
| uhlelo.serialNumber
Inombolo yomkhiqizo wedivayisi. |
thola | 10 | umucu
(17 izinhlamvu) |
ooooooooooooxx |
| uhlelo.firmwareVersion
Inguqulo ye-firmware esebenza kudivayisi. Lokhu kusethwa ngokuzenzakalelayo ekuthuthukisweni kwe-firmware yesistimu. |
thola | 16 | umucu
(1-16 izinhlamvu) |
0.0.0 |
| uhlelo.imodeli
Imodeli yale divayisi. |
thola | D6 | umucu
(1-22 izinhlamvu) |
Akusethiwe |
| uhlelo.igama
Igama ledivayisi ukuze likhonjwe ngendlela ehlukile. |
thola ukususa | 25 | umucu
(1-22 izinhlamvu) |
Akusethiwe |
| isistimu.igumbi
Indawo yegumbi yedivayisi |
thola ukususa | 26 | umucu
(0-128 izinhlamvu) |
Akusethiwe |
| uhlelo.phansi
Indawo yaphansi yedivayisi. |
thola ukususa | 27 | umucu
(0-128 izinhlamvu) |
Akusethiwe |
| uhlelo.ukwakha
Indawo yokwakha yedivayisi. |
thola ukususa | 28 | umucu
(0-128 izinhlamvu) |
Akusethiwe |
| system.gpiMuteStatus (VBl)
Isimo sokuthulisa se-GPI (kuvuliwe/kuvaliwe). |
thola | C7 | 110 | (Isekelwa ku-VBl) 0 |
| uhlelo.maxOccupancy
Ukuhlala kwegumbi okuphezulu kwedivayisi. |
thola ukususa | DF | umucu
(0-128 izinhlamvu) |
Akusethiwe |
| behaviour.ethernetEnabled (VBl)
Ivula/ivale isixhumi esibonakalayo se-Ethernet yesistimu. |
thola ukususa | 38 | 110 | (Isekelwa ku-VBl) 1 |
| ukuziphatha.bluetoothKuvunyelwe
Ivula/ivale i-Bluetooth yesistimu. |
thola ukususa | 3A | 110 | 1 |
| behaviour.wifiEnabled
Ivula/ivale i-WiFi yesistimu. |
thola ukususa | 3B | 110 | 1 |
| behaviour.hdmiEnabled (VBl)
Ivula/ivale i-HDMI. |
thola ukususa | C9 | 110 | (Isekelwa ku-VBl) 0 |
| i-usb.connectionIsimo
Isimo sokuxhuma ikhebula le-USB; 0 uma inqanyuliwe. |
thola | 36 | 110 | 0 |
| usb.callIsimo
Isimo sekholi kusuka kumsingathi oxhumeke embobeni ye-USB yohlelo. |
thola | 37 | 110 | 0 |
| i-audio.micThulisa
Ithulisa/ithulisa imakrofoni yesistimu. |
beka | 2 | 110 | 0 |
| audio.micMuteToggle
Iguqula isimo sokuthulisa semakrofoni yesistimu. |
okuthunyelwe | 15 | N/A | N/A |
| Igama/ Incazelo | Izenzo | Cmd ID | Uhla Lwamagugu | Inani elizenzakalelayo |
| i-audio.loudspeakerThulisa
Ithulisa/ithulisa isipikha sesistimu. |
okuthunyelwe | 34 | N/A | N/A |
| audio.loudspeakerMuteToggle
Iguqula isimo sokuthulisa sesikhumulo sezwi sohlelo. |
okuthunyelwe | 34 | N/A | N/A |
| audio.loudspeakerVolume
Isetha ivolumu yesipikha sesistimu. |
thola ukususa | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
Khulisa ivolumu yesipikha sesistimu ngesinyathelo esisodwa. |
okuthunyelwe | 4 | N/A | N/A |
| audio.loudspeakerVolumeDown
Yehlisa ivolumu yesipikha sesistimu ngesinyathelo esisodwa. |
okuthunyelwe | 5 | N/A | N/A |
| ikhamera.zoom
Inani lamanje lokusondeza lekhamera. |
thola ukususa | 6 | 1-10 | 1 |
| ikhamela.pan
Inani lamanje le-pan yekhamera. |
thola ukususa | 7 | -10-10 | 0 |
| ikhamera.tilt
Inani lamanje lokutshekisa lekhamera. |
thola ukususa | 8 | -10-10 | 0 |
| camera.zoom In
Isondeza ikhamera ngesinyathelo esisodwa. |
okuthunyelwe | 9 | N/A | N/A |
| camera.zoomOut
Isondeza ikhamera ngesinyathelo esisodwa. |
okuthunyelwe | OA | N/A | N/A |
| ikhamela.pan Kwesokunxele
Ikhanyisa ikhamera kwesokunxele ngesinyathelo esisodwa. |
okuthunyelwe | OB | N/A | N/A |
| ikhamela.pan Kulungile
Ikhanyisa ikhamera kwesokudla ngesinyathelo esisodwa. |
okuthunyelwe | oc | N/A | N/A |
| camera.tiltUp
Itshekisa ikhamera ngesinyathelo esisodwa. |
okuthunyelwe | OD | N/A | N/A |
| camera.tiltDown
Itshekisa ikhamera phansi ngesinyathelo esisodwa. |
okuthunyelwe | OE | N/A | N/A |
| camera.homePreset
Ikhamera yokusetha kabusha ikhaya ngohlelo lokusondeza lwe-pan tilt |
thola ukususa | 56 | 0 01 | |
| ikhamera.firstPreset
Ikhamera iqala ukusethwa ngaphambilini ngohlelo lokusondeza lwe-pan tilt. |
thola ukususa | 57 | 0 01 | |
| ikhamera.yesibili Ukusetha ngaphambilini
Ikhamera isethwe ngaphambilini kuhlelo lokusondeza lwe-pan tilt. |
thola ukususa | 58 | 0 01 | |
| camera.savePresetHome
Ilondoloza ekusetheni kusengaphambili amanani e-PTZ amanje. |
okuthunyelwe | 12 | N/A | N/A |
| camera.savePresetFirst
Ilondoloza ekusetheni kuqala amanani amanje e-PTZ. |
okuthunyelwe | 17 | N/A | N/A |
| camera.savePresetSecond
Ilondoloza ekusetheni ngaphambilini kwesibili amanani amanje e-PTZ. |
okuthunyelwe | 18 | N/A | N/A |
| Igama/ Incazelo | Izenzo | Cmd ID | Uhla Lwamagugu | Inani elizenzakalelayo |
| ikhamera.sebenzisa I-ActivePreset
Isebenzisa ukusetha ngaphambilini okusebenzayo kuzilungiselelo ze-PTZ. |
okuthunyelwe | OF | N/A | N/A |
| ikhamera.iyasebenza Setha kusengaphambili
Lokhu ukusetha ngaphambilini okusebenzayo. Qaphela, ekuqaliseni kwekhamera noma ekuqaliseni kabusha okusethiwe okusebenzayo kusethwe kokuthi Ikhaya. |
thola ukususa | 13 | 11213 | 1 |
| camera.state
Isimo sekhamera. Uma isebenza, ikhamera isakaza ividiyo. Uma ingasebenzi, ikhamera ayisakazi. Uma ithuthukiswa, ikhamera ithuthukisa i-firmware. |
thola | 60 | asebenzayoAngisebenziNgiyathuthukisa | engasebenzi |
| autoframing.state
Vula/vala isici sozimele wekhamera. |
thola ukususa | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Guqula isimo sokumatanisa kusukela ekuvuleni/ukuvala uye kokuvala/ukuvula. |
okuthunyelwe | C6 | N/A | N/A |
| bluetooth.pairingState
Isimo sokumatanisa se-Bluetooth. Isimo sizovumela ukubhanqa nedivayisi isikhathi esinqunyiwe. Uma isikhawu sokumatanisa sesiphelile, isimo sizoshintsha sivale. |
beka | 14 | 110 | 0 |
| bluetooth.state
I-Bluetooth ne-BLE state. Isimo sizobonisa ukuthi i-Bluetooth ne-BLE kuvuliwe; isimo esivaliwe sizobonisa ukuthi i-Bluetooth ne-BLE kuvaliwe. |
thola | 67 | 110 | 0 |
| bluetooth.paired
Igama ledivayisi ebhanqiwe. |
thola | 6A | umucu
(0-128 izinhlamvu) |
Akusethiwe |
| i-bluetooth.ixhunyiwe
Isimo sokuxhuma idivayisi ebhanqiwe. |
thola | 6B | 110 | 0 |
| bluetooth.streamState
Isimo sokusakaza se-Bluetooth. |
thola | C2 | 110 | 0 |
| bluetooth.callState
Isimo sekholi ye-Bluetooth. |
thola | 6C | 110 | 0 |
| i-bluetooth.nqamula
Nqamula idivayisi ye-Bluetooth. |
okuthunyelwe | E4 | 11213 | N/A |
| network.dhcpState
Isimo se-DHCP. Uma isimo se-DHCP sivuliwe, inethiwekhi izolungiswa nge-DHCP. Uma isimo se-DHCP sivaliwe, amanani amile asetshenziswa. |
thola ukususa | 74 | 110 | 1 |
| network.ip (VBl)
Ikheli le-IP elimile lapho isimo se-DHCP sivaliwe. |
thola ukususa | 75 | (Isekelwa ku-VBl) 0.0.0.0 | |
| network.state (VBl)
Isimo semojula ye-Ethernet. |
thola | 7F | ukwehluleka kokungenzi lutho!
inhlanganoI ukumisaI readyI nqamula! ku-inthanethi |
(Isekelwe ku-VBl) isilungile |
| Igama/ Incazelo | Izenzo | Cmd ID | Uhla Lwamagugu | Inani elizenzakalelayo |
| network.mac (VBl)
Ikheli le-MAC lesixhumi esibonakalayo se-LAN. |
thola | 80 | (Isekelwa ku-VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
Isimo se-DHCP. Uma isimo se-DHCP sivuliwe, i-WiFi izolungiselelwa nge-DHCP. Uma isimo se-DHCP sivaliwe, amanani amile asetshenziswa. |
thola ukususa | Al | 110 | 1 |
| wifi.ip
Ikheli le-IP elimile lapho isimo se-DHCP sivaliwe. |
thola ukususa | A2 | 0.0.0.0 | |
| i-wifi.mac
Ikheli le-MAC le-interface ye-WiFi. |
thola | AC | 00:00:00:00:00:00 | |
| i-wifi.state
Isimo semojuli ye-WiFi. |
thola | BO | ukwehluleka kokungenzi lutho!
inhlanganoI ukumisaI readyI nqamula! ku-inthanethi |
engenzi lutho |
| telemetry.peopleCount (VBl)
Inani labantu ababalwa nge-algorithm yekhamera ye-autoframing. |
thola ukususa | DA | 0-99 | (Isekelwa ku-VBl) 0 |
| telemetry.peoplePresent (VBl)
Iqiniso uma noma yibaphi abantu betholwe i-algorithm yekhamera ye-autoframing. |
thola ukususa | DC | 110 | (Isekelwa ku-VBl) 0 |
Amadokhumenti / Izinsiza
 |
I-BOSE Work Rest API App [pdf] Umhlahlandlela Womsebenzisi Work, Rest API, App, Work Rest API App |
