BOSE Work Rest API-app
Indledning
Bose Videobar-enhederne understøtter applikationsprogrammeringsgrænseflade for repræsentativ tilstandsoverførsel (REST API) til netværksstyring og overvågning. Denne vejledning giver instruktioner til aktivering og konfiguration af REST API på Videobar-enheder, og den giver en detaljeret beskrivelse af de understøttede variabler og operationer.
Konfigurationselementer og operationer er grupperet i disse kategorier:
- system
- opførsel
- usb
- lyd
- kamera
- audioframing
- bluetooth
- netværk (VBl)
- wifi
- telemetri (VBl)
API-kommandoreferenceafsnittet indeholder følgende oplysninger for hvert objekt:
- Navn/beskrivelse Navn på objektet og beskrivelse af dets brug.
- Handlinger Handlinger der kan udføres på objektet. Handlingen kan
- være en eller flere af følgende: get, put, delete, post.
- Interval af værdier Acceptable værdier for objektet.
- Standardværdi Objektets standardværdi. Dette er den værdi, der bruges, hvis du vender enheden tilbage til fabriksindstillingerne.
Alle værdier er angivet som strenge.
Varemærkemeddelelser
- Bose, Bose Work og Videobar er varemærker tilhørende Bose Corporation.
- "Bluetooth"-ordmærket og -logoerne er registrerede varemærker, der ejes af Bluetooth SIG, Inc., og enhver brug af sådanne mærker af Bose Corporation er under licens.
- Udtrykket HDMI er et varemærke eller registreret varemærke tilhørende HDMI Licensing Administrator, Inc.
- Alle andre varemærker tilhører deres respektive ejere.
Oplysninger om beskyttelse af personlige oplysninger
Dit privatliv er vigtigt for Bose, så vi har udviklet en privatlivspolitik, der dækker, hvordan vi indsamler, bruger, videregiver, overfører og opbevarer dine personlige oplysninger.
LÆS VENLIGST DENNE FORTROLIGHEDSPOLIT OMHYGGELIGT FOR AT FORSTÅ, HVORDAN VI HÅNDTERER DINE OPLYSNINGER. HVIS DU IKKE ACCEPTERER DENNE FORTROLIGHEDSPOLITIK, SKAL DU IKKE BRUGE TJENESTERNE.
Aktivering og konfiguration af REST API
For at aktivere adgang til REST API på en enhed skal du bruge Bose Work Configuration-appen, Bose Work Management-appen eller Web UI. Få adgang til Network> API-indstillingerne. Aktiver API-adgang og angiv et API-brugernavn og en adgangskode. Du skal bruge disse API-legitimationsoplysninger for at bruge nogen af REST API-kommandoerne. Se venligst applikationens brugervejledninger for mere information.
Test af REST API
Du kan teste Videobar REST API ved at bruge Swagger OpenAPI-grænsefladen, der er indlejret i enheden. For at få adgang til denne grænseflade skal Videobar være forbundet til et IP-netværk via dens kablede eller WiFi-grænseflade, og din værts-pc skal være på det samme netværk eller et netværk, der kan få adgang til enheden via HTTPS.
Tilslut din pc til videobaren via USB-grænsefladen. Start Bose Work Configuration-appen, og log ind for at få adgang til administratorkontrolelementer. Vælg siden Netværk > API, og klik på linket:
REST API dokumentation (Web UI)
Hvis du ikke er tilsluttet enheden via USB, og din pc er på det samme netværk, kan du få adgang til REST API via din browser ved at browse til følgende adresse:
https://<videobar-ip-address>/doc-api
REST API-kommandoer
Videobar REST API-grænsefladen bruger kommando-id'er i hver af de fire understøttede HTTP-metoder: get, put, delete og post.
Nedenfor er en beskrivelse af de fire metoder efterfulgt af en tabel, der beskriver de metoder, der understøttes for hver af kommandoerne.
FÅ
"Get"-metoden accepterer et enkelt kommando-id eller flere kommaseparerede ID'er. F.eksample, for at få tilstanden audio.micMute, er kommando-id'et 2. The URL er sådan her:
https://192.168.1.40/api?query=2
Svarteksten er som følger, med en værdi på "O", hvilket indikerer, at mikrofonen ikke er slået fra:
{“2”: {“status”: “succes”, “value”: “0”}}
For at forespørge efter flere værdier skal du adskille flere kommando-id'er med et komma. F.eksample, du kan forespørge efter audio.micMute (ID=2) og system.firmwareVersion (ID=l6) sådan her:
https://192.168.1.40/api?query=2,16
Bemærk: Medtag ikke mellemrum mellem flere id'er.
Resultatet ville være:
{“2”: {“status”: “success”, “value”: “0”}, “16”: {“status”: “success”, “value”: “1.2.13_fd6cc0e”}}
SÆTTE
En "put"-kommando bruger et JSON-kroppsformat, hvor nøglen er "data", og værdien er ID:værdi-par.
F.eksample, for at indstille audio.loudspeakerVolume (ID=3) til 39, er teksten "https://192.168.1.40/api":
{“data”:”{“3″:”39″}”}
Svaret er:
{“3”: {“status”: “succes”, “code”: “0xe000”}}
Her er en example indstilling af flere værdier:
{“data”:”{“2″:”1″,”3″:”70″}”}
Svaret er:
{“2”: {“status”: “success”, “code”: “0xe000”}, “3”: {“status”: “success”, “code”: “0xe000”}}
Svarets "kode"-værdier kan være en af følgende:
- 0xe000 : Succes
- 0xe001 : Succes – Ingen ændring i værdi
- 0xe002 : Fejl – Ugyldig egenskab
- 0xe003 : Fejl – Ugyldig egenskabsværdi
- 0xe004 : Fejl – Ugyldig egenskabshandling
- 0xe005 : Fejl – Meddelelsen er forkert udformet
- 0xe006 : Fejl – Adgang nægtet
STOLPE
Et "indlæg" ligner "sæt" og bruges til handlinger, såsom slå mikrofonlydløs og højttalerlydstyrke op/ned. Du angiver kommando-id'et og bruger en tom streng for værdien.
F.eksample, for at øge højttalerlydstyrken et flueben, brug audio.loudspeakerVolumeUp (ID=4) med kropsformatet som dette:
{“data”:”{“4″:””}”}
Svarlegemet er:
{“4”: {“status”: “succes”, “code”: “0xe000”}}
De mulige "kode"-værdier for svar er de samme som angivet for PUT-kommandoen.
SLET
Kommandoformatet "delete" ligner "get", og svarteksten ligner "put". Brug af slet vil sætte værdien tilbage til standardværdien.
F.eksample, for at indstille lydstyrken for audio.loudspeaker (ID=3) til standardværdien URL er sådan her:
https://192.168.1.40/api?delete=3
Svarlegemet er:
{“3”: {“status”: “succes”, “code”: “0xe000”}}
Du skal udstede en "get" for at hente den nye værdi, som i dette tilfælde er 50. F.eks.ampdet:
Kommando:
https://192.168.1.40/api?query=3
Svar:
{“3”: {“status”: “succes”, “value”: “50”}}
De mulige "kode"-værdier for svar er de samme som angivet for PUT-kommandoen
Videobar REST API Kommandoreference
| Navn/beskrivelse | Handlinger | Cmd ID | Række af værdier | Standardværdi |
| system.genstart
Genstarter systemet. |
stolpe | 32 | N/A | N/A |
| system.serienummer
Enhedens serienummer. |
få | 10 | snor
(17 tegn) |
ååååååååååååååå |
| system.firmwareversion
Version af firmwaren, der kører på enheden. Dette indstilles automatisk ved opgradering af systemets firmware. |
få | 16 | snor
(1-16 tegn) |
0.0.0 |
| system.model
Model af denne enhed. |
få | D6 | snor
(1-22 tegn) |
Ikke indstillet |
| system.navn
Navnet på enheden, så den kan identificeres entydigt. |
få sat slet | 25 | snor
(1-22 tegn) |
Ikke indstillet |
| system.rum
Rumplacering af enheden |
få sat slet | 26 | snor
(0-128 tegn) |
Ikke indstillet |
| system.gulv
Enhedens placering på gulvet. |
få sat slet | 27 | snor
(0-128 tegn) |
Ikke indstillet |
| system.opbygning
Bygningsplacering af enheden. |
få sat slet | 28 | snor
(0-128 tegn) |
Ikke indstillet |
| system.gpiMuteStatus (VBl)
GPI mute-status (til/fra). |
få | C7 | 110 | (Understøttet i VBl) 0 |
| system.maxBelægning
Rum maksimal belægning af enheden. |
få sat slet | DF | snor
(0-128 tegn) |
Ikke indstillet |
| behavior.ethernetEnabled (VBl)
Tænder/slukker systemets Ethernet-grænseflade. |
få sat slet | 38 | 110 | (Understøttet i VBl) 1 |
| behavior.bluetoothEnabled
Tænder/slukker systemets Bluetooth. |
få sat slet | 3A | 110 | 1 |
| behavior.wifiEnabled
Tænder/slukker systemets WiFi. |
få sat slet | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
Tænder/slukker HDMI. |
få sat slet | C9 | 110 | (Understøttet i VBl) 0 |
| usb.connectionStatus
USB-kabelforbindelsesstatus; 0, når den er afbrudt. |
få | 36 | 110 | 0 |
| usb.callStatus
Opkaldsstatus fra værten, der er tilsluttet systemets USB-port. |
få | 37 | 110 | 0 |
| audio.micMute
Slår lyden fra/til for systemmikrofonen. |
blive sat | 2 | 110 | 0 |
| audio.micMuteToggle
Skifter til lydløs tilstand for systemmikrofonen. |
stolpe | 15 | N/A | N/A |
| Navn/beskrivelse | Handlinger | Cmd ID | Række af værdier | Standardværdi |
| lyd.højttaler Dæmp
Slår lyden fra/til for systemhøjttaleren. |
stolpe | 34 | N/A | N/A |
| audio.loudspeakerMuteToggle
Skifter til lydløs tilstand for systemhøjttaleren. |
stolpe | 34 | N/A | N/A |
| lyd.højttalerVolume
Indstiller systemets højttalerlydstyrke. |
få sat slet | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
Øger systemets højttalerlydstyrke med et trin. |
stolpe | 4 | N/A | N/A |
| audio.loudspeakerVolumeDown
Sænker systemets højttalerlydstyrke med et trin. |
stolpe | 5 | N/A | N/A |
| kamera.zoom
Kameraets aktuelle zoomværdi. |
få sat slet | 6 | 1-10 | 1 |
| camera.pan
Kameraets aktuelle panoreringsværdi. |
få sat slet | 7 | -10-10 | 0 |
| kamera.tilt
Kameraets aktuelle hældningsværdi. |
få sat slet | 8 | -10-10 | 0 |
| camera.zoom ind
Zoomer kameraet ind med et trin. |
stolpe | 9 | N/A | N/A |
| camera.zoomOut
Zoomer kameraet ud med et trin. |
stolpe | OA | N/A | N/A |
| camera.pan Venstre
Panser kamera venstre med et trin. |
stolpe | OB | N/A | N/A |
| camera.pan Højre
Panorer kamera lige ved et trin. |
stolpe | oc | N/A | N/A |
| camera.tiltUp
Vipper kameraet op et trin. |
stolpe | OD | N/A | N/A |
| camera.tiltDown
Vipper kameraet et trin ned. |
stolpe | OE | N/A | N/A |
| camera.homeForudindstillet
Forudindstillet kamerahjem i panoreret tilt zoom rækkefølge |
få sat slet | 56 | 0 01 | |
| camera.firstPreset
Kameraet er først forudindstillet i panoreret tilt-zoomrækkefølge. |
få sat slet | 57 | 0 01 | |
| camera.second Forudindstilling
Kameraets anden forudindstilling i panorerings-tilt-zoomrækkefølge. |
få sat slet | 58 | 0 01 | |
| camera.savePresetHome
Gemmer de aktuelle PTZ-værdier i hjemmeforudindstillingen. |
stolpe | 12 | N/A | N/A |
| camera.savePresetFirst
Gemmer de aktuelle PTZ-værdier til den første forudindstilling. |
stolpe | 17 | N/A | N/A |
| camera.savePresetSecond
Gemmer de aktuelle PTZ-værdier til den anden forudindstilling. |
stolpe | 18 | N/A | N/A |
| Navn/beskrivelse | Handlinger | Cmd ID | Række af værdier | Standardværdi |
| kamera.anvend ActivePreset
Anvender den aktive forudindstilling til PTZ-indstillingerne. |
stolpe | OF | N/A | N/A |
| kamera.aktiv Forudindstillet
Dette er den aktive forudindstilling. Bemærk, ved kamerastart eller genstart er den aktive forudindstilling indstillet til Hjem. |
få sat slet | 13 | 11213 | 1 |
| kamera.tilstand
Kameratilstand. Når det er aktivt, streamer kameraet video. Når kameraet er inaktivt, streamer det ikke. Ved opgradering opgraderer kameraet firmwaren. |
få | 60 | aktivI inaktivI opgradering | inaktiv |
| autoframing.state
Slå kameraets autoframing-funktion til/fra. |
få sat slet | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Skift parringstilstanden fra til/fra til fra/til. |
stolpe | C6 | N/A | N/A |
| bluetooth.pairingState
Bluetooth-parringstilstand. Til-tilstanden tillader parring med enheden i et fast interval. Når parringsintervallet er forbi, skifter tilstanden til off. |
blive sat | 14 | 110 | 0 |
| bluetooth.state
Bluetooth og BLE tilstand. Til-tilstanden vil indikere, at Bluetooth og BLE er tændt; Off-tilstanden vil indikere, at Bluetooth og BLE er slukket. |
få | 67 | 110 | 0 |
| bluetooth.parret
Parret enhedsnavn. |
få | 6A | snor
(0-128 tegn) |
Ikke indstillet |
| bluetooth.tilsluttet
Forbindelsesstatus for parret enhed. |
få | 6B | 110 | 0 |
| bluetooth.streamState
Stream status for Bluetooth. |
få | C2 | 110 | 0 |
| bluetooth.callState
Status for Bluetooth-opkald. |
få | 6C | 110 | 0 |
| bluetooth.afbryde forbindelsen
Afbryd Bluetooth-enheden. |
stolpe | E4 | 11213 | N/A |
| netværk.dhcpState
DHCP-tilstand. Når DHCP-tilstand er aktiveret, konfigureres netværket via DHCP. Når DHCP-tilstand er slået fra, bruges statiske værdier. |
få sat slet | 74 | 110 | 1 |
| netværk.ip (VBl)
Statisk IP-adresse, når DHCP-tilstand er slået fra. |
få sat slet | 75 | (Understøttet i VBl) 0.0.0.0 | |
| netværk.stat (VBl)
Ethernet-modulets tilstand. |
få | 7F | tomgangsfejl!
associationI konfigurationI klarI koble fra! online |
(Understøttet i VBl) klar |
| Navn/beskrivelse | Handlinger | Cmd ID | Række af værdier | Standardværdi |
| netværk.mac (VBl)
MAC-adressen på LAN-grænsefladen. |
få | 80 | (Understøttet i VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP-tilstand. Når DHCP-tilstand er aktiveret, konfigureres WiFi via DHCP. Når DHCP-tilstand er slået fra, bruges statiske værdier. |
få sat slet | Al | 110 | 1 |
| wifi.ip
Statisk IP-adresse, når DHCP-tilstand er slået fra. |
få sat slet | A2 | 0.0.0.0 | |
| wifi.mac
MAC-adressen på WiFi-grænsefladen. |
få | AC | 00:00:00:00:00:00 | |
| wifi.stat
WiFi-modulets tilstand. |
få | BO | tomgangsfejl!
associationI konfigurationI klarI koble fra! online |
ledig |
| telemetry.peopleCount (VBl)
Antallet af personer, der tælles af kameraets autoframing-algoritme. |
få sat slet | DA | 0-99 | (Understøttet i VBl) 0 |
| telemetry.peoplePresent (VBl)
Sandt, når nogen personer er blevet opdaget af kameraets autoframing-algoritme. |
få sat slet | DC | 110 | (Understøttet i VBl) 0 |
Dokumenter/ressourcer
 |
BOSE Work Rest API-app [pdfBrugervejledning Work, Rest API, App, Work Rest API App |
