BOSE Work Rest API հավելված

Ներածություն

Bose Videobar սարքերն աջակցում են ներկայացուցչական վիճակի փոխանցման հավելվածի ծրագրավորման ինտերֆեյսին (REST API) ցանցի կառավարման և մոնիտորինգի համար: Այս ուղեցույցը հրահանգներ է տալիս REST API-ն միացնելու և կարգավորելու Videobar սարքերում, ինչպես նաև տրամադրում է աջակցվող փոփոխականների և գործողությունների մանրամասն նկարագրություն:
Կազմաձևման տարրերը և գործողությունները խմբավորված են հետևյալ կատեգորիաներում.

• համակարգ
• վարքագիծը
• 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 օգտվողի անուն և գաղտնաբառ: Ձեզ անհրաժեշտ կլինեն այս API հավատարմագրերը REST API հրամաններից որևէ մեկը օգտագործելու համար: Լրացուցիչ տեղեկությունների համար խնդրում ենք հղում կատարել հավելվածի օգտագործման ուղեցույցներին:

REST API-ի փորձարկում

Դուք կարող եք փորձարկել Videobar REST API-ն՝ օգտագործելով Swagger OpenAPI ինտերֆեյսը, որը ներկառուցված է սարքում: Այս ինտերֆեյսը մուտք գործելու համար Videobar-ը պետք է միացված լինի IP ցանցին իր լարային կամ WiFi ինտերֆեյսի միջոցով, և ձեր հյուրընկալող համակարգիչը պետք է լինի նույն ցանցում կամ ցանցում, որը կարող է մուտք գործել սարք HTTPS-ի միջոցով:
Միացրեք ձեր համակարգիչը Videobar-ին USB ինտերֆեյսի միջոցով: Գործարկեք Bose Work Configuration հավելվածը և մուտք գործեք՝ ադմինիստրատորի կառավարումներից օգտվելու համար: Ընտրեք Ցանց > API էջը և սեղմեք հղմանը.
REST API Փաստաթղթեր (Web UI)
Եթե ​​դուք սարքին միացված չեք USB-ի միջոցով, և ձեր համակարգիչը միևնույն ցանցում է, կարող եք մուտք գործել REST API ձեր բրաուզերի միջոցով՝ զննարկելով հետևյալ հասցեով.
https://<videobar-ip-address>/doc-api

REST API հրամաններ

Videobar REST API ինտերֆեյսը օգտագործում է հրամանի ID-ներ աջակցվող HTTP չորս մեթոդներից յուրաքանչյուրում՝ ստանալ, տեղադրել, ջնջել և տեղադրել:
Ստորև ներկայացված է չորս մեթոդների նկարագրությունը, որին հաջորդում է աղյուսակը, որը նկարագրում է հրամաններից յուրաքանչյուրի համար աջակցվող մեթոդները:

ՍՏԱՆԱԼ

«Get» մեթոդն ընդունում է մեկ հրամանի ID կամ մի քանի ստորակետերով սահմանազատված ID-ներ: Նախample, audio.micMute վիճակ ստանալու համար հրամանի ID-ն 2 է 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”: {“status”: “success”, “value”: “0”}, “16”: {“status”: “success”, “value”: “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: Սխալ – Մուտքը մերժված է

ՓՈՍՏ

«Գրառումը» նման է «տեղադրմանը» և օգտագործվում է այնպիսի գործողությունների համար, ինչպիսիք են խոսափողի անջատումը և բարձրախոսի ձայնի բարձրացում/նվազում: Դուք նշում եք հրամանի ID-ն և արժեքի համար օգտագործում դատարկ տող:
Նախample, բարձրախոսի ձայնը մեկ տիկ բարձրացնելու համար օգտագործեք audio.loudspeakerVolumeUp (ID=4) մարմնի ձևաչափով հետևյալը.
{“տվյալներ”:”{“4″:””}”}

Արձագանքման մարմինն է.
{“4”: {“կարգավիճակ”: “հաջողություն”, “կոդ”: “0xe000”}}
Հնարավոր պատասխանի «կոդ» արժեքները նույնն են, ինչ նշված է PUT հրամանի համար:

ՋՆՋԵԼ

«Ջնջել» հրամանի ձևաչափը նման է «ստանալ»-ին, իսկ պատասխանի մարմինը՝ «տեղադրել»: Ջնջման օգտագործումը արժեքը կվերադարձնի իր լռելյայն:
Նախample, audio.loudspeaker-ի ձայնը (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	N/A	N/A
system.serialNumber Սարքի սերիական համարը.	ստանալ	10	լար (17 նիշ)	Ooooooxooooooooxx
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.maxOccupancy Սենյակի առավելագույն զբաղվածությունը սարքի.	ստանալ դրել ջնջել	DF	լար (0-128 նիշ)	Սահմանված չէ
Behaviour.ethernetEnabled (VBl) Միացնում/անջատում է համակարգի Ethernet ինտերֆեյսը:	ստանալ դրել ջնջել	38	110	(Աջակցվում է VBl-ում) 1
Behavior.bluetooth Enabled Միացնում/անջատում է համակարգի Bluetooth-ը:	ստանալ դրել ջնջել	3A	110	1
Behavior.wifi Միացված է Միացնում/անջատում է համակարգի WiFi-ը:	ստանալ դրել ջնջել	3B	110	1
Behavior.hdmiEnabled (VBl) Միացնում/անջատում է HDMI-ը:	ստանալ դրել ջնջել	C9	110	(Աջակցվում է VBl-ում) 0
usb.connectionStatus USB մալուխի միացման կարգավիճակը; 0, երբ անջատված է:	ստանալ	36	110	0
usb.callStatus Զանգի կարգավիճակը հյուրընկալողից, որը միացված է համակարգի USB միացքին:	ստանալ	37	110	0
audio.mic Mute Անջատում/անջատում է համակարգի խոսափողը:	դնել	2	110	0
audio.micMuteToggle Անջատում է համակարգի խոսափողի անջատման վիճակը:	գրառում	15	N/A	N/A

Անուն/Նկարագրություն	Գործողություններ	Cmd ID	Արժեքների միջակայք	Կանխադրված արժեք
audio.loudspeaker Mute Անջատում/անջատում է համակարգի բարձրախոսը:	գրառում	34	N/A	N/A
audio.loudspeakerMuteToggle Անջատում է համակարգի բարձրախոսի անջատման վիճակը:	գրառում	34	N/A	N/A
audio.loudspeakerVolume Սահմանում է համակարգի բարձրախոսի ձայնը:	ստանալ դրել ջնջել	3	0-100	50
audio.loudspeakerVolumeUp Մեկ քայլով մեծացնում է համակարգի բարձրախոսի ձայնը:	գրառում	4	N/A	N/A
audio.loudspeakerVolumeDown Մեկ քայլով նվազեցնում է համակարգի բարձրախոսի ձայնը:	գրառում	5	N/A	N/A
տեսախցիկ.խոշորացում Խցիկի ընթացիկ խոշորացման արժեքը:	ստանալ դրել ջնջել	6	1-10	1
տեսախցիկ.pan Տեսախցիկի ներկա պահման արժեքը:	ստանալ դրել ջնջել	7	-10-10	0
տեսախցիկ.թեք Տեսախցիկի ընթացիկ թեքության արժեքը:	ստանալ դրել ջնջել	8	-10-10	0
camera.zoom In Մեծացնում է տեսախցիկը մեկ քայլով:	գրառում	9	N/A	N/A
camera.zoomOut Մեծացնում է տեսախցիկը մեկ քայլով:	գրառում	OA	N/A	N/A
տեսախցիկ.pan Ձախ Տապակել տեսախցիկը մեկ քայլով:	գրառում	OB	N/A	N/A
տեսախցիկ.pan Ճիշտ է Շրջեք տեսախցիկը մեկ քայլով:	գրառում	oc	N/A	N/A
camera.tiltUp Տեսախցիկը մեկ քայլով վեր է թեքում:	գրառում	OD	N/A	N/A
camera.tiltDown Տեսախցիկը մեկ քայլով թեքվում է ներքև:	գրառում	OE	N/A	N/A
camera.homePreset Տան տեսախցիկի նախադրվածը` թեքության մեծացման կարգով	ստանալ դրել ջնջել	56		0 01
camera.firstPreset Տեսախցիկը առաջինը նախադրված է թեքության թեքման կարգով:	ստանալ դրել ջնջել	57		0 01
camera.second Նախադրված Տեսախցիկի երկրորդ նախադրյալը` համաժողովրդական թեքման խոշորացման կարգով:	ստանալ դրել ջնջել	58		0 01
camera.savePresetHome Պահպանում է հիմնական նախադրված PTZ-ի ընթացիկ արժեքները:	գրառում	12	N/A	N/A
camera.savePresetFirst Պահպանում է ընթացիկ PTZ արժեքները առաջին նախադրվածում:	գրառում	17	N/A	N/A
camera.savePresetSecond Պահպանում է ընթացիկ PTZ արժեքները երկրորդ նախադրյալում:	գրառում	18	N/A	N/A

Անուն/Նկարագրություն	Գործողություններ	Cmd ID	Արժեքների միջակայք	Կանխադրված արժեք
տեսախցիկ.դիմել ActivePreset Կիրառում է ակտիվ նախադրյալը PTZ կարգավորումների վրա:	գրառում	OF	N/A	N/A
տեսախցիկ.ակտիվ Նախադրված Սա ակտիվ նախադրյալն է: Նկատի ունեցեք, որ տեսախցիկի մեկնարկի կամ վերագործարկման ժամանակ ակտիվ նախադրյալը դրված է Գլխավոր էջ:	ստանալ դրել ջնջել	13	11213	1
տեսախցիկ.պետ Տեսախցիկի վիճակը. Երբ ակտիվ է, տեսախցիկը տեսանյութ է հեռարձակում: Երբ անգործուն է, տեսախցիկը չի հեռարձակվում: Թարմացնելիս տեսախցիկը թարմացնում է որոնվածը:	ստանալ	60	ակտիվ, ոչ ակտիվ, թարմացում	ոչ ակտիվ
autoframing.state Միացնել/անջատել տեսախցիկի ավտոմատ կադրավորումը:	ստանալ դրել ջնջել	19	110	0
bluetooth.pairingStateToggle Միացնել/անջատել/անջատել/միացնել զուգավորման վիճակը:	գրառում	C6	N/A	N/A
bluetooth.pairingState Bluetooth-ի զուգակցման վիճակ: Միացված վիճակը թույլ կտա զուգակցել սարքի հետ ֆիքսված ընդմիջումով: Երբ զուգակցման միջակայքն ավարտվի, վիճակը կփոխվի անջատվածի:	դնել	14	110	0
bluetooth.state 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	N/A
network.dhcpState DHCP վիճակ. Երբ DHCP վիճակը միացված է, ցանցը կկարգավորվի DHCP-ի միջոցով: Երբ DHCP վիճակն անջատված է, օգտագործվում են ստատիկ արժեքներ:	ստանալ դրել ջնջել	74	110	1
network.ip (VBl) Ստատիկ IP հասցե, երբ DHCP վիճակն անջատված է:	ստանալ դրել ջնջել	75		(Աջակցվում է VBl-ում) 0.0.0.0
network.state (VBl) Ethernet մոդուլի վիճակը:	ստանալ	7F	անգործության ձախողում! ասոցիացիա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 Ստատիկ IP հասցե, երբ DHCP վիճակն անջատված է:	ստանալ դրել ջնջել	A2		0.0.0.0
wifi.mac WiFi ինտերֆեյսի MAC հասցեն:	ստանալ	AC		00:00:00:00:00:00
wifi.state WiFi մոդուլի վիճակը:	ստանալ	BO	անգործության ձախողում! ասոցիացիա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 հավելված

Հղումներ

• Օգտագործողի ձեռնարկ