Aplikasi API Istirahat Kerja BOSE
Perkenalan
Perangkat Bose Videobar mendukung antarmuka pemrograman aplikasi transfer status representasional (REST API) untuk manajemen dan pemantauan jaringan. Panduan ini memberikan instruksi untuk mengaktifkan dan mengonfigurasi REST API pada perangkat Videobar, dan memberikan deskripsi terperinci tentang variabel dan operasi yang didukung.
Item konfigurasi dan operasi dikelompokkan dalam kategori berikut:
- sistem
- perilaku
- USB (Penghubung)
- suara
- kamera
- bingkai audio
- Bahasa Indonesia: Bluetooth
- jaringan (VBl)
- akses internet nirkabel
- telemetri (VBl)
Bagian Referensi Perintah API menyediakan informasi berikut untuk setiap objek:
- Nama/Deskripsi Nama objek dan deskripsi penggunaannya.
- Tindakan Tindakan yang dapat dilakukan pada objek. Tindakan tersebut dapat
- menjadi satu atau lebih dari yang berikut: dapatkan, taruh, hapus, posting.
- Rentang Nilai Nilai yang dapat diterima untuk objek.
- Nilai Default Nilai default objek. Ini adalah nilai yang digunakan jika Anda mengembalikan perangkat ke default pabrik.
Semua nilai ditentukan sebagai string.
Pemberitahuan Merek Dagang
- Bose, Bose Work, dan Videobar adalah merek dagang dari Bose Corporation.
- Tanda kata dan logo Bluetooth” adalah merek dagang terdaftar yang dimiliki oleh Bluetooth SIG, Inc. dan setiap penggunaan merek tersebut oleh Bose Corporation berada di bawah lisensi.
- Istilah HDMI adalah merek dagang atau merek dagang terdaftar dari HDMI Licensing Administrator, Inc.
- Semua merek dagang lainnya adalah milik pemiliknya masing-masing.
Informasi Privasi
Privasi Anda penting bagi Bose, jadi kami telah mengembangkan Kebijakan Privasi yang mencakup cara kami mengumpulkan, menggunakan, mengungkapkan, mentransfer, dan menyimpan informasi pribadi Anda.
HARAP BACA KEBIJAKAN PRIVASI INI DENGAN SEKSAMA UNTUK MEMAHAMI BAGAIMANA KAMI MENANGANI INFORMASI ANDA. JIKA ANDA TIDAK MENYETUJUI KEBIJAKAN PRIVASI INI, JANGAN GUNAKAN LAYANAN.
Mengaktifkan dan Mengonfigurasi REST API
Untuk mengaktifkan akses ke REST API pada perangkat, gunakan aplikasi Bose Work Configuration, aplikasi Bose Work Management, atau Web UI. Akses pengaturan Jaringan> API. Aktifkan akses API dan tentukan nama pengguna dan kata sandi API. Anda akan memerlukan kredensial API ini untuk menggunakan salah satu perintah REST API. Silakan lihat panduan pengguna aplikasi untuk informasi lebih lanjut.
Menguji REST API
Anda dapat menguji REST API Videobar dengan menggunakan antarmuka Swagger OpenAPI yang disematkan di perangkat. Untuk mengakses antarmuka ini, Videobar harus terhubung ke jaringan IP melalui antarmuka kabel atau WiFi, dan PC host Anda harus berada di jaringan yang sama atau jaringan yang dapat mengakses perangkat melalui HTTPS.
Hubungkan PC Anda ke Videobar melalui antarmuka USB. Mulai aplikasi Bose Work Configuration dan masuk untuk mengakses kontrol admin. Pilih halaman Jaringan > API dan klik tautan:
Dokumentasi REST API (Web UI)
Jika Anda tidak terhubung ke perangkat melalui USB dan PC Anda berada di jaringan yang sama, Anda dapat mengakses REST API melalui browser Anda dengan menelusuri alamat berikut:
https://<videobar-ip-address>/doc-api
Perintah API REST
Antarmuka Videobar REST API menggunakan ID perintah di masing-masing dari empat metode HTTP yang didukung: get, put, delete, dan post.
Di bawah ini adalah deskripsi dari empat metode diikuti dengan tabel yang menjelaskan metode yang didukung untuk masing-masing perintah.
MENDAPATKAN
Metode "get" menerima satu ID perintah atau beberapa ID yang dipisahkan koma. Untuk mantanample, untuk mendapatkan status audio.micMute, ID perintahnya adalah 2. The URL seperti ini:
https://192.168.1.40/api?query=2
Badan respons adalah sebagai berikut, dengan nilai "O" yang menunjukkan mikrofon tidak dimatikan:
{“2”: {“status”: “sukses”, “nilai”: “0”}}
Untuk menanyakan beberapa nilai, pisahkan beberapa ID perintah dengan koma. Untuk mantanample, Anda dapat meminta audio.micMute (ID=2) dan system.firmwareVersion (ID=l6) seperti ini:
https://192.168.1.40/api?query=2,16
Catatan: Jangan sertakan spasi di antara beberapa ID.
Hasilnya akan menjadi:
{“2”: {“status”: “sukses”, “nilai”: “0”}, “16”: {“status”: “sukses”, “nilai”: “1.2.13_fd6cc0e”}}
MELETAKKAN
Perintah "put" menggunakan format isi JSON dengan kuncinya adalah "data" dan nilainya adalah ID: pasangan nilai.
Misalnyaample, untuk menyetel audio.loudspeakerVolume (ID=3) ke 39, isi “https://192.168.1.40/ api” adalah:
{“data”:”{“3″:”39″}”}
Tanggapannya adalah:
{“3”: {“status”: “sukses”, “kode”: “0xe000”}}
Ini adalah mantanample mengatur beberapa nilai:
{“data”:”{“2″:”1″,”3″:”70″}”}
Tanggapannya adalah:
{“2”: {“status”: “sukses”, “kode”: “0xe000”}, “3”: {“status”: “sukses”, “kode”: “0xe000”}}
Nilai "kode" respons dapat berupa salah satu dari berikut ini:
- 0xe000 : Sukses
- 0xe001 : Sukses – Tidak ada perubahan nilai
- 0xe002 : Kesalahan – Properti tidak valid
- 0xe003 : Kesalahan – Nilai properti tidak valid
- 0xe004 : Kesalahan – Tindakan properti tidak valid
- 0xe005 : Kesalahan – Pesan salah format
- 0xe006 : Kesalahan – Akses ditolak
POS
Sebuah "posting" mirip dengan "menempatkan" dan digunakan untuk tindakan, seperti beralih mic mute dan volume speaker naik/turun. Anda menentukan ID perintah dan menggunakan string kosong untuk nilainya.
Misalnyaample, untuk memperbesar volume speaker satu centang, gunakan audio.loudspeakerVolumeUp (ID=4) dengan format body seperti ini:
{“data”:”{“4″:””}”}
Badan tanggapan adalah:
{“4”: {“status”: “sukses”, “kode”: “0xe000”}}
Nilai "kode" respons yang mungkin sama dengan yang tercantum untuk perintah PUT.
MENGHAPUS
Format perintah "hapus" mirip dengan "mendapatkan", dan isi respons mirip dengan "menempatkan". Menggunakan delete akan mengembalikan nilai ke default.
Misalnyaample, untuk mengatur volume audio.loudspeaker (ID=3) ke nilai default, tombol URL seperti ini:
https://192.168.1.40/api?delete=3
Badan tanggapan adalah:
{“3”: {“status”: “sukses”, “kode”: “0xe000”}}
Anda perlu mengeluarkan "get" untuk mengambil nilai baru, yang dalam hal ini adalah 50. Misalnya,ampsaya:
Memerintah:
https://192.168.1.40/api?query=3
Tanggapan:
{“3”: {“status”: “sukses”, “nilai”: “50”}}
Nilai "kode" respons yang mungkin sama dengan yang tercantum untuk perintah PUT
Referensi Perintah REST API Videobar
| Nama / Deskripsi | Tindakan | perintah ID | Rentang Nilai | Nilai Default |
| sistem.reboot
Reboot sistem. |
pos | 32 | Tidak tersedia | Tidak tersedia |
| sistem.serialNumber
Nomor seri perangkat. |
mendapatkan | 10 | rangkaian
(17 karakter) |
oooooooooooooxx |
| system.firmwareVersion
Versi firmware yang berjalan di perangkat. Ini diatur secara otomatis pada peningkatan firmware sistem. |
mendapatkan | 16 | rangkaian
(1-16 karakter) |
0.0.0 |
| model sistem
Model perangkat ini. |
mendapatkan | D6 | rangkaian
(1-22 karakter) |
Tidak diatur |
| sistem.nama
Nama perangkat sehingga dapat diidentifikasi secara unik. |
dapatkan hapus | 25 | rangkaian
(1-22 karakter) |
Tidak diatur |
| sistem.ruangan
Lokasi kamar perangkat |
dapatkan hapus | 26 | rangkaian
(0-128 karakter) |
Tidak diatur |
| sistem.lantai
Lokasi lantai perangkat. |
dapatkan hapus | 27 | rangkaian
(0-128 karakter) |
Tidak diatur |
| sistem.bangunan
Lokasi bangunan perangkat. |
dapatkan hapus | 28 | rangkaian
(0-128 karakter) |
Tidak diatur |
| sistem.gpiMuteStatus (VBL)
Status bisu GPI (hidup/mati). |
mendapatkan | C7 | 110 | (Didukung dalam VBl) 0 |
| system.maxOccupancy
Hunian maksimum kamar perangkat. |
dapatkan hapus | DF | rangkaian
(0-128 karakter) |
Tidak diatur |
| perilaku.ethernetEnabled (VBl)
Menghidupkan/mematikan antarmuka Ethernet sistem. |
dapatkan hapus | 38 | 110 | (Didukung dalam VBl) 1 |
| perilaku.bluetoothEnabled
Menghidupkan/mematikan sistem Bluetooth. |
dapatkan hapus | 3A | 110 | 1 |
| behavior.wifiEnabled
Menghidupkan/mematikan sistem WiFi. |
dapatkan hapus | 3B | 110 | 1 |
| perilaku.hdmiEnabled (VBl)
Menghidupkan/mematikan HDMI. |
dapatkan hapus | C9 | 110 | (Didukung dalam VBl) 0 |
| usb.koneksiStatus
status koneksi kabel USB; 0 saat terputus. |
mendapatkan | 36 | 110 | 0 |
| usb.callStatus
Status panggilan dari host yang terhubung ke port USB sistem. |
mendapatkan | 37 | 110 | 0 |
| audio.micMute
Mematikan/menyalakan mikrofon sistem. |
dapatkan | 2 | 110 | 0 |
| audio.micMuteToggle
Mengalihkan status bisu mikrofon sistem. |
pos | 15 | Tidak tersedia | Tidak tersedia |
| Nama / Deskripsi | Tindakan | perintah ID | Rentang Nilai | Nilai Default |
| audio.loudspeakerMute
Mematikan/menyalakan loudspeaker sistem. |
pos | 34 | Tidak tersedia | Tidak tersedia |
| audio.loudspeakerMuteToggle
Mengalihkan status mute loudspeaker sistem. |
pos | 34 | Tidak tersedia | Tidak tersedia |
| audio.loudspeakerVolume
Mengatur volume pengeras suara sistem. |
dapatkan hapus | 3 | Nomor telepon 0-100 | 50 |
| audio.loudspeakerVolumeUp
Meningkatkan volume loudspeaker sistem satu langkah. |
pos | 4 | Tidak tersedia | Tidak tersedia |
| audio.loudspeakerVolumeDown
Mengurangi volume loudspeaker sistem satu langkah. |
pos | 5 | Tidak tersedia | Tidak tersedia |
| kamera.zoom
Nilai zoom kamera saat ini. |
dapatkan hapus | 6 | Nomor telepon 1-10 | 1 |
| kamera.pan
Nilai pan kamera saat ini. |
dapatkan hapus | 7 | -10-10 | 0 |
| kamera.miring
Nilai kemiringan kamera saat ini. |
dapatkan hapus | 8 | -10-10 | 0 |
| kamera.zoom In
Memperbesar kamera dengan satu langkah. |
pos | 9 | Tidak tersedia | Tidak tersedia |
| kamera.zoomOut
Memperbesar kamera dengan satu langkah. |
pos | OA | Tidak tersedia | Tidak tersedia |
| kamera.pan Kiri
Pans kamera tertinggal satu langkah. |
pos | OB | Tidak tersedia | Tidak tersedia |
| kamera.pan Benar
Pans kamera dengan satu langkah. |
pos | oc | Tidak tersedia | Tidak tersedia |
| kamera.tiltUp
Miringkan kamera satu langkah. |
pos | OD | Tidak tersedia | Tidak tersedia |
| kamera.tiltDown
Miringkan kamera ke bawah satu langkah. |
pos | OE | Tidak tersedia | Tidak tersedia |
| kamera.homePreset
Prasetel beranda kamera dalam urutan zoom pan tilt |
dapatkan hapus | 56 | 0 01 | |
| kamera.firstPreset
Kamera prasetel pertama dalam urutan zoom pan tilt. |
dapatkan hapus | 57 | 0 01 | |
| kamera.Preset kedua
Kamera preset kedua dalam urutan zoom pan tilt. |
dapatkan hapus | 58 | 0 01 | |
| kamera.savePresetHome
Menyimpan ke preset awal nilai PTZ saat ini. |
pos | 12 | Tidak tersedia | Tidak tersedia |
| kamera.savePresetFirst
Menyimpan ke preset pertama nilai PTZ saat ini. |
pos | 17 | Tidak tersedia | Tidak tersedia |
| kamera.savePresetSecond
Menyimpan ke preset kedua nilai PTZ saat ini. |
pos | 18 | Tidak tersedia | Tidak tersedia |
| Nama / Deskripsi | Tindakan | perintah ID | Rentang Nilai | Nilai Default |
| kamera.berlaku Preset Aktif
Menerapkan preset aktif ke pengaturan PTZ. |
pos | OF | Tidak tersedia | Tidak tersedia |
| kamera.aktif Telah ditetapkan sebelumnya
Ini adalah prasetel aktif. Catatan, saat kamera memulai atau memulai ulang, preset aktif diatur ke Home. |
dapatkan hapus | 13 | 11213 | 1 |
| kamera.negara
Status kamera. Saat aktif, kamera sedang streaming video. Saat tidak aktif, kamera tidak streaming. Saat memutakhirkan, kamera sedang mengupgrade firmware. |
mendapatkan | 60 | aktif saya tidak aktif saya meningkatkan | tidak aktif |
| autoframing.state
Mengaktifkan/menonaktifkan fitur autoframing kamera. |
dapatkan hapus | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
Alihkan status penyandingan dari on/off ke off/on. |
pos | C6 | Tidak tersedia | Tidak tersedia |
| bluetooth.pairingState
Status pasangan Bluetooth. Status aktif akan memungkinkan pemasangan dengan perangkat untuk interval tetap. Setelah interval pemasangan selesai, status akan berubah menjadi mati. |
dapatkan | 14 | 110 | 0 |
| bluetooth.status
Status Bluetooth dan BLE. Status aktif akan menunjukkan bahwa Bluetooth dan BLE aktif; keadaan mati akan menunjukkan bahwa Bluetooth dan BLE mati. |
mendapatkan | 67 | 110 | 0 |
| bluetooth.dipasangkan
Nama perangkat yang dipasangkan. |
mendapatkan | 6A | rangkaian
(0-128 karakter) |
Tidak diatur |
| bluetooth. terhubung
Status koneksi perangkat yang dipasangkan. |
mendapatkan | 6B | 110 | 0 |
| bluetooth.streamState
Status streaming Bluetooth. |
mendapatkan | C2 | 110 | 0 |
| bluetooth.callState
Status panggilan Bluetooth. |
mendapatkan | 6C | 110 | 0 |
| bluetooth.putuskan
Putuskan sambungan perangkat Bluetooth. |
pos | E4 | 11213 | Tidak tersedia |
| jaringan.dhcpState
status DHCP. Ketika status DHCP aktif, jaringan akan dikonfigurasi melalui DHCP. Saat status DHCP mati, nilai statis digunakan. |
dapatkan hapus | 74 | 110 | 1 |
| jaringan.ip (VBl)
Alamat IP statis saat status DHCP mati. |
dapatkan hapus | 75 | (Didukung dalam VBl) 0.0.0.0 | |
| jaringan.status (VBl)
Status modul Ethernet. |
mendapatkan | 7F | kegagalan yang sia-sia!
asosiasiI konfigurasiSaya siapI memutuskan! on line |
(Didukung dalam VBl) siap |
| Nama / Deskripsi | Tindakan | perintah ID | Rentang Nilai | Nilai Default |
| jaringan.mac (VBL)
Alamat MAC dari antarmuka LAN. |
mendapatkan | 80 | (Didukung di VBl) 00:00:00:00:00:00 | |
| wifi.dhcpState
status DHCP. Saat status DHCP aktif, WiFi akan dikonfigurasi melalui DHCP. Saat status DHCP mati, nilai statis digunakan. |
dapatkan hapus | Al | 110 | 1 |
| wifi.ip
Alamat IP statis saat status DHCP mati. |
dapatkan hapus | A2 | 0.0.0.0 | |
| wifi.mac
Alamat MAC dari antarmuka WiFi. |
mendapatkan | AC | 00:00:00:00:00:00 | |
| wifi.negara
Status modul WiFi. |
mendapatkan | BO | kegagalan yang sia-sia!
asosiasiI konfigurasiSaya siapI memutuskan! on line |
menganggur |
| telemetri.penghitungan orang (VBL)
Jumlah orang yang dihitung oleh algoritma autoframing kamera. |
dapatkan hapus | DA | Nomor telepon 0-99 | (Didukung dalam VBl) 0 |
| telemetri.peoplePresent (VBL)
Benar ketika ada orang yang terdeteksi oleh algoritma autoframing kamera. |
dapatkan hapus | DC | 110 | (Didukung dalam VBl) 0 |
Dokumen / Sumber Daya
 |
Aplikasi API Istirahat Kerja BOSE [Bahasa Indonesia:] Panduan Pengguna Work, Rest API, Aplikasi, Aplikasi Work Rest API |
