BOSE Work Rest API Apo
Enkonduko
La Bose Videobar-aparatoj subtenas reprezentan ŝtattransigan programinterfacon (REST API) por retadministrado kaj monitorado. Ĉi tiu gvidilo provizas instrukciojn por ebligi kaj agordi REST API sur Videobar-aparatoj, kaj ĝi provizas detalan priskribon de la subtenataj variabloj kaj operacioj.
Agordaj eroj kaj operacioj estas grupigitaj en ĉi tiuj kategorioj:
- sistemo
- konduto
- usb
- audio
- fotilo
- aŭdkadrado
- bluetooth
- reto (VBl)
- wifi
- telemetrio (VBl)
La sekcio de API Command Reference provizas la sekvajn informojn por ĉiu objekto:
- Nomo/Priskribo Nomo de la objekto kaj priskribo de ĝia uzo.
- Agoj Agoj kiuj povas esti faritaj sur la objekto. La ago povas
- estu unu aŭ pli el la jenaj: akiri, meti, forigi, afiŝi.
- Gamo de Valoroj Akcepteblaj valoroj por la objekto.
- Defaŭlta valoro Defaŭlta valoro de la objekto. Ĉi tiu estas la valoro kiu estas uzata se vi restarigas la aparaton al fabriko defaŭlta.
Ĉiuj valoroj estas specifitaj kiel ĉenoj.
Varmarko-Avizoj
- Bose, Bose Work kaj Videobar estas varmarkoj de Bose Corporation.
- La vortmarko Bluetooth” kaj emblemoj estas registritaj varmarkoj posedataj de Bluetooth SIG, Inc. kaj ajna uzo de tiaj markoj fare de Bose Corporation estas sub licenco.
- La termino HDMI estas varmarko aŭ registrita varmarko de HDMI Licensing Administrator, Inc.
- Ĉiuj aliaj varmarkoj estas la posedaĵo de siaj respektivaj posedantoj.
Privateca Informo
Via privateco estas grava por Bose, do ni evoluigis Privatecan Politikon, kiu kovras kiel ni kolektas, uzas, malkaŝas, transdonas kaj konservas viajn personajn informojn.
BONVOLU LEGI ĈI ĈI POLITIKON PRI PRIVATECO POR KOPRI KIEL NI traktas VIAN INFORMON. SE VI NE AKCORDAS ĈI ĈI PRI POLITIKO DE PRIVATECO, BONVOLU NE UZU LA SERVOJN.
Ebligante kaj Agordante la REST API
Por ebligi aliron al la REST API en aparato, uzu la apon Bose Work Configuration, la apon Bose Work Management aŭ la Web UI. Aliru la Reto> API-agordojn. Ebligu API-aliron kaj specifu API-uzantnomon kaj pasvorton. Vi bezonos ĉi tiujn API-akreditaĵojn por uzi iun el la REST-API-komandoj. Bonvolu referenci la aplikajn uzantgvidilojn por pliaj informoj.
Testante la REST API
Vi povas testi la Videobar REST API uzante la Swagger OpenAPI-interfacon, kiu estas enigita en la aparato. Por aliri ĉi tiun interfacon, la Videobar devas esti konektita al IP-reto per sia kablita aŭ WiFi-interfaco, kaj via gastiga komputilo devas esti en la sama reto aŭ reto kiu povas aliri la aparaton per HTTPS.
Konektu vian komputilon al la Videobar per la USB-interfaco. Komencu la apon Bose Work Configuration kaj ensalutu por aliri administrajn kontrolojn. Elektu la paĝon Reto > API kaj alklaku la ligilon:
Dokumentado de REST API (Web UI)
Se vi ne estas konektita al la aparato per USB kaj via komputilo estas en la sama reto, vi povas aliri la REST API per via retumilo foliumante al la sekva adreso:
https://<videobar-ip-address>/doc-api
REST-API-Komandoj
La Videobar REST API-interfaco uzas komandidentigilojn en ĉiu el la kvar HTTP-metodoj subtenataj: akiri, meti, forigi kaj afiŝi.
Malsupre estas priskribo de la kvar metodoj sekvataj de tabelo priskribanta la metodojn subtenatajn por ĉiu el la komandoj.
GET
La "akiri" metodo akceptas ununuran komandan ID aŭ plurajn komo-limigitajn ID-ojn. Por ekzample, por ricevi la staton audio.micMute, la komanda ID estas 2. La URL estas tiel:
https://192.168.1.40/api?query=2
La respondkorpo estas kiel sekvas, kun valoro de "O" indikante ke la mikrofono ne estas silentigita:
{“2”: {“stato”: “sukceso”, “valoro”: “0”}}
Por demandi plurajn valorojn, apartigu plurajn komandidentigilojn per komo. Por ekzample, vi povus demandi por audio.micMute (ID=2) kaj system.firmwareVersion (ID=l6) jene:
https://192.168.1.40/api?query=2,16
Noto: Ne inkluzivu spacojn inter pluraj identigiloj.
La rezulto estus:
{“2”: {“stato”: “sukceso”, “valoro”: “0”}, “16”: {“stato”: “sukceso”, “valoro”: “1.2.13_fd6cc0e”}}
METU
Komando "metu" uzas JSON-korpan formaton kun la ŝlosilo estas "datumoj" kaj la valoro estas ID:valoraj paroj.
Por ekzample, por agordi la audio.loudspeakerVolume (ID=3) al 39, la korpo "https://192.168.1.40/ api" estas:
{“datenoj”:”{“3″:”39″}”}
La respondo estas:
{“3”: {“stato”: “sukceso”, “kodo”: “0xe000”}}
Jen eksampLe agordante plurajn valorojn:
{“datenoj”:”{“2″:”1″,”3″:”70″}”}
La respondo estas:
{“2”: {“stato”: “sukceso”, “kodo”: “0xe000”}, “3”: {“stato”: “sukceso”, “kodo”: “0xe000”}}
Respondaj "kodaj" valoroj povas esti iu el la jenaj:
- 0xe000 : Sukceso
- 0xe001 : Sukceso - Neniu ŝanĝo en valoro
- 0xe002 : Eraro - Nevalida posedaĵo
- 0xe003 : Eraro - Nevalida posedaĵvaloro
- 0xe004 : Eraro - Nevalida proprieta ago
- 0xe005 : Eraro - Mesaĝo misformita
- 0xe006 : Eraro - Aliro malakceptita
POST
"Afiŝo" similas al "meti" kaj estas uzata por agoj, kiel baskuli mikrofonon kaj laŭtvoĉan volumon supren/malsupren. Vi specifas la komandan ID kaj uzas malplenan ĉenon por la valoro.
Por ekzample, por pliigi la laŭtvoĉan volumon unu tick, uzu audio.loudspeakerVolumeUp (ID=4) kun la korpoformato jene:
{“datenoj”:”{“4″:””}”}
La respondkorpo estas:
{“4”: {“stato”: “sukceso”, “kodo”: “0xe000”}}
La eblaj respondaj "kodo-" valoroj estas la samaj tiuj listigitaj por la PUT-komando.
FORIGI
La "forigi" komandformato similas al "ricevi", kaj la respondkorpo similas al "meti". Uzo de forigo reigos la valoron al sia defaŭlta.
Por ekzample, por agordi la audio.laŭtparolilan volumon (ID=3) al ĝia defaŭlta valoro, la URL estas tiel:
https://192.168.1.40/api?delete=3
La respondkorpo estas:
{“3”: {“stato”: “sukceso”, “kodo”: “0xe000”}}
Vi bezonus elsendi "akiri" por preni la novan valoron, kiu en ĉi tiu kazo estas 50. Ekzempleample:
Komando:
https://192.168.1.40/api?query=3
Respondo:
{“3”: {“stato”: “sukceso”, “valoro”: “50”}}
La eblaj respondaj "kodo-" valoroj estas la samaj tiuj listigitaj por la PUT-komando
Videobar REST API Komanda Referenco
| Nomo/ Priskribo | Agoj | Kmd ID | Gamo de Valoroj | Defaŭlta Valoro |
| sistemo.reboot
Rekomencas la sistemon. |
post | 32 | N/A | N/A |
| system.serialNumber
Seria numero de la aparato. |
akiri | 10 | ŝnuro
(17 signoj) |
ooooooxooooooooxx |
| system.firmwareVersion
Versio de la firmware funkcianta sur la aparato. Ĉi tio estas agordita aŭtomate en la ĝisdatigo de la sistema firmvaro. |
akiri | 16 | ŝnuro
(1-16 signoj) |
0.0.0 |
| sistemo.modelo
Modelo de ĉi tiu aparato. |
akiri | D6 | ŝnuro
(1-22 signoj) |
Ne starigita |
| sistemo.nomo
Nomo de la aparato tiel ĝi povas esti unike identigita. |
get put forigi | 25 | ŝnuro
(1-22 signoj) |
Ne starigita |
| sistemo.ĉambro
Loko de la ĉambro de la aparato |
get put forigi | 26 | ŝnuro
(0-128 signoj) |
Ne starigita |
| sistemo.planko
Etaĝa loko de la aparato. |
get put forigi | 27 | ŝnuro
(0-128 signoj) |
Ne starigita |
| sistemo.konstruaĵo
Konstrua loko de la aparato. |
get put forigi | 28 | ŝnuro
(0-128 signoj) |
Ne starigita |
| system.gpiMuteStatus (VBl)
GPI-muta statuso (ŝaltita/malŝaltita). |
akiri | C7 | 110 | (Apogita en VBl) 0 |
| sistemo.maxOccupancy
Ĉambro maksimuma okupado de la aparato. |
get put forigi | DF | ŝnuro
(0-128 signoj) |
Ne starigita |
| behavior.ethernetEnabled (VBl)
Ŝaltas/malŝaltas la sisteman Ethernet-interfacon. |
get put forigi | 38 | 110 | (Apogita en VBl) 1 |
| konduto.bluetoothEnabled
Ŝaltas/malŝaltas la sistemon Bluetooth. |
get put forigi | 3A | 110 | 1 |
| konduto.wifiEnabled
Ŝaltas/malŝaltas la sistemon WiFi. |
get put forigi | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
Ŝaltas/malŝaltas la HDMI. |
get put forigi | C9 | 110 | (Apogita en VBl) 0 |
| usb.connectionStatus
Statuso de konekto de USB-kablo; 0 kiam malkonektita. |
akiri | 36 | 110 | 0 |
| usb.callStatus
Voka stato de la gastiganto konektita al USB-haveno de la sistemo. |
akiri | 37 | 110 | 0 |
| audio.micMute
Mutas/malŝaltas la sisteman mikrofonon. |
meti | 2 | 110 | 0 |
| audio.micMuteToggle
Ŝaltas la silentan staton de la sistema mikrofono. |
post | 15 | N/A | N/A |
| Nomo/ Priskribo | Agoj | Kmd ID | Gamo de Valoroj | Defaŭlta Valoro |
| audio.laŭtparoliloMute
Silentigas/malŝaltas la sisteman laŭtparolilon. |
post | 34 | N/A | N/A |
| audio.laŭtparoliloMuteToggle
Ŝaltas la silentan staton de la sistema laŭtparolilo. |
post | 34 | N/A | N/A |
| audio.laŭtparoliloVolumo
Agordas la sisteman laŭtparolilon. |
get put forigi | 3 | 0-100 | 50 |
| audio.laŭtparoliloVolumeSupre
Pliigas la volumon de la sistema laŭtparolilo je unu paŝo. |
post | 4 | N/A | N/A |
| audio.laŭtparoliloVolumeDown
Malgrandigas la volumon de la sistema laŭtparolilo je unu paŝo. |
post | 5 | N/A | N/A |
| fotilo.zomi
La nuna zomvaloro de la fotilo. |
get put forigi | 6 | 1-10 | 1 |
| fotilo.pan
La nuna panorama valoro de la fotilo. |
get put forigi | 7 | -10-10 | 0 |
| fotilo.klini
La nuna klinadvaloro de la fotilo. |
get put forigi | 8 | -10-10 | 0 |
| fotilo.zomi En
Zomi la fotilon je unu paŝo. |
post | 9 | N/A | N/A |
| fotilo.zoomOut
Malproksimigas fotilon je unu paŝo. |
post | OA | N/A | N/A |
| fotilo.pan Maldekstre
Panas fotilon forlasitan je unu paŝo. |
post | OB | N/A | N/A |
| fotilo.pan Ĝuste
Panas fotilon ĝuste je unu paŝo. |
post | oc | N/A | N/A |
| fotilo.kliniSupren
Klinas fotilon supren je unu paŝo. |
post | OD | N/A | N/A |
| fotilo.klini malsupren
Klinas fotilon malsupren je unu paŝo. |
post | OE | N/A | N/A |
| fotilo.hejmoPreset
Fotilo hejme antaŭdifinita en pano-klina zom-ordo |
get put forigi | 56 | 0 01 | |
| fotilo.unuaPrestaraĵo
Fotilo unua antaŭdifinita en pano-klina zom-ordo. |
get put forigi | 57 | 0 01 | |
| fotilo.dua Antaŭmetita
Fotilo dua antaŭdifinita en pano-klina zom-ordo. |
get put forigi | 58 | 0 01 | |
| fotilo.savePresetHome
Konservas al la hejma antaŭdiro la nunajn PTZ-valorojn. |
post | 12 | N/A | N/A |
| fotilo.savePresetFirst
Konservas al la unua antaŭdiro la nunajn PTZ-valorojn. |
post | 17 | N/A | N/A |
| fotilo.savePresetSecond
Konservas al la dua antaŭdiro la nunajn PTZ-valorojn. |
post | 18 | N/A | N/A |
| Nomo/ Priskribo | Agoj | Kmd ID | Gamo de Valoroj | Defaŭlta Valoro |
| fotilo.apliki ActivePreset
Aplikas la aktivan antaŭdifinilon al la PTZ-agordoj. |
post | OF | N/A | N/A |
| fotilo.aktiva Antaŭdifinita
Ĉi tiu estas la aktiva antaŭdiro. Notu, ĉe fotila komenco aŭ rekomenco la aktiva antaŭdiro estas agordita al Hejmo. |
get put forigi | 13 | 11213 | 1 |
| fotilo.stato
Fotila stato. Kiam aktiva, fotilo elsendas videon. Kiam neaktiva, fotilo ne fluas. Dum ĝisdatigo, fotilo ĝisdatigas firmvaron. |
akiri | 60 | aktivaI neaktivaI ĝisdatigo | neaktiva |
| aŭtomata enkadrigo.stato
Ŝaltu/malŝaltu la funkcion de aŭtomata enkadrigo de fotilo. |
get put forigi | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Ŝaltu la parigon de ŝaltita/malŝaltita al malŝaltita/ŝalti. |
post | C6 | N/A | N/A |
| bluetooth.pairingState
Bludenta pariĝa stato. La enŝaltita stato permesos pariĝon kun la aparato por fiksa intervalo. Post kiam la parigintervalo finiĝas, la stato ŝanĝiĝos al malŝaltita. |
meti | 14 | 110 | 0 |
| bluetooth.stato
Bluetooth kaj BLE stato. La stato indikos, ke Bluetooth kaj BLE estas ŝaltitaj; la malŝaltita stato indikos ke la Bluetooth kaj BLE estas malŝaltitaj. |
akiri | 67 | 110 | 0 |
| bluetooth.parigita
Parigita aparato nomo. |
akiri | 6A | ŝnuro
(0-128 signoj) |
Ne starigita |
| bluetooth.konektita
Parigita aparato-konekto-statuso. |
akiri | 6B | 110 | 0 |
| bluetooth.streamState
Flua stato de Bluetooth. |
akiri | C2 | 110 | 0 |
| bluetooth.callState
Statuso de Bluetooth-voko. |
akiri | 6C | 110 | 0 |
| bluetooth.malkonekti
Malkonektu Bluetooth-aparaton. |
post | E4 | 11213 | N/A |
| reto.dhcpState
DHCP-ŝtato. Kiam DHCP-ŝtato estas ŝaltita, reto estos agordita per DHCP. Kiam DHCP-ŝtato estas malŝaltita, senmovaj valoroj estas uzataj. |
get put forigi | 74 | 110 | 1 |
| reto.ip (VBl)
Senmova IP-adreso kiam DHCP-ŝtato estas malŝaltita. |
get put forigi | 75 | (Apogita en VBl) 0.0.0.0 | |
| reto.stato (VBl)
Stato de la Ethernet-modulo. |
akiri | 7F | senutila fiasko!
asocioI agordoMi pretaI malkonekti! rete |
(Apogita en VBl) preta |
| Nomo/ Priskribo | Agoj | Kmd ID | Gamo de Valoroj | Defaŭlta Valoro |
| reto.mac (VBl)
MAC-adreso de la LAN-interfaco. |
akiri | 80 | (Subtenita en VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP-ŝtato. Kiam DHCP-ŝtato estas ŝaltita, WiFi estos agordita per DHCP. Kiam DHCP-ŝtato estas malŝaltita, senmovaj valoroj estas uzataj. |
get put forigi | Al | 110 | 1 |
| wifi.ip
Senmova IP-adreso kiam DHCP-ŝtato estas malŝaltita. |
get put forigi | A2 | 0.0.0.0 | |
| wifi.mac
MAC-adreso de la WiFi-interfaco. |
akiri | AC | 00:00:00:00:00:00 | |
| wifi.stato
Stato de la WiFi-modulo. |
akiri | BO | senutila fiasko!
asocioI agordoMi pretaI malkonekti! rete |
senlabore |
| telemetrio.peopleCount (VBl)
La nombro da homoj kalkulitaj per la fotila aŭtomata enkadrigo-algoritmo. |
get put forigi | DA | 0-99 | (Apogita en VBl) 0 |
| telemetry.peoplePresent (VBl)
Vera kiam iuj homoj estas detektitaj de la fotila aŭtomata enkadrigo-algoritmo. |
get put forigi | DC | 110 | (Apogita en VBl) 0 |
Dokumentoj/Rimedoj
 |
BOSE Work Rest API Apo [pdf] Uzantogvidilo Work, Rest API, App, Work Rest API App |
