BOSE Work Rest API-app
Introduksjon
Bose Videobar-enhetene støtter programmeringsgrensesnitt for representasjonstilstandsoverføring (REST API) for nettverksadministrasjon og overvåking. Denne veiledningen gir instruksjoner for å aktivere og konfigurere REST API på Videobar-enheter, og den gir en detaljert beskrivelse av de støttede variablene og operasjonene.
Konfigurasjonselementer og operasjoner er gruppert i disse kategoriene:
- system
- oppførsel
- usb
- lyd
- kamera
- audioframing
- bluetooth
- nettverk (VBl)
- wifi
- telemetri (VBl)
API Command Reference-delen gir følgende informasjon for hvert objekt:
- Navn/beskrivelse Navn på objektet og beskrivelse av bruken.
- Handlinger Handlinger som kan utføres på objektet. Handlingen kan
- være ett eller flere av følgende: få, legg, slett, post.
- Område for verdier Akseptable verdier for objektet.
- Standardverdi Standardverdien til objektet. Dette er verdien som brukes hvis du tilbakestiller enheten til fabrikkinnstillingene.
Alle verdier er spesifisert som strenger.
Varemerkemerknader
- Bose, Bose Work og Videobar er varemerker for Bose Corporation.
- "Bluetooth"-ordmerket og -logoer er registrerte varemerker som eies av Bluetooth SIG, Inc. og all bruk av slike merker av Bose Corporation er under lisens.
- Begrepet HDMI er et varemerke eller registrert varemerke for HDMI Licensing Administrator, Inc.
- Alle andre varemerker tilhører sine respektive eiere.
Personverninformasjon
Personvernet ditt er viktig for Bose, så vi har utviklet en personvernerklæring som dekker hvordan vi samler inn, bruker, avslører, overfører og lagrer personopplysningene dine.
VENNLIGST LES DENNE PERSONVERNSRETNINGENE NØYE FOR Å FORSTÅ HVORDAN VI HÅNDTER INFORMASJONEN DIN. HVIS DU IKKE SAMTYKKER DENNE PERSONVERNSRETNINGENE, VENNLIGST IKKE BRUKE TJENESTERNE.
Aktivering og konfigurering av REST API
For å aktivere tilgang til REST API på en enhet, bruk Bose Work Configuration-appen, Bose Work Management-appen eller Web UI. Få tilgang til Network> API-innstillingene. Aktiver API-tilgang og spesifiser et API-brukernavn og passord. Du trenger disse API-legitimasjonene for å bruke noen av REST API-kommandoene. Se brukerveiledningene for programmet for mer informasjon.
Tester REST API
Du kan teste Videobar REST API ved å bruke Swagger OpenAPI-grensesnittet som er innebygd i enheten. For å få tilgang til dette grensesnittet må Videobar være koblet til et IP-nettverk via kablet eller WiFi-grensesnitt, og verts-PC-en må være på samme nettverk eller et nettverk som kan få tilgang til enheten via HTTPS.
Koble PC-en til videolinjen via USB-grensesnittet. Start Bose Work Configuration-appen og logg på for å få tilgang til administratorkontroller. Velg Nettverk > API-siden og klikk på lenken:
REST API-dokumentasjon (Web Brukergrensesnitt)
Hvis du ikke er koblet til enheten via USB og PC-en din er på samme nettverk, kan du få tilgang til REST API via nettleseren din ved å bla til følgende adresse:
https://<videobar-ip-address>/doc-api
REST API-kommandoer
Videobar REST API-grensesnittet bruker kommando-ID-er i hver av de fire HTTP-metodene som støttes: get, put, delete og post.
Nedenfor er en beskrivelse av de fire metodene etterfulgt av en tabell som beskriver metodene som støttes for hver av kommandoene.
BLI
"get"-metoden godtar en enkelt kommando-ID eller flere kommadelte IDer. For eksample, for å få audio.micMute-tilstanden, er kommando-ID-en 2. The URL er slik:
https://192.168.1.40/api?query=2
Svarteksten er som følger, med verdien "O" som indikerer at mikrofonen ikke er dempet:
{“2”: {“status”: “suksess”, “verdi”: “0”}}
For å spørre etter flere verdier, separer flere kommando-ID-er med komma. For eksample, kan du spørre etter audio.micMute (ID=2) og system.firmwareVersion (ID=l6) slik:
https://192.168.1.40/api?query=2,16
Merk: Ikke ta med mellomrom mellom flere ID-er.
Resultatet vil være:
{“2”: {“status”: “success”, “value”: “0”}, “16”: {“status”: “success”, “value”: “1.2.13_fd6cc0e”}}
SETTE
En "put"-kommando bruker et JSON-kroppsformat med nøkkelen "data" og verdien er ID:verdi-par.
For eksample, for å sette audio.loudspeakerVolume (ID=3) til 39, er "https://192.168.1.40/ api"-kroppen:
{“data”:”{“3″:”39″}”}
Svaret er:
{"3": {"status": "suksess", "kode": "0xe000"}}
Her er en eksample innstilling av flere verdier:
{“data”:”{“2″:”1″,”3″:”70″}”}
Svaret er:
{“2”: {“status”: “success”, “code”: “0xe000”}, “3”: {“status”: “success”, “code”: “0xe000”}}
Respons "kode"-verdier kan være en av følgende:
- 0xe000 : Suksess
- 0xe001 : Suksess – Ingen endring i verdi
- 0xe002 : Feil – Ugyldig egenskap
- 0xe003 : Feil – Ugyldig egenskapsverdi
- 0xe004 : Feil – Ugyldig egenskapshandling
- 0xe005 : Feil – Meldingen er feil
- 0xe006 : Feil – Tilgang nektet
STOLPE
Et "innlegg" ligner på "sett" og brukes til handlinger, for eksempel slå av mikrofondemping og høyttalervolum opp/ned. Du spesifiserer kommando-ID og bruker en tom streng for verdien.
For eksample, for å øke høyttalervolumet ett hake, bruk audio.loudspeakerVolumeUp (ID=4) med kroppsformatet slik:
{“data”:”{“4″:””}”}
Svarorganet er:
{"4": {"status": "suksess", "kode": "0xe000"}}
De mulige responsverdiene for "kode" er de samme som er oppført for PUT-kommandoen.
SLETT
"delete"-kommandoformatet ligner på "get", og svarteksten ligner på "put". Bruk av sletting vil sette verdien tilbake til standardverdien.
For eksample, for å sette lyd.høyttalervolumet (ID=3) til standardverdien, den URL er slik:
https://192.168.1.40/api?delete=3
Svarorganet er:
{"3": {"status": "suksess", "kode": "0xe000"}}
Du må utstede en "get" for å hente den nye verdien, som i dette tilfellet er 50. F.eks.ampde:
Kommando:
https://192.168.1.40/api?query=3
Svar:
{“3”: {“status”: “suksess”, “verdi”: “50”}}
De mulige responsverdiene for "kode" er de samme som er oppført for PUT-kommandoen
Videobar REST API Command Reference
| Navn/beskrivelse | Handlinger | Cmd ID | Utvalg av verdier | Standardverdi |
| system.reboot
Starter systemet på nytt. |
stolpe | 32 | N/A | N/A |
| system.serienummer
Serienummeret til enheten. |
bli | 10 | streng
(17 tegn) |
ååååååååååååååå |
| system.firmwareVersion
Versjon av fastvaren som kjører på enheten. Dette settes automatisk ved oppgradering av systemfastvare. |
bli | 16 | streng
(1-16 tegn) |
0.0.0 |
| system.modell
Modell av denne enheten. |
bli | D6 | streng
(1-22 tegn) |
Ikke satt |
| system.navn
Navnet på enheten slik at den kan identifiseres unikt. |
få satt slett | 25 | streng
(1-22 tegn) |
Ikke satt |
| system.rom
Romplassering av enheten |
få satt slett | 26 | streng
(0-128 tegn) |
Ikke satt |
| system.etasje
Gulvplassering av enheten. |
få satt slett | 27 | streng
(0-128 tegn) |
Ikke satt |
| systembygging
Byggeplassering av enheten. |
få satt slett | 28 | streng
(0-128 tegn) |
Ikke satt |
| system.gpiMuteStatus (VBl)
GPI mute-status (på/av). |
bli | C7 | 110 | (Støttes i VBl) 0 |
| system.maxBelegg
Maksimalt antall rom for enheten. |
få satt slett | DF | streng
(0-128 tegn) |
Ikke satt |
| behavior.ethernetEnabled (VBl)
Slår på/av systemets Ethernet-grensesnitt. |
få satt slett | 38 | 110 | (Støttes i VBl) 1 |
| behavior.bluetoothEnabled
Slår på/av systemets Bluetooth. |
få satt slett | 3A | 110 | 1 |
| behavior.wifiEnabled
Slår av/på systemets WiFi. |
få satt slett | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
Slår på/av HDMI. |
få satt slett | C9 | 110 | (Støttes i VBl) 0 |
| usb.connectionStatus
USB-kabeltilkoblingsstatus; 0 når den er frakoblet. |
bli | 36 | 110 | 0 |
| usb.callStatus
Anropsstatus fra verten som er koblet til USB-porten på systemet. |
bli | 37 | 110 | 0 |
| audio.micMute
Slår av/på systemmikrofonen. |
bli satt | 2 | 110 | 0 |
| audio.micMuteToggle
Slår av på demp-tilstanden til systemmikrofonen. |
stolpe | 15 | N/A | N/A |
| Navn/beskrivelse | Handlinger | Cmd ID | Utvalg av verdier | Standardverdi |
| audio.loudspeakerMute
Slår av/på systemhøyttaleren. |
stolpe | 34 | N/A | N/A |
| audio.loudspeakerMuteToggle
Veksler på dempet tilstand for systemhøyttaleren. |
stolpe | 34 | N/A | N/A |
| lyd.høyttalerVolum
Stiller inn systemets høyttalervolum. |
få satt slett | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
Øker systemets høyttalervolumet med ett trinn. |
stolpe | 4 | N/A | N/A |
| audio.loudspeakerVolumeNed
Reduserer systemets høyttalervolumet med ett trinn. |
stolpe | 5 | N/A | N/A |
| kamera.zoom
Kameraets nåværende zoomverdi. |
få satt slett | 6 | 1-10 | 1 |
| kamera.pan
Kameraets gjeldende panoreringsverdi. |
få satt slett | 7 | -10-10 | 0 |
| kamera.tilt
Kameraets gjeldende tilt-verdi. |
få satt slett | 8 | -10-10 | 0 |
| camera.zoom inn
Zoomer inn kameraet med ett trinn. |
stolpe | 9 | N/A | N/A |
| camera.zoomOut
Zoomer ut kameraet med ett trinn. |
stolpe | OA | N/A | N/A |
| kamera.pan Igjen
Panser kamera igjen med ett trinn. |
stolpe | OB | N/A | N/A |
| kamera.pan Høyre
Panorer kamera rett med ett trinn. |
stolpe | oc | N/A | N/A |
| camera.tiltUp
Vipper kameraet ett trinn opp. |
stolpe | OD | N/A | N/A |
| camera.tiltDown
Vipper kameraet ned ett trinn. |
stolpe | OE | N/A | N/A |
| camera.homeForhåndsinnstilling
Forhåndsinnstilt hjemmekamera i panorerings-zoomrekkefølge |
få satt slett | 56 | 0 01 | |
| camera.firstPreset
Kameraet er først forhåndsinnstilt i panorerings-zoomrekkefølge. |
få satt slett | 57 | 0 01 | |
| camera.second Forhåndsinnstilling
Kamera nummer to forhåndsinnstilt i panorerings-zoomrekkefølge. |
få satt slett | 58 | 0 01 | |
| camera.savePresetHome
Lagrer gjeldende PTZ-verdier i hjemmeforhåndsinnstillingen. |
stolpe | 12 | N/A | N/A |
| camera.savePresetFirst
Lagrer gjeldende PTZ-verdier til den første forhåndsinnstillingen. |
stolpe | 17 | N/A | N/A |
| camera.savePresetSecond
Lagrer gjeldende PTZ-verdier til den andre forhåndsinnstillingen. |
stolpe | 18 | N/A | N/A |
| Navn/beskrivelse | Handlinger | Cmd ID | Utvalg av verdier | Standardverdi |
| kamera.bruke ActivePreset
Bruker den aktive forhåndsinnstillingen på PTZ-innstillingene. |
stolpe | OF | N/A | N/A |
| kamera.aktivt Forhåndsinnstilt
Dette er den aktive forhåndsinnstillingen. Merk at ved start eller omstart av kamera er den aktive forhåndsinnstillingen satt til Hjem. |
få satt slett | 13 | 11213 | 1 |
| kamera.tilstand
Kameratilstand. Når det er aktivt, strømmer kameraet video. Når kameraet er inaktivt, strømmer ikke kameraet. Ved oppgradering oppgraderer kameraet firmware. |
bli | 60 | aktivI inaktivI oppgradering | inaktiv |
| autoframing.state
Slå på/av kameraets autoframing-funksjon. |
få satt slett | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Bytt sammenkoblingstilstand fra på/av til av/på. |
stolpe | C6 | N/A | N/A |
| bluetooth.pairingState
Bluetooth-paringstilstand. På-tilstanden vil tillate sammenkobling med enheten i et fast intervall. Når paringsintervallet er over, endres tilstanden til av. |
bli satt | 14 | 110 | 0 |
| bluetooth.state
Bluetooth og BLE tilstand. På-tilstanden vil indikere at Bluetooth og BLE er på; av-tilstanden vil indikere at Bluetooth og BLE er av. |
bli | 67 | 110 | 0 |
| bluetooth.paret
Navn på sammenkoblet enhet. |
bli | 6A | streng
(0-128 tegn) |
Ikke satt |
| bluetooth.tilkoblet
Tilkoblingsstatus for sammenkoblet enhet. |
bli | 6B | 110 | 0 |
| bluetooth.streamState
Strømstatus for Bluetooth. |
bli | C2 | 110 | 0 |
| bluetooth.callState
Status for Bluetooth-anrop. |
bli | 6C | 110 | 0 |
| bluetooth.frakoble
Koble fra Bluetooth-enheten. |
stolpe | E4 | 11213 | N/A |
| network.dhcpState
DHCP-tilstand. Når DHCP-tilstand er på, vil nettverket konfigureres via DHCP. Når DHCP-tilstand er av, brukes statiske verdier. |
få satt slett | 74 | 110 | 1 |
| network.ip (VBl)
Statisk IP-adresse når DHCP-tilstand er av. |
få satt slett | 75 | (Støttes i VBl) 0.0.0.0 | |
| nettverk.stat (VBl)
Status for Ethernet-modulen. |
bli | 7F | tomgangsfeil!
associationI konfigurasjonI klarI koble fra! på nett |
(Støttes i VBl) klar |
| Navn/beskrivelse | Handlinger | Cmd ID | Utvalg av verdier | Standardverdi |
| nettverk.mac (VBl)
MAC-adressen til LAN-grensesnittet. |
bli | 80 | (Støttes i VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP-tilstand. Når DHCP-tilstand er på, vil WiFi bli konfigurert gjennom DHCP. Når DHCP-tilstand er av, brukes statiske verdier. |
få satt slett | Al | 110 | 1 |
| wifi.ip
Statisk IP-adresse når DHCP-tilstand er av. |
få satt slett | A2 | 0.0.0.0 | |
| wifi.mac
MAC-adressen til WiFi-grensesnittet. |
bli | AC | 00:00:00:00:00:00 | |
| wifi.state
Status for WiFi-modulen. |
bli | BO | tomgangsfeil!
associationI konfigurasjonI klarI koble fra! på nett |
uvirksom |
| telemetry.peopleCount (VBl)
Antall personer som telles av kameraets autoframing-algoritme. |
få satt slett | DA | 0-99 | (Støttes i VBl) 0 |
| telemetry.peoplePresent (VBl)
Sant når noen personer har blitt oppdaget av kameraets autoframing-algoritme. |
få satt slett | DC | 110 | (Støttes i VBl) 0 |
Dokumenter / Ressurser
 |
BOSE Work Rest API-app [pdfBrukerhåndbok Work, Rest API, App, Work Rest API-app |
