Додаток BOSE Work Rest API
вступ
Пристрої Bose Videobar підтримують репрезентативний програмний інтерфейс передачі стану (REST API) для керування та моніторингу мережі. Цей посібник містить інструкції щодо ввімкнення та налаштування REST API на пристроях Videobar, а також містить детальний опис підтримуваних змінних і операцій.
Елементи конфігурації та операції згруповані в такі категорії:
- система
- поведінка
- USB
- аудіо
- камера
- аудіокадрування
- bluetooth
- мережа (VBl)
- wifi
- телеметрія (VBl)
У розділі «Довідник команд API» міститься така інформація для кожного об’єкта:
- Назва/Опис Назва предмета та опис його використання.
- Дії Дії, які можна виконати над об'єктом. Дія може
- бути одним або декількома з таких: отримати, розмістити, видалити, опублікувати.
- Діапазон значень Допустимі значення для об'єкта.
- Значення за замовчуванням Значення за замовчуванням об’єкта. Це значення, яке використовується, якщо ви повертаєте пристрій до заводських налаштувань.
Усі значення задаються як рядки.
Повідомлення про товарні знаки
- Bose, Bose Work і Videobar є товарними знаками Bose Corporation.
- Словесний знак і логотипи Bluetooth» є зареєстрованими товарними знаками, що належать Bluetooth SIG, Inc., і будь-яке використання таких знаків корпорацією Bose здійснюється за ліцензією.
- Термін HDMI є торговою маркою або зареєстрованою торговою маркою HDMI Licensing Administrator, Inc.
- Усі інші торгові марки є власністю відповідних власників.
Інформація про конфіденційність
Ваша конфіденційність важлива для Bose, тому ми розробили Політику конфіденційності, яка описує, як ми збираємо, використовуємо, розкриваємо, передаємо та зберігаємо вашу особисту інформацію.
БУДЬ ЛАСКА, УВАЖНО ПРОЧИТАЙТЕ ЦЮ ПОЛІТИКУ КОНФІДЕНЦІЙНОСТІ, ЩОБ ЗРОЗУМІТИ, ЯК МИ ОБРОБЛЯЄМОСЯ З ВАШОЮ ІНФОРМАЦІЄЮ. ЯКЩО ВИ НЕ ПОГОДЖУЄТЕСЯ З ЦІЄЮ ПОЛІТИКОЮ КОНФІДЕНЦІЙНОСТІ, БУДЬ ЛАСКА, НЕ КОРИСТУЙТЕСЯ ПОСЛУГАМИ.
Увімкнення та налаштування REST API
Щоб увімкнути доступ до REST API на пристрої, використовуйте програму Bose Work Configuration, Bose Work Management або Web інтерфейс користувача. Перейдіть до налаштувань API Network > API. Увімкніть доступ до API та вкажіть ім’я користувача та пароль API. Вам знадобляться ці облікові дані API, щоб використовувати будь-які команди REST API. Для отримання додаткової інформації зверніться до посібників користувача програми.
Тестування REST API
Ви можете перевірити API REST Videobar за допомогою інтерфейсу Swagger OpenAPI, вбудованого в пристрій. Щоб отримати доступ до цього інтерфейсу, Videobar має бути підключено до IP-мережі через дротовий або WiFi-інтерфейс, а ваш хост-комп’ютер має бути в тій самій мережі або мережі, яка має доступ до пристрою через HTTPS.
Підключіть свій ПК до Videobar через інтерфейс USB. Запустіть програму Bose Work Configuration і ввійдіть, щоб отримати доступ до елементів керування адміністратора. Виберіть сторінку Мережа > API та натисніть посилання:
Документація REST API (Web інтерфейс користувача)
Якщо ви не підключені до пристрою через USB і ваш комп’ютер підключено до тієї самої мережі, ви можете отримати доступ до REST API через браузер, перейшовши за такою адресою:
https://<videobar-ip-address>/doc-api
Команди REST API
Інтерфейс API REST Videobar використовує ідентифікатори команд у кожному з чотирьох підтримуваних методів HTTP: отримання, розміщення, видалення та публікація.
Нижче наведено опис чотирьох методів, а потім таблицю з описом методів, які підтримуються для кожної з команд.
ОТРИМАТИ
Метод «get» приймає один ідентифікатор команди або кілька ідентифікаторів, розділених комами. наприкладample, щоб отримати стан audio.micMute, ID команди дорівнює 2. The URL виглядає так:
https://192.168.1.40/api?query=2
Тіло відповіді виглядає наступним чином, зі значенням «O», що вказує на те, що мікрофон не вимкнено:
{“2”: {“статус”: “успішно”, “значення”: “0”}}
Щоб запитати кілька значень, розділіть кілька ідентифікаторів команд комою. наприкладample, ви можете запитати audio.micMute (ID=2) і system.firmwareVersion (ID=l6) так:
https://192.168.1.40/api?query=2,16
Примітка. Не додавайте пробіли між кількома ідентифікаторами.
Результатом буде:
{“2”: {“статус”: “успішно”, “значення”: “0”}, “16”: {“статус”: “успішно”, “значення”: “1.2.13_fd6cc0e”}}
ПОСТАВИТИ
Команда «put» використовує формат тіла JSON, де ключ — «дані», а значення — пари ID:значення.
наприкладample, щоб встановити audio.loudspeakerVolume (ID=3) на 39, тіло «https://192.168.1.40/api» має вигляд:
{“дані”:”{“3″:”39″}”}
Відповідь така:
{“3”: {“статус”: “успішно”, “код”: “0xe000”}}
Ось колишнійample встановлення кількох значень:
{“дані”:”{“2″:”1″,”3″:”70″}”}
Відповідь така:
{“2”: {“статус”: “успішно”, “код”: “0xe000”}, “3”: {“статус”: “успішно”, “код”: “0xe000”}}
Значення «коду» відповіді можуть бути будь-якими з наступного:
- 0xe000: Успіх
- 0xe001: Успіх – значення не змінюється
- 0xe002: Помилка – Недійсна властивість
- 0xe003: Помилка – Недійсне значення властивості
- 0xe004: Помилка – Недійсна дія властивості
- 0xe005: Помилка – повідомлення неправильно сформоване
- 0xe006: Помилка – Доступ заборонено
ПОСТ
«Post» схожий на «put» і використовується для таких дій, як вимикання мікрофона та збільшення/зменшення гучності динаміка. Ви вказуєте ідентифікатор команди та використовуєте порожній рядок для значення.
наприкладample, щоб збільшити гучність динаміка на одну позначку, використовуйте audio.loudspeakerVolumeUp (ID=4) із таким форматом:
{“дані”:”{“4″:””}”}
Тіло відповіді:
{“4”: {“статус”: “успішно”, “код”: “0xe000”}}
Можливі значення «коду» відповіді такі самі, як і для команди PUT.
ВИДАЛИТИ
Формат команди «видалити» схожий на «отримати», а тіло відповіді схоже на «пут». Використання видалення поверне значення до стандартного.
наприкладample, щоб встановити гучність audio.loudspeaker (ID=3) на значення за замовчуванням, the URL виглядає так:
https://192.168.1.40/api?delete=3
Тіло відповіді:
{“3”: {“статус”: “успішно”, “код”: “0xe000”}}
Щоб отримати нове значення, яке в даному випадку дорівнює 50, вам потрібно буде ввести «get».ampле:
Команда:
https://192.168.1.40/api?query=3
Відповідь:
{“3”: {“статус”: “успішно”, “значення”: “50”}}
Можливі значення «коду» відповіді такі самі, як і для команди PUT
Відеопанель REST API команд
| Назва/Опис | Дії | Cmd ID | Діапазон значень | Значення за замовчуванням |
| system.reboot
Перезавантажує систему. |
пост | 32 | N/A | N/A |
| system.serialNumber
Серійний номер пристрою. |
отримати | 10 | рядок
(17 символів) |
оооооооооооооооо |
| system.firmwareVersion
Версія мікропрограми, що працює на пристрої. Це встановлюється автоматично під час оновлення мікропрограми системи. |
отримати | 16 | рядок
(1-16 символів) |
0.0.0 |
| система.модель
Модель цього пристрою. |
отримати | D6 | рядок
(1-22 символів) |
Не встановлено |
| system.name
Назва пристрою, щоб його можна було однозначно ідентифікувати. |
get put delete | 25 | рядок
(1-22 символів) |
Не встановлено |
| система.кімната
Кімнатне розташування пристрою |
get put delete | 26 | рядок
(0-128 символів) |
Не встановлено |
| система.пов
Поверхове розташування приладу. |
get put delete | 27 | рядок
(0-128 символів) |
Не встановлено |
| система.буд
Будівельне розташування пристрою. |
get put delete | 28 | рядок
(0-128 символів) |
Не встановлено |
| system.gpiMuteStatus (VBl)
Статус вимкнення звуку GPI (увімкнено/вимкнено). |
отримати | C7 | 110 | (Підтримується у VBl) 0 |
| system.maxOccupancy
Максимальне розміщення приміщення пристрою. |
get put delete | DF | рядок
(0-128 символів) |
Не встановлено |
| behavior.ethernetEnabled (VBl)
Вмикає/вимикає системний інтерфейс Ethernet. |
get put delete | 38 | 110 | (Підтримується у VBl) 1 |
| behavior.bluetoothEnabled
Вмикає/вимикає системний Bluetooth. |
get put delete | 3A | 110 | 1 |
| behavior.wifiEnabled
Вмикає/вимикає системний WiFi. |
get put delete | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
Вмикає/вимикає HDMI. |
get put delete | C9 | 110 | (Підтримується у VBl) 0 |
| usb.connectionStatus
стан підключення кабелю USB; 0 при відключенні. |
отримати | 36 | 110 | 0 |
| usb.callStatus
Статус виклику з хоста, підключеного до USB-порту системи. |
отримати | 37 | 110 | 0 |
| audio.micMute
Вмикає/вмикає мікрофон системи. |
отримати посаду | 2 | 110 | 0 |
| audio.micMuteToggle
Перемикає без звуку системний мікрофон. |
пост | 15 | N/A | N/A |
| Назва/Опис | Дії | Cmd ID | Діапазон значень | Значення за замовчуванням |
| audio.loudspeakerMute
Вимкнення/ввімкнення звуку системного гучномовця. |
пост | 34 | N/A | N/A |
| audio.loudspeakerMuteToggle
Перемикає без звуку системний гучномовець. |
пост | 34 | N/A | N/A |
| audio.loudspeakerVolume
Встановлює гучність системного динаміка. |
get put delete | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
Збільшує гучність системного динаміка на один крок. |
пост | 4 | N/A | N/A |
| audio.loudspeakerVolumeDown
Зменшує гучність системного динаміка на один крок. |
пост | 5 | N/A | N/A |
| camera.zoom
Поточне значення масштабу камери. |
get put delete | 6 | 1-10 | 1 |
| camera.pan
Поточне значення панорамування камери. |
get put delete | 7 | -10-10 | 0 |
| camera.tilt
Поточне значення нахилу камери. |
get put delete | 8 | -10-10 | 0 |
| camera.zoom In
Збільшує камеру на один крок. |
пост | 9 | N/A | N/A |
| camera.zoomOut
Зменшує камеру на один крок. |
пост | OA | N/A | N/A |
| camera.pan Ліворуч
Панорамує камеру вліво на один крок. |
пост | OB | N/A | N/A |
| camera.pan правильно
Повертає камеру праворуч на один крок. |
пост | oc | N/A | N/A |
| camera.tiltUp
Нахиляє камеру вгору на один крок. |
пост | OD | N/A | N/A |
| camera.tiltDown
Нахиляє камеру вниз на один крок. |
пост | OE | N/A | N/A |
| camera.homePreset
Початкове налаштування камери в порядку панорамування та нахилу |
get put delete | 56 | 0 01 | |
| camera.firstPreset
Камера спочатку попередньо налаштована в порядку повороту та нахилу масштабування. |
get put delete | 57 | 0 01 | |
| camera.second Preset
Друге налаштування камери в порядку панорамування та нахилу. |
get put delete | 58 | 0 01 | |
| camera.savePresetHome
Зберігає поточні значення PTZ у головному попередньому налаштуванні. |
пост | 12 | N/A | N/A |
| camera.savePresetFirst
Зберігає в першому пресеті поточні значення PTZ. |
пост | 17 | N/A | N/A |
| camera.savePresetSecond
Зберігає поточні значення PTZ у другому попередньому налаштуванні. |
пост | 18 | N/A | N/A |
| Назва/Опис | Дії | Cmd ID | Діапазон значень | Значення за замовчуванням |
| camera.apply ActivePreset
Застосовує активні попередні налаштування до налаштувань PTZ. |
пост | OF | N/A | N/A |
| camera.active Попереднє налаштування
Це активний пресет. Зауважте, що під час запуску або перезапуску камери активним попереднім налаштуванням буде встановлено значення Home. |
get put delete | 13 | 11213 | 1 |
| camera.state
Стан камери. Коли камера активна, камера транслює відео. У неактивному стані камера не транслює. Під час оновлення камера оновлює мікропрограму. |
отримати | 60 | активнийІ неактивнийІ оновлення | неактивний |
| autoframing.state
Увімкніть/вимкніть функцію автокадрування камери. |
get put delete | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Перемикайте стан сполучення з увімкнено/вимкнено на вимкнено/увімкнено. |
пост | C6 | N/A | N/A |
| bluetooth.pairingState
Стан сполучення Bluetooth. Увімкнений стан дозволить створювати пару з пристроєм протягом фіксованого інтервалу. Після закінчення інтервалу сполучення стан зміниться на вимкнено. |
отримати посаду | 14 | 110 | 0 |
| bluetooth.state
Стан Bluetooth і BLE. Увімкнений стан означає, що Bluetooth і BLE увімкнено; вимкнений стан означатиме, що Bluetooth і BLE вимкнено. |
отримати | 67 | 110 | 0 |
| bluetooth.paired
Назва сполученого пристрою. |
отримати | 6A | рядок
(0-128 символів) |
Не встановлено |
| bluetooth.connected
Статус підключення спарених пристроїв. |
отримати | 6B | 110 | 0 |
| bluetooth.streamState
Статус потоку Bluetooth. |
отримати | C2 | 110 | 0 |
| bluetooth.callState
Статус виклику Bluetooth. |
отримати | 6C | 110 | 0 |
| bluetooth.disconnect
Відключіть пристрій Bluetooth. |
пост | E4 | 11213 | N/A |
| network.dhcpState
Стан DHCP. Коли стан DHCP увімкнено, мережа буде налаштована через DHCP. Коли стан DHCP вимкнено, використовуються статичні значення. |
get put delete | 74 | 110 | 1 |
| network.ip (VBl)
Статична IP-адреса, коли стан DHCP вимкнено. |
get put delete | 75 | (Підтримується у VBl) 0.0.0.0 | |
| network.state (VBl)
Стан модуля Ethernet. |
отримати | 7F | бездіяльний провал!
об'єднанняI конфігураціяI готовийI відключити! онлайн |
(Підтримується у VBl) готовий |
| Назва/Опис | Дії | Cmd ID | Діапазон значень | Значення за замовчуванням |
| network.mac (VBl)
MAC-адреса інтерфейсу LAN. |
отримати | 80 | (Підтримується у VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
Стан DHCP. Коли стан DHCP увімкнено, WiFi буде налаштовано через DHCP. Коли стан DHCP вимкнено, використовуються статичні значення. |
get put delete | Al | 110 | 1 |
| wifi.ip
Статична IP-адреса, коли стан DHCP вимкнено. |
get put delete | A2 | 0.0.0.0 | |
| wifi.mac
MAC-адреса інтерфейсу WiFi. |
отримати | AC | 00:00:00:00:00:00 | |
| wifi.state
Стан WiFi модуля. |
отримати | BO | бездіяльний провал!
об'єднанняI конфігураціяI готовийI відключити! онлайн |
непрацюючий |
| telemetry.peopleCount (VBl)
Кількість людей, підрахованих алгоритмом автокадрування камери. |
get put delete | DA | 0-99 | (Підтримується у VBl) 0 |
| telemetry.peoplePresent (VBl)
Правда, коли будь-які люди були виявлені алгоритмом автокадрування камери. |
get put delete | DC | 110 | (Підтримується у VBl) 0 |
Документи / Ресурси
 |
Додаток BOSE Work Rest API [pdfПосібник користувача Work, Rest API, App, Work Rest API App |
