BOSE Work Rest API app
Inngangur
Bose Videobar tækin styðja forritunarviðmót fyrir framsetningu ástandsflutnings (REST API) fyrir netstjórnun og eftirlit. Þessi handbók veitir leiðbeiningar um að virkja og stilla REST API á Videobar tækjum og hún veitir nákvæma lýsingu á studdum breytum og aðgerðum.
Stillingaratriði og aðgerðir eru flokkaðar í þessa flokka:
- kerfi
- hegðun
- usb
- hljóð
- myndavél
- hljóðramma
- bluetooth
- net (VBl)
- WiFi
- fjarmæling (VBl)
API Command Reference hluti veitir eftirfarandi upplýsingar fyrir hvern hlut:
- Nafn/lýsing Nafn hlutar og lýsing á notkun hans.
- Aðgerðir Aðgerðir sem hægt er að framkvæma á hlutnum. Aðgerðin getur
- vera eitt eða fleiri af eftirfarandi: fá, setja, eyða, senda.
- Gildasvið Viðunandi gildi fyrir hlutinn.
- Sjálfgefið gildi Sjálfgefið gildi hlutarins. Þetta er gildið sem er notað ef þú snýrð tækinu aftur í verksmiðjustillingar.
Öll gildi eru tilgreind sem strengir.
Tilkynningar um vörumerki
- Bose, Bose Work og Videobar eru vörumerki Bose Corporation.
- Bluetooth“ orðamerkið og lógóin eru skráð vörumerki í eigu Bluetooth SIG, Inc. og öll notkun Bose Corporation á slíkum merkjum er með leyfi.
- Hugtakið HDMI er vörumerki eða skráð vörumerki HDMI Licensing Administrator, Inc.
- Öll önnur vörumerki eru eign viðkomandi eigenda.
Persónuverndarupplýsingar
Persónuvernd þín er mikilvæg fyrir Bose svo við höfum þróað persónuverndarstefnu sem fjallar um hvernig við söfnum, notum, birtum, flytjum og geymum persónuupplýsingarnar þínar.
VINSAMLEGAST LESIÐ ÞESSA PERSONVERNARREGLUR vandlega til að skilja hvernig við meðhöndlum upplýsingarnar þínar. EF ÞÚ ER EKKI SAMÞYKKT ÞESSA PERSONVERNDARREGLUR, VINSAMLEGAST EKKI NOTA ÞJÓNUSTA.
Virkja og stilla REST API
Til að virkja aðgang að REST API á tæki skaltu nota Bose Work Configuration appið, Bose Work Management appið eða Web HÍ. Fáðu aðgang að Network> API stillingum. Virkjaðu API aðgang og tilgreindu API notandanafn og lykilorð. Þú þarft þessi API skilríki til að nota einhverjar af REST API skipunum. Vinsamlegast skoðaðu notendahandbækur forritsins fyrir frekari upplýsingar.
Er að prófa REST API
Þú getur prófað Videobar REST API með því að nota Swagger OpenAPI viðmótið sem er innbyggt í tækið. Til að fá aðgang að þessu viðmóti verður myndstikan að vera tengd við IP netkerfi í gegnum hlerunarbúnað eða WiFi tengi þess, og gestgjafi tölvan þín verður að vera á sama neti eða neti sem hefur aðgang að tækinu í gegnum HTTPS.
Tengdu tölvuna þína við myndbandsstikuna í gegnum USB tengið. Ræstu Bose Work Configuration appið og skráðu þig inn til að fá aðgang að stjórnunarstýringum. Veldu Network > API síðuna og smelltu á hlekkinn:
REST API skjöl (Web HÍ)
Ef þú ert ekki tengdur við tækið í gegnum USB og tölvan þín er á sama neti geturðu fengið aðgang að REST API í gegnum vafrann þinn með því að fletta á eftirfarandi heimilisfang:
https://<videobar-ip-address>/doc-api
REST API skipanir
Videobar REST API viðmótið notar skipanaauðkenni í hverri af fjórum HTTP aðferðum sem studdar eru: fá, setja, eyða og senda.
Hér að neðan er lýsing á aðferðunum fjórum og fylgt eftir með töflu sem lýsir aðferðunum sem studdar eru fyrir hverja skipanirnar.
FÁ
„Fá“ aðferðin tekur við einu skipunarauðkenni eða mörg auðkenni aðskilin með kommum. Til dæmisample, til að fá audio.micMute ástandið er skipanakennið 2. The URL er svona:
https://192.168.1.40/api?query=2
Meginmál svarsins er sem hér segir, með gildinu „O“ sem gefur til kynna að hljóðneminn sé ekki þaggaður:
{“2”: {“status”: “success”, “value”: “0”}}
Til að spyrjast fyrir um mörg gildi skaltu aðskilja mörg skipanakenni með kommu. Til dæmisampÞú gætir spurt um audio.micMute (ID=2) og system.firmwareVersion (ID=l6) eins og þetta:
https://192.168.1.40/api?query=2,16
Athugið: Ekki hafa bil á milli margra auðkenna.
Niðurstaðan yrði:
{“2”: {“status”: “success”, “value”: “0”}, “16”: {“status”: “success”, “value”: “1.2.13_fd6cc0e”}}
SETJA
„setja“ skipun notar JSON líkamssnið þar sem lykillinn er „gögn“ og gildið er ID:gildi pör.
Til dæmisample, til að stilla audio.loudspeakerVolume (ID=3) á 39, er „https://192.168.1.40/ api“ meginmálið:
{“gögn”:”{“3″:”39″}”}
Svarið er:
{“3”: {“status”: “success”, “code”: “0xe000”}}
Hér er fyrrverandiample stillir mörg gildi:
{“gögn“:“{“2″:“1″,”3″:“70″}“}
Svarið er:
{“2”: {“status”: “success”, “code”: “0xe000”}, “3”: {“status”: “success”, “code”: “0xe000”}}
Gildi „kóða“ svara geta verið eitthvað af eftirfarandi:
- 0xe000 : Árangur
- 0xe001: Árangur - Engin breyting á gildi
- 0xe002: Villa - Ógild eign
- 0xe003 : Villa - Ógilt eignargildi
- 0xe004: Villa - Ógild eignaraðgerð
- 0xe005 : Villa - Skilaboð röng
- 0xe006: Villa - Aðgangi hafnað
POST
„Pistla“ er svipað og „setja“ og er notað fyrir aðgerðir, svo sem að skipta á hljóðnema og hljóðstyrk hátalara upp/lækka. Þú tilgreinir skipanakennið og notar tóman streng fyrir gildið.
Til dæmisample, til að auka hljóðstyrk hátalara með einu haki, notaðu audio.loudspeakerVolumeUp (ID=4) með líkamssniðinu svona:
{“gögn”:”{“4″:””}”}
Svarhluti er:
{“4”: {“status”: “success”, “code”: “0xe000”}}
Möguleg svörunargildi „kóða“ eru þau sömu og skráð eru fyrir PUT skipunina.
EYÐA
Skipunarsniðið „eyða“ er svipað og „fá“ og meginmál svarsins er svipað og „setja“. Með því að nota eyða mun gildið stilla aftur á sjálfgefið.
Til dæmisample, til að stilla hljóðstyrk audio.hátalara (ID=3) á sjálfgefið gildi, the URL er svona:
https://192.168.1.40/api?delete=3
Svarhluti er:
{“3”: {“status”: “success”, “code”: “0xe000”}}
Þú þyrftir að gefa út „get“ til að sækja nýja gildið, sem í þessu tilfelli er 50. Til dæmisample:
Skipun:
https://192.168.1.40/api?query=3
Svar:
{“3”: {“status”: “success”, “value”: “50”}}
Möguleg svörunargildi „kóða“ eru þau sömu og skráð eru fyrir PUT skipunina
Videobar REST API Command Reference
| Nafn/lýsing | Aðgerðir | Cmd ID | Gildissvið | Sjálfgefið gildi |
| system.endurræsa
Endurræsir kerfið. |
færslu | 32 | N/A | N/A |
| system.serialNumber
Raðnúmer tækisins. |
fá | 10 | strengur
(17 stafir) |
ooooooooooooooxx |
| system.firmwareVersion
Útgáfa af fastbúnaði sem keyrir á tækinu. Þetta er stillt sjálfkrafa við uppfærslu vélbúnaðar kerfisins. |
fá | 16 | strengur
(1-16 stafir) |
0.0.0 |
| system.model
Gerð af þessu tæki. |
fá | D6 | strengur
(1-22 stafir) |
Ekki stillt |
| kerfi.nafn
Nafn tækisins svo hægt sé að bera kennsl á það. |
fá sett eyða | 25 | strengur
(1-22 stafir) |
Ekki stillt |
| kerfi.herbergi
Staðsetning herbergis tækisins |
fá sett eyða | 26 | strengur
(0-128 stafir) |
Ekki stillt |
| kerfi.hæð
Staðsetning á gólfi tækisins. |
fá sett eyða | 27 | strengur
(0-128 stafir) |
Ekki stillt |
| kerfis.bygging
Byggingarstaðsetning tækisins. |
fá sett eyða | 28 | strengur
(0-128 stafir) |
Ekki stillt |
| system.gpiMuteStatus (VBl)
GPI slökkt staða (kveikt/slökkt). |
fá | C7 | 110 | (Stuðningur í VBl) 0 |
| system.maxUmlestur
Hámarksfjöldi í herbergi í tækinu. |
fá sett eyða | DF | strengur
(0-128 stafir) |
Ekki stillt |
| behavior.ethernetEnabled (VBl)
Kveikir/slökkvið á Ethernet tengi kerfisins. |
fá sett eyða | 38 | 110 | (Stuðningur í VBl) 1 |
| behavior.bluetoothEnabled
Kveikir/slökkvið á Bluetooth kerfinu. |
fá sett eyða | 3A | 110 | 1 |
| behavior.wifiEnabled
Kveikir/slökkvið á WiFi kerfisins. |
fá sett eyða | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
Kveikir/slökkvið á HDMI. |
fá sett eyða | C9 | 110 | (Stuðningur í VBl) 0 |
| usb.tengingarstaða
Staða USB snúrutengingar; 0 þegar það er aftengt. |
fá | 36 | 110 | 0 |
| usb.callStatus
Símtalsstaða frá hýsil sem er tengdur við USB tengi kerfisins. |
fá | 37 | 110 | 0 |
| audio.micMute
Slökktar/kveikir á hljóðnema kerfisins. |
fá sett | 2 | 110 | 0 |
| audio.micMuteToggle
Skiptir um slökkt á hljóðnema kerfisins. |
færslu | 15 | N/A | N/A |
| Nafn/lýsing | Aðgerðir | Cmd ID | Gildissvið | Sjálfgefið gildi |
| hljóð.hátalari Þagga
Slökktar/kveikir á hljóði í hátalara kerfisins. |
færslu | 34 | N/A | N/A |
| hljóð.hátalariMuteToggle
Skiptir á slökkt ástandi hátalara kerfisins. |
færslu | 34 | N/A | N/A |
| hljóð.hátalariVolume
Stillir hljóðstyrk kerfishátalara. |
fá sett eyða | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
Eykur hljóðstyrk kerfishátalara um eitt skref. |
færslu | 4 | N/A | N/A |
| hljóð.hátalariVolumeDown
Minnkar hljóðstyrk kerfishátalara um eitt skref. |
færslu | 5 | N/A | N/A |
| myndavél.aðdráttur
Núverandi aðdráttargildi myndavélarinnar. |
fá sett eyða | 6 | 1-10 | 1 |
| camera.pan
Núverandi pönnugildi myndavélarinnar. |
fá sett eyða | 7 | -10-10 | 0 |
| myndavél.halla
Núverandi hallagildi myndavélarinnar. |
fá sett eyða | 8 | -10-10 | 0 |
| camera.zoom In
Aðdráttur myndavélarinnar með einu skrefi. |
færslu | 9 | N/A | N/A |
| camera.zoomOut
Aðdráttur myndavélina út um eitt skref. |
færslu | OA | N/A | N/A |
| camera.pan Vinstri
Pans myndavél skilin eftir með einu skrefi. |
færslu | OB | N/A | N/A |
| camera.pan Rétt
Pans myndavél rétt með einu skrefi. |
færslu | oc | N/A | N/A |
| camera.tiltUp
Hallar myndavélinni upp um eitt skref. |
færslu | OD | N/A | N/A |
| camera.tiltDown
Hallar myndavélinni niður um eitt skref. |
færslu | OE | N/A | N/A |
| camera.homeForstilling
Forstillt heimamyndavél í aðdráttarröð með pönnuhalla |
fá sett eyða | 56 | 0 01 | |
| camera.firstPreset
Myndavél er fyrst forstillt í aðdráttarröð með pönnuhalla. |
fá sett eyða | 57 | 0 01 | |
| camera.second Forstilling
Önnur forstilling myndavélar í aðdráttarröð með pönnuhalla. |
fá sett eyða | 58 | 0 01 | |
| camera.savePresetHome
Vistar núverandi PTZ gildi á forstillingu heima. |
færslu | 12 | N/A | N/A |
| camera.savePresetFirst
Vistar núverandi PTZ gildi í fyrstu forstillingu. |
færslu | 17 | N/A | N/A |
| camera.savePresetSecond
Vistar í seinni forstillingu núverandi PTZ gildi. |
færslu | 18 | N/A | N/A |
| Nafn/lýsing | Aðgerðir | Cmd ID | Gildissvið | Sjálfgefið gildi |
| myndavél.beita ActivePreset
Notar virku forstillinguna á PTZ stillingarnar. |
færslu | OF | N/A | N/A |
| myndavél.virk Forstillt
Þetta er virka forstillingin. Athugaðu að við ræsingu eða endurræsingu myndavélarinnar er virka forstillingin stillt á Heima. |
fá sett eyða | 13 | 11213 | 1 |
| myndavél.ástand
Ástand myndavélar. Þegar hún er virk streymir myndavélin myndbandi. Þegar hún er óvirk streymir myndavélin ekki. Við uppfærslu er myndavélin að uppfæra fastbúnað. |
fá | 60 | virkI óvirkI uppfærsla | óvirkt |
| autoframing.state
Kveiktu/slökktu á sjálfvirkri rammaeiginleika myndavélarinnar. |
fá sett eyða | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Skiptu um pörunarstöðu úr kveikt/slökkt í slökkt/kveikt. |
færslu | C6 | N/A | N/A |
| bluetooth.pairingState
Bluetooth pörunarstaða. Kveikt ástand mun leyfa pörun við tækið í ákveðið bil. Þegar pörunartímabilinu er lokið mun ástandið breytast í slökkt. |
fá sett | 14 | 110 | 0 |
| bluetooth.ríki
Bluetooth og BLE ástand. Kveikt ástand mun gefa til kynna að kveikt sé á Bluetooth og BLE; slökkt ástand mun gefa til kynna að slökkt sé á Bluetooth og BLE. |
fá | 67 | 110 | 0 |
| bluetooth.parað
Heiti paraðs tækis. |
fá | 6A | strengur
(0-128 stafir) |
Ekki stillt |
| bluetooth.tengdur
Tengingarstaða paraðs tækis. |
fá | 6B | 110 | 0 |
| bluetooth.streamState
Straumsstaða Bluetooth. |
fá | C2 | 110 | 0 |
| bluetooth.callState
Staða Bluetooth símtals. |
fá | 6C | 110 | 0 |
| bluetooth.aftengjast
Aftengdu Bluetooth tæki. |
færslu | E4 | 11213 | N/A |
| net.dhcpState
DHCP ástand. Þegar kveikt er á DHCP ástandi verður netkerfi stillt í gegnum DHCP. Þegar slökkt er á DHCP ástandi eru truflanir notaðir. |
fá sett eyða | 74 | 110 | 1 |
| net.ip (VBl)
Stöðugt IP-tala þegar slökkt er á DHCP-stöðu. |
fá sett eyða | 75 | (Stuðningur í VBl) 0.0.0.0 | |
| net.ríki (VBl)
Staða Ethernet-einingarinnar. |
fá | 7F | aðgerðalaus bilun!
AssociationI stillingarI readyI aftengjast! á netinu |
(Stuðningur í VBl) tilbúinn |
| Nafn/lýsing | Aðgerðir | Cmd ID | Gildissvið | Sjálfgefið gildi |
| net.mac (VBl)
MAC vistfang LAN tengisins. |
fá | 80 | (Stuðningur í VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP ástand. Þegar kveikt er á DHCP ástandi verður WiFi stillt í gegnum DHCP. Þegar slökkt er á DHCP ástandi eru truflanir notaðir. |
fá sett eyða | Al | 110 | 1 |
| wifi.ip
Stöðugt IP-tala þegar slökkt er á DHCP-stöðu. |
fá sett eyða | A2 | 0.0.0.0 | |
| wifi.mac
MAC vistfang WiFi tengisins. |
fá | AC | 00:00:00:00:00:00 | |
| wifi.ríki
Staða WiFi einingarinnar. |
fá | BO | aðgerðalaus bilun!
AssociationI stillingarI readyI aftengjast! á netinu |
aðgerðalaus |
| telemetry.peopleCount (VBl)
Fjöldi fólks sem er talinn af sjálfvirkri ramma reiknirit myndavélarinnar. |
fá sett eyða | DA | 0-99 | (Stuðningur í VBl) 0 |
| telemetry.peoplePresent (VBl)
Rétt þegar einhver fólk hefur greinst með sjálfvirkri ramma reiknirit myndavélarinnar. |
fá sett eyða | DC | 110 | (Stuðningur í VBl) 0 |
Skjöl / auðlindir
 |
BOSE Work Rest API app [pdfNotendahandbók Vinna, Rest API, App, Work Rest API App |
