chrome.bluetooth LowEnergy

توضیحات

رابط برنامه‌نویسی کاربردی chrome.bluetoothLowEnergy برای ارتباط با دستگاه‌های بلوتوث هوشمند (کم‌مصرف) با استفاده از پروفایل ویژگی عمومی (GATT) استفاده می‌شود.

در دسترس بودن

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

مانیفست

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

"bluetooth"

انواع

Advertisement

کروم ۴۷+

خواص

  • تولیدکنندهداده‌ها

    تولیدکنندهداده‌ها [] اختیاری

    فهرست داده‌های خاص تولیدکننده که باید در فیلدهای «داده‌های خاص تولیدکننده» از داده‌های تبلیغاتی گنجانده شوند.

  • سرویس‌داده

    ServiceData [] اختیاری

    فهرست داده‌های خدماتی که باید در فیلدهای «داده‌های خدمات» داده‌های تبلیغاتی گنجانده شوند.

  • سرویس‌های یویید

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

    فهرست UUIDهایی که باید در فیلد «UUIDهای سرویس» در داده‌های تبلیغاتی وارد شوند. این UUIDها می‌توانند فرمت‌های ۱۶ بیتی، ۳۲ بیتی یا ۱۲۸ بیتی داشته باشند.

  • سوکیوها

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

    فهرست UUIDهایی که باید در فیلد «UUIDهای درخواستی» در داده‌های تبلیغاتی گنجانده شوند. این UUIDها می‌توانند فرمت‌های ۱۶ بیتی، ۳۲ بیتی یا ۱۲۸ بیتی داشته باشند.

  • نوع تبلیغ.

AdvertisementType

کروم ۴۷+

نوع تبلیغات. اگر «پخش» انتخاب شود، نوع تبلیغات ارسالی ADV_NONCONN_IND خواهد بود و دستگاه با یک آدرس MAC تصادفی پخش خواهد شد. اگر روی «محیطی» تنظیم شود، نوع تبلیغات ADV_IND یا ADV_SCAN_IND خواهد بود و دستگاه با آدرس MAC واقعی آداپتور بلوتوث پخش خواهد شد.

شمارشی

"پخش"

"پیرامون"

Characteristic

خواص

  • شناسه نمونه

    رشته اختیاری

    شناسه اختصاص داده شده به این مشخصه را برمی‌گرداند. از شناسه نمونه برای تمایز بین مشخصه‌ها از یک وسیله جانبی با همان UUID و برای انجام فراخوانی‌های تابعی که یک شناسه مشخصه را دریافت می‌کنند، استفاده می‌کند. در صورتی که این نمونه نشان دهنده یک مشخصه از راه دور باشد، ارائه می‌شود.

  • خواص این ویژگی.

  • خدمات

    خدمات اختیاری

    این ویژگی متعلق به سرویس GATT است.

  • یویید

    رشته

    UUID مربوط به مشخصه، مثلاً 00002a37-0000-1000-8000-00805f9b34fb.

  • ارزش

    ArrayBuffer اختیاری

    مقدار مشخصه ذخیره شده فعلی. این مقدار زمانی به‌روزرسانی می‌شود که مقدار مشخصه از طریق اعلان یا نشانه خوانده یا به‌روزرسانی شود.

CharacteristicProperty

مقادیری که نشان‌دهنده‌ی ویژگی‌های ممکن یک مشخصه هستند. مجوزهای مشخصه از این ویژگی‌ها استنباط می‌شوند. لطفاً برای مشاهده‌ی معنای هر ویژگی، به مشخصات بلوتوث ۴.x مراجعه کنید.

شمارشی

"پخش"

«خواندن»

"نوشتن بدون پاسخ"

«بنویس»

"ابلاغ کردن"

"نشان دادن"

"نویسه‌های امضا شده‌ی احراز هویت شده"

"ویژگی‌های توسعه‌یافته"

"قابل اعتماد بنویسید"

"کمکی‌های قابل نوشتن"

"رمزگذاری خواندن"

"رمزگذاری"

"رمزگذاری شده با احراز هویت خوانده شده"

"رمزگذاری با احراز هویت"

ConnectProperties

خواص

  • مداوم

    بولی

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

Descriptor

خواص

  • مشخصه

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

    مشخصه GATT که این توصیفگر به آن تعلق دارد.

  • شناسه نمونه

    رشته اختیاری

    شناسه اختصاص داده شده به این توصیفگر را برمی‌گرداند. از شناسه نمونه برای تمایز بین توصیفگرها از یک وسیله جانبی با UUID یکسان و برای انجام فراخوانی‌های تابعی که یک شناسه توصیفگر را دریافت می‌کنند، استفاده می‌کند. در صورتی که این نمونه نشان دهنده یک ویژگی از راه دور باشد، ارائه می‌شود.

  • مجوزها

    مجوز توصیفگر []

    کروم ۵۲+

    مجوزهای این توصیفگر.

  • یویید

    رشته

    UUID توصیفگر مشخصه، مثلاً 00002902-0000-1000-8000-00805f9b34fb.

  • ارزش

    ArrayBuffer اختیاری

    مقدار توصیف‌گر ذخیره‌شده‌ی فعلی. این مقدار با خوانده شدن مقدار توصیف‌گر به‌روزرسانی می‌شود.

DescriptorPermission

کروم ۵۲+

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

شمارشی

«خواندن»

«بنویس»

"رمزگذاری شده خوانده شده"

"نوشتن رمزگذاری شده"

"رمزگذاری شده-احراز هویت شده-خوانده شده"

"نوشتن رمزگذاری‌شده با احراز هویت"

Device

کروم ۵۲+

خواص

  • آدرس

    رشته

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

  • کلاس دستگاه

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

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

  • نام

    رشته اختیاری

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

ManufacturerData

کروم ۴۷+

خواص

  • داده‌ها

    شماره[]

  • شناسه

    شماره

Notification

کروم ۵۲+

خواص

  • shouldIndicate

    بولی اختیاری

    پرچم اختیاری برای ارسال یک نشانه به جای اعلان.

  • ارزش

    آرایه بافر

    مقدار جدید مشخصه.

NotificationProperties

خواص

  • مداوم

    بولی

    پرچمی که نشان می‌دهد آیا برنامه باید هنگام بارگیری صفحه رویداد برنامه، اعلان دریافت کند یا خیر ( به مدیریت چرخه عمر برنامه مراجعه کنید). مقدار پیش‌فرض false است.

Request

کروم ۵۲+

خواص

  • دستگاه

    دستگاه

    دستگاهی که این درخواست را ارسال می‌کند.

  • شناسه درخواست

    شماره

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

  • ارزش

    ArrayBuffer اختیاری

    مقداری که باید نوشته شود (اگر این یک درخواست نوشتن است).

Response

کروم ۵۲+

خواص

  • خطا

    بولی

    اگر این یک پاسخ خطا باشد، باید درست باشد.

  • شناسه درخواست

    شماره

    شناسه درخواستی که این پاسخ به آن است.

  • ارزش

    ArrayBuffer اختیاری

    مقدار پاسخ. درخواست‌های نوشتن و پاسخ‌های خطا این پارامتر را نادیده می‌گیرند.

Service

خواص

  • آدرس دستگاه

    رشته اختیاری

    آدرس دستگاه جانبی راه دور که سرویس GATT به آن تعلق دارد. در صورتی که این نمونه نشان‌دهنده یک سرویس راه دور باشد، ارائه می‌شود.

  • شناسه نمونه

    رشته اختیاری

    شناسه اختصاص داده شده به این سرویس را برمی‌گرداند. از شناسه نمونه برای تمایز بین سرویس‌ها از یک دستگاه جانبی با UUID یکسان و برای انجام فراخوانی‌های تابعی که شناسه سرویس را دریافت می‌کنند، استفاده می‌کند. در صورتی که این نمونه نشان دهنده یک سرویس از راه دور باشد، ارائه می‌شود.

  • isPrimary

    بولی

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

  • یویید

    رشته

    شناسه کاربری (UUID) سرویس، مثلاً ‎0000180d-0000-1000-8000-00805f9b34fb‎.

ServiceData

کروم ۴۷+

خواص

  • داده‌ها

    شماره[]

  • یویید

    رشته

روش‌ها

connect()

وعده
chrome.bluetoothLowEnergy.connect(
  deviceAddress: string,
  properties?: ConnectProperties,
  callback?: function,
): Promise<void>

اتصالی بین برنامه و دستگاه با آدرس داده شده برقرار می‌کند. ممکن است یک دستگاه از قبل متصل باشد و سرویس‌های GATT آن بدون فراخوانی connect در دسترس باشند، با این حال، برنامه‌ای که می‌خواهد به سرویس‌های GATT یک دستگاه دسترسی داشته باشد، باید این تابع را فراخوانی کند تا مطمئن شود که اتصال به دستگاه برقرار است. اگر دستگاه متصل نباشد، تمام سرویس‌های GATT دستگاه پس از فراخوانی موفقیت‌آمیز connect کشف می‌شوند.

پارامترها

  • آدرس دستگاه

    رشته

    آدرس بلوتوث دستگاه راه دوری که باید اتصال GATT به آن برقرار شود.

  • خواص

    ConnectProperties اختیاری است

    ویژگی‌های اتصال (اختیاری).

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

createCharacteristic()

قول کروم ۵۲+
chrome.bluetoothLowEnergy.createCharacteristic(
  characteristic: Characteristic,
  serviceId: string,
  callback?: function,
): Promise<string>

یک مشخصه GATT با میزبانی محلی ایجاد کنید. این مشخصه باید تحت یک سرویس معتبر میزبانی شود. اگر شناسه سرویس معتبر نباشد، lastError تنظیم خواهد شد. این تابع فقط در صورتی در دسترس است که برنامه هر دو مجوز bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. مجوز peripheral ممکن است برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • مشخصه

    مشخصه

    ویژگی برای ایجاد.

  • شناسه سرویس

    رشته

    شناسه سرویسی که قرار است این مشخصه برای آن ایجاد شود.

  • تماس برگشتی

    تابع اختیاری

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

    (characteristicId: string) => void

    • شناسه مشخصه

      رشته

بازگشت‌ها

  • قول<string>

    کروم ۹۱+

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

createDescriptor()

قول کروم ۵۲+
chrome.bluetoothLowEnergy.createDescriptor(
  descriptor: Descriptor,
  characteristicId: string,
  callback?: function,
): Promise<string>

یک توصیفگر GATT که به صورت محلی میزبانی می‌شود ایجاد کنید. این توصیفگر باید تحت یک مشخصه معتبر میزبانی شود. اگر شناسه مشخصه معتبر نباشد، lastError تنظیم خواهد شد. این تابع فقط در صورتی در دسترس است که برنامه هر دو مجوز bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. مجوز محیطی ممکن است برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • توصیفگر

    توصیفگر

    توصیف‌گری که باید ایجاد شود.

  • شناسه مشخصه

    رشته

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

  • تماس برگشتی

    تابع اختیاری

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

    (descriptorId: string) => void

    • شناسه توصیفگر

      رشته

بازگشت‌ها

  • قول<string>

    کروم ۹۱+

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

createService()

قول کروم ۵۲+
chrome.bluetoothLowEnergy.createService(
  service: Service,
  callback?: function,
): Promise<string>

یک سرویس GATT با میزبانی محلی ایجاد کنید. این سرویس را می‌توان طوری ثبت کرد که روی یک سرور محلی GATT در دسترس باشد. این عملکرد فقط در صورتی در دسترس است که برنامه هر دو مجوز bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. مجوز peripheral ممکن است برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • خدمات

    خدمات

    خدماتی که باید خلق شود.

  • تماس برگشتی

    تابع اختیاری

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

    (serviceId: string) => void

    • شناسه سرویس

      رشته

بازگشت‌ها

  • قول<string>

    کروم ۹۱+

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

disconnect()

وعده
chrome.bluetoothLowEnergy.disconnect(
  deviceAddress: string,
  callback?: function,
): Promise<void>

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

پارامترها

  • آدرس دستگاه

    رشته

    آدرس بلوتوث دستگاه از راه دور.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

getCharacteristic()

وعده
chrome.bluetoothLowEnergy.getCharacteristic(
  characteristicId: string,
  callback?: function,
): Promise<Characteristic>

مشخصه GATT را با شناسه نمونه داده شده که متعلق به سرویس GATT داده شده است، در صورت وجود، دریافت کنید.

پارامترها

  • شناسه مشخصه

    رشته

    شناسه نمونه مشخصه GATT درخواستی.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Characteristic) => void

بازگشت‌ها

  • قول< ویژگی >

    کروم ۹۱+

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

getCharacteristics()

وعده
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
): Promise<Characteristic[]>

فهرستی از تمام ویژگی‌های کشف‌شده‌ی GATT که متعلق به سرویس مورد نظر هستند، تهیه کنید.

پارامترها

  • شناسه سرویس

    رشته

    شناسه نمونه سرویس GATT که مشخصات آن باید برگردانده شود.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Characteristic[]) => void

بازگشت‌ها

  • قول< مشخصه []>

    کروم ۹۱+

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

getDescriptor()

وعده
chrome.bluetoothLowEnergy.getDescriptor(
  descriptorId: string,
  callback?: function,
): Promise<Descriptor>

توصیفگر مشخصه GATT را با شناسه نمونه داده شده دریافت کنید.

پارامترها

  • شناسه توصیفگر

    رشته

    شناسه نمونه توصیفگر مشخصه GATT درخواستی.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Descriptor) => void

بازگشت‌ها

  • قول< توصیفگر >

    کروم ۹۱+

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

getDescriptors()

وعده
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
): Promise<Descriptor[]>

فهرستی از توصیف‌گرهای مشخصه GATT که به مشخصه داده شده تعلق دارند را تهیه کنید.

پارامترها

  • شناسه مشخصه

    رشته

    شناسه نمونه مشخصه GATT که توصیفگرهای آن باید بازگردانده شوند.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Descriptor[]) => void

بازگشت‌ها

  • قول< توصیفگر []>

    کروم ۹۱+

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

getIncludedServices()

وعده
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
): Promise<Service[]>

فهرستی از خدمات GATT که شامل سرویس داده شده می‌شوند را دریافت کنید.

پارامترها

  • شناسه سرویس

    رشته

    شناسه نمونه سرویس GATT که سرویس‌های شامل آن باید بازگردانده شوند.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Service[]) => void

بازگشت‌ها

  • وعده< خدمات []>

    کروم ۹۱+

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

getService()

وعده
chrome.bluetoothLowEnergy.getService(
  serviceId: string,
  callback?: function,
): Promise<Service>

سرویس GATT را با شناسه نمونه داده شده دریافت کنید.

پارامترها

  • شناسه سرویس

    رشته

    شناسه نمونه سرویس GATT درخواستی.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Service) => void

بازگشت‌ها

  • وعده < خدمات >

    کروم ۹۱+

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

getServices()

وعده
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
): Promise<Service[]>

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

نکته: اگر کشف سرویس هنوز روی دستگاه کامل نشده باشد، این API زیرمجموعه‌ای (احتمالاً خالی) از سرویس‌ها را برمی‌گرداند. یک راه حل، اضافه کردن یک تأخیر مبتنی بر زمان و/یا فراخوانی مکرر تا زمان بازگشت تعداد مورد انتظار سرویس‌ها است.

پارامترها

  • آدرس دستگاه

    رشته

    آدرس بلوتوث دستگاه راه دوری که سرویس‌های GATT باید به آن بازگردانده شوند.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Service[]) => void

بازگشت‌ها

  • وعده< خدمات []>

    کروم ۹۱+

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

notifyCharacteristicValueChanged()

قول کروم ۵۲+
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
): Promise<void>

یک دستگاه از راه دور را از مقدار جدید یک مشخصه مطلع کنید. اگر پرچم shouldIndicate در شیء اعلان درست باشد، به جای اعلان، یک نشانه ارسال می‌شود. توجه داشته باشید که برای موفقیت‌آمیز بودن این فراخوانی، مشخصه باید در هنگام ایجاد، ویژگی 'notify' یا 'indicate' را به درستی تنظیم کند. این تابع فقط در صورتی در دسترس است که برنامه هر دو مجوز bluetooth:low_energy و bluetooth:peripheral را روی درست تنظیم کرده باشد. مجوز محیطی ممکن است برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • شناسه مشخصه

    رشته

    مشخصه ای که باید برای آن اعلان ارسال شود.

  • اعلان

    اعلان

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

readCharacteristicValue()

وعده
chrome.bluetoothLowEnergy.readCharacteristicValue(
  characteristicId: string,
  callback?: function,
): Promise<Characteristic>

مقدار یک مشخصه مشخص شده را از یک دستگاه جانبی از راه دور بازیابی کنید.

پارامترها

  • شناسه مشخصه

    رشته

    شناسه نمونه مشخصه GATT که مقدار آن باید از دستگاه راه دور خوانده شود.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Characteristic) => void

بازگشت‌ها

  • قول< ویژگی >

    کروم ۹۱+

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

readDescriptorValue()

وعده
chrome.bluetoothLowEnergy.readDescriptorValue(
  descriptorId: string,
  callback?: function,
): Promise<Descriptor>

مقدار یک توصیفگر مشخصه مشخص شده را از یک دستگاه جانبی از راه دور بازیابی کنید.

پارامترها

  • شناسه توصیفگر

    رشته

    شناسه نمونه توصیفگر مشخصه GATT که مقدار آن باید از دستگاه راه دور خوانده شود.

  • تماس برگشتی

    تابع اختیاری

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

    (result: Descriptor) => void

بازگشت‌ها

  • قول< توصیفگر >

    کروم ۹۱+

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

registerAdvertisement()

قول کروم ۴۷+
chrome.bluetoothLowEnergy.registerAdvertisement(
  advertisement: Advertisement,
  callback?: function,
): Promise<number>

یک تبلیغ ایجاد کنید و آن را برای تبلیغات ثبت کنید. برای فراخوانی این تابع، برنامه باید مجوزهای bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کند. علاوه بر این، این API فقط برای برنامه‌هایی که به صورت خودکار در حالت کیوسک یا با تنظیم سوئیچ خط فرمان '--enable-ble-advertising-in-apps' اجرا می‌شوند، در دسترس است. به https://developer.chrome.com/apps/manifest/bluetooth مراجعه کنید. توجه: در برخی سخت‌افزارها، حالت‌های مرکزی و جانبی به طور همزمان پشتیبانی می‌شوند، اما در سخت‌افزارهایی که از این پشتیبانی نمی‌کنند، انجام این فراخوانی دستگاه را به حالت جانبی تغییر می‌دهد. در مورد سخت‌افزاری که از هر دو حالت مرکزی و جانبی پشتیبانی نمی‌کند، تلاش برای استفاده از دستگاه در هر دو حالت منجر به رفتار نامشخص یا جلوگیری از عملکرد صحیح سایر برنامه‌های نقش مرکزی (از جمله کشف دستگاه‌های بلوتوث کم مصرف) خواهد شد.

پارامترها

  • تبلیغات

    تبلیغات

    تبلیغ برای تبلیغ.

  • تماس برگشتی

    تابع اختیاری

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

    (advertisementId: number) => void

    • شناسه تبلیغات

      شماره

بازگشت‌ها

  • قول<number>

    کروم ۹۱+

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

registerService()

قول کروم ۵۲+
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
): Promise<void>

سرویس داده شده را در سرور محلی GATT ثبت کنید. اگر شناسه سرویس نامعتبر باشد، lastError تنظیم خواهد شد. این تابع فقط در صورتی در دسترس است که برنامه هر دو مجوز bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. مجوز peripheral ممکن است برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • شناسه سرویس

    رشته

    شناسه منحصر به فرد یک سرویس ایجاد شده.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

removeService()

قول کروم ۵۲+
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
): Promise<void>

سرویس مشخص شده را حذف کنید و در صورت ثبت، آن را لغو ثبت کنید. اگر شناسه سرویس نامعتبر باشد، lastError تنظیم خواهد شد. این تابع فقط در صورتی در دسترس است که برنامه هر دو مجوز bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. مجوز محیطی ممکن است برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • شناسه سرویس

    رشته

    شناسه منحصر به فرد یک سرویس ثبت شده فعلی.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

resetAdvertising()

قول کروم ۶۱+
chrome.bluetoothLowEnergy.resetAdvertising(
  callback?: function,
): Promise<void>

تبلیغات روی دستگاه فعلی را مجدداً تنظیم می‌کند. این کار باعث لغو ثبت و توقف تمام تبلیغات موجود می‌شود.

پارامترها

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

sendRequestResponse()

کروم ۵۲+
chrome.bluetoothLowEnergy.sendRequestResponse(
  response: Response,
): void

پاسخی را برای درخواست خواندن/نوشتن یک مشخصه یا توصیفگر ارسال می‌کند. این تابع فقط در صورتی در دسترس است که برنامه هر دو مجوز bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. مجوز محیطی ممکن است برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • پاسخ

    پاسخ

    پاسخ به درخواست.

setAdvertisingInterval()

قول کروم ۵۵+
chrome.bluetoothLowEnergy.setAdvertisingInterval(
  minInterval: number,
  maxInterval: number,
  callback?: function,
): Promise<void>

فاصله بین دو تبلیغ متوالی را تنظیم کنید. توجه: این بهترین تلاش است. فاصله واقعی ممکن است به طور قابل توجهی با فواصل درخواستی متفاوت باشد. در برخی سخت‌افزارها، حداقل فاصله ۱۰۰ میلی‌ثانیه وجود دارد. حداقل و حداکثر مقادیر نمی‌توانند از محدوده مجاز توسط مشخصات بلوتوث ۴.۲ تجاوز کنند.

پارامترها

  • حداقل فاصله

    شماره

    حداقل فاصله بین تبلیغات (برحسب میلی‌ثانیه). این مقدار نمی‌تواند کمتر از ۲۰ میلی‌ثانیه باشد (طبق مشخصات).

  • حداکثر فاصله

    شماره

    حداکثر فاصله بین تبلیغات (برحسب میلی‌ثانیه). این مقدار نمی‌تواند بیش از ۱۰۲۴۰ میلی‌ثانیه باشد (طبق مشخصات).

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

startCharacteristicNotifications()

وعده
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
  characteristicId: string,
  properties?: NotificationProperties,
  callback?: function,
): Promise<void>

اعلان‌ها/نشانه‌های مقدار را از مشخصه مشخص شده فعال کنید. پس از فعال شدن، یک برنامه می‌تواند با استفاده از رویداد onCharacteristicValueChanged به اعلان‌ها گوش دهد.

پارامترها

  • شناسه مشخصه

    رشته

    شناسه نمونه مشخصه GATT که اعلان‌ها باید روی آن فعال شوند.

  • خواص

    NotificationProperties اختیاری است

    ویژگی‌های جلسه اعلان (اختیاری).

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

stopCharacteristicNotifications()

وعده
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
  characteristicId: string,
  callback?: function,
): Promise<void>

غیرفعال کردن اعلان‌ها/نشانه‌های مقدار از مشخصه مشخص شده. پس از فراخوانی موفقیت‌آمیز، برنامه دریافت اعلان‌ها/نشانه‌ها از این مشخصه را متوقف می‌کند.

پارامترها

  • شناسه مشخصه

    رشته

    شناسه نمونه مشخصه GATT که جلسه اعلان این برنامه باید در آن متوقف شود.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

unregisterAdvertisement()

قول کروم ۴۷+
chrome.bluetoothLowEnergy.unregisterAdvertisement(
  advertisementId: number,
  callback?: function,
): Promise<void>

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

پارامترها

  • شناسه تبلیغات

    شماره

    شناسه آگهی برای لغو ثبت نام.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

unregisterService()

قول کروم ۵۲+
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
): Promise<void>

سرویس داده شده را در سرور محلی GATT لغو ثبت کنید. اگر شناسه سرویس نامعتبر باشد، lastError تنظیم خواهد شد. این تابع فقط در صورتی در دسترس است که برنامه هر دو مجوز bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. مجوز peripheral ممکن است برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • شناسه سرویس

    رشته

    شناسه منحصر به فرد یک سرویس ثبت شده فعلی.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

writeCharacteristicValue()

وعده
chrome.bluetoothLowEnergy.writeCharacteristicValue(
  characteristicId: string,
  value: ArrayBuffer,
  callback?: function,
): Promise<void>

مقدار یک مشخصه مشخص شده را از یک دستگاه جانبی راه دور بنویسید.

پارامترها

  • شناسه مشخصه

    رشته

    شناسه نمونه مشخصه GATT که مقدار آن باید در آن نوشته شود.

  • ارزش

    آرایه بافر

    مقداری که باید به عنوان بخشی از درخواست نوشتن به مشخصه راه دور ارسال شود.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

writeDescriptorValue()

وعده
chrome.bluetoothLowEnergy.writeDescriptorValue(
  descriptorId: string,
  value: ArrayBuffer,
  callback?: function,
): Promise<void>

مقدار یک توصیفگر مشخصه مشخص شده را از یک دستگاه جانبی راه دور بنویسید.

پارامترها

  • شناسه توصیفگر

    رشته

    شناسه نمونه توصیفگر مشخصه GATT که مقدار آن باید در آن نوشته شود.

  • ارزش

    آرایه بافر

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

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

رویدادها

onCharacteristicReadRequest

کروم ۵۲+
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
  callback: function,
)

زمانی فعال می‌شود که یک دستگاه مرکزی متصل، درخواست خواندن مقدار یک مشخصه ثبت‌شده در سرور محلی GATT را داشته باشد. عدم پاسخ به این درخواست برای مدت طولانی ممکن است منجر به قطع ارتباط شود. این رویداد فقط در صورتی در دسترس است که برنامه، مجوزهای bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. ممکن است مجوز محیطی برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • تماس برگشتی

    تابع

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

    (request: Request, characteristicId: string) => void

onCharacteristicValueChanged

chrome.bluetoothLowEnergy.onCharacteristicValueChanged.addListener(
  callback: function,
)

زمانی اجرا می‌شود که مقدار یک مشخصه GATT از راه دور، چه در نتیجه درخواست خواندن، و چه در نتیجه اعلان/نشانه تغییر مقدار، تغییر کند. این رویداد فقط در صورتی ارسال می‌شود که برنامه با فراخوانی startCharacteristicNotifications اعلان‌ها را فعال کرده باشد.

پارامترها

  • تماس برگشتی

    تابع

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

    (characteristic: Characteristic) => void

onCharacteristicWriteRequest

کروم ۵۲+
chrome.bluetoothLowEnergy.onCharacteristicWriteRequest.addListener(
  callback: function,
)

زمانی اجرا می‌شود که یک دستگاه مرکزی متصل، درخواست نوشتن مقدار یک مشخصه ثبت‌شده در سرور محلی GATT را داشته باشد. عدم پاسخ به این درخواست برای مدت طولانی ممکن است منجر به قطع ارتباط شود. این رویداد فقط در صورتی در دسترس است که برنامه، مجوزهای bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. ممکن است مجوز محیطی برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • تماس برگشتی

    تابع

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

    (request: Request, characteristicId: string) => void

onDescriptorReadRequest

کروم ۵۲+
chrome.bluetoothLowEnergy.onDescriptorReadRequest.addListener(
  callback: function,
)

زمانی اجرا می‌شود که یک دستگاه مرکزی متصل، درخواست خواندن مقدار یک توصیف‌گر ثبت‌شده در سرور محلی GATT را داشته باشد. عدم پاسخ به این درخواست برای مدت طولانی ممکن است منجر به قطع ارتباط شود. این رویداد فقط در صورتی در دسترس است که برنامه، مجوزهای bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. ممکن است مجوز محیطی برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • تماس برگشتی

    تابع

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

    (request: Request, descriptorId: string) => void

onDescriptorValueChanged

chrome.bluetoothLowEnergy.onDescriptorValueChanged.addListener(
  callback: function,
)

زمانی اجرا می‌شود که مقدار یک توصیف‌گر مشخصه GATT از راه دور، معمولاً در نتیجه درخواست خواندن، تغییر کند. این رویداد عمدتاً برای راحتی وجود دارد و همیشه پس از یک فراخوانی موفق readDescriptorValue ارسال می‌شود.

پارامترها

  • تماس برگشتی

    تابع

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

    (descriptor: Descriptor) => void

onDescriptorWriteRequest

کروم ۵۲+
chrome.bluetoothLowEnergy.onDescriptorWriteRequest.addListener(
  callback: function,
)

زمانی اجرا می‌شود که یک دستگاه مرکزی متصل، درخواست نوشتن مقدار یک توصیف‌گر ثبت‌شده در سرور محلی GATT را داشته باشد. عدم پاسخ به این درخواست برای مدت طولانی ممکن است منجر به قطع ارتباط شود. این رویداد فقط در صورتی در دسترس است که برنامه، مجوزهای bluetooth:low_energy و bluetooth:peripheral را روی true تنظیم کرده باشد. ممکن است مجوز محیطی برای همه برنامه‌ها در دسترس نباشد.

پارامترها

  • تماس برگشتی

    تابع

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

    (request: Request, descriptorId: string) => void

onServiceAdded

chrome.bluetoothLowEnergy.onServiceAdded.addListener(
  callback: function,
)

زمانی که یک سرویس جدید GATT در یک دستگاه از راه دور کشف شد، اخراج شد.

پارامترها

  • تماس برگشتی

    تابع

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

    (service: Service) => void

onServiceChanged

chrome.bluetoothLowEnergy.onServiceChanged.addListener(
  callback: function,
)

زمانی اجرا می‌شود که وضعیت یک سرویس GATT از راه دور تغییر کند. این شامل هرگونه ویژگی و/یا توصیف‌گری می‌شود که به سرویس اضافه یا حذف می‌شوند، و همچنین اعلان‌های "ServiceChanged" از دستگاه راه دور.

پارامترها

  • تماس برگشتی

    تابع

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

    (service: Service) => void

onServiceRemoved

chrome.bluetoothLowEnergy.onServiceRemoved.addListener(
  callback: function,
)

زمانی فعال می‌شود که یک سرویس GATT که قبلاً در یک دستگاه از راه دور کشف شده بود، حذف شود.

پارامترها

  • تماس برگشتی

    تابع

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

    (service: Service) => void