راهنمای کاربر برنامه BOSE Work Rest API

دستگاه های Bose Videobar از رابط برنامه نویسی برنامه انتقال حالت نمایشی (REST API) برای مدیریت و نظارت شبکه پشتیبانی می کنند. این راهنما دستورالعمل‌هایی را برای فعال کردن و پیکربندی REST API در دستگاه‌های نوار ویدئو ارائه می‌کند و شرح مفصلی از متغیرها و عملیات‌های پشتیبانی شده ارائه می‌دهد.
موارد و عملیات پیکربندی در این دسته بندی ها دسته بندی می شوند:

سیستم
رفتار
usb
صوتی
دوربین
فریم صوتی
بلوتوث
شبکه (VBl)
وای فای
تله متری (VBl)

بخش API Command Reference اطلاعات زیر را برای هر شی ارائه می دهد:

نام/توضیحات نام شیء و شرح کاربرد آن.

اقدامات اعمالی که می توان روی شی انجام داد. عمل می تواند
یکی یا چند مورد از موارد زیر باشد: دریافت، گذاشتن، حذف، ارسال.

محدوده مقادیر مقادیر قابل قبول برای شی.
مقدار پیش فرض مقدار پیش فرض شی. این مقداری است که اگر دستگاه را به حالت پیش فرض کارخانه برگردانید استفاده می شود.
همه مقادیر به عنوان رشته مشخص می شوند.

اعلامیه های علامت تجاری

Bose، Bose Work و Videobar علائم تجاری Bose Corporation هستند.

علامت و آرم کلمه بلوتوث علائم تجاری ثبت شده متعلق به Bluetooth SIG، Inc. هستند و هرگونه استفاده از این علائم توسط Bose Corporation تحت مجوز است.
اصطلاح HDMI یک علامت تجاری یا علامت تجاری ثبت شده HDMI Licensing Administrator, Inc است.

سایر علائم تجاری متعلق به صاحبان مربوطه می باشد.

اطلاعات حریم خصوصی

حریم خصوصی شما برای Bose مهم است، بنابراین ما یک خط‌مشی رازداری ایجاد کرده‌ایم که نحوه جمع‌آوری، استفاده، افشای، انتقال و ذخیره اطلاعات شخصی شما را پوشش می‌دهد.
لطفاً این سیاست حفظ حریم خصوصی را با دقت بخوانید تا متوجه شوید که ما چگونه با اطلاعات شما برخورد می کنیم. اگر با این سیاست حفظ حریم خصوصی موافق نیستید، لطفاً از خدمات استفاده نکنید.

فعال کردن و پیکربندی REST API

برای فعال کردن دسترسی به REST API در دستگاه، از برنامه Bose Work Configuration، برنامه Bose Work Management یا Web UI. به تنظیمات Network> API دسترسی پیدا کنید. دسترسی API را فعال کنید و نام کاربری و رمز عبور API را مشخص کنید. برای استفاده از هر یک از دستورات REST API به این اعتبارنامه های API نیاز دارید. لطفاً برای اطلاعات بیشتر به راهنمای کاربر برنامه مراجعه کنید.

تست REST API

می توانید Videobar REST API را با استفاده از رابط Swagger OpenAPI که در دستگاه تعبیه شده است، آزمایش کنید. برای دسترسی به این رابط، نوار ویدئو باید از طریق رابط سیمی یا WiFi به یک شبکه IP متصل باشد و رایانه میزبان شما باید در همان شبکه یا شبکه ای باشد که بتواند از طریق HTTPS به دستگاه دسترسی داشته باشد.
کامپیوتر خود را از طریق رابط USB به نوار ویدئو وصل کنید. برنامه Bose Work Configuration را راه اندازی کنید و برای دسترسی به کنترل های سرپرست وارد شوید. صفحه Network > API را انتخاب کنید و روی پیوند کلیک کنید:
اسناد REST API (Web رابط کاربری)
اگر از طریق USB به دستگاه متصل نیستید و رایانه شخصی شما در همان شبکه است، می توانید با مرور به آدرس زیر به REST API از طریق مرورگر خود دسترسی پیدا کنید:
https://<videobar-ip-address>/doc-api

دستورات REST API

رابط Videobar REST API از شناسه های فرمان در هر یک از چهار روش HTTP پشتیبانی شده استفاده می کند: دریافت، قرار دادن، حذف و ارسال.
در زیر شرحی از چهار روش به همراه جدولی ارائه شده است که متدهای پشتیبانی شده برای هر یک از دستورات را توضیح می دهد.

دریافت کنید

روش "get" یک شناسه فرمان واحد یا چند شناسه محدود شده با کاما را می پذیرد. برای مثالample، برای دریافت حالت audio.micMute، شناسه فرمان 2 است URL مانند این است:
https://192.168.1.40/api?query=2

بدنه پاسخ به شرح زیر است، با مقدار "O" که نشان می دهد میکروفون بی صدا نیست:
{“2”: {“وضعیت”: “موفقیت”, “ارزش”: “0”}}

برای پرس و جو برای مقادیر متعدد، شناسه های چندگانه فرمان را با کاما جدا کنید. برای مثالampشما می‌توانید برای audio.micMute (ID=2) و system.firmwareVersion (ID=l6) پرس و جو کنید:
https://192.168.1.40/api?query=2,16

توجه: فاصله بین چند شناسه را وارد نکنید.
نتیجه این خواهد بود:
{«2»: {«وضعیت»: «موفقیت»، «مقدار»: «0»}، «16»: {«وضعیت»: «موفقیت»، «مقدار»: «1.2.13_fd6cc0e»}}

قرار دادن

دستور "put" از فرمت بدنه JSON با کلید "داده" و مقدار جفت ID:مقدار استفاده می کند.
برای مثالample، برای تنظیم صدا.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: خطا - دسترسی ممنوع است

ارسال کنید

یک "پست" شبیه "گزارش" است و برای اقداماتی مانند خاموش کردن صدای میکروفون و افزایش/کاهش صدای بلندگو استفاده می شود. شما شناسه فرمان را مشخص کرده و از یک رشته خالی برای مقدار استفاده می کنید.
برای مثالampبرای افزایش یک تیک صدای بلندگو، از audio.loudspeakerVolumeUp (ID=4) با فرمت بدنه مانند زیر استفاده کنید:
{“داده”:”{“4″:””}”}

بدن پاسخ:
{“4”: {“وضعیت”: “موفقیت”, “کد”: “0xe000”}}
مقادیر پاسخ ممکن "کد" همان مقادیری است که برای دستور PUT ذکر شده است.

حذف کنید

فرمت دستور "حذف" شبیه "get" و بدنه پاسخ مشابه "put" است. استفاده از delete مقدار را به حالت پیش فرض برمی گرداند.
برای مثالample، برای تنظیم میزان صدای audio.loudspeaker (ID=3) به مقدار پیش فرض آن، the URL مانند این است:
https://192.168.1.40/api?delete=3

بدن پاسخ:
{“3”: {“وضعیت”: “موفقیت”, “کد”: “0xe000”}}

برای بازیابی مقدار جدید، که در این مورد 50 است، باید یک "get" صادر کنید.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.Serial Number شماره سریال دستگاه.	دریافت کنید	10	رشته (17 کاراکتر)	اووووووووووووخ
system.firmwareVersion نسخه سیستم عامل در حال اجرا بر روی دستگاه. این به طور خودکار در ارتقاء سیستم عامل سیستم تنظیم می شود.	دریافت کنید	16	رشته (1-16 نویسه)	0.0.0
سیستم.مدل مدل این دستگاه.	دریافت کنید	D6	رشته (1-22 نویسه)	تنظیم نشده
system.name نام دستگاه تا بتوان آن را به طور منحصر به فرد شناسایی کرد.	قرار دادن حذف	25	رشته (1-22 نویسه)	تنظیم نشده
سیستم.اتاق محل قرارگیری دستگاه در اتاق	قرار دادن حذف	26	رشته (0-128 نویسه)	تنظیم نشده
سیستم.کف محل طبقه دستگاه.	قرار دادن حذف	27	رشته (0-128 نویسه)	تنظیم نشده
سیستم.ساختمان محل ساخت دستگاه.	قرار دادن حذف	28	رشته (0-128 نویسه)	تنظیم نشده
system.gpiMuteStatus (VBl) وضعیت قطع GPI (روشن/خاموش).	دریافت کنید	C7	110	(پشتیبانی شده در VBl) 0
system.max اشغال حداکثر اشغال اتاق دستگاه.	قرار دادن حذف	DF	رشته (0-128 نویسه)	تنظیم نشده
Behavior.ethernetEnabled (VBl) رابط اترنت سیستم را روشن/خاموش می کند.	قرار دادن حذف	38	110	(پشتیبانی شده در VBl) 1
Behavior.bluetoothEnabled بلوتوث سیستم را روشن/خاموش می کند.	قرار دادن حذف	3A	110	1
Behavior.wifiEnabled وای فای سیستم را روشن/خاموش می کند.	قرار دادن حذف	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.micMute میکروفون سیستم را بی صدا/لغو می کند.	قرار دادن	2	110	0
audio.micMuteToggle وضعیت بی صدا میکروفون سیستم را تغییر می دهد.	پست	15	N/A	N/A

نام / توضیحات	اقدامات	Cmd ID	محدوده ارزش ها	مقدار پیش فرض
audio.loudspeaker نادیده گرفتن بلندگوی سیستم را بی صدا/لغو می کند.	پست	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
دوربین. پان مقدار حرکت فعلی دوربین.	قرار دادن حذف	7	-10-10	0
دوربین. شیب مقدار شیب فعلی دوربین.	قرار دادن حذف	8	-10-10	0
camera.zoom In دوربین را یک مرحله بزرگنمایی می کند.	پست	9	N/A	N/A
camera.zoomOut دوربین را یک مرحله بزرگنمایی می کند.	پست	OA	N/A	N/A
دوربین. پان سمت چپ دوربین را یک قدم به سمت چپ می چرخاند.	پست	OB	N/A	N/A
دوربین. پان درسته دوربین را یک قدم به سمت راست حرکت می دهد.	پست	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	فعال I غیر فعال در حال ارتقاء	غیر فعال
autoframing.state ویژگی قاب خودکار دوربین را روشن/خاموش کنید.	قرار دادن حذف	19	110	0
bluetooth.pairingStateToggle وضعیت جفت شدن را از روشن/خاموش به خاموش/روشن تغییر دهید.	پست	C6	N/A	N/A
bluetooth.pairingState وضعیت جفت شدن بلوتوث حالت روشن اجازه جفت شدن با دستگاه را برای یک بازه زمانی ثابت می دهد. هنگامی که فاصله جفت شدن تمام شد، وضعیت به خاموش تغییر می کند.	قرار دادن	14	110	0
بلوتوث.state حالت بلوتوث و BLE. وضعیت روشن نشان می دهد که بلوتوث و BLE روشن هستند. حالت خاموش نشان می دهد که بلوتوث و BLE خاموش هستند.	دریافت کنید	67	110	0
بلوتوث. جفت شد نام دستگاه جفت شده.	دریافت کنید	6A	رشته (0-128 نویسه)	تنظیم نشده
بلوتوث. متصل وضعیت اتصال دستگاه جفت شده.	دریافت کنید	6B	110	0
bluetooth.streamState وضعیت جریان بلوتوث	دریافت کنید	C2	110	0
بلوتوث.callState وضعیت تماس بلوتوث	دریافت کنید	6C	110	0
بلوتوث.قطع دستگاه بلوتوث را قطع کنید	پست	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) وضعیت ماژول اترنت	دریافت کنید	7F	شکست بیکار! AssociationI پیکربندی آماده I قطع شدن! برخط	(پشتیبانی شده در VBl) آماده است

نام / توضیحات	اقدامات	Cmd ID	محدوده ارزش ها	مقدار پیش فرض
network.mac (VBl) آدرس MAC رابط LAN.	دریافت کنید	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.	دریافت کنید	AC		00:00:00:00:00:00
wifi.state وضعیت ماژول وای فای	دریافت کنید	BO	شکست بیکار! AssociationI پیکربندی آماده I قطع شدن! برخط	بیکار
تله متری.مردم شمار (VBl) تعداد افراد شمارش شده توسط الگوریتم قاب خودکار دوربین.	قرار دادن حذف	DA	0-99	(پشتیبانی شده در VBl) 0
تله متری.مردم حاضر (VBl) زمانی درست است که افراد توسط الگوریتم قاب خودکار دوربین شناسایی شده باشند.	قرار دادن حذف	DC	110	(پشتیبانی شده در VBl) 0

اسناد / منابع

برنامه BOSE Work Rest API [pdfراهنمای کاربر
Work, Rest API, App, Work Rest API App

مراجع

راهنمای کاربر

برنامه BOSE Work Rest API

مقدمه