Апликација BOSE Work Rest API
Вовед
Уредите Bose Videobar поддржуваат програмски интерфејс за апликација за пренос на репрезентативна состојба (REST API) за управување и следење на мрежата. Овој водич дава инструкции за овозможување и конфигурирање на REST API на уредите Videobar и дава детален опис на поддржаните променливи и операции.
Конфигурациските ставки и операции се групирани во овие категории:
- систем
- однесување
- USB
- аудио
- камера
- аудио кадрирање
- блутут
- мрежа (VBl)
- wifi
- телеметрија (VBl)
Секцијата за референца за команди на API ги обезбедува следните информации за секој објект:
- Име/Опис Име на објектот и опис на неговата употреба.
- Дејства Дејства што можат да се извршат на објектот. Дејството може
- да биде едно или повеќе од следниве: добивај, ставај, бришеш, објавувај.
- Опсег на вредности Прифатливи вредности за објектот.
- Стандардна вредност Стандардна вредност на објектот. Ова е вредноста што се користи ако го вратите уредот на фабрички поставки.
Сите вредности се наведени како низи.
Известувања за трговска марка
- Bose, Bose Work и Videobar се заштитни знаци на Bose Corporation.
- Зборот и логоата на Bluetooth“ се регистрирани заштитни знаци во сопственост на Bluetooth SIG, Inc. и секоја употреба на таквите ознаки од страна на Bose Corporation е под лиценца.
- Терминот HDMI е заштитен знак или регистриран заштитен знак на HDMI Licensing Administrator, Inc.
- Сите други трговски марки се сопственост на нивните соодветни сопственици.
Информации за приватност
Вашата приватност е важна за Bose, затоа развивме Политика за приватност која опфаќа како ги собираме, користиме, откриваме, пренесуваме и складираме вашите лични податоци.
ВЕ МОЛИМЕ ВНИМАТЕЛНО ПРОЧИТАЈТЕ ЈА ОВАА ПОЛИТИКА ЗА ПРИВАТНОСТ ЗА ДА РАЗБЕРЕТЕ КАКО СЕ РАКУВАМЕ СО ВАШИТЕ ИНФОРМАЦИИ. АКО НЕ СЕ СОГЛАСУВАТЕ СО ОВАА ПОЛИТИКА ЗА ПРИВАТНОСТ, ВЕ МОЛИМЕ НЕ КОРИСТЕТЕ ГИ УСЛУГИТЕ.
Овозможување и конфигурирање на REST API
За да овозможите пристап до REST API на уред, користете ја апликацијата Bose Work Configuration, апликацијата Bose Work Management или Web UI. Пристапете до поставките за Network> API. Овозможете пристап до API и наведете корисничко име и лозинка за API. Ќе ви требаат овие акредитиви на API за да користите некоја од командите REST API. Ве молиме погледнете ги упатствата за користење на апликацијата за повеќе информации.
Тестирање на REST API
Можете да го тестирате Videobar REST API со користење на интерфејсот Swagger OpenAPI што е вграден во уредот. За да пристапите до овој интерфејс, Videobar мора да биде поврзана со IP мрежа преку нејзиниот жичен или WiFi интерфејс, а вашиот компјутер домаќин мора да биде на истата мрежа или мрежа што може да пристапи до уредот преку HTTPS.
Поврзете го вашиот компјутер со лентата за видео преку USB-интерфејсот. Стартувајте ја апликацијата Bose Work Configuration и најавете се за да пристапите до административните контроли. Изберете ја страницата Мрежа > API и кликнете на врската:
REST API документација (Web Интерфејс)
Ако не сте поврзани со уредот преку USB и вашиот компјутер е на истата мрежа, можете да пристапите до REST API преку вашиот прелистувач со прелистување на следната адреса:
https://<videobar-ip-address>/doc-api
REST API команди
Интерфејсот на Videobar REST API користи ИД на команди во секој од четирите поддржани методи на HTTP: земи, става, брише и објавува.
Подолу е опис на четирите методи проследени со табела која ги опишува методите поддржани за секоја од командите.
ДОБИЈ
Методот „земи“ прифаќа единствен ID на наредба или повеќе ID-и ограничени со запирки. За прample, за да се добие состојбата audio.micMute, ID на командата е 2. На URL е вака:
https://192.168.1.40/api?query=2
Телото за одговор е како што следува, со вредност „О“ што покажува дека микрофонот не е исклучен:
{„2“: {„статус“: „успешно“, „вредност“: „0“}}
За да побарате повеќе вредности, одвојте повеќе ИД на команди со запирка. За прampможе да побарате аудио.micMute (ID=2) и system.firmwareVersion (ID=l6) како ова:
https://192.168.1.40/api?query=2,16
Забелешка: Не вклучувајте празни места помеѓу повеќе ИД.
Резултатот би бил:
{„2“: {„статус“: „успешно“, „вредност“: „0“}, „16“: {„статус“: „успешно“, „вредност“: „1.2.13_fd6cc0e“}}
СТАВИ
Командата „стави“ користи формат на тело JSON, при што клучот е „податок“, а вредноста е парови ID:вредност.
За прampза да го поставите audio.loudspeakerVolume (ID=3) на 39, телото „https://192.168.1.40/ api“ е:
{„податоци“:“{„3″:“39″}“}
Одговорот е:
{„3“: {„статус“: „успешно“, „код“: „0xe000“}}
Еве еден поранешенampпоставувајте повеќе вредности:
{„податоци“:“{„2″:“1″,“3″:“70″}“}
Одговорот е:
{„2“: {„статус“: „успешно“, „код“: „0xe000“}, „3“: {„статус“: „успешно“, „код“: „0xe000“}}
Вредностите на „кодот“ на одговорот може да бидат кои било од следниве:
- 0xe000 : Успех
- 0xe001 : Успех – Нема промена во вредноста
- 0xe002 : Грешка – Неважечко својство
- 0xe003 : Грешка – Неважечка вредност на имотот
- 0xe004 : Грешка – Неважечко дејство на имотот
- 0xe005 : Грешка – Пораката е погрешна
- 0xe006 : Грешка – Пристапот е одбиен
ПОСТАВЕТЕ
„Објавата“ е слична на „стави“ и се користи за дејства, како што се вклучување исклучување на микрофонот и зголемување/намалување на јачината на звукот на звучникот. Ја одредувате командата ID и користите празна низа за вредноста.
За прampле, за да ја зголемите гласноста на звучникот за еден штиклирајте, користете audio.loudspeakerVolumeUp (ID=4) со формат на телото вака:
{„податоци“:“{„4″:““}“}
Телото за одговор е:
{„4“: {„статус“: „успешно“, „код“: „0xe000“}}
Вредностите на можниот одговор „код“ се исти со оние наведени за командата PUT.
ИЗБРИШИ
Форматот на командата „избриши“ е сличен на „get“, а телото за одговор е слично на „стави“. Користењето на Delete ќе ја врати вредноста на стандардната вредност.
За прample, за да ја поставите јачината на звукот на звучникот (ID=3) на неговата основна вредност, на URL е вака:
https://192.168.1.40/api?delete=3
Телото за одговор е:
{„3“: {„статус“: „успешно“, „код“: „0xe000“}}
Ќе треба да издадете „get“ за да ја вратите новата вредност, која во овој случај е 50. На пр.ampле:
Команда:
https://192.168.1.40/api?query=3
Одговор:
{„3“: {„статус“: „успешно“, „вредност“: „50“}}
Вредностите на можниот одговор „код“ се исти со оние наведени за командата PUT
Референца за команда на видеобар REST API
| Име/Опис | Акции | Cmd ID | Опсег на вредности | Стандардна вредност |
| систем.рестартирај
Го рестартира системот. |
пост | 32 | N/A | N/A |
| систем.сериски број
Сериски број на уредот. |
добие | 10 | низа
(17 знаци) |
ооооооооооооооохх |
| систем.верзија на firmware
Верзија на фирмверот што работи на уредот. Ова се поставува автоматски при надградба на фирмверот на системот. |
добие | 16 | низа
(1-16 знаци) |
0.0.0 |
| систем.модел
Модел на овој уред. |
добие | D6 | низа
(1-22 знаци) |
Не е поставено |
| систем.име
Име на уредот за да може уникатно да се идентификува. |
се стави брише | 25 | низа
(1-22 знаци) |
Не е поставено |
| систем.соба
Локација на собата на уредот |
се стави брише | 26 | низа
(0-128 знаци) |
Не е поставено |
| систем.под
Локација на подот на уредот. |
се стави брише | 27 | низа
(0-128 знаци) |
Не е поставено |
| систем.зграда
Локација на зградата на уредот. |
се стави брише | 28 | низа
(0-128 знаци) |
Не е поставено |
| систем.gpiMuteStatus (VBl)
Статус на исклучување на GPI (вклучено/исклучено). |
добие | C7 | 110 | (Поддржано во VBl) 0 |
| систем.maxOccupancy
Максимално зафаќање на собата на уредот. |
се стави брише | DF | низа
(0-128 знаци) |
Не е поставено |
| Behaviour.ethernetEnabled (VBl)
Го вклучува/исклучува системскиот етернет интерфејс. |
се стави брише | 38 | 110 | (Поддржано во VBl) 1 |
| однесување.блутут овозможено
Го вклучува/исклучува системот Bluetooth. |
се стави брише | 3A | 110 | 1 |
| однесување.wifi Овозможено
Го вклучува/исклучува системот WiFi. |
се стави брише | 3B | 110 | 1 |
| Behaviour.hdmiEnabled (VBl)
Вклучува/исклучува HDMI. |
се стави брише | C9 | 110 | (Поддржано во VBl) 0 |
| USB.Статус на конекција
Статус на поврзување со USB кабел; 0 кога е исклучен. |
добие | 36 | 110 | 0 |
| usb.callStatus
Статус на повици од домаќинот поврзан на USB-портата на системот. |
добие | 37 | 110 | 0 |
| аудио.micИсклучи
Исклучува/вклучува звук на системскиот микрофон. |
се стави | 2 | 110 | 0 |
| аудио.micMuteToggle
Ја исклучува состојбата на исклучување на системскиот микрофон. |
пост | 15 | N/A | N/A |
| Име/Опис | Акции | Cmd ID | Опсег на вредности | Стандардна вредност |
| аудио.loudspeakerИсклучи звук
Го исклучува/вклучува звукот на системскиот звучник. |
пост | 34 | N/A | N/A |
| аудио.loudspeakerMuteToggle
Ја исклучува состојбата на исклучен звук на системскиот звучник. |
пост | 34 | N/A | N/A |
| аудио.звучник Јачина на звук
Ја поставува гласноста на системскиот звучник. |
се стави брише | 3 | 0-100 | 50 |
| аудио.звучник VolumeUp
Ја зголемува гласноста на системскиот звучник за еден чекор. |
пост | 4 | N/A | N/A |
| аудио.звучник VolumeDown
Ја намалува гласноста на системскиот звучник за еден чекор. |
пост | 5 | N/A | N/A |
| камера.зум
Тековната вредност на зумирање на камерата. |
се стави брише | 6 | 1-10 | 1 |
| камера.тава
Тековната вредност на тавата на камерата. |
се стави брише | 7 | -10-10 | 0 |
| камера.навалување
Тековната вредност на навалување на камерата. |
се стави брише | 8 | -10-10 | 0 |
| камера.зумирајте
Ја зумира камерата за еден чекор. |
пост | 9 | N/A | N/A |
| камера.зумирање
Ја зумира камерата за еден чекор. |
пост | OA | N/A | N/A |
| камера.тава Лево
Камерата ја заобиколува за еден чекор. |
пост | OB | N/A | N/A |
| камера.тава Во право
Снимајте камера веднаш за еден чекор. |
пост | oc | N/A | N/A |
| камера.tiltUp
Ја наведнува камерата за еден чекор нагоре. |
пост | OD | N/A | N/A |
| камера.навалување надолу
Ја наведнува камерата за еден чекор надолу. |
пост | OE | N/A | N/A |
| камера.homePreset
Претходно поставена домашна камера во редослед на зумирање со навалување на тава |
се стави брише | 56 | 0 01 | |
| камера.firstPreset
Камерата прво поставена по редослед на зумирање со навалување на тава. |
се стави брише | 57 | 0 01 | |
| камера.втора претходно поставена
Второ меморирана камера по редослед на зумирање со навалување на тава. |
се стави брише | 58 | 0 01 | |
| камера.savePresetHome
Ги зачувува тековните вредности на PTZ во почетната поставеност. |
пост | 12 | N/A | N/A |
| камера.savePresetFirst
Ги зачувува тековните вредности на PTZ на првото претходно поставено. |
пост | 17 | N/A | N/A |
| камера.savePresetSecond
Ги зачувува тековните вредности на PTZ на второто претходно поставено. |
пост | 18 | N/A | N/A |
| Име/Опис | Акции | Cmd ID | Опсег на вредности | Стандардна вредност |
| камера.примени ActivePreset
Го применува активното претходно поставено на поставките за PTZ. |
пост | OF | N/A | N/A |
| камера.активна Претходно поставено
Ова е активно претходно поставено. Забелешка, при стартување или рестартирање на камерата, активното претходно поставено е поставено на Home. |
се стави брише | 13 | 11213 | 1 |
| камера.состојба
Состојба на камерата. Кога е активна, камерата пренесува видео. Кога е неактивна, камерата не стримува. Кога се надградува, камерата го надградува фирмверот. |
добие | 60 | активен/неактивен/надградба | неактивни |
| автоматско кадрирање.состојба
Вклучете/исклучете ја функцијата за автоматско кадрирање на камерата. |
се стави брише | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Вклучете ја состојбата на спарување од вклучување/исклучување на исклучување/вклучување. |
пост | C6 | N/A | N/A |
| bluetooth.спарувањеСостојба
Состојба на спарување Bluetooth. Вклучената состојба ќе овозможи спарување со уредот за фиксен интервал. Откако ќе заврши интервалот за спарување, состојбата ќе се промени во исклучена. |
се стави | 14 | 110 | 0 |
| bluetooth.состојба
Bluetooth и BLE состојба. Вклучената состојба ќе покаже дека Bluetooth и BLE се вклучени; исклучената состојба ќе покаже дека Bluetooth и BLE се исклучени. |
добие | 67 | 110 | 0 |
| bluetooth.спарени
Име на спарен уред. |
добие | 6A | низа
(0-128 знаци) |
Не е поставено |
| bluetooth.поврзан
Статус на поврзување со спарен уред. |
добие | 6B | 110 | 0 |
| bluetooth.streamState
Статус на пренос на Bluetooth. |
добие | C2 | 110 | 0 |
| bluetooth.callState
Статус на повикот со Bluetooth. |
добие | 6C | 110 | 0 |
| bluetooth.исклучи се
Исклучете го уредот со Bluetooth. |
пост | E4 | 11213 | N/A |
| мрежа.dhcpДржава
Состојба на DHCP. Кога состојбата на DHCP е вклучена, мрежата ќе се конфигурира преку DHCP. Кога состојбата на DHCP е исклучена, се користат статички вредности. |
се стави брише | 74 | 110 | 1 |
| network.ip (VBl)
Статична IP адреса кога состојбата на DHCP е исклучена. |
се стави брише | 75 | (Поддржано во VBl) 0.0.0.0 | |
| network.state (VBl)
Состојба на етернет модулот. |
добие | 7F | неактивен неуспех!
асоцијацијаI конфигурација Подготвени исклучете се! онлајн |
(Поддржано во VBl) подготвено |
| Име/Опис | Акции | Cmd ID | Опсег на вредности | Стандардна вредност |
| мрежа.mac (VBl)
MAC адреса на LAN интерфејсот. |
добие | 80 | (Поддржано во VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
Состојба на DHCP. Кога состојбата на DHCP е вклучена, WiFi ќе се конфигурира преку DHCP. Кога состојбата на DHCP е исклучена, се користат статички вредности. |
се стави брише | Al | 110 | 1 |
| wifi.ip
Статична IP адреса кога состојбата на DHCP е исклучена. |
се стави брише | A2 | 0.0.0.0 | |
| wifi.mac
MAC адреса на WiFi интерфејсот. |
добие | AC | 00:00:00:00:00:00 | |
| wifi.состојба
Состојба на WiFi модулот. |
добие | BO | неактивен неуспех!
асоцијацијаI конфигурација Подготвени исклучете се! онлајн |
неактивен |
| телеметрија.луѓе Број (VBl)
Бројот на луѓе броен според алгоритмот за автоматско кадрирање на камерата. |
се стави брише | DA | 0-99 | (Поддржано во VBl) 0 |
| телеметрија.луѓеПрисутни (VBl)
Вистина е кога некои луѓе биле откриени од алгоритмот за автоматско кадрирање на камерата. |
се стави брише | DC | 110 | (Поддржано во VBl) 0 |
Документи / ресурси
 |
Апликација BOSE Work Rest API [pdf] Упатство за корисникот Work, Rest API, App, Work Rest API App |
