BOSE Work Isinmi API App
Ọrọ Iṣaaju
Awọn ẹrọ Bose Videobar ṣe atilẹyin ni wiwo siseto ohun elo gbigbe ipinlẹ aṣoju (REST API) fun iṣakoso nẹtiwọki ati ibojuwo. Itọsọna yii n pese awọn ilana fun ṣiṣe ati tunto REST API lori awọn ẹrọ fidiobar, ati pe o pese alaye alaye ti awọn oniyipada ati awọn iṣẹ ṣiṣe.
Awọn nkan iṣeto ni ati awọn iṣẹ ṣiṣe jẹ akojọpọ ni awọn ẹka wọnyi:
- eto
- iwa
- usb
- ohun ohun
- kamẹra
- audioframing
- bluetooth
- nẹtiwọki (VBl)
- wifi
- telemetry (VBl)
Abala Itọkasi Aṣẹ API n pese alaye atẹle fun nkan kọọkan:
- Orukọ/Apejuwe Orukọ nkan naa ati apejuwe ti lilo rẹ.
- Awọn iṣe Awọn iṣe ti o le ṣee ṣe lori ohun naa. Iṣe naa le
- jẹ ọkan tabi diẹ ẹ sii ti atẹle: gba, fi, paarẹ, firanṣẹ.
- Ibiti Awọn iye Awọn iye itẹwọgba fun ohun naa.
- Aiyipada Iye Aiyipada iye ti ohun naa. Eyi ni iye ti o lo ti o ba yi ẹrọ naa pada si awọn aṣiṣe ile-iṣẹ.
Gbogbo iye wa ni pato bi awọn gbolohun ọrọ.
Awọn akiyesi aami-iṣowo
- Bose, Bose Work, ati Videobar jẹ aami-iṣowo ti Bose Corporation.
- Aami ọrọ Bluetooth” ati awọn aami jẹ aami-išowo ti a forukọsilẹ ti Bluetooth SIG, Inc. ati lilo eyikeyi iru awọn aami bẹ nipasẹ Bose Corporation wa labẹ iwe-aṣẹ.
- Oro ti HDMI jẹ aami-iṣowo tabi aami-iṣowo ti a forukọsilẹ ti HDMI Aṣẹ Alakoso, Inc.
- Gbogbo awọn aami-išowo miiran jẹ ohun-ini ti awọn oniwun wọn.
Ìpamọ Alaye
Aṣiri rẹ ṣe pataki fun Bose nitorinaa a ti ṣe agbekalẹ Ilana Aṣiri kan ti o ni wiwa bi a ṣe n gba, lo, ṣafihan, gbigbe, ati tọju alaye ti ara ẹni rẹ.
Jọ̀wọ́ ka ìlànà ìpamọ́ yìí dáradára láti lóye bí a ṣe ń fọwọ́ pàtàkì mú ìwífún rẹ. TI O KO BA GBA SI OTO Asiri YI, Jọwọ MAA ṢE LO awọn iṣẹ naa.
Muu ṣiṣẹ ati Ṣiṣeto API REST
Lati mu iraye si API REST lori ẹrọ kan, lo ohun elo Iṣeto Iṣẹ Bose, ohun elo Iṣakoso Iṣẹ Bose, tabi Web UI. Wọle si Nẹtiwọọki> Eto API. Muu wiwọle API ṣiṣẹ ki o pato orukọ olumulo API ati ọrọ igbaniwọle kan. Iwọ yoo nilo awọn iwe-ẹri API lati lo eyikeyi awọn pipaṣẹ API REST. Jọwọ tọka si awọn itọsọna olumulo ohun elo fun alaye diẹ sii.
Idanwo REST API
O le ṣe idanwo API REST Videobar nipa lilo wiwo Swagger OpenAPI ti o wa ninu ẹrọ naa. Lati wọle si wiwo yii, Videobar gbọdọ wa ni asopọ si nẹtiwọọki IP nipasẹ ti firanṣẹ tabi wiwo WiFi, ati pe PC agbalejo rẹ gbọdọ wa lori nẹtiwọọki kanna tabi nẹtiwọọki kan ti o le wọle si ẹrọ nipasẹ HTTPS.
So PC rẹ pọ si Videobar nipasẹ wiwo USB. Bẹrẹ ohun elo Iṣeto Iṣẹ Bose ki o wọle lati wọle si awọn iṣakoso abojuto. Yan Nẹtiwọọki> Oju-iwe API ki o tẹ ọna asopọ naa:
REST API Iwe (Web UI)
Ti o ko ba sopọ mọ ẹrọ nipasẹ USB ati pe PC rẹ wa lori nẹtiwọọki kanna, o le wọle si API REST nipasẹ ẹrọ aṣawakiri rẹ nipa lilọ kiri si adirẹsi atẹle yii:
https://<videobar-ip-address>/doc-api
Awọn pipaṣẹ API REST
Fidiobar REST API ni wiwo nlo awọn ID aṣẹ ni ọkọọkan awọn ọna HTTP mẹrin ti o ni atilẹyin: gba, fi sii, paarẹ, ati firanṣẹ.
Ni isalẹ ni apejuwe awọn ọna mẹrin ti o tẹle pẹlu tabili ti n ṣalaye awọn ọna ti o ṣe atilẹyin fun ọkọọkan awọn aṣẹ.
GBA
Ọna “gba” gba ID pipaṣẹ ẹyọkan tabi awọn ID ti o ni opin idẹsẹ pupọ. Fun example, lati gba awọn audio.micMute ipinle, awọn pipaṣẹ ID ni 2. Awọn URL jẹ bi eleyi:
https://192.168.1.40/api?query=2
Ara idahun jẹ bi atẹle, pẹlu iye “O” ti o nfihan gbohungbohun ko dakẹ:
{"2": {"ipo": "aṣeyọri", "iye": "0"}}
Lati beere fun awọn iye pupọ, ya awọn ID pipaṣẹ lọpọlọpọ pẹlu aami idẹsẹ kan. Fun example, o le beere fun audio.micMute (ID=2) ati system.firmwareVersion (ID=l6) ni eyi:
https://192.168.1.40/api?query=2,16
Akiyesi: Ma ṣe pẹlu awọn alafo laarin awọn ID pupọ.
Abajade yoo jẹ:
{"2": {"ipo": "aseyori", "iye": "0"}, "16": {"ipo": "aseyori", "iye": "1.2.13_fd6cc0e"}}
PUT
Aṣẹ “fi” kan nlo ọna kika ara JSON pẹlu bọtini naa jẹ “data” ati pe iye jẹ ID: awọn orisii iye.
Fun example, lati ṣeto audio.loudspeakerVolume (ID=3) si 39, ara “https://192.168.1.40/ api” ni:
{"data":"{"3″:"39″}"}
Idahun si jẹ:
{"3": {"ipo": "aṣeyọri", "koodu": "0xe000"}}
Eyi jẹ ẹya Mofiample ṣeto awọn iye pupọ:
{"data":"{"2″:"1″,"3″:"70″}"}
Idahun si jẹ:
{"2": {"ipo": "aseyori", "koodu": "0xe000"}, "3": {"ipo": "aseyori", "koodu": "0xe000"}}
Awọn iye idahun “koodu” le jẹ eyikeyi ninu awọn atẹle:
- 0xe000: Aṣeyọri
- 0xe001: Aṣeyọri - Ko si iyipada ninu iye
- 0xe002: Aṣiṣe – Ohun ini ti ko tọ
- 0xe003: Aṣiṣe – Iye ohun ini ti ko tọ
- 0xe004: Aṣiṣe – Iṣe ohun-ini ti ko tọ
- 0xe005: Aṣiṣe – Ifiranṣẹ bajẹ
- 0xe006: Aṣiṣe – Ti kọ wiwọle si
POST
“Ifiranṣẹ” kan jọra si “fi” ati pe a lo fun awọn iṣe, bii dakẹ gbohungbohun ati iwọn didun agbọrọsọ soke/isalẹ. O pato ID aṣẹ ati lo okun sofo fun iye naa.
Fun example, lati mu iwọn didun agbọrọsọ pọ si ami kan, lo audio.loudspeakerVolumeUp (ID=4) pẹlu ọna kika ara bi eleyi:
{"data":"{"4″:"}"}
Ara idahun ni:
{"4": {"ipo": "aṣeyọri", "koodu": "0xe000"}}
Awọn iye idahun “koodu” ti o ṣeeṣe jẹ awọn ti a ṣe akojọ fun pipaṣẹ PUT.
PAArẹ
Ọna kika aṣẹ “paarẹ” jẹ iru si “gba”, ati pe ara idahun jẹ iru si “fi”. Lilo piparẹ yoo ṣeto iye pada si aiyipada rẹ.
Fun example, lati ṣeto awọn audio.agbohunsoke iwọn didun (ID=3) si awọn oniwe-aiyipada iye, awọn URL jẹ bi eleyi:
https://192.168.1.40/api?delete=3
Ara idahun ni:
{"3": {"ipo": "aṣeyọri", "koodu": "0xe000"}}
Iwọ yoo nilo lati fun “gba” lati gba iye tuntun pada, eyiti ninu ọran yii jẹ 50. Fun ex.ample:
Àṣẹ:
https://192.168.1.40/api?query=3
Idahun:
{"3": {"ipo": "aṣeyọri", "iye": "50"}}
Awọn iye idahun “koodu” ti o ṣeeṣe jẹ awọn ti a ṣe akojọ fun pipaṣẹ PUT
Videobar REST API Òfin Reference
| Orukọ / Apejuwe | Awọn iṣe | cmd ID | Ibiti o ti iye | Aiyipada Iye |
| eto.atunbere
Tun atunbere eto naa. |
ifiweranṣẹ | 32 | N/A | N/A |
| system.serialNọmba
Nọmba ni tẹlentẹle ti awọn ẹrọ. |
gba | 10 | okun
(awọn ẹmu 17) |
ooooooooooooooxx |
| eto.firmwareVersion
Ẹya ti famuwia nṣiṣẹ lori ẹrọ naa. Eyi ti ṣeto laifọwọyi lori igbesoke famuwia eto. |
gba | 16 | okun
(awọn ẹmu 1-16) |
0.0.0 |
| eto.awoṣe
Awoṣe ti yi ẹrọ. |
gba | D6 | okun
(awọn ẹmu 1-22) |
Ko ṣeto |
| eto.orukọ
Orukọ ẹrọ naa ki o le ṣe idanimọ ni iyasọtọ. |
gba parẹ | 25 | okun
(awọn ẹmu 1-22) |
Ko ṣeto |
| eto.yara
Yara ipo ti awọn ẹrọ |
gba parẹ | 26 | okun
(awọn ẹmu 0-128) |
Ko ṣeto |
| eto.pakà
Pakà ipo ti awọn ẹrọ. |
gba parẹ | 27 | okun
(awọn ẹmu 0-128) |
Ko ṣeto |
| eto.ile
Ile ipo ti awọn ẹrọ. |
gba parẹ | 28 | okun
(awọn ẹmu 0-128) |
Ko ṣeto |
| eto.gpiMuteStatus (VBl)
Ipo dakẹ GPI (tan/pa). |
gba | C7 | 110 | (Ti ṣe atilẹyin ni VBl) 0 |
| eto.maxOccupancy
Yara ti o pọju ibugbe ti awọn ẹrọ. |
gba parẹ | DF | okun
(awọn ẹmu 0-128) |
Ko ṣeto |
| ihuwasi.ethernet Ti ṣiṣẹ (VBl)
Tan-an/pa eto Ethernet ni wiwo. |
gba parẹ | 38 | 110 | (Ti ṣe atilẹyin ni VBl) 1 |
| ihuwasi.bluetoothEnabled
Tan-an/pa Bluetooth eto. |
gba parẹ | 3A | 110 | 1 |
| ihuwasi.wifiEnabled
Tan-an/pa WiFi eto naa. |
gba parẹ | 3B | 110 | 1 |
| ihuwasi.hdmi Ti ṣiṣẹ (VBl)
Tan-an/pa HDMI. |
gba parẹ | C9 | 110 | (Ti ṣe atilẹyin ni VBl) 0 |
| usb.connectionIpo
Ipo asopọ okun USB; 0 nigba ti ge asopọ. |
gba | 36 | 110 | 0 |
| usb.callIpo
Ipo ipe lati ọdọ agbalejo ti a ti sopọ si ibudo USB ti eto naa. |
gba | 37 | 110 | 0 |
| audio.micMute
Mutes/mutisilẹ gbohungbohun eto. |
gba fi | 2 | 110 | 0 |
| audio.micMuteToggle
Yipada ipo odi ti gbohungbohun eto. |
ifiweranṣẹ | 15 | N/A | N/A |
| Orukọ / Apejuwe | Awọn iṣe | cmd ID | Ibiti o ti iye | Aiyipada Iye |
| audio.agbohunsokeMute
Mutes/mu agbohunsoke eto kuro. |
ifiweranṣẹ | 34 | N/A | N/A |
| audio.agbohunsokeMuteToggle
Yipada ipo odi ti ẹrọ agbohunsoke. |
ifiweranṣẹ | 34 | N/A | N/A |
| audio.agbohunsoke Iwọn didun
Ṣeto iwọn didun agbohunsoke eto. |
gba parẹ | 3 | 0-100 | 50 |
| audio.agbohunsokeVolumeUp
Ṣe alekun iwọn didun agbohunsoke eto nipasẹ igbesẹ kan. |
ifiweranṣẹ | 4 | N/A | N/A |
| audio.agbohunsokeVolumeDown
Dinku iwọn didun agbohunsoke eto nipasẹ igbesẹ kan. |
ifiweranṣẹ | 5 | N/A | N/A |
| kamẹra.sun
Iwọn sisun lọwọlọwọ kamẹra. |
gba parẹ | 6 | 1-10 | 1 |
| kamẹra.pan
Awọn kamẹra ká lọwọlọwọ pan iye. |
gba parẹ | 7 | -10-10 | 0 |
| kamẹra.tẹ
Iwọn tẹ kamẹra lọwọlọwọ. |
gba parẹ | 8 | -10-10 | 0 |
| camera.sun In
Sun-un kamẹra sinu nipasẹ igbesẹ kan. |
ifiweranṣẹ | 9 | N/A | N/A |
| camera.sunOut
Sun-un kamẹra jade nipasẹ igbesẹ kan. |
ifiweranṣẹ | OA | N/A | N/A |
| kamẹra.pan Osi
Pans kamẹra osi nipa igbese kan. |
ifiweranṣẹ | OB | N/A | N/A |
| kamẹra.pan Ọtun
Pan kamẹra ọtun nipasẹ igbese kan. |
ifiweranṣẹ | oc | N/A | N/A |
| kamẹra.tiltUp
Di kamẹra soke nipasẹ igbesẹ kan. |
ifiweranṣẹ | OD | N/A | N/A |
| kamẹra.tiltDown
Di kamẹra si isalẹ nipasẹ igbesẹ kan. |
ifiweranṣẹ | OE | N/A | N/A |
| camera.homePreset
Tito ile kamẹra ni aṣẹ sisun tẹ pan |
gba parẹ | 56 | 0 01 | |
| camera.pristPreset
Tito tẹlẹ kamẹra akọkọ ninu pan tẹ sun-un ibere. |
gba parẹ | 57 | 0 01 | |
| camera.second Tito
Tito tẹlẹ kamẹra keji ni aṣẹ sisun tẹ pan. |
gba parẹ | 58 | 0 01 | |
| camera.savePresetHome
Fipamọ si tito tẹlẹ ile awọn iye PTZ lọwọlọwọ. |
ifiweranṣẹ | 12 | N/A | N/A |
| camera.savePresetFirst
Fipamọ si tito tẹlẹ akọkọ awọn iye PTZ lọwọlọwọ. |
ifiweranṣẹ | 17 | N/A | N/A |
| camera.savePresetSecond
Fipamọ si tito tẹlẹ keji awọn iye PTZ lọwọlọwọ. |
ifiweranṣẹ | 18 | N/A | N/A |
| Orukọ / Apejuwe | Awọn iṣe | cmd ID | Ibiti o ti iye | Aiyipada Iye |
| kamẹra.fi Ti tẹlẹ ti nṣiṣe lọwọ
Waye tito tẹlẹ lọwọ si awọn eto PTZ. |
ifiweranṣẹ | OF | N/A | N/A |
| kamẹra.lọwọ Tito tẹlẹ
Eyi ni tito tẹlẹ lọwọ. Akiyesi, ni ibẹrẹ kamẹra tabi tun bẹrẹ tito tẹlẹ ti nṣiṣe lọwọ ti ṣeto si Ile. |
gba parẹ | 13 | 11213 | 1 |
| kamẹra.ipinle
Ipo kamẹra. Nigbati o ba n ṣiṣẹ, kamẹra n ṣanwọle fidio. Nigbati o ba ṣiṣẹ, kamẹra ko ni ṣiṣanwọle. Nigbati igbegasoke, kamẹra ti wa ni igbegasoke famuwia. |
gba | 60 | activeI aláìṣiṣẹmọI igbegasoke | aiṣiṣẹ |
| autoframing.state
Tan/paa ẹya ara ẹrọ adaṣe kamẹra. |
gba parẹ | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Yipada ipo isọpọ lati tan/paa si pipa/tan. |
ifiweranṣẹ | C6 | N/A | N/A |
| bluetooth.pairingState
Bluetooth sisopọ ipinle. Ipo ti o wa yoo gba laaye sisopọ pẹlu ẹrọ fun aarin ti o wa titi. Ni kete ti aarin sisopọ ba ti pari, ipinlẹ yoo yipada si pipa. |
gba fi | 14 | 110 | 0 |
| bluetooth.ipinle
Bluetooth ati BLE ipinle. Ipinle ti o wa yoo fihan pe Bluetooth ati BLE wa ni titan; ipinle pipa yoo fihan pe Bluetooth ati BLE wa ni pipa. |
gba | 67 | 110 | 0 |
| bluetooth.paired
Orukọ ẹrọ ti a so pọ. |
gba | 6A | okun
(awọn ẹmu 0-128) |
Ko ṣeto |
| bluetooth.ti sopọ
Ipo asopọ ẹrọ ti a so pọ. |
gba | 6B | 110 | 0 |
| bluetooth.streamState
Ipo ṣiṣanwọle ti Bluetooth. |
gba | C2 | 110 | 0 |
| bluetooth.callState
Ipo ipe Bluetooth. |
gba | 6C | 110 | 0 |
| bluetooth.disconnect
Ge asopọ Bluetooth ẹrọ. |
ifiweranṣẹ | E4 | 11213 | N/A |
| nẹtiwọki.dhcpState
DHCP ipinle. Nigbati ipo DHCP ba wa ni titan, nẹtiwọki yoo tunto nipasẹ DHCP. Nigbati ipo DHCP ba wa ni pipa, awọn iye aimi ni a lo. |
gba parẹ | 74 | 110 | 1 |
| network.ip (VBl)
Adirẹsi IP aimi nigbati ipo DHCP wa ni pipa. |
gba parẹ | 75 | (Ti ṣe atilẹyin ni VBl) 0.0.0.0 | |
| nẹtiwọki.state (VBl)
Ipinle ti àjọlò module. |
gba | 7F | aisedeede ikuna!
AssociationI atuntoI readyI ge asopọ! online |
(Ti ṣe atilẹyin ni VBl) ṣetan |
| Orukọ / Apejuwe | Awọn iṣe | cmd ID | Ibiti o ti iye | Aiyipada Iye |
| nẹtiwọki.mac (VBl)
Adirẹsi MAC ti wiwo LAN. |
gba | 80 | (Ti ṣe atilẹyin ni VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP ipinle. Nigbati ipo DHCP ba wa ni titan, WiFi yoo tunto nipasẹ DHCP. Nigbati ipo DHCP ba wa ni pipa, awọn iye aimi ni a lo. |
gba parẹ | Al | 110 | 1 |
| wifi.ip
Adirẹsi IP aimi nigbati ipo DHCP wa ni pipa. |
gba parẹ | A2 | 0.0.0.0 | |
| wifi.mac
Adirẹsi MAC ti wiwo WiFi. |
gba | AC | 00:00:00:00:00:00 | |
| wifi.ipinle
Ipinle ti WiFi module. |
gba | BO | aisedeede ikuna!
AssociationI atuntoI readyI ge asopọ! online |
laišišẹ |
| telemetry.eniyanCount (VBl)
Nọmba awọn eniyan ti a ka nipasẹ kamẹra autoframing algorithm. |
gba parẹ | DA | 0-99 | (Ti ṣe atilẹyin ni VBl) 0 |
| telemetry.eniyanPresent (VBl)
Otitọ nigbati eyikeyi eniyan ti rii nipasẹ algorithm autoframing kamẹra. |
gba parẹ | DC | 110 | (Ti ṣe atilẹyin ni VBl) 0 |
Awọn iwe aṣẹ / Awọn orisun
 |
BOSE Work Isinmi API App [pdf] Itọsọna olumulo Ise, Isinmi API, App, Isinmi API App |
