Aplicació BOSE Work Rest API
Introducció
Els dispositius Bose Videobar admeten la interfície de programació d'aplicacions de transferència d'estat de representació (API REST) per a la gestió i la supervisió de la xarxa. Aquesta guia proporciona instruccions per habilitar i configurar l'API REST als dispositius Videobar i ofereix una descripció detallada de les variables i operacions admeses.
Els elements de configuració i les operacions s'agrupen en aquestes categories:
- sistema
- comportament
- usb
- àudio
- càmera
- audioframing
- bluetooth
- xarxa (VBl)
- wifi
- telemetria (VBl)
La secció Referència d'ordres de l'API proporciona la informació següent per a cada objecte:
- Nom/Descripció Nom de l'objecte i descripció del seu ús.
- Accions Accions que es poden realitzar sobre l'objecte. L'acció pot
- ser un o més dels següents: obtenir, posar, eliminar, publicar.
- Interval de valors Valors acceptables per a l'objecte.
- Valor per defecte Valor per defecte de l'objecte. Aquest és el valor que s'utilitza si torneu el dispositiu als valors predeterminats de fàbrica.
Tots els valors s'especifiquen com a cadenes.
Avisos de marques comercials
- Bose, Bose Work i Videobar són marques comercials de Bose Corporation.
- La marca verbal i els logotips de Bluetooth són marques registrades propietat de Bluetooth SIG, Inc. i qualsevol ús d'aquestes marques per part de Bose Corporation és sota llicència.
- El terme HDMI és una marca comercial o marca comercial registrada de HDMI Licensing Administrator, Inc.
- Totes les altres marques comercials són propietat dels seus respectius propietaris.
Informació de privadesa
La vostra privadesa és important per a Bose, de manera que hem desenvolupat una Política de privadesa que inclou com recopilem, utilitzem, divulgem, transferim i emmagatzemem la vostra informació personal.
LLEGIU ATENCIÓ AQUESTA POLÍTICA DE PRIVACITAT PER ENTENIR COM MANEJEM LA SEVA INFORMACIÓ. SI NO ESTEU D'ACCORD AMB AQUESTA POLÍTICA DE PRIVACITAT, NO UTILITZEU ELS SERVEIS.
Habilitació i configuració de l'API REST
Per habilitar l'accés a l'API REST en un dispositiu, utilitzeu l'aplicació Bose Work Configuration, l'aplicació Bose Work Management o Web IU. Accediu a Xarxa> Configuració de l'API. Activeu l'accés a l'API i especifiqueu un nom d'usuari i una contrasenya de l'API. Necessitareu aquestes credencials de l'API per utilitzar qualsevol de les ordres de l'API REST. Consulteu les guies d'usuari de l'aplicació per obtenir més informació.
Prova de l'API REST
Podeu provar l'API REST de Videobar utilitzant la interfície Swagger OpenAPI que està incrustada al dispositiu. Per accedir a aquesta interfície, la Videobar ha d'estar connectada a una xarxa IP mitjançant la seva interfície cablejada o WiFi, i el vostre PC amfitrió ha d'estar a la mateixa xarxa o una xarxa que pugui accedir al dispositiu mitjançant HTTPS.
Connecteu el vostre ordinador a la barra de vídeo mitjançant la interfície USB. Inicieu l'aplicació Bose Work Configuration i inicieu la sessió per accedir als controls d'administració. Trieu la pàgina Xarxa > API i feu clic a l'enllaç:
Documentació de l'API REST (Web IU)
Si no esteu connectat al dispositiu mitjançant USB i el vostre PC es troba a la mateixa xarxa, podeu accedir a l'API REST mitjançant el vostre navegador navegant a l'adreça següent:
https://<videobar-ip-address>/doc-api
Ordres de l'API REST
La interfície de l'API REST de Videobar utilitza identificadors d'ordres en cadascun dels quatre mètodes HTTP admesos: obtenir, posar, suprimir i publicar.
A continuació es mostra una descripció dels quatre mètodes seguida d'una taula que descriu els mètodes admesos per a cadascuna de les ordres.
OBTENIR
El mètode "obté" accepta un únic identificador d'ordre o diversos identificadors delimitats per comes. Per example, per obtenir l'estat audio.micMute, l'ID d'ordre és 2. El URL és així:
https://192.168.1.40/api?query=2
El cos de la resposta és el següent, amb un valor de "O" que indica que el micròfon no està silenciat:
{“2”: {“estat”: “èxit”, “valor”: “0”}}
Per consultar diversos valors, separeu els ID d'ordres amb una coma. Per exampli, podeu consultar audio.micMute (ID=2) i system.firmwareVersion (ID=l6) com això:
https://192.168.1.40/api?query=2,16
Nota: no inclogueu espais entre diversos identificadors.
El resultat seria:
{“2”: {“estat”: “èxit”, “valor”: “0”}, “16”: {“estat”: “èxit”, “valor”: “1.2.13_fd6cc0e”}}
POSAR
Una ordre "posar" utilitza un format de cos JSON amb la clau "dades" i el valor els parells ID:valor.
Per example, per establir l'audio.loudspeakerVolume (ID=3) a 39, el cos "https://192.168.1.40/ api" és:
{“dades”:”{“3″:”39″}”}
La resposta és:
{“3”: {“estat”: “èxit”, “codi”: “0xe000”}}
Aquí teniu un exampli estableix diversos valors:
{“dades”:”{“2″:”1″,”3″:”70″}”}
La resposta és:
{“2”: {“estat”: “èxit”, “codi”: “0xe000”}, “3”: {“estat”: “èxit”, “codi”: “0xe000”}}
Els valors del "codi" de resposta poden ser qualsevol dels següents:
- 0xe000: èxit
- 0xe001: èxit: no hi ha canvis de valor
- 0xe002: Error: propietat no vàlida
- 0xe003: error: valor de propietat no vàlid
- 0xe004: error: acció de propietat no vàlida
- 0xe005: Error: missatge mal format
- 0xe006: Error - Accés denegat
PUBLICACIÓ
Una "publicació" és semblant a "posar" i s'utilitza per a accions, com ara activar/desactivar el silenci del micròfon i el volum de l'altaveu cap amunt/baix. Especifiqueu l'ID de l'ordre i utilitzeu una cadena buida per al valor.
Per example, per augmentar el volum de l'altaveu un cop, utilitzeu audio.loudspeakerVolumeUp (ID=4) amb el format del cos com aquest:
{“dades”:”{“4″:””}”}
El cos de resposta és:
{“4”: {“estat”: “èxit”, “codi”: “0xe000”}}
Els valors de "codi" de resposta possibles són els mateixos que es mostren per a l'ordre PUT.
ELIMINAR
El format de l'ordre "suprimeix" és similar a "obté" i el cos de la resposta és similar a "posa". Si feu servir suprimir, el valor tornarà al seu valor predeterminat.
Per example, per configurar el volum d'àudio.altaveu (ID=3) al seu valor predeterminat, el URL és així:
https://192.168.1.40/api?delete=3
El cos de resposta és:
{“3”: {“estat”: “èxit”, “codi”: “0xe000”}}
Hauríeu d'emetre un "get" per recuperar el nou valor, que en aquest cas és 50. Per exempleampLI:
Comandament:
https://192.168.1.40/api?query=3
Resposta:
{“3”: {“estat”: “èxit”, “valor”: “50”}}
Els valors de "codi" de resposta possibles són els mateixos que es mostren per a l'ordre PUT
Referència de comandaments de l'API REST de Videobar
| Nom/Descripció | Accions | Cmd ID | Interval de valors | Valor per defecte |
| system.reboot
Reinicia el sistema. |
publicació | 32 | N/A | N/A |
| system.serialNumber
Número de sèrie del dispositiu. |
aconseguir | 10 | corda
(17 caràcters) |
oooooooooooooxx |
| system.firmwareVersion
Versió del firmware que s'executa al dispositiu. S'estableix automàticament a l'actualització del microprogramari del sistema. |
aconseguir | 16 | corda
(1-16 caràcters) |
0.0.0 |
| sistema.model
Model d'aquest dispositiu. |
aconseguir | D6 | corda
(1-22 caràcters) |
No configurat |
| nom.sistema
Nom del dispositiu perquè es pugui identificar de manera única. |
posar esborrar | 25 | corda
(1-22 caràcters) |
No configurat |
| sistema.habitació
Ubicació de l'habitació del dispositiu |
posar esborrar | 26 | corda
(0-128 caràcters) |
No configurat |
| sistema.pis
Ubicació a terra del dispositiu. |
posar esborrar | 27 | corda
(0-128 caràcters) |
No configurat |
| sistema.edifici
Localització de l'edifici del dispositiu. |
posar esborrar | 28 | corda
(0-128 caràcters) |
No configurat |
| system.gpiMuteStatus (VBl)
Estat de silenci GPI (activat/desactivat). |
aconseguir | C7 | 110 | (Comptat amb VBl) 0 |
| system.maxOccupancy
Ocupació màxima de l'habitació de l'aparell. |
posar esborrar | DF | corda
(0-128 caràcters) |
No configurat |
| behavior.ethernetEnabled (VBl)
Activa/desactiva la interfície Ethernet del sistema. |
posar esborrar | 38 | 110 | (Comptat amb VBl) 1 |
| behavior.bluetoothEnabled
Activa/desactiva el sistema Bluetooth. |
posar esborrar | 3A | 110 | 1 |
| behavior.wifiEnabled
Activa/desactiva el sistema WiFi. |
posar esborrar | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
Activa/desactiva l'HDMI. |
posar esborrar | C9 | 110 | (Comptat amb VBl) 0 |
| usb.connectionStatus
estat de connexió del cable USB; 0 quan està desconnectat. |
aconseguir | 36 | 110 | 0 |
| usb.callStatus
Estat de la trucada des de l'amfitrió connectat al port USB del sistema. |
aconseguir | 37 | 110 | 0 |
| audio.micMute
Silencia/activa el silenci del micròfon del sistema. |
posar-se | 2 | 110 | 0 |
| audio.micMuteToggle
Commuta l'estat de silenci del micròfon del sistema. |
publicació | 15 | N/A | N/A |
| Nom/Descripció | Accions | Cmd ID | Interval de valors | Valor per defecte |
| àudio.altaveuMut
Silencia/activa el silenci de l'altaveu del sistema. |
publicació | 34 | N/A | N/A |
| audio.loudspeakerMuteToggle
Commuta l'estat de silenci de l'altaveu del sistema. |
publicació | 34 | N/A | N/A |
| àudio.altaveuVolum
Configura el volum de l'altaveu del sistema. |
posar esborrar | 3 | 0-100 | 50 |
| àudio.altaveuVolumeUp
Augmenta el volum de l'altaveu del sistema en un pas. |
publicació | 4 | N/A | N/A |
| audio.loudspeakerVolumeDown
Disminueix el volum de l'altaveu del sistema en un pas. |
publicació | 5 | N/A | N/A |
| càmera.zoom
El valor de zoom actual de la càmera. |
posar esborrar | 6 | 1-10 | 1 |
| càmera.pan
El valor de panoràmica actual de la càmera. |
posar esborrar | 7 | -10-10 | 0 |
| càmera.inclinació
Valor d'inclinació actual de la càmera. |
posar esborrar | 8 | -10-10 | 0 |
| càmera.apropar
Apropa la càmera en un pas. |
publicació | 9 | N/A | N/A |
| camera.zoomOut
Allunya la càmera en un pas. |
publicació | OA | N/A | N/A |
| càmera.pan Esquerra
Panorama de la càmera cap a l'esquerra un pas. |
publicació | OB | N/A | N/A |
| càmera.pan D'acord
Panorama de la càmera a la dreta un pas. |
publicació | oc | N/A | N/A |
| camera.tiltUp
Inclina la càmera cap amunt un pas. |
publicació | OD | N/A | N/A |
| camera.tiltDown
Inclina la càmera cap avall un pas. |
publicació | OE | N/A | N/A |
| camera.homePreset
Preestablert a casa de la càmera en ordre de zoom panoràmica i inclinació |
posar esborrar | 56 | 0 01 | |
| camera.firstPreset
Primera càmera preestablerta en ordre de zoom panoràmica i inclinació. |
posar esborrar | 57 | 0 01 | |
| càmera.segon Preset
Segon preestablert de la càmera en ordre de zoom panoràmica i inclinació. |
posar esborrar | 58 | 0 01 | |
| camera.savePresetHome
Desa a la configuració predeterminada d'inici els valors PTZ actuals. |
publicació | 12 | N/A | N/A |
| camera.savePresetFirst
Desa al primer valor predefinit els valors PTZ actuals. |
publicació | 17 | N/A | N/A |
| camera.savePresetSecond
Desa al segon valor predefinit els valors PTZ actuals. |
publicació | 18 | N/A | N/A |
| Nom/Descripció | Accions | Cmd ID | Interval de valors | Valor per defecte |
| càmera.aplicar ActivePreset
Aplica el valor predefinit actiu a la configuració PTZ. |
publicació | OF | N/A | N/A |
| càmera.activa Preestablert
Aquest és el valor predefinit actiu. Tingueu en compte que quan s'inicia o reinicia la càmera, el valor predefinit actiu es configura a Inici. |
posar esborrar | 13 | 11213 | 1 |
| càmera.estat
Estat de la càmera. Quan està activa, la càmera transmet vídeo. Quan està inactiva, la càmera no està en streaming. Quan s'actualitza, la càmera està actualitzant el firmware. |
aconseguir | 60 | Actualització activeI inactiveI | inactiu |
| autoframing.estat
Activa/desactiva la funció d'enquadrament automàtic de la càmera. |
posar esborrar | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Canvia l'estat de vinculació d'activat/desactivat a desactivat/activat. |
publicació | C6 | N/A | N/A |
| bluetooth.pairingState
Estat d'aparellament de Bluetooth. L'estat encès permetrà l'aparellament amb el dispositiu durant un interval fix. Un cop finalitzat l'interval d'aparellament, l'estat canviarà a desactivat. |
posar-se | 14 | 110 | 0 |
| bluetooth.estat
Estat de Bluetooth i BLE. L'estat activat indicarà que Bluetooth i BLE estan activats; l'estat desactivat indicarà que el Bluetooth i el BLE estan desactivats. |
aconseguir | 67 | 110 | 0 |
| bluetooth.aparellat
Nom del dispositiu vinculat. |
aconseguir | 6A | corda
(0-128 caràcters) |
No configurat |
| bluetooth.connectat
Estat de connexió del dispositiu aparellat. |
aconseguir | 6B | 110 | 0 |
| bluetooth.streamState
Estat del flux de Bluetooth. |
aconseguir | C2 | 110 | 0 |
| bluetooth.callState
Estat de la trucada Bluetooth. |
aconseguir | 6C | 110 | 0 |
| bluetooth.desconnectar
Desconnecteu el dispositiu Bluetooth. |
publicació | E4 | 11213 | N/A |
| network.dhcpState
Estat DHCP. Quan l'estat DHCP està activat, la xarxa es configurarà mitjançant DHCP. Quan l'estat DHCP està desactivat, s'utilitzen valors estàtics. |
posar esborrar | 74 | 110 | 1 |
| network.ip (VBl)
Adreça IP estàtica quan l'estat DHCP està desactivat. |
posar esborrar | 75 | (Comptat amb VBl) 0.0.0.0 | |
| estat.xarxa (VBl)
Estat del mòdul Ethernet. |
aconseguir | 7F | fracàs inactiu!
associacióI configuracióI llestI desconnectar! en línia |
(Comptat amb VBl) llest |
| Nom/Descripció | Accions | Cmd ID | Interval de valors | Valor per defecte |
| xarxa.mac (VBl)
Adreça MAC de la interfície LAN. |
aconseguir | 80 | (Comptat amb VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
Estat DHCP. Quan l'estat DHCP està activat, el WiFi es configurarà mitjançant DHCP. Quan l'estat DHCP està desactivat, s'utilitzen valors estàtics. |
posar esborrar | Al | 110 | 1 |
| wifi.ip
Adreça IP estàtica quan l'estat DHCP està desactivat. |
posar esborrar | A2 | 0.0.0.0 | |
| wifi.mac
Adreça MAC de la interfície WiFi. |
aconseguir | AC | 00:00:00:00:00:00 | |
| wifi.estat
Estat del mòdul WiFi. |
aconseguir | BO | fracàs inactiu!
associacióI configuracióI llestI desconnectar! en línia |
inactiu |
| telemetry.peopleCount (VBl)
El nombre de persones comptades per l'algoritme d'enquadrament automàtic de la càmera. |
posar esborrar | DA | 0-99 | (Comptat amb VBl) 0 |
| telemetry.peoplePresent (VBl)
És cert quan l'algoritme d'enquadrament automàtic de la càmera ha detectat persones. |
posar esborrar | DC | 110 | (Comptat amb VBl) 0 |
Documents/Recursos
 |
Aplicació BOSE Work Rest API [pdfGuia de l'usuari Work, Rest API, App, Work Rest API App |
