BOSE Work Rest API програм
Танилцуулга
Bose Videobar төхөөрөмжүүд нь сүлжээний удирдлага, мониторинг хийхэд зориулсан төлөв дамжуулах программчлалын интерфейсийг (REST API) дэмждэг. Энэхүү гарын авлага нь Videobar төхөөрөмж дээр REST API-г идэвхжүүлэх, тохируулах зааварчилгааг өгдөг бөгөөд дэмжигдсэн хувьсагчид болон үйлдлүүдийн дэлгэрэнгүй тайлбарыг өгдөг.
Тохиргооны зүйлүүд болон үйлдлүүдийг дараах ангилалд хуваадаг.
- систем
- зан байдал
- usb
- аудио
- камер
- аудио фрейм
- bluetooth
- сүлжээ (VBl)
- wifi
- телеметр (VBl)
API тушаалын лавлагааны хэсэг нь объект бүрийн хувьд дараах мэдээллийг өгдөг.
- Нэр/Тодорхойлолт Объектын нэр, ашиглалтын тодорхойлолт.
- Үйлдлүүд Объект дээр хийж болох үйлдлүүд. Үйлдэл болно
- дараах зүйлсийн нэг буюу хэд хэдэн байх: авах, тавих, устгах, нийтлэх.
- Утгын хүрээ Объектийн зөвшөөрөгдөх утгууд.
- Default Value Объектийн үндсэн утга. Энэ нь та төхөөрөмжийг үйлдвэрийн тохиргоонд буцаах үед хэрэглэгдэх утга юм.
Бүх утгыг мөр болгон зааж өгсөн.
Барааны тэмдгийн мэдэгдэл
- Bose, Bose Work, Videobar нь Bose корпорацийн худалдааны тэмдэг юм.
- Bluetooth” үгийн тэмдэг болон лого нь Bluetooth SIG, Inc.-ийн эзэмшдэг бүртгэгдсэн худалдааны тэмдэг бөгөөд Bose корпораци ийм тэмдгийг ашиглах зөвшөөрөлтэй.
- 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-г ашигладаг.
Доорх дөрвөн аргын тайлбар, дараа нь тушаал тус бүрийн дэмжигдсэн аргуудыг тайлбарласан хүснэгт байна.
АВАХ
"Авах" арга нь нэг тушаалын ID эсвэл таслалаар тусгаарлагдсан олон ID-г хүлээн зөвшөөрдөг. Жишээ ньample, audio.micMute төлөвийг авахын тулд тушаалын ID нь 2. The URL ийм байна:
https://192.168.1.40/api?query=2
Хариултын хэсэг нь дараах байдалтай байна, "O" утга нь микрофоны дууг хаагаагүйг илтгэнэ.
{“2”: {“статус”: “амжилт”, “утга”: “0”}}
Олон утгыг асуухын тулд олон командын ID-г таслалаар тусгаарлана уу. Жишээ ньampТа дараах байдлаар 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-г зааж өгч, утгыг хоосон мөр ашиглана.
Жишээ ньampЧанга яригчийн дууг нэг товчлуураар нэмэгдүүлэхийн тулд audio.loudspeakerVolumeUp (ID=4)-г дараах үндсэн форматтай ашиглана уу:
{“өгөгдөл”:”{“4″:””}”}
Хариуцах байгууллага нь:
{“4”: {“статус”: “амжилт”, “код”: “0xe000”}}
"Код"-ын хариултын боломжит утгууд нь PUT командын жагсаалттай ижил байна.
УСТГАХ
"Устгах" командын формат нь "авах"-тай төстэй бөгөөд хариултын хэсэг нь "тавих"-тай төстэй. Устгавал утгыг анхдагч руу нь буцаана.
Жишээ ньample, audio.чанга яригчийн дууны хэмжээг (ID=3) анхдагч утгад нь тохируулахын тулд, the 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 тэмдэгт) |
ооооооооооооооооооо |
| system.firmwareVersion
Төхөөрөмж дээр ажиллаж байгаа програм хангамжийн хувилбар. Энэ нь системийн програм хангамжийг шинэчлэх үед автоматаар тохируулагдана. |
авах | 16 | мөр
(1-16 тэмдэгт) |
0.0.0 |
| систем.загвар
Энэ төхөөрөмжийн загвар. |
авах | D6 | мөр
(1-22 тэмдэгт) |
Тохируулаагүй байна |
| систем.нэр
Төхөөрөмжийн нэрийг өвөрмөц байдлаар тодорхойлох боломжтой. |
устгана уу | 25 | мөр
(1-22 тэмдэгт) |
Тохируулаагүй байна |
| систем.өрөө
Төхөөрөмжийн өрөөний байршил |
устгана уу | 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 |
| зан төлөв.bluetoothEnabled
Bluetooth системийг асаах/унтраах. |
устгана уу | 3A | 110 | 1 |
| зан төлөв.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 | Утгын хүрээ | Өгөгдмөл утга |
| аудио.чанга яригч Дууг хаах
Системийн чанга яригчийн дууг хааж/асаана. |
бичлэг | 34 | Үгүй | Үгүй |
| audio.loudspeakerMuteToggle
Системийн чанга яригчийн дууг хаах горимыг асаана. |
бичлэг | 34 | Үгүй | Үгүй |
| аудио.чанга яригчЭзлэхүүн
Системийн чанга яригчийн дууны хэмжээг тохируулна. |
устгана уу | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
Системийн чанга яригчийн дууг нэг алхамаар нэмэгдүүлнэ. |
бичлэг | 4 | Үгүй | Үгүй |
| audio.loudspeakerVolume Down
Системийн чанга яригчийн дууг нэг алхамаар бууруулдаг. |
бичлэг | 5 | Үгүй | Үгүй |
| камер. томруулах
Камерын одоогийн томруулах утга. |
устгана уу | 6 | 1-10 | 1 |
| камер.пан
Камерын одоогийн pan утга. |
устгана уу | 7 | -10-10 | 0 |
| камер.налалт
Камерын одоогийн хазайлтын утга. |
устгана уу | 8 | -10-10 | 0 |
| камер. томруулах
Камерыг нэг алхамаар томруулна. |
бичлэг | 9 | Үгүй | Үгүй |
| камер. томруулах
Камерыг нэг алхамаар томруулна. |
бичлэг | OA | Үгүй | Үгүй |
| камер.пан Зүүн
Камерыг нэг алхамаар эргүүлнэ. |
бичлэг | OB | Үгүй | Үгүй |
| камер.пан Зөв
Камерыг нэг алхамаар эргүүлнэ. |
бичлэг | oc | Үгүй | Үгүй |
| camera.tiltUp
Камерыг нэг алхамаар дээшлүүлнэ. |
бичлэг | OD | Үгүй | Үгүй |
| camera.tiltDown
Камерыг нэг алхамаар доошлуул. |
бичлэг | OE | Үгүй | Үгүй |
| camera.homePreset
Камерын нүүр царайг томруулах дарааллаар тохируулна |
устгана уу | 56 | 0 01 | |
| camera.firstPreset
Камерыг эхлээд эргүүлэх томруулалтын дарааллаар тохируулна. |
устгана уу | 57 | 0 01 | |
| камер.секунд Урьдчилан тохируулах
Камерын хоёр дахь урьдчилан тохируулсан, налууг томруулах дарааллаар. |
устгана уу | 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.төлөв
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 | Үгүй |
| 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 салга! онлайн |
(VBl-д дэмжигдсэн) бэлэн байна |
| Нэр/ Тайлбар | Үйлдлүүд | Cmd ID | Утгын хүрээ | Өгөгдмөл утга |
| сүлжээ.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 салга! онлайн |
сул зогсолт |
| telemetry.peopleCount (VBl)
Камерын автомат фрэймийн алгоритмаар тоологдсон хүмүүсийн тоо. |
устгана уу | DA | 0-99 | (VBl-д дэмжигдсэн) 0 |
| телеметр.хүмүүсТэтгэлэг (VBl)
Камерын автомат фрэймийн алгоритмаар ямар ч хүн илэрсэн тохиолдолд үнэн болно. |
устгана уу | DC | 110 | (VBl-д дэмжигдсэн) 0 |
Баримт бичиг / нөөц
 |
BOSE Work Rest API програм [pdf] Хэрэглэгчийн гарын авлага Ажил, Амралт API, Апп, Ажлын Амралт API програм |
