BOSE Work Rest API App

Mawu Oyamba

Zida za Bose Videobar zimathandizira mawonekedwe amtundu wosinthira pulogalamu yamtundu wamtundu (REST API) pakuwongolera ndi kuyang'anira maukonde. Bukuli limapereka malangizo othandizira ndikusintha REST API pazida za Videobar, ndipo limapereka kufotokozera mwatsatanetsatane zamitundu yosiyanasiyana ndi magwiridwe antchito.
Zosintha ndi magwiridwe antchito zagawidwa m'magulu awa:

• dongosolo
• khalidwe
• USB
• zomvera
• kamera
• audioframing
• bulutufi
• network (VBl)
• Wifi
• telemetry (VBl)

Gawo la API Command Reference limapereka chidziwitso chotsatira pa chinthu chilichonse:

• Dzina/Mafotokozedwe Dzina la chinthucho ndi kufotokoza kwa ntchito yake.
• Zochita Zochita zomwe zitha kuchitidwa pa chinthucho. Zochita zimatha
• khalani chimodzi kapena zingapo mwa izi: pezani, ikani, chotsani, tumizani.
• Kusiyanasiyana kwa Makhalidwe Makhalidwe ovomerezeka a chinthucho.
• Mtengo Wofikira Msinkhu wa chinthucho. Uwu ndiye mtengo womwe umagwiritsidwa ntchito ngati mubweza chipangizocho kukhala chosasintha kuchokera kufakitale.
  Makhalidwe onse amatchulidwa ngati zingwe.

Zidziwitso za Chizindikiro

• Bose, Bose Work, ndi Videobar ndi zizindikiro za Bose Corporation.
• Mawu a Bluetooth” ndi ma logo ndi zizindikilo zolembetsedwa za Bluetooth SIG, Inc. ndipo kugwiritsa ntchito zilembo zotere ndi Bose Corporation kuli ndi chilolezo.
• Mawu akuti HDMI ndi chizindikiro kapena chizindikiro cholembetsedwa cha HDMI Licensing Administrator, Inc.
• Zizindikiro zina zonse ndi katundu wa eni ake.

Zambiri Zazinsinsi

Zinsinsi zanu ndizofunikira kwa Bose kotero tapanga Mfundo Zazinsinsi zomwe zimakhudza momwe timatolera, kugwiritsa ntchito, kuulula, kusamutsa, ndi kusunga zinsinsi zanu.
CHONDE WERENGANI MFUNDO ZOKHUDZA ZINTHU ZIZISINKHA IZI KUTI MUMVETSE MMENE TIMACHITA ZINTHU ZANU. NGATI MUKUGWIRIZANA NDI MFUNDO YOTSATIRA ZINTHU IZI, CHONDE MUSAMAGWIRITSE NTCHITO NTCHITO.

Kuyang'anira ndi Kukonza REST API

Kuti muthe kupeza REST API pa chipangizo, gwiritsani ntchito pulogalamu ya Bose Work Configuration, Bose Work Management app, kapena Web UI. Pezani Network> zokonda za API. Yambitsani kulowa kwa API ndikutchula dzina lolowera ndi mawu achinsinsi a API. Mudzafunika zizindikiro za API kuti mugwiritse ntchito malamulo aliwonse a REST API. Chonde onani maupangiri ogwiritsira ntchito kuti mumve zambiri.

Kuyesa API ya REST

Mutha kuyesa Videobar REST API pogwiritsa ntchito mawonekedwe a Swagger OpenAPI omwe ali pachidacho. Kuti mupeze mawonekedwe awa Videobar iyenera kulumikizidwa ndi netiweki ya IP kudzera pa mawaya ake kapena mawonekedwe a WiFi, ndipo PC yanu yolandila iyenera kukhala pa netiweki yomweyi kapena netiweki yomwe imatha kulumikizana ndi chipangizocho kudzera pa HTTPS.
Lumikizani PC yanu ku Videobar kudzera pa USB mawonekedwe. Yambitsani pulogalamu ya Bose Work Configuration ndikulowa kuti mupeze zowongolera za admin. Sankhani Network> API tsamba ndikudina ulalo:
Zolemba za REST API (Web UI)
Ngati simunalumikizidwe ndi chipangizocho kudzera pa USB ndipo PC yanu ili pa netiweki yomweyo, mutha kupeza REST API kudzera pa msakatuli wanu posakatula ku adilesi iyi:
https://<videobar-ip-address>/doc-api

Malamulo a REST API

Mawonekedwe a Videobar REST API amagwiritsa ntchito ma ID munjira zinayi zilizonse za HTTP zothandizidwa: pezani, ikani, chotsani, ndi kutumiza.
Pansipa pali kufotokoza kwa njira zinayi zotsatiridwa ndi tebulo lofotokoza njira zomwe zimathandizidwa pa lamulo lililonse.

GET

Njira ya "peza" imavomereza ID ya lamulo limodzi kapena ma ID angapo omwe ali ndi comma. Za example, kuti mupeze audio.micMute state, ID ya lamulo ndi 2. The URL ili monga chonchi:
https://192.168.1.40/api?query=2  

Gulu loyankhira lili motere, ndi mtengo wa "O" kusonyeza kuti maikolofoni sanasinthidwe:
{“2”: {“status”: “chipambano”, “mtengo”: “0”}}

Kuti mufufuze zamitundu ingapo, siyanitsani ma ID olamula angapo ndi koma. Za example, mutha kufunsa audio.micMute (ID=2) ndi system.firmwareVersion (ID=l6) motere:
https://192.168.1.40/api?query=2,16 

Chidziwitso: Osaphatikizira mipata pakati pa ma ID angapo.
Zotsatira zake zikhala:
{“2”: {“status”: “chipambano”, “mtengo”: “0”}, “16”: {“status”: “chipambano”, “value”: “1.2.13_fd6cc0e”}}

WEKA

Lamulo la "put" limagwiritsa ntchito mawonekedwe a thupi la JSON ndi fungulo kukhala "deta" ndipo mtengo wake ndi ID: mtengo awiriawiri.
Za example, kukhazikitsa audio.loudspeakerVolume (ID=3) kukhala 39, thupi la "https://192.168.1.40/ api" ndi:
{"deta":"{"3":"39″}"}

Yankho ndi:
{“3”: {“status”: “chipambano”, “code”: “0xe000”}}

Nayi exampndikukhazikitsa ma values ​​angapo:
{"deta":"{"2":"1","3":"70"}"}

Yankho ndi:
{“2”: {“status”: “chipambano”, “code”: “0xe000”}, “3”: {“status”: “success”, “code”: “0xe000”}}

Mayankho a "code" akhoza kukhala awa:

• 0xe000 : Kupambana
• 0xe001 : Kupambana - Palibe kusintha kwa mtengo
• 0xe002 : Zolakwika - Katundu wosavomerezeka
• 0xe003 : Cholakwika - Mtengo wa katundu wosavomerezeka
• 0xe004 : Zolakwika - Zolakwika za katundu
• 0xe005 : Zolakwika - Mauthenga olakwika
• 0xe006: Cholakwika - Kufikira kwatsutsidwa

POST

"Positi" ndi yofanana ndi "kuyika" ndipo imagwiritsidwa ntchito pochita zinthu, monga kutembenuza maikolofoni osalankhula ndi kukweza voliyumu ya speaker m'mwamba/pansi. Mumatchula ID yalamulo ndikugwiritsa ntchito chingwe chopanda kanthu pamtengowo.
Za example, kuti muwonjezere voliyumu ya wokamba mawu tick imodzi, gwiritsani ntchito audio.loudspeakerVolumeUp (ID=4) yokhala ndi mawonekedwe a thupi motere:
{"data":"{"4″:""}}"}

Bungwe loyankha ndi:
{“4”: {“status”: “chipambano”, “code”: “0xe000”}}
Mayankhidwe a "code" omwe angayankhidwe ndi ofanana ndi omwe alembedwa pamalamulo a PUT.

FUTA

Mawonekedwe a lamulo la "delete" akufanana ndi "peza", ndipo thupi loyankhira likufanana ndi "kuyika". Kugwiritsa ntchito kufufuta kudzabwezeretsa mtengo kukhala wokhazikika.
Za example, kuti muyike voliyumu ya audio.loudspeaker (ID=3) kuti ikhale yokhazikika, the URL ili monga chonchi:
https://192.168.1.40/api?delete=3 

Bungwe loyankha ndi: 
{“3”: {“status”: “chipambano”, “code”: “0xe000”}}

Mungafunike kutulutsa "tenga" kuti mutenge mtengo watsopano, womwe mu nkhani iyi ndi 50. ExampLe:
Lamulo:
https://192.168.1.40/api?query=3

Yankho: 
{“3”: {“status”: “chipambano”, “mtengo”: “50”}}
Mayankhidwe a "code" omwe angayankhidwe ndi ofanana ndi omwe alembedwa pamalamulo a PUT

Videobar REST API Command Reference

Dzina/ Kufotokozera	Zochita	Cmd ID	Kusiyanasiyana kwa Makhalidwe	Mtengo Wofikira
system.reboot Yambitsaninso dongosolo.	positi	32	N / A	N / A
system.serialNumber Nambala ya seri ya chipangizocho.	kupeza	10	chingwe (17 zilembo)	uuuuuuuuuuuuuuxx
system.firmwareVersion Mtundu wa firmware womwe ukuyenda pa chipangizocho. Izi zimakhazikitsidwa zokha pakukweza kwa firmware system.	kupeza	16	chingwe (1-16 zilembo)	0.0.0
dongosolo.chitsanzo Chitsanzo cha chipangizo ichi.	kupeza	D6	chingwe (1-22 zilembo)	Zosakhazikika
system.name Dzina la chipangizocho kuti chizindikirike mwapadera.	kupeza kuchotsa	25	chingwe (1-22 zilembo)	Zosakhazikika
dongosolo.chipinda Malo a chipinda cha chipangizocho	kupeza kuchotsa	26	chingwe (0-128 zilembo)	Zosakhazikika
dongosolo.pansi Malo apansi a chipangizocho.	kupeza kuchotsa	27	chingwe (0-128 zilembo)	Zosakhazikika
dongosolo.kumanga Malo omangira chipangizocho.	kupeza kuchotsa	28	chingwe (0-128 zilembo)	Zosakhazikika
system.gpiMuteStatus (VBl) GPI osalankhula mawonekedwe (kuya / kuzimitsa).	kupeza	C7	110	(Zothandizidwa ndi VBl) 0
system.maxOccupancy Kuchuluka kwa chipinda kwa chipangizocho.	kupeza kuchotsa	DF	chingwe (0-128 zilembo)	Zosakhazikika
Behavior.ethernetEnabled (VBl) Imayatsa/kuzimitsa mawonekedwe a Efaneti.	kupeza kuchotsa	38	110	(Zothandizidwa ndi VBl) 1
khalidwe.bluetoothEnabled Kuyatsa/kuzimitsa dongosolo Bluetooth.	kupeza kuchotsa	3A	110	1
behaviour.wifiEnabled Kuyatsa/kuzimitsa dongosolo WiFi.	kupeza kuchotsa	3B	110	1
Behavior.hdmiEnabled (VBl) Kuyatsa / kuzimitsa HDMI.	kupeza kuchotsa	C9	110	(Zothandizidwa ndi VBl) 0
usb.connectionStatus Chingwe cholumikizira chingwe cha USB; 0 ikachotsedwa.	kupeza	36	110	0
usb.callStatus Kuyimba foni kuchokera kwa wolandirayo wolumikizidwa ku doko la USB la dongosolo.	kupeza	37	110	0
audio.micMute Imaletsa/kumasula maikolofoni yadongosolo.	yikani	2	110	0
audio.micMuteToggle Imasintha kusalankhula kwa maikolofoni yadongosolo.	positi	15	N / A	N / A

Dzina/ Kufotokozera	Zochita	Cmd ID	Kusiyanasiyana kwa Makhalidwe	Mtengo Wofikira
audio.loudspeakerMute Imaletsa/kutsegula chokweza mawu.	positi	34	N / A	N / A
audio.loudspeakerMuteToggle Imatembenuza kusalankhula kwa chowuzira cholumikizira.	positi	34	N / A	N / A
audio.loudspeakerVolume Imakhazikitsa voliyumu ya zokuzira mawu.	kupeza kuchotsa	3	0-100	50
audio.loudspeakerVolumeUp Imawonjezera voliyumu ya zokuzira mawu pa sitepe imodzi.	positi	4	N / A	N / A
audio.loudspeakerVolumeDown Imachepetsa voliyumu ya zokuzira mawu pa sitepe imodzi.	positi	5	N / A	N / A
camera.zoom Mtengo wamakulitsidwe wa kamera pano.	kupeza kuchotsa	6	1-10	1
kamera.pan Mtengo wapano wa kamera.	kupeza kuchotsa	7	-10-10	0
kamera.tilt Mtengo wopendekeka wa kamera pano.	kupeza kuchotsa	8	-10-10	0
camera.zoom In Makulitsira kamera mkati ndi sitepe imodzi.	positi	9	N / A	N / A
camera.zoomOut Imakulitsa kamera ndi sitepe imodzi.	positi	OA	N / A	N / A
kamera.pan Kumanzere Imayatsa kamera kumanzere ndi sitepe imodzi.	positi	OB	N / A	N / A
kamera.pan Kulondola Imayatsa kamera pomwe ndi sitepe imodzi.	positi	oc	N / A	N / A
kamera.tiltUp Imapendekera kamera m'mwamba ndi sitepe imodzi.	positi	OD	N / A	N / A
camera.tiltDown Imapendekera kamera pansi ndi sitepe imodzi.	positi	OE	N / A	N / A
camera.homePreset Kukonzekera kwanyumba kwa kamera mu poto yopendekera makulitsidwe dongosolo	kupeza kuchotsa	56		0 01
camera.firstPreset Kamera yokhazikitsidwa koyamba mu dongosolo la makulitsidwe a pan.	kupeza kuchotsa	57		0 01
camera.second Preset Kukonzekera kwachiwiri kwa kamera mu poto yopendekera makulitsidwe dongosolo.	kupeza kuchotsa	58		0 01
camera.savePresetHome Imasunga ku preset yanyumba zomwe zili pano za PTZ.	positi	12	N / A	N / A
camera.savePresetFirst Imasunga ku preset yoyamba ya PTZ yomwe ilipo.	positi	17	N / A	N / A
camera.savePresetSecond Imasunga ku preset yachiwiri ya PTZ yomwe ilipo.	positi	18	N / A	N / A

Dzina/ Kufotokozera	Zochita	Cmd ID	Kusiyanasiyana kwa Makhalidwe	Mtengo Wofikira
kamera.ikani ActivePreset Imayika zokhazikitsira zokhazikika pazokonda za PTZ.	positi	OF	N / A	N / A
kamera.yogwira Kukonzekeratu Uku ndiye kukhazikitsidwa kwachangu. Zindikirani, pakuyambitsa kwa kamera kapena kuyambitsanso kukhazikitsidwa kwachangu kumayikidwa Kunyumba.	kupeza kuchotsa	13	11213	1
kamera.state Dziko la kamera. Ikamagwira, kamera imasewerera kanema. Kamera ikasiya kugwira ntchito, sikungotuluka. Mukakulitsa, kamera ikukweza firmware.	kupeza	60	activeI inactiveI kukweza	osagwira ntchito
autoframing.state Yatsani/zimitsani mawonekedwe a kamera.	kupeza kuchotsa	19	110	0
bluetooth.pairingStateToggle Sinthani mkhalidwe wolumikizana kuchokera pa kuyatsa/kuzimitsa kupita ku/kuyatsa.	positi	C6	N / A	N / A
bluetooth.pairingState Bluetooth pairing state. The on state adzalola kulumikiza ndi chipangizo kwa nthawi yokhazikika. Nthawi yolumikizana ikatha, boma lisintha.	yikani	14	110	0
bluetooth.state Bluetooth ndi BLE state. Zomwe zili paboma zidzawonetsa kuti Bluetooth ndi BLE zayatsidwa; kuchotsedwako kudzawonetsa kuti Bluetooth ndi BLE zazimitsidwa.	kupeza	67	110	0
bluetooth.paired Dzina la chipangizo chophatikizana.	kupeza	6A	chingwe (0-128 zilembo)	Zosakhazikika
bluetooth.olumikizidwa Makhalidwe olumikizana ndi chipangizocho.	kupeza	6B	110	0
bluetooth.streamState Mawonekedwe a Bluetooth.	kupeza	C2	110	0
bluetooth.callState Momwe kuyimba kwa Bluetooth.	kupeza	6C	110	0
bluetooth.disconnect Lumikizani chipangizo cha Bluetooth.	positi	E4	11213	N / A
network.dhcpState DHCP state. State DHCP ikayatsidwa, netiweki idzakonzedwa kudzera pa DHCP. Pamene DHCP yazimitsidwa, ma static values ​​amagwiritsidwa ntchito.	kupeza kuchotsa	74	110	1
network.ip (VBl) Adilesi ya IP yokhazikika pomwe DHCP yazimitsidwa.	kupeza kuchotsa	75		(Zothandizidwa ndi VBl) 0.0.0.0
network.state (VBl) Mtundu wa Ethernet module.	kupeza	7F	kulephera kwachabechabe! associationI kasinthidweNdakonzekaI kusagwirizana! pa intaneti	(Zothandizidwa mu VBl) zakonzeka

Dzina/ Kufotokozera	Zochita	Cmd ID	Kusiyanasiyana kwa Makhalidwe	Mtengo Wofikira
network.mac (VBl) Adilesi ya MAC ya mawonekedwe a LAN.	kupeza	80		(Zothandizidwa mu VBl) 00:00:00:00:00:00
wifi.dhcpState DHCP state. State DHCP ikayatsidwa, WiFi idzasinthidwa kudzera pa DHCP. Pamene DHCP yazimitsidwa, ma static values ​​amagwiritsidwa ntchito.	kupeza kuchotsa	Al	110	1
wifi.ip Adilesi ya IP yokhazikika pomwe DHCP yazimitsidwa.	kupeza kuchotsa	A2		0.0.0.0
wifi.mac Adilesi ya MAC ya mawonekedwe a WiFi.	kupeza	AC		00:00:00:00:00:00
wifi.state Mtundu wa module ya WiFi.	kupeza	BO	kulephera kwachabechabe! associationI kasinthidweNdakonzekaI kusagwirizana! pa intaneti	opanda ntchito
telemetry.peopleCount (VBl) Chiwerengero cha anthu owerengedwa ndi kamera autoframing algorithm.	kupeza kuchotsa	DA	0-99	(Zothandizidwa ndi VBl) 0
telemetry.peoplePresent (VBl) Zowona ngati anthu azindikiridwa ndi kamera ya autoframing algorithm.	kupeza kuchotsa	DC	110	(Zothandizidwa ndi VBl) 0

Zolemba / Zothandizira

BOSE Work Rest API App [pdf] Buku Logwiritsa Ntchito Work, Rest API, App, Work Rest API App

Maumboni

• Buku Logwiritsa Ntchito