Aplicația BOSE Work Rest API
Introducere
Dispozitivele Bose Videobar acceptă interfața de programare a aplicației de transfer de stat reprezentativ (REST API) pentru gestionarea și monitorizarea rețelei. Acest ghid oferă instrucțiuni pentru activarea și configurarea API-ului REST pe dispozitivele Videobar și oferă o descriere detaliată a variabilelor și operațiunilor acceptate.
Elementele de configurare și operațiunile sunt grupate în următoarele categorii:
- sistem
- comportament
- USB
- audio
- aparat de fotografiat
- încadrarea audio
- bluetooth
- rețea (VBl)
- Wifi
- telemetrie (VBl)
Secțiunea API Command Reference oferă următoarele informații pentru fiecare obiect:
- Nume/Descriere Numele obiectului și descrierea utilizării acestuia.
- Acțiuni Acțiuni care pot fi efectuate asupra obiectului. Acțiunea poate
- fi unul sau mai multe dintre următoarele: obține, pune, șterge, postează.
- Interval de valori Valori acceptabile pentru obiect.
- Valoare implicită Valoarea implicită a obiectului. Aceasta este valoarea care este utilizată dacă reveniți dispozitivului la setările implicite din fabrică.
Toate valorile sunt specificate ca șiruri.
Notificări privind mărcile comerciale
- Bose, Bose Work și Videobar sunt mărci comerciale ale Bose Corporation.
- Marca verbală și logo-urile Bluetooth sunt mărci comerciale înregistrate deținute de Bluetooth SIG, Inc. și orice utilizare a acestor mărci de către Bose Corporation este sub licență.
- Termenul HDMI este o marcă comercială sau o marcă comercială înregistrată a HDMI Licensing Administrator, Inc.
- Toate celelalte mărci comerciale sunt proprietatea deținătorilor respectivi.
Informații de confidențialitate
Confidențialitatea dvs. este importantă pentru Bose, așa că am dezvoltat o Politică de confidențialitate care acoperă modul în care colectăm, folosim, dezvăluim, transferăm și stocăm informațiile dvs. personale.
VĂ RUGĂM CITIȚI CU ATENȚIE ACEASTĂ POLITICĂ DE CONFIDENTIALITATE PENTRU A ÎNȚELEGE CUM TRAȚIEM INFORMAȚIILE DVS. DACĂ NU SUNTEȚI DE ACORD CU ACEASTĂ POLITICĂ DE CONFIDENTIALITATE, VĂ RUGĂM SĂ NU UTILIZAȚI SERVICIILE.
Activarea și configurarea API-ului REST
Pentru a activa accesul la API-ul REST pe un dispozitiv, utilizați aplicația Bose Work Configuration, aplicația Bose Work Management sau Web UI. Accesați Setările Rețea> API. Activați accesul API și specificați un nume de utilizator și o parolă API. Veți avea nevoie de aceste acreditări API pentru a utiliza oricare dintre comenzile API REST. Vă rugăm să consultați ghidurile utilizatorului aplicației pentru mai multe informații.
Testarea API-ului REST
Puteți testa API-ul Videobar REST utilizând interfața Swagger OpenAPI care este încorporată în dispozitiv. Pentru a accesa această interfață, Videobar trebuie să fie conectată la o rețea IP prin interfața sa prin cablu sau WiFi, iar computerul gazdă trebuie să fie în aceeași rețea sau o rețea care poate accesa dispozitivul prin HTTPS.
Conectați computerul la Videobar prin interfața USB. Porniți aplicația Bose Work Configuration și conectați-vă pentru a accesa comenzile de administrare. Alegeți pagina Rețea > API și faceți clic pe link:
Documentația REST API (Web UI)
Dacă nu sunteți conectat la dispozitiv prin USB și computerul dvs. se află în aceeași rețea, puteți accesa API-ul REST prin browser, navigând la următoarea adresă:
https://<videobar-ip-address>/doc-api
Comenzi API REST
Interfața Videobar REST API utilizează ID-uri de comandă în fiecare dintre cele patru metode HTTP acceptate: obțineți, puneți, ștergeți și postați.
Mai jos este o descriere a celor patru metode urmată de un tabel care descrie metodele acceptate pentru fiecare dintre comenzi.
OBŢINE
Metoda „get” acceptă un singur ID de comandă sau mai multe ID-uri delimitate prin virgulă. De example, pentru a obține starea audio.micMute, ID-ul comenzii este 2 URL este cam asa:
https://192.168.1.40/api?query=2
Corpul răspunsului este după cum urmează, cu o valoare „O” indicând că microfonul nu este dezactivat:
{“2”: {“status”: „succes”, „valoare”: „0”}}
Pentru a căuta mai multe valori, separați mai multe ID-uri de comandă cu o virgulă. De example, puteți interoga pentru audio.micMute (ID=2) și system.firmwareVersion (ID=l6) așa:
https://192.168.1.40/api?query=2,16
Notă: nu includeți spații între mai multe ID-uri.
Rezultatul ar fi:
{“2”: {„status”: „succes”, „valoare”: „0”}, „16”: {„status”: „succes”, „valoare”: „1.2.13_fd6cc0e”}}
PUNE
O comandă „put” folosește un format de corp JSON, cu cheia fiind „date”, iar valoarea fiind perechi ID:valoare.
De example, pentru a seta audio.loudspeakerVolume (ID=3) la 39, corpul „https://192.168.1.40/ api” este:
{„date”:”{“3″:”39″}”}
Raspunsul este:
{“3”: {“status”: „succes”, „cod”: „0xe000”}}
Iată un exampsetarea mai multor valori:
{„date”:”{“2″:”1″,”3″:”70″}”}
Raspunsul este:
{“2”: {„status”: „succes”, „cod”: „0xe000”}, „3”: {„stare”: „succes”, „cod”: „0xe000”}}
Valorile „codului” de răspuns pot fi oricare dintre următoarele:
- 0xe000 : Succes
- 0xe001: Succes – Nicio modificare a valorii
- 0xe002: Eroare – Proprietate nevalidă
- 0xe003: Eroare – Valoare de proprietate nevalidă
- 0xe004: Eroare – Acțiune de proprietate nevalidă
- 0xe005: Eroare – Mesaj incorect
- 0xe006: Eroare – Acces refuzat
POST
O „postare” este similară cu „pune” și este folosită pentru acțiuni, cum ar fi comutarea între microfon și volumul difuzorului în sus/jos. Specificați ID-ul comenzii și utilizați un șir gol pentru valoare.
De example, pentru a crește volumul difuzorului cu o bifare, utilizați audio.loudspeakerVolumeUp (ID=4) cu formatul corpului astfel:
{„date”:”{“4″:””}”}
Corpul de răspuns este:
{“4”: {“status”: „succes”, „cod”: „0xe000”}}
Valorile posibile de „cod” de răspuns sunt aceleași cu cele enumerate pentru comanda PUT.
ŞTERGE
Formatul comenzii „șterge” este similar cu „get”, iar corpul răspunsului este similar cu „put”. Utilizarea ștergerii va restabili valoarea implicită.
De example, pentru a seta volumul audio.difuzor (ID=3) la valoarea sa implicită, the URL este cam asa:
https://192.168.1.40/api?delete=3
Corpul de răspuns este:
{“3”: {“status”: „succes”, „cod”: „0xe000”}}
Ar trebui să emiteți un „get” pentru a prelua noua valoare, care în acest caz este 50. De exempluamppe:
Comanda:
https://192.168.1.40/api?query=3
Răspuns:
{“3”: {“status”: „succes”, „valoare”: „50”}}
Valorile posibile de „cod” de răspuns sunt aceleași cu cele enumerate pentru comanda PUT
Referință pentru comenzile API REST Videobar
| Nume/Descriere | Acțiuni | Cmd ID | Gama de valori | Valoare implicită |
| sistem.repornire
Repornește sistemul. |
post | 32 | N / A | N / A |
| system.serialNumber
Numărul de serie al dispozitivului. |
obţine | 10 | şir
(17 caractere) |
ooooooxooooooooxx |
| system.firmwareVersion
Versiunea firmware-ului care rulează pe dispozitiv. Acesta este setat automat la actualizarea firmware-ului sistemului. |
obţine | 16 | şir
(1-16 caractere) |
0.0.0 |
| sistem.model
Modelul acestui dispozitiv. |
obţine | D6 | şir
(1-22 caractere) |
Nu este setat |
| sistem.nume
Numele dispozitivului, astfel încât să poată fi identificat în mod unic. |
get put delete | 25 | şir
(1-22 caractere) |
Nu este setat |
| sistem.camera
Locația camerei dispozitivului |
get put delete | 26 | şir
(0-128 caractere) |
Nu este setat |
| sistem.pardoseală
Locația la podea a dispozitivului. |
get put delete | 27 | şir
(0-128 caractere) |
Nu este setat |
| sistem.cladire
Locația de clădire a dispozitivului. |
get put delete | 28 | şir
(0-128 caractere) |
Nu este setat |
| system.gpiMuteStatus (VBl)
Stare GPI mute (pornit/dezactivat). |
obţine | C7 | 110 | (Acceptat în VBl) 0 |
| system.maxOccupancy
Ocuparea maximă a aparatului în cameră. |
get put delete | DF | şir
(0-128 caractere) |
Nu este setat |
| behavior.ethernetEnabled (VBl)
Pornește/oprește interfața Ethernet a sistemului. |
get put delete | 38 | 110 | (Acceptat în VBl) 1 |
| comportament.bluetoothActivat
Pornește/oprește sistemul Bluetooth. |
get put delete | 3A | 110 | 1 |
| behavior.wifiEnabled
Pornește/oprește sistemul WiFi. |
get put delete | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
Pornește/oprește HDMI. |
get put delete | C9 | 110 | (Acceptat în VBl) 0 |
| usb.connectionStatus
Starea conexiunii cablului USB; 0 când este deconectat. |
obţine | 36 | 110 | 0 |
| usb.callStatus
Starea apelului de la gazda conectată la portul USB al sistemului. |
obţine | 37 | 110 | 0 |
| audio.micMute
Dezactivează/activează sunetul microfonului de sistem. |
pune-te | 2 | 110 | 0 |
| audio.micMuteToggle
Comută starea de sunet a microfonului de sistem. |
post | 15 | N / A | N / A |
| Nume/Descriere | Acțiuni | Cmd ID | Gama de valori | Valoare implicită |
| audio.difuzor Mute
Dezactivează/activează sunetul difuzorului sistemului. |
post | 34 | N / A | N / A |
| audio.difuzorMuteToggle
Comută starea de sunet a difuzorului de sistem. |
post | 34 | N / A | N / A |
| audio.difuzorVolum
Setează volumul difuzorului sistemului. |
get put delete | 3 | 0-100 | 50 |
| audio.difuzorVolumeUp
Mărește volumul difuzorului sistemului cu un pas. |
post | 4 | N / A | N / A |
| audio.difuzorVolumeDown
Reduce volumul difuzorului sistemului cu un pas. |
post | 5 | N / A | N / A |
| camera.zoom
Valoarea actuală de zoom a camerei. |
get put delete | 6 | 1-10 | 1 |
| camera.pan
Valoarea actuală a panoului camerei. |
get put delete | 7 | -10-10 | 0 |
| cameră.înclinare
Valoarea actuală a înclinării camerei. |
get put delete | 8 | -10-10 | 0 |
| camera.zoom In
Mărește camera cu un pas. |
post | 9 | N / A | N / A |
| camera.zoomOut
Micșește camera cu un pas. |
post | OA | N / A | N / A |
| camera.pan Stânga
Deplasează camera la stânga cu un pas. |
post | OB | N / A | N / A |
| camera.pan Corect
Deplasați camera direct cu un pas. |
post | oc | N / A | N / A |
| camera.tiltUp
Înclină camera în sus cu un pas. |
post | OD | N / A | N / A |
| camera.tiltDown
Înclină camera în jos cu un pas. |
post | OE | N / A | N / A |
| camera.homePreset
Camera de pornire presetată în ordinea de zoom pan tilt |
get put delete | 56 | 0 01 | |
| camera.firstPreset
Aparatul foto este prima presetat în ordinea de zoom pan tilt. |
get put delete | 57 | 0 01 | |
| camera.a doua Presetare
A doua cameră presetată în ordinea de zoom pan tilt. |
get put delete | 58 | 0 01 | |
| camera.savePresetHome
Salvează în presetarea de acasă valorile PTZ curente. |
post | 12 | N / A | N / A |
| camera.savePresetFirst
Salvează la prima presetare valorile PTZ curente. |
post | 17 | N / A | N / A |
| camera.savePresetSecond
Salvează la a doua presetare valorile PTZ curente. |
post | 18 | N / A | N / A |
| Nume/Descriere | Acțiuni | Cmd ID | Gama de valori | Valoare implicită |
| camera.aplic ActivePreset
Aplică presetarea activă la setările PTZ. |
post | OF | N / A | N / A |
| camera.activ Presetat
Aceasta este presetarea activă. Rețineți că la pornirea sau repornirea camerei, presetarea activă este setată la Acasă. |
get put delete | 13 | 11213 | 1 |
| camera.stare
Starea camerei. Când este activă, camera redă în flux video. Când este inactiv, camera nu este transmisă în flux. Când faceți upgrade, camera actualizează firmware-ul. |
obţine | 60 | ActiveI inactiveI upgrade | inactiv |
| autoframing.stare
Activați/dezactivați funcția de încadrare automată a camerei. |
get put delete | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Comutați starea de asociere de la activat/dezactivat la dezactivat/activat. |
post | C6 | N / A | N / A |
| bluetooth.pairingState
Stare de asociere Bluetooth. Starea pornit va permite asocierea cu dispozitivul pentru un interval fix. Odată ce intervalul de asociere se termină, starea se va schimba în dezactivat. |
pune-te | 14 | 110 | 0 |
| bluetooth.stare
Stare Bluetooth și BLE. Starea pornit va indica faptul că Bluetooth și BLE sunt activate; starea oprită va indica faptul că Bluetooth și BLE sunt oprite. |
obţine | 67 | 110 | 0 |
| bluetooth.pereche
Numele dispozitivului asociat. |
obţine | 6A | şir
(0-128 caractere) |
Nu este setat |
| bluetooth.conectat
Starea conexiunii dispozitivului asociat. |
obţine | 6B | 110 | 0 |
| bluetooth.streamState
Starea fluxului Bluetooth. |
obţine | C2 | 110 | 0 |
| bluetooth.callState
Starea apelului Bluetooth. |
obţine | 6C | 110 | 0 |
| bluetooth.deconectare
Deconectați dispozitivul Bluetooth. |
post | E4 | 11213 | N / A |
| network.dhcpState
stare DHCP. Când starea DHCP este activată, rețeaua va fi configurată prin DHCP. Când starea DHCP este dezactivată, sunt utilizate valori statice. |
get put delete | 74 | 110 | 1 |
| network.ip (VBl)
Adresă IP statică când starea DHCP este dezactivată. |
get put delete | 75 | (Acceptat în VBl) 0.0.0.0 | |
| stare.rețea (VBl)
Starea modulului Ethernet. |
obţine | 7F | eșec inactiv!
asociereI configuratieI gataI deconecta! online |
(Acceptat în VBl) gata |
| Nume/Descriere | Acțiuni | Cmd ID | Gama de valori | Valoare implicită |
| reţea.mac (VBl)
adresa MAC a interfeței LAN. |
obţine | 80 | (Acceptat în VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
stare DHCP. Când starea DHCP este activată, WiFi va fi configurat prin DHCP. Când starea DHCP este dezactivată, sunt utilizate valori statice. |
get put delete | Al | 110 | 1 |
| wifi.ip
Adresă IP statică când starea DHCP este dezactivată. |
get put delete | A2 | 0.0.0.0 | |
| wifi.mac
Adresa MAC a interfeței WiFi. |
obţine | AC | 00:00:00:00:00:00 | |
| wifi.stare
Starea modulului WiFi. |
obţine | BO | eșec inactiv!
asociereI configuratieI gataI deconecta! online |
inactiv |
| telemetrie.peopleCount (VBl)
Numărul de persoane numărate de algoritmul de încadrare automată a camerei. |
get put delete | DA | 0-99 | (Acceptat în VBl) 0 |
| telemetrie.peoplePresent (VBl)
Adevărat atunci când orice persoană a fost detectată de algoritmul de încadrare automată a camerei. |
get put delete | DC | 110 | (Acceptat în VBl) 0 |
Documente/Resurse
 |
Aplicația BOSE Work Rest API [pdfGhid de utilizare Work, Rest API, App, Work Rest API App |
