کروم.بلوتوث

توضیحات

از API chrome.bluetooth برای اتصال به یک دستگاه بلوتوث استفاده کنید. همه توابع از طریق chrome.runtime.lastError خرابی‌ها را گزارش می‌دهند.

در دسترس بودن

فقط سیستم عامل کروم

مانیفست

برای استفاده از این API، کلیدهای زیر باید در مانیفست تعریف شوند.

"bluetooth"

انواع

AdapterState

خواص

  • آدرس

    رشته

    آدرس آداپتور، با فرمت 'XX:XX:XX:XX:XX:XX:XX'.

  • موجود است

    بولی

    نشان می‌دهد که آیا آداپتور در دسترس است یا خیر (یعنی فعال است).

  • کشف کردن

    بولی

    نشان می‌دهد که آیا آداپتور در حال حاضر در حال شناسایی است یا خیر.

  • نام

    رشته

    نام آداپتور که برای انسان قابل خواندن است.

  • دارای قدرت

    بولی

    نشان می‌دهد که آیا آداپتور برق دارد یا خیر.

BluetoothFilter

کروم ۶۷+

خواص

  • نوع فیلتر

    نوع فیلتر اختیاری

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

  • حد

    شماره اختیاری

    حداکثر تعداد دستگاه‌های بلوتوث برای بازگشت. اگر مشخص نشده باشد، پیش‌فرض 0 (بدون محدودیت) است.

Device

خواص

  • آدرس

    رشته

    آدرس دستگاه، با فرمت 'XX:XX:XX:XX:XX:XX:XX'.

  • درصد باتری

    شماره اختیاری

    کروم ۷۷+

    باتری باقی مانده دستگاه.

  • قابل اتصال

    بولی اختیاری

    کروم ۴۸+

    نشان می‌دهد که آیا دستگاه قابل اتصال است یا خیر.

  • متصل

    بولی اختیاری

    نشان می‌دهد که آیا دستگاه در حال حاضر به سیستم متصل است یا خیر.

  • اتصال

    بولی اختیاری

    کروم ۴۸+

    نشان می‌دهد که آیا دستگاه در حال حاضر به سیستم متصل است یا خیر.

  • کلاس دستگاه

    شماره اختیاری

    کلاس دستگاه، یک فیلد بیتی که توسط http://www.bluetooth.org/en-us/specification/assigned-numbers/baseband تعریف شده است.

  • شناسه دستگاه

    شماره اختیاری

  • استعلامRSSI

    شماره اختیاری

    کروم ۴۴+

    قدرت سیگنال دریافتی، بر حسب dBm. این فیلد فقط در زمان کشف (discovery) در دسترس و معتبر است. خارج از کشف (discovery)، مقدار آن مشخص نشده است.

  • استعلام TxPower

    شماره اختیاری

    کروم ۴۴+

    سطح توان ارسالی. این فیلد فقط برای دستگاه‌های LE که این فیلد را در AD دارند، در دسترس است. این فیلد فقط در طول فرآیند کشف (discovery) در دسترس و معتبر است.

  • نام

    رشته اختیاری

    نام قابل خواندن توسط انسان برای دستگاه.

  • جفت شده

    بولی اختیاری

    نشان می‌دهد که آیا دستگاه با سیستم جفت شده است یا خیر.

  • شناسه محصول

    شماره اختیاری

  • حمل و نقل

    حمل و نقل اختیاری

    کروم ۷۶+

    نوع انتقال دستگاه بلوتوث.

  • نوع

    نوع دستگاه اختیاری

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

  • یوییدها

    رشته[] اختیاری

    UUID پروتکل‌ها، پروفایل‌ها و سرویس‌هایی که توسط دستگاه تبلیغ می‌شوند. برای دستگاه‌های بلوتوث کلاسیک، این لیست از داده‌های EIR و جداول SDP به دست می‌آید. برای دستگاه‌های کم مصرف، این لیست از سرویس‌های اولیه AD و GATT به دست می‌آید. برای دستگاه‌های دو حالته، این لیست را می‌توان از هر دو دریافت کرد.

  • شناسه فروشنده

    شماره اختیاری

  • شناسه فروشنده (VenderIdSource)

    شناسه فروشنده ( اختیاری)

    رکورد شناسه دستگاه، در صورت وجود.

DeviceType

انواع دستگاه‌های رایجی که توسط کروم شناسایی می‌شوند.

شمارشی

"کامپیوتر"

«تلفن»

"مودم"

"صوتی"

"سیستم صوتی ماشین"

«ویدئو»

"پیرامون"

"جوی‌استیک"

"گیم پد"

"صفحه کلید"

"موش"

"تبلت"

"ترکیب کیبورد و ماوس"

FilterType

کروم ۶۷+

انواع فیلتر کردن دستگاه‌های بلوتوث

شمارشی

«همه»

«معروف»

Transport

کروم ۷۶+

نوع حمل و نقل دستگاه بلوتوث.

شمارشی

"نامعتبر"

"کلاسیک"

"له"

"دوگانه"

VendorIdSource

مراجع تخصیص شناسه‌های فروشنده.

شمارشی

"بلوتوث"

"یو اس بی"

روش‌ها

getAdapterState()

وعده
chrome.bluetooth.getAdapterState(
  callback?: function,
): Promise<AdapterState>

اطلاعات مربوط به آداپتور بلوتوث را دریافت کنید.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (adapterInfo: AdapterState) => void

بازگشت‌ها

  • کروم ۹۱+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

getDevice()

وعده
chrome.bluetooth.getDevice(
  deviceAddress: string,
  callback?: function,
): Promise<Device>

دریافت اطلاعات مربوط به دستگاه بلوتوث شناخته شده برای سیستم.

پارامترها

  • آدرس دستگاه

    رشته

    آدرس دستگاهی که باید دریافت شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (deviceInfo: Device) => void

    • اطلاعات دستگاه

      دستگاه

      شیء حاوی اطلاعات دستگاه.

بازگشت‌ها

  • قول< دستگاه >

    کروم ۹۱+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

getDevices()

وعده
chrome.bluetooth.getDevices(
  filter?: BluetoothFilter,
  callback?: function,
): Promise<Device[]>

لیستی از دستگاه‌های بلوتوث شناخته شده برای سیستم، از جمله دستگاه‌های جفت شده و دستگاه‌های اخیراً کشف شده، دریافت کنید.

پارامترها

  • فیلتر

    فیلتر بلوتوث اختیاری

    کروم ۶۷+

    برخی معیارها برای فیلتر کردن لیست دستگاه‌های بلوتوث برگردانده شده. اگر فیلتر تنظیم نشده باشد یا روی {} تنظیم شده باشد، لیست دستگاه‌های برگردانده شده شامل تمام دستگاه‌های بلوتوث خواهد بود. در حال حاضر این فقط در ChromeOS پشتیبانی می‌شود، برای سایر پلتفرم‌ها، یک لیست کامل برگردانده می‌شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (deviceInfos: Device[]) => void

    • اطلاعات دستگاه

      دستگاه []

      آرایه‌ای از اشیاء حاوی اطلاعات دستگاه.

بازگشت‌ها

  • قول< دستگاه []>

    کروم ۹۱+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

startDiscovery()

وعده
chrome.bluetooth.startDiscovery(
  callback?: function,
): Promise<void>

شروع به کشف کنید. دستگاه‌های تازه کشف شده از طریق رویداد onDeviceAdded بازگردانده می‌شوند. دستگاه‌های قبلاً کشف شده که از قبل برای آداپتور شناخته شده‌اند باید با استفاده از getDevices دریافت شوند و فقط در صورتی که اطلاعات مربوط به آنها تغییر کند، با استفاده از رویداد onDeviceChanged به‌روزرسانی می‌شوند.

اگر این برنامه قبلاً startDiscovery را فراخوانی کرده باشد، Discovery شروع نخواهد شد. Discovery می‌تواند منابع زیادی را مصرف کند: stopDiscovery باید در اسرع وقت فراخوانی شود.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

stopDiscovery()

وعده
chrome.bluetooth.stopDiscovery(
  callback?: function,
): Promise<void>

کشف را متوقف کنید.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

رویدادها

onAdapterStateChanged

chrome.bluetooth.onAdapterStateChanged.addListener(
  callback: function,
)

وقتی وضعیت آداپتور بلوتوث تغییر می‌کند، فعال می‌شود.

پارامترها

onDeviceAdded

chrome.bluetooth.onDeviceAdded.addListener(
  callback: function,
)

زمانی اجرا می‌شود که اطلاعاتی درباره یک دستگاه بلوتوث جدید در دسترس باشد.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    (device: Device) => void

onDeviceChanged

chrome.bluetooth.onDeviceChanged.addListener(
  callback: function,
)

زمانی فعال می‌شود که اطلاعات مربوط به یک دستگاه بلوتوث شناخته شده تغییر کرده باشد.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    (device: Device) => void

onDeviceRemoved

chrome.bluetooth.onDeviceRemoved.addListener(
  callback: function,
)

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    (device: Device) => void