BOSE Work Rest API колдонмосу
Introduction
Bose Videobar түзмөктөрү тармакты башкаруу жана мониторинг жүргүзүү үчүн өкүлчүлүк абалын которуу колдонмо программалоо интерфейсин (REST API) колдойт. Бул колдонмо Videobar түзмөктөрүндө REST APIди иштетүү жана конфигурациялоо боюнча нускамаларды камсыз кылат жана ал колдоого алынган өзгөрмөлөрдүн жана операциялардын кеңири сүрөттөмөсүн берет.
Конфигурациянын элементтери жана операциялары төмөнкү категорияларга бөлүнөт:
- системасы
- жүрүм-турум
- usb
- аудио
- камера
- аудиофраминг
- bluetooth
- тармак (VBl)
- wifi
- телеметрия (VBl)
API Command Reference бөлүмү ар бир объект үчүн төмөнкү маалыматты камсыз кылат:
- Аты/Сыпаттамасы Объекттин аталышы жана аны колдонуунун сүрөттөлүшү.
- Арекеттер Объектте аткарыла турган аракеттер. Аракет болот
- төмөнкүлөрдүн бири же бир нечеси бол: алуу, коюу, жок кылуу, жарыялоо.
- Баалардын диапазону Объект үчүн алгылыктуу маанилер.
- Default Value Объекттин демейки мааниси. Бул түзмөктү демейки жөндөөлөргө кайтарганда колдонулуучу маани.
Бардык баалуулуктар саптар катары көрсөтүлгөн.
Соода белгиси жөнүндө эскертүүлөр
- 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. Тармак> API жөндөөлөрүнө кириңиз. API мүмкүнчүлүгүн иштетиңиз жана API колдонуучу атын жана сырсөзүн көрсөтүңүз. REST API буйруктарынын каалаганын колдонуу үчүн сизге бул API эсептик дайындары керек болот. Көбүрөөк маалымат алуу үчүн колдонмонун колдонуучу колдонмолоруна кайрылыңыз.
REST API сыналууда
Түзмөктө камтылган Swagger OpenAPI интерфейсин колдонуу менен Videobar REST API сынай аласыз. Бул интерфейске жетүү үчүн Videobar зымдуу же WiFi интерфейси аркылуу IP тармагына туташтырылган болушу керек жана сиздин хост компьютериңиз ошол эле тармакта же HTTPS аркылуу түзмөккө кире алган тармакта болушу керек.
Компьютериңизди USB интерфейси аркылуу Videobarга туташтырыңыз. Bose Work Configuration колдонмосун иштетип, администратордун башкаруу элементтерине кирүү үчүн кириңиз. Тармак > API барагын тандап, шилтемени басыңыз:
REST API документациясы (Web UI)
Эгер сиз аспапка USB аркылуу туташпасаңыз жана сиздин компьютериңиз бир тармакта болсо, REST API'ге браузериңиз аркылуу төмөнкү даректи карап кире аласыз:
https://<videobar-ip-address>/doc-api
REST API буйруктары
Videobar REST API интерфейси колдоого алынган төрт HTTP ыкмаларынын ар биринде буйрук ID'лерин колдонот: алуу, коюу, жок кылуу жана жарыялоо.
Төмөндө төрт ыкманын сүрөттөлүшү, андан кийин ар бир буйрук үчүн колдоого алынган ыкмаларды сүрөттөгөн таблица келтирилген.
GET
"Алуу" ыкмасы бир буйрук ID же бир нече үтүр менен бөлүнгөн ID кабыл алат. Мисалы үчүнample, audio.micMute абалын алуу үчүн, буйрук ID 2. The URL мындай:
https://192.168.1.40/api?query=2
Жооптун корпусу төмөнкүчө, "O" мааниси микрофондун үнү өчүрүлбөгөнүн билдирет:
{“2”: {“статус”: “ийгилик”, “маани”: “0”}}
Бир нече маанилерди суроо үчүн, бир нече буйрук ID'лерин үтүр менен бөлүңүз. Мисалы үчүнample, сиз бул үчүн audio.micMute (ID=2) жана system.firmwareVersion (ID=l6) сурасаңыз болот:
https://192.168.1.40/api?query=2,16
Эскертүү: Бир нече ID ортосундагы боштуктарды камтыбаңыз.
Натыйжа мындай болмок:
{“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”}}
Бул жерде мурункуampбир нече маанилерди коюу:
{“маалымат”:”{“2″:”1″,”3″:”70″}”}
Жооп мындай:
{“2”: {“статус”: “ийгилик”, “код”: “0xe000”}, “3”: {“статус”: “ийгилик”, “код”: “0xe000”}}
Жооптун "кодунун" маанилери төмөнкүлөр болушу мүмкүн:
- 0xe000 : Ийгилик
- 0xe001 : Ийгилик - Мааниде өзгөрүү жок
- 0xe002: Ката – Жараксыз мүлк
- 0xe003: Ката – Жараксыз мүлктүн мааниси
- 0xe004: Ката – Жараксыз мүлк аракети
- 0xe005: Ката - Билдирүү туура эмес
- 0xe006: Ката – Кирүү четке кагылды
POST
"Пост" "коюуга" окшош жана микрофондун үнүн басуу жана динамиктин үнүн өйдө/төмөндүрүү сыяктуу аракеттер үчүн колдонулат. Сиз буйрук ID көрсөтүңүз жана маани үчүн бош сапты колдоносуз.
Мисалы үчүнample, динамиктин үнүн бир белги менен жогорулатуу үчүн, төмөнкүдөй негизги формат менен audio.loudspeakerVolumeUp (ID=4) колдонуңуз:
{“маалымат”:”{“4″:””}”}
жооп орган болуп саналат:
{“4”: {“статус”: “ийгилик”, “код”: “0xe000”}}
Мүмкүн болгон жооптун "кодунун" маанилери PUT буйругу үчүн тизмеленгендер менен бирдей.
ЖОК
"Жок кылуу" буйругунун форматы "алууга" окшош, ал эми жооп бөлүгү "коюуга" окшош. Жок кылуу маанисин демейки абалына кайтарат.
Мисалы үчүнample, аудио.катуу сүйлөгүчтүн үнүн (ID=3) демейки маанисине коюу үчүн, URL мындай:
https://192.168.1.40/api?delete=3
жооп орган болуп саналат:
{“3”: {“статус”: “ийгилик”, “код”: “0xe000”}}
Жаңы маанини алуу үчүн сиз "алууну" чыгарышыңыз керек, бул учурда 50. Мурунampле:
Буйрук:
https://192.168.1.40/api?query=3
Жооп:
{“3”: {“статус”: “ийгилик”, “маани”: “50”}}
Мүмкүн болгон жооптун "кодунун" маанилери PUT буйругу үчүн тизмеленгендер менен бирдей
Videobar REST API буйругунун маалымдамасы
| Аты/Сипаттамасы | Аракеттер | Cmd ID | Маанилердин диапазону | Демейки маани |
| system.reboot
Системаны кайра жүктөйт. |
пост | 32 | Жок | Жок |
| system.serialNumber
Аппараттын сериялык номери. |
алуу | 10 | сап
(17 белги) |
oooooxoooooooxx |
| system.firmwareVersion
Түзмөктө иштеп жаткан микропрограмманын версиясы. Бул системанын микропрограммасын жаңыртууда автоматтык түрдө орнотулат. |
алуу | 16 | сап
(1-16 белги) |
0.0.0 |
| система.модел
Бул аппараттын модели. |
алуу | D6 | сап
(1-22 белги) |
Орнотулган жок |
| system.name
Аппараттын аталышы, ошондуктан аны уникалдуу аныктоого болот. |
алып салгыла | 25 | сап
(1-22 белги) |
Орнотулган жок |
| system.room
Аппараттын бөлмө жайгашкан жери |
алып салгыла | 26 | сап
(0-128 белги) |
Орнотулган жок |
| система.кабат
Аппараттын полдун жайгашкан жери. |
алып салгыла | 27 | сап
(0-128 белги) |
Орнотулган жок |
| система.имарат
Аппараттын жайгашкан жери. |
алып салгыла | 28 | сап
(0-128 белги) |
Орнотулган жок |
| system.gpiMuteStatus (VBl)
GPI үнсүз абалы (күйгүзүү/өчүрүү). |
алуу | C7 | 110 | (VBlде колдоого алынат) 0 |
| system.maxOccupency
аппараттын бөлмө максималдуу ээлөө. |
алып салгыла | DF | сап
(0-128 белги) |
Орнотулган жок |
| davranış.ethernetEnabled (VBl)
Системанын Ethernet интерфейсин күйгүзөт/өчүрөт. |
алып салгыла | 38 | 110 | (VBlде колдоого алынат) 1 |
| davranış.bluetoothEnabled
Bluetooth тутумун күйгүзөт/өчүрөт. |
алып салгыла | 3A | 110 | 1 |
| davranış.wifiEnabled
WiFi тутумун күйгүзөт/өчөт. |
алып салгыла | 3B | 110 | 1 |
| davranış.hdmiEnabled (VBl)
HDMI күйгүзөт/өчөт. |
алып салгыла | 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 | Жок | Жок |
| Аты/Сипаттамасы | Аракеттер | Cmd ID | Маанилердин диапазону | Демейки маани |
| audio.loudspeakerҮнсүз
Системанын катуу сүйлөгүчүнүн үнүн өчүрөт/ачат. |
пост | 34 | Жок | Жок |
| audio.loudspeakerMuteToggle
Системанын катуу сүйлөгүчүнүн үнүн өчүрүү абалын которушат. |
пост | 34 | Жок | Жок |
| audio.loudspeakerVolume
Системанын катуу сүйлөгүчүнүн үнүн орнотот. |
алып салгыла | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
Системанын катуу сүйлөгүчүнүн үнүн бир кадамга жогорулатат. |
пост | 4 | Жок | Жок |
| audio.loudspeakerVolumeDown
Системанын катуу сүйлөгүчүнүн үнүн бир кадамга азайтат. |
пост | 5 | Жок | Жок |
| камера.кичирейтүү
Камеранын учурдагы масштабдуу мааниси. |
алып салгыла | 6 | 1-10 | 1 |
| камера.пан
Камеранын учурдагы панорама мааниси. |
алып салгыла | 7 | -10-10 | 0 |
| камера.тилт
Камеранын учурдагы эңкейүү мааниси. |
алып салгыла | 8 | -10-10 | 0 |
| камера.кичирейтүү
Камераны бир кадам менен чоңойтот. |
пост | 9 | Жок | Жок |
| camera.zoomout
Камераны бир кадамга кичирейтет. |
пост | OA | Жок | Жок |
| камера.пан Солго
Камераны бир кадам артка жылдырат. |
пост | OB | Жок | Жок |
| камера.пан Туура
Камераны туура бир кадамга жылдырат. |
пост | oc | Жок | Жок |
| camera.tiltUp
Камераны бир кадам өйдө эңкейт. |
пост | OD | Жок | Жок |
| camera.tiltDown
Камераны бир кадам ылдый эңкейт. |
пост | OE | Жок | Жок |
| camera.homePreset
Камеранын үйгө алдын ала орнотулган панорамалык жантайтууну масштабдоо тартиби |
алып салгыла | 56 | 0 01 | |
| camera.firstPreset
Камеранын биринчи алдын ала орнотулган панорама жантайтууну масштабдоо тартиби. |
алып салгыла | 57 | 0 01 | |
| camera.second Preset
Камеранын экинчи алдын ала орнотулган панорама эңкейтүүнү масштабдоо тартиби. |
алып салгыла | 58 | 0 01 | |
| camera.savePresetHome
Учурдагы PTZ маанилерин алдын ала коюлган үйгө сактайт. |
пост | 12 | Жок | Жок |
| camera.savePresetFirst
Учурдагы PTZ маанилерин биринчи алдын ала коюлганга сактайт. |
пост | 17 | Жок | Жок |
| camera.savePresetSecond
Учурдагы PTZ маанилерин экинчи алдын ала коюлганга сактайт. |
пост | 18 | Жок | Жок |
| Аты/Сипаттамасы | Аракеттер | Cmd ID | Маанилердин диапазону | Демейки маани |
| камера.колдонуу ActivePreset
PTZ орнотууларына активдүү алдын ала орнотууну колдонот. |
пост | OF | Жок | Жок |
| камера.активдүү Алдын ала коюлган
Бул активдүү алдын ала коюлган. Эскертүү, камераны баштоодо же кайра иштетүүдө активдүү алдын ала орнотуу Башкы бетке коюлган. |
алып салгыла | 13 | 11213 | 1 |
| камера.мамлекет
Камера абалы. Активдүү болгондо, камера видеону агылтып жатат. Жигерсиз болгондо, камера агылбайт. Жаңыртуу учурунда камера микропрограмманы жаңыртып жатат. |
алуу | 60 | активдүүI жигерсизI өркүндөтүү | активдүү эмес |
| autoframing.state
Камераны автоматтык кадрлоо мүмкүнчүлүгүн күйгүзүңүз/өчүңүз. |
алып салгыла | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Жупташтыруу абалын күйгүзүү/өчүрүүдөн өчүрүү/күйгүзүү. |
пост | C6 | Жок | Жок |
| bluetooth.pairingState
Bluetooth жупташтыруу абалы. Күйүк абалы белгиленген аралыкка түзмөк менен жупташтырууга мүмкүндүк берет. Жупташтыруу аралыгы аяктагандан кийин, абал өчүк болуп өзгөрөт. |
коюу | 14 | 110 | 0 |
| bluetooth.state
Bluetooth жана BLE абалы. Күйүк абалы Bluetooth жана BLE күйүк экенин көрсөтөт; өчүрүлгөн абал Bluetooth жана BLE өчүк экенин көрсөтөт. |
алуу | 67 | 110 | 0 |
| bluetooth.жупташтырылган
Жупташтырылган түзмөктүн аты. |
алуу | 6A | сап
(0-128 белги) |
Орнотулган жок |
| bluetooth.connected
Түзмөктүн туташуу абалы. |
алуу | 6B | 110 | 0 |
| bluetooth.streamState
Bluetooth агымынын абалы. |
алуу | C2 | 110 | 0 |
| bluetooth.callState
Bluetooth чалуу абалы. |
алуу | 6C | 110 | 0 |
| bluetooth.ажыратуу
Bluetooth түзмөгүн ажыратыңыз. |
пост | E4 | 11213 | Жок |
| network.dhcpState
DHCP абалы. DHCP абалы күйгүзүлгөндө, тармак DHCP аркылуу конфигурацияланат. DHCP абалы өчүк болгондо, статикалык маанилер колдонулат. |
алып салгыла | 74 | 110 | 1 |
| network.ip (VBl)
DHCP абалы өчүк болгондо статикалык IP дареги. |
алып салгыла | 75 | (VBlде колдоого алынат) 0.0.0.0 | |
| network.state (VBl)
Ethernet модулунун абалы. |
алуу | 7F | бекерчилик!
ассоциацияI конфигурацияI даярI ажырат! онлайн |
(VBlде колдоого алынат) даяр |
| Аты/Сипаттамасы | Аракеттер | Cmd ID | Маанилердин диапазону | Демейки маани |
| network.mac (VBl)
LAN интерфейсинин MAC дареги. |
алуу | 80 | (VBlде колдоого алынат) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP абалы. DHCP абалы күйгүзүлгөндө, WiFi DHCP аркылуу конфигурацияланат. DHCP абалы өчүк болгондо, статикалык маанилер колдонулат. |
алып салгыла | Al | 110 | 1 |
| wifi.ip
DHCP абалы өчүк болгондо статикалык IP дареги. |
алып салгыла | A2 | 0.0.0.0 | |
| wifi.mac
WiFi интерфейсинин MAC дареги. |
алуу | AC | 00:00:00:00:00:00 | |
| wifi.state
WiFi модулунун абалы. |
алуу | BO | бекерчилик!
ассоциацияI конфигурацияI даярI ажырат! онлайн |
бош |
| telemetry.peopleCount (VBl)
Камераны автокадрлоо алгоритми менен эсептелген адамдардын саны. |
алып салгыла | DA | 0-99 | (VBlде колдоого алынат) 0 |
| telemetry.peoplePresent (VBl)
Камеранын автокадрлөө алгоритми тарабынан кандайдыр бир адамдар аныкталганда туура болот. |
алып салгыла | DC | 110 | (VBlде колдоого алынат) 0 |
Документтер / Ресурстар
 |
BOSE Work Rest API колдонмосу [pdf] Колдонуучунун колдонмосу Work, Rest API, App, Work Rest API App |
