Mwongozo wa Mtumiaji wa Programu ya BOSE Work Rest API

Vifaa vya Bose Videobar vinaauni kiolesura cha uwakilishi cha programu ya uhamishaji wa hali (REST API) kwa usimamizi na ufuatiliaji wa mtandao. Mwongozo huu unatoa maagizo ya kuwezesha na kusanidi API ya REST kwenye vifaa vya Upau wa Video, na unatoa maelezo ya kina ya vigeuzo na uendeshaji vinavyotumika.
Vipengee vya usanidi na shughuli zimewekwa katika vikundi hivi:

mfumo
tabia
usb
sauti
kamera
muundo wa sauti
bluetooth
mtandao (VBl)
wifi
telemetry (VBl)

Sehemu ya Marejeleo ya Amri ya API hutoa habari ifuatayo kwa kila kitu:

Jina/Maelezo Jina la kitu na maelezo ya matumizi yake.

Vitendo Vitendo vinavyoweza kufanywa kwenye kitu. Kitendo kinaweza
kuwa moja au zaidi ya yafuatayo: pata, weka, futa, chapisha.

Msururu wa Thamani Thamani zinazokubalika kwa kitu.
Thamani Chaguo-msingi Thamani chaguo-msingi ya kitu. Hii ndiyo thamani inayotumika ukirejesha kifaa kwa chaguomsingi kilichotoka kiwandani.
Thamani zote zimebainishwa kama mifuatano.

Notisi za Alama ya Biashara

Bose, Bose Work, na Videobar ni alama za biashara za Bose Corporation.

Alama ya neno ya Bluetooth” na nembo ni alama za biashara zilizosajiliwa zinazomilikiwa na Bluetooth SIG, Inc. na matumizi yoyote ya alama hizo na Bose Corporation yako chini ya leseni.
Neno HDMI ni alama ya biashara au alama ya biashara iliyosajiliwa ya Msimamizi wa Leseni ya HDMI, Inc.

Alama nyingine zote za biashara ni mali ya wamiliki husika.

Taarifa za Faragha

Faragha yako ni muhimu kwa Bose kwa hivyo tumeunda Sera ya Faragha ambayo inashughulikia jinsi tunavyokusanya, kutumia, kufichua, kuhamisha na kuhifadhi maelezo yako ya kibinafsi.
TAFADHALI SOMA SERA HII YA FARAGHA KWA UMAKINI ILI KUELEWA JINSI TUNAVYOSHUGHULIKIA HABARI YAKO. IWAPO HUKUBALI SERA HII YA FARAGHA, TAFADHALI USITUMIE HUDUMA.

Kuwasha na Kusanidi API ya REST

Ili kuwezesha ufikiaji wa API ya REST kwenye kifaa, tumia programu ya Usanidi wa Bose Work, programu ya Usimamizi wa Kazi ya Bose, au Web UI. Fikia Mtandao> Mipangilio ya API. Washa ufikiaji wa API na ubainishe jina la mtumiaji na nenosiri la API. Utahitaji vitambulisho hivi vya API ili kutumia amri zozote za REST API. Tafadhali rejelea miongozo ya matumizi ya programu kwa habari zaidi.

Inajaribu API ya REST

Unaweza kujaribu Videobar REST API kwa kutumia kiolesura cha Swagger OpenAPI ambacho kimepachikwa kwenye kifaa. Ili kufikia kiolesura hiki Upau wa Video lazima uunganishwe kwa mtandao wa IP kupitia kiolesura chake cha waya au WiFi, na Kompyuta yako mwenyeji lazima iwe kwenye mtandao huo huo au mtandao unaoweza kufikia kifaa kupitia HTTPS.
Unganisha Kompyuta yako kwenye Upau wa Video kupitia kiolesura cha USB. Anzisha programu ya Usanidi wa Bose Work na uingie katika akaunti ili kufikia vidhibiti vya wasimamizi. Chagua Mtandao > ukurasa wa API na ubofye kiungo:
Hati ya API ya REST (Web UI)
Ikiwa hujaunganishwa kwenye kifaa kupitia USB na Kompyuta yako iko kwenye mtandao huo huo, unaweza kufikia API ya REST kupitia kivinjari chako kwa kuvinjari hadi anwani ifuatayo:
https://<videobar-ip-address>/doc-api

Amri za API za REST

Kiolesura cha Videobar REST API hutumia vitambulisho vya amri katika kila mojawapo ya mbinu nne za HTTP zinazotumika: pata, weka, futa, na uchapishe.
Ifuatayo ni maelezo ya njia nne zinazofuatwa na jedwali linaloelezea mbinu zinazotumika kwa kila amri.

PATA

Mbinu ya "pata" inakubali kitambulisho cha amri moja au vitambulisho vingi vilivyotenganishwa kwa koma. Kwa mfanoample, ili kupata hali ya audio.micMute, kitambulisho cha amri ni 2. The URL iko hivi:
https://192.168.1.40/api?query=2

Mwili wa majibu ni kama ifuatavyo, huku thamani ya "O" ikionyesha kuwa maikrofoni haijanyamazishwa:
{“2”: {“status”: “mafanikio”, “thamani”: “0”}}

Ili kuuliza thamani nyingi, tenga vitambulisho vya amri nyingi na koma. Kwa mfanoampna, unaweza kuuliza audio.micMute (ID=2) na system.firmwareVersion (ID=l6) kama hivi:
https://192.168.1.40/api?query=2,16

Kumbuka: Usijumuishe nafasi kati ya Vitambulisho vingi.
Matokeo yake yatakuwa:
{“2”: {“status”: “mafanikio”, “thamani”: “0”}, “16”: {“status”: “success”, “value”: “1.2.13_fd6cc0e”}}

WEKA

Amri ya "weka" hutumia umbizo la mwili la JSON na ufunguo kuwa "data" na thamani ikiwa ID:value pairs.
Kwa mfanoample, ili kuweka Volume ya sauti.kipaza sauti (ID=3) hadi 39, mwili wa "https://192.168.1.40/ api" ni:
{“data”:”{“3″:”39″}”}

Jibu ni:
{“3”: {“status”: “success”, “code”: “0xe000”}}

Hapa kuna exampna kuweka maadili mengi:
{“data”:”{“2″:”1″,”3″:”70″}”}

Jibu ni:
{“2”: {“status”: “success”, “code”: “0xe000”}, “3”: {“status”: “success”, “code”: “0xe000”}}

Maadili ya "msimbo" ya majibu yanaweza kuwa yoyote kati ya yafuatayo:

0xe000 : Mafanikio
0xe001 : Mafanikio - Hakuna mabadiliko katika thamani
0xe002 : Hitilafu - Sifa batili
0xe003 : Hitilafu - Thamani ya mali isiyo sahihi
0xe004 : Hitilafu - Kitendo batili cha mali
0xe005 : Kosa - Ujumbe haujaundwa vizuri
0xe006 : Kosa - Ufikiaji umekataliwa

POST

"Chapisho" ni sawa na "weka" na hutumika kwa vitendo, kama vile kugeuza sauti ya kipaza sauti juu/chini. Unabainisha kitambulisho cha amri na utumie kamba tupu kwa thamani.
Kwa mfanoample, ili kuongeza sauti ya spika tiki moja, tumia audio.loudspeakerVolumeUp (ID=4) na umbizo la mwili kama hili:
{“data”:”{“4″:””}”}

Mwili wa majibu ni:
{“4”: {“status”: “success”, “code”: “0xe000”}}
Thamani zinazowezekana za majibu ya "msimbo" ni sawa na zile zilizoorodheshwa kwa amri ya PUT.

FUTA

Muundo wa amri ya "kufuta" ni sawa na "kupata", na mwili wa majibu ni sawa na "kuweka". Kutumia delete kutarejesha thamani kwa chaguomsingi yake.
Kwa mfanoample, ili kuweka sauti ya kipaza sauti (ID=3) kwa thamani yake chaguomsingi, the URL iko hivi:
https://192.168.1.40/api?delete=3

Mwili wa majibu ni:
{“3”: {“status”: “success”, “code”: “0xe000”}}

Utahitaji kutoa "kupata" ili kurejesha thamani mpya, ambayo katika kesi hii ni 50. Kwa mfanoample:
Amri:
https://192.168.1.40/api?query=3

Jibu:
{“3”: {“status”: “mafanikio”, “thamani”: “50”}}
Thamani zinazowezekana za majibu ya "msimbo" ni sawa na zile zilizoorodheshwa kwa amri ya PUT

Rejea ya Amri ya Upau wa Video REST API

Jina/ Maelezo	Vitendo	Cmd ID	Msururu wa Maadili	Thamani Chaguomsingi
mfumo.washa upya Huanzisha upya mfumo.	chapisho	32	N/A	N/A
mfumo.serialNumber Nambari ya serial ya kifaa.	pata	10	kamba ( herufi 17)	ooooooooooooxx
mfumo.firmwareVersion Toleo la firmware inayoendesha kwenye kifaa. Hii imewekwa kiotomatiki kwenye uboreshaji wa programu dhibiti ya mfumo.	pata	16	kamba (herufi 1-16)	0.0.0
mfumo.mfano Mfano wa kifaa hiki.	pata	D6	kamba (herufi 1-22)	Haijawekwa
mfumo.jina Jina la kifaa ili kiweze kutambuliwa kipekee.	weka futa	25	kamba (herufi 1-22)	Haijawekwa
chumba.mfumo Eneo la chumba cha kifaa	weka futa	26	kamba (herufi 0-128)	Haijawekwa
mfumo.sakafu Eneo la sakafu la kifaa.	weka futa	27	kamba (herufi 0-128)	Haijawekwa
ujenzi.mfumo Mahali pa ujenzi wa kifaa.	weka futa	28	kamba (herufi 0-128)	Haijawekwa
system.gpiMuteStatus (VBl) Hali ya kunyamazisha ya GPI (imewashwa/kuzima).	pata	C7	110	(Inatumika katika VBl) 0
mfumo.maxOccupancy Ukaaji wa juu wa chumba wa kifaa.	weka futa	DF	kamba (herufi 0-128)	Haijawekwa
behaviour.ethernetImewezeshwa (VBl) Huwasha/kuzima kiolesura cha Ethaneti cha mfumo.	weka futa	38	110	(Inatumika katika VBl) 1
tabia.bluetoothImewezeshwa Huwasha/kuzima Bluetooth ya mfumo.	weka futa	3A	110	1
tabia.wifiImewezeshwa Huwasha/kuzima WiFi ya mfumo.	weka futa	3B	110	1
behaviour.hdmiEnabled (VBl) Huwasha/kuzima HDMI.	weka futa	C9	110	(Inatumika katika VBl) 0
usb.muunganishoHali hali ya uunganisho wa kebo ya USB; 0 wakati imekatwa.	pata	36	110	0
usb.callHali Hali ya simu kutoka kwa seva pangishi iliyounganishwa kwenye mlango wa USB wa mfumo.	pata	37	110	0
sauti.micMute Inazima/inazima maikrofoni ya mfumo.	weka	2	110	0
audio.micMuteToggle Hugeuza hali ya kimya ya maikrofoni ya mfumo.	chapisho	15	N/A	N/A

Jina/ Maelezo	Vitendo	Cmd ID	Msururu wa Maadili	Thamani Chaguomsingi
Kipaza sauti.Nyamaza Inazima/inazima kipaza sauti cha mfumo.	chapisho	34	N/A	N/A
kipaza sauti.MuteToggle Hugeuza hali ya bubu ya kipaza sauti cha mfumo.	chapisho	34	N/A	N/A
Sauti.ya.kipaza sauti Huweka sauti ya kipaza sauti cha mfumo.	weka futa	3	0-100	50
kipaza sauti.VolumeUp Huongeza sauti ya kipaza sauti cha mfumo kwa hatua moja.	chapisho	4	N/A	N/A
kipaza sauti.VolumeDown Hupunguza sauti ya kipaza sauti cha mfumo kwa hatua moja.	chapisho	5	N/A	N/A
kamera.kuza Thamani ya kukuza ya sasa ya kamera.	weka futa	6	1-10	1
sufuria.kamera Thamani ya sasa ya sufuria ya kamera.	weka futa	7	-10-10	0
kamera.inamisha Thamani ya sasa ya kuinamisha ya kamera.	weka futa	8	-10-10	0
kamera.kuza ndani Hukuza kamera ndani kwa hatua moja.	chapisho	9	N/A	N/A
camera.zoomOut Hukuza kamera nje kwa hatua moja.	chapisho	OA	N/A	N/A
sufuria.kamera Kushoto Bandika kamera kushoto kwa hatua moja.	chapisho	OB	N/A	N/A
sufuria.kamera Sawa Bandika kamera kulia kwa hatua moja.	chapisho	oc	N/A	N/A
camera.tiltUp Inainamisha kamera juu kwa hatua moja.	chapisho	OD	N/A	N/A
kamera.tiltDown Inainamisha kamera chini kwa hatua moja.	chapisho	OE	N/A	N/A
camera.homePreset Uwekaji upya wa kamera nyumbani katika mpangilio wa kukuza wa pan	weka futa	56		0 01
camera.firstPreset Kamera imewekwa mapema katika mpangilio wa kukuza wa pan.	weka futa	57		0 01
kamera.pili Seti mapema Uwekaji upya wa kamera katika mpangilio wa kukuza wa pan.	weka futa	58		0 01
camera.savePresetHome Huhifadhi kwa mpangilio wa nyumbani thamani za sasa za PTZ.	chapisho	12	N/A	N/A
camera.savePresetFirst Huhifadhi kwa uwekaji awali wa thamani za sasa za PTZ.	chapisho	17	N/A	N/A
camera.savePresetSecond Huhifadhi kwa uwekaji awali wa pili thamani za sasa za PTZ.	chapisho	18	N/A	N/A

Jina/ Maelezo	Vitendo	Cmd ID	Msururu wa Maadili	Thamani Chaguomsingi
kamera.tumia ActivePreset Hutumia uwekaji awali amilifu kwa mipangilio ya PTZ.	chapisho	OF	N/A	N/A
kamera.inatumika Weka mapema Huu ndio uwekaji awali amilifu. Kumbuka, wakati kamera inapowashwa au kuwasha upya uwekaji awali amilifu umewekwa kuwa Nyumbani.	weka futa	13	11213	1
hali.kamera Hali ya kamera. Inapotumika, kamera inatiririsha video. Wakati haitumiki, kamera haitiririri. Wakati wa kusasisha, kamera inasasisha programu dhibiti.	pata	60	activeI inactiveI kuboresha	asiyefanya kazi
hali.ya kufremu kiotomatiki Washa/zima kipengele cha uundaji otomatiki wa kamera.	weka futa	19	110	0
bluetooth.pairingStateToggle Geuza hali ya kuoanisha kutoka kwa kuwasha/kuzima hadi kuzima/kuwasha.	chapisho	C6	N/A	N/A
bluetooth.pairingState Hali ya kuoanisha Bluetooth. Hali itaruhusu kuoanisha na kifaa kwa muda uliowekwa. Mara baada ya muda wa kuoanisha kukamilika, hali itabadilika na kuzima.	weka	14	110	0
bluetooth.state Bluetooth na hali ya BLE. Hali itaonyesha kuwa Bluetooth na BLE zimewashwa; hali ya kuzima itaonyesha kuwa Bluetooth na BLE zimezimwa.	pata	67	110	0
bluetooth.imeoanishwa Jina la kifaa lililooanishwa.	pata	6A	kamba (herufi 0-128)	Haijawekwa
bluetooth.imeunganishwa Hali ya muunganisho wa kifaa kilichooanishwa.	pata	6B	110	0
bluetooth.streamState Hali ya mtiririko wa Bluetooth.	pata	C2	110	0
bluetooth.callState Hali ya simu ya Bluetooth.	pata	6C	110	0
Bluetooth.tenganisha Tenganisha kifaa cha Bluetooth.	chapisho	E4	11213	N/A
mtandao.dhcpState Jimbo la DHCP. Hali ya DHCP ikiwa imewashwa, mtandao utasanidiwa kupitia DHCP. Wakati hali ya DHCP imezimwa, maadili tuli hutumiwa.	weka futa	74	110	1
network.ip (VBl) Anwani ya IP tuli wakati hali ya DHCP imezimwa.	weka futa	75		(Inatumika katika VBl) 0.0.0.0
network.state (VBl) Hali ya moduli ya Ethernet.	pata	7F	kushindwa bila kazi! muunganoI usanidiNiko tayariI tenganisha! mtandaoni	(Inatumika katika VBl) tayari

Jina/ Maelezo	Vitendo	Cmd ID	Msururu wa Maadili	Thamani Chaguomsingi
mtandao.mac (VBl) Anwani ya MAC ya kiolesura cha LAN.	pata	80		(Inatumika katika VBl) 00:00:00:00:00:00
wifi.dhcpState Jimbo la DHCP. Hali ya DHCP ikiwa imewashwa, WiFi itasanidiwa kupitia DHCP. Wakati hali ya DHCP imezimwa, maadili tuli hutumiwa.	weka futa	Al	110	1
wifi.ip Anwani ya IP tuli wakati hali ya DHCP imezimwa.	weka futa	A2		0.0.0.0
wifi.mac Anwani ya MAC ya kiolesura cha WiFi.	pata	AC		00:00:00:00:00:00
wifi.state Hali ya moduli ya WiFi.	pata	BO	kushindwa bila kazi! muunganoI usanidiNiko tayariI tenganisha! mtandaoni	bila kazi
telemetry.peopleCount (VBl) Idadi ya watu wanaohesabiwa na algoriti ya uundaji picha otomatiki wa kamera.	weka futa	DA	0-99	(Inatumika katika VBl) 0
telemetry.peoplePresent (VBl) Kweli wakati watu wowote wamegunduliwa na algoriti ya uundaji otomatiki wa kamera.	weka futa	DC	110	(Inatumika katika VBl) 0

Nyaraka / Rasilimali

Programu ya API ya BOSE Work Rest [pdf] Mwongozo wa Mtumiaji
Work, Rest API, App, Work Rest API App

Marejeleo

Mwongozo wa Mtumiaji

Programu ya API ya BOSE Work Rest

Utangulizi