chrome.bluetoothLowEnergy

شرح

از chrome.bluetoothLowEnergy API برای برقراری ارتباط با دستگاه‌های Bluetooth Smart (کم‌مصرف) بااستفاده از نمایه مشخصه عمومی (GATT) استفاده می‌شود.

دردسترس بودن

فقط ChromeOS

مانیفست

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

"bluetooth"

انواع

Advertisement

Chrome نسخه ۴۷ و بالاتر

مشخصات

  • manufacturerData

    ManufacturerData[] اختیاری

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

  • serviceData

    ServiceData[] اختیاری

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

  • serviceUuids

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

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

  • solicitUuids

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

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

  • نوع تبلیغ.

AdvertisementType

Chrome نسخه ۴۷ و بالاتر

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

شمارشی

"broadcast"

«peripheral»

Characteristic

مشخصات

  • instanceId

    رشته اختیاری

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

  • اقامتگاه‌ها

    CharacteristicProperty[]

    ویژگی‌های این مشخصه.

  • خدمات

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

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

  • uuid

    رشته

    شناسه UUID مشخصه، مثلاً 00002a37-0000-1000-8000-00805f9b34fb.

  • مقدار

    ArrayBuffer اختیاری

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

CharacteristicProperty

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

شمارشی

"broadcast"

«read»

"writeWithoutResponse"

«write»

«notify»

«indicate»

"authenticatedSignedWrites"

"extendedProperties"

"reliableWrite"

"writableAuxiliaries"

"encryptRead"

"encryptWrite"

"encryptAuthenticatedRead"

"encryptAuthenticatedWrite"

ConnectProperties

مشخصات

  • دائمی

    بولی

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

Descriptor

مشخصات

  • مشخصه

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

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

  • instanceId

    رشته اختیاری

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

  • اجازه‌ها

    DescriptorPermission[]

    Chrome نسخه ۵۲ و بالاتر

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

  • uuid

    رشته

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

  • مقدار

    ArrayBuffer اختیاری

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

DescriptorPermission

Chrome نسخه ۵۲ و بالاتر

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

شمارشی

«read»

«write»

"encryptedRead"

"encryptedWrite"

"encryptedAuthenticatedRead"

"encryptedAuthenticatedWrite"

Device

Chrome نسخه ۵۲ و بالاتر

مشخصات

  • نشانی

    رشته

    نشانی دستگاه، در قالب «XX:XX:XX:XX:XX:XX».

  • deviceClass

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

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

  • نام

    رشته اختیاری

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

ManufacturerData

Chrome نسخه ۴۷ و بالاتر

مشخصات

  • داده

    عدد[]

  • id

    شماره

Notification

Chrome نسخه ۵۲ و بالاتر

مشخصات

  • shouldIndicate

    بولی اختیاری

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

  • مقدار

    ArrayBuffer

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

NotificationProperties

مشخصات

  • دائمی

    بولی

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

Request

Chrome نسخه ۵۲ و بالاتر

مشخصات

  • دستگاه

    دستگاه

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

  • requestId

    شماره

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

  • مقدار

    ArrayBuffer اختیاری

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

Response

Chrome نسخه ۵۲ و بالاتر

مشخصات

  • isError

    بولی

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

  • requestId

    شماره

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

  • مقدار

    ArrayBuffer اختیاری

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

Service

مشخصات

  • deviceAddress

    رشته اختیاری

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

  • instanceId

    رشته اختیاری

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

  • isPrimary

    بولی

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

  • uuid

    رشته

    شناسه منحصربه‌فرد جهانی سرویس، برای مثال 0000180d-0000-1000-8000-00805f9b34fb.

ServiceData

Chrome نسخه ۴۷ و بالاتر

مشخصات

  • داده

    عدد[]

  • uuid

    رشته

روش‌ها

connect()

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

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

پارامترها

  • deviceAddress

    رشته

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

  • اقامتگاه‌ها

    ConnectProperties اختیاری

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

createCharacteristic()

Promise Chrome نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.createCharacteristic(
  characteristic: Characteristic,
  serviceId: string,
  callback?: function,
): Promise<string>

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

پارامترها

  • مشخصه

    مشخصه

    مشخصه‌ای که باید ایجاد شود.

  • serviceId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (characteristicId: string) => void

    • characteristicId

      رشته

بازگشتی‌ها

  • Promise<string>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

createDescriptor()

Promise Chrome نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.createDescriptor(
  descriptor: Descriptor,
  characteristicId: string,
  callback?: function,
): Promise<string>

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

پارامترها

  • توصیف‌گر

    توصیف‌گر

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

  • characteristicId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (descriptorId: string) => void

    • descriptorId

      رشته

بازگشتی‌ها

  • Promise<string>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

createService()

Promise Chrome نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.createService(
  service: Service,
  callback?: function,
): Promise<string>

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

پارامترها

  • خدمات

    سرویس

    سرویس برای ایجاد.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (serviceId: string) => void

    • serviceId

      رشته

بازگشتی‌ها

  • Promise<string>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

disconnect()

قول 
chrome.bluetoothLowEnergy.disconnect(
  deviceAddress: string,
  callback?: function,
): Promise<void>

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

پارامترها

  • deviceAddress

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getCharacteristic()

قول 
chrome.bluetoothLowEnergy.getCharacteristic(
  characteristicId: string,
  callback?: function,
): Promise<Characteristic>

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

پارامترها

  • characteristicId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Characteristic) => void

بازگشتی‌ها

  • Promise<Characteristic>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getCharacteristics()

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

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

پارامترها

  • serviceId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Characteristic[]) => void

بازگشتی‌ها

  • Promise<Characteristic[]>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getDescriptor()

قول 
chrome.bluetoothLowEnergy.getDescriptor(
  descriptorId: string,
  callback?: function,
): Promise<Descriptor>

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

پارامترها

  • descriptorId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Descriptor) => void

بازگشتی‌ها

  • Promise<Descriptor>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getDescriptors()

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

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

پارامترها

  • characteristicId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Descriptor[]) => void

بازگشتی‌ها

  • Promise<Descriptor[]>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getIncludedServices()

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

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

پارامترها

  • serviceId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Service[]) => void

بازگشتی‌ها

  • Promise<Service[]>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getService()

قول 
chrome.bluetoothLowEnergy.getService(
  serviceId: string,
  callback?: function,
): Promise<Service>

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

پارامترها

  • serviceId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Service) => void

بازگشتی‌ها

  • Promise<Service>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getServices()

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

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

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

پارامترها

  • deviceAddress

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Service[]) => void

بازگشتی‌ها

  • Promise<Service[]>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

notifyCharacteristicValueChanged()

Promise Chrome نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
): Promise<void>

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

پارامترها

  • characteristicId

    رشته

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

  • اعلان

    اعلان

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

readCharacteristicValue()

قول 
chrome.bluetoothLowEnergy.readCharacteristicValue(
  characteristicId: string,
  callback?: function,
): Promise<Characteristic>

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

پارامترها

  • characteristicId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Characteristic) => void

بازگشتی‌ها

  • Promise<Characteristic>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

readDescriptorValue()

قول 
chrome.bluetoothLowEnergy.readDescriptorValue(
  descriptorId: string,
  callback?: function,
): Promise<Descriptor>

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

پارامترها

  • descriptorId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: Descriptor) => void

بازگشتی‌ها

  • Promise<Descriptor>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

registerAdvertisement()

Promise Chrome 47+ 
chrome.bluetoothLowEnergy.registerAdvertisement(
  advertisement: Advertisement,
  callback?: function,
): Promise<number>

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

پارامترها

  • آگهی

    تبلیغات

    تبلیغی که باید تبلیغ شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (advertisementId: number) => void

    • advertisementId

      شماره

بازگشتی‌ها

  • Promise<number>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

registerService()

Promise Chrome نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

پارامترها

  • serviceId

    رشته

    شناسه یکتای سرویس ایجادشده.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

removeService()

Promise Chrome نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

پارامترها

  • serviceId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

resetAdvertising()

Promise Chrome نسخه ۶۱ و بالاتر 
chrome.bluetoothLowEnergy.resetAdvertising(
  callback?: function,
): Promise<void>

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

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

sendRequestResponse()

Chrome نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.sendRequestResponse(
  response: Response,
): void

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

پارامترها

  • پاسخ

    پاسخ

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

setAdvertisingInterval()

Promise Chrome نسخه ۵۵ و بالاتر 
chrome.bluetoothLowEnergy.setAdvertisingInterval(
  minInterval: number,
  maxInterval: number,
  callback?: function,
): Promise<void>

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

پارامترها

  • minInterval

    شماره

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

  • maxInterval

    شماره

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

startCharacteristicNotifications()

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

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

پارامترها

  • characteristicId

    رشته

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

  • اقامتگاه‌ها

    NotificationProperties اختیاری

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

stopCharacteristicNotifications()

قول 
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
  characteristicId: string,
  callback?: function,
): Promise<void>

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

پارامترها

  • characteristicId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

unregisterAdvertisement()

Promise Chrome 47+ 
chrome.bluetoothLowEnergy.unregisterAdvertisement(
  advertisementId: number,
  callback?: function,
): Promise<void>

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

پارامترها

  • advertisementId

    شماره

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

unregisterService()

Promise Chrome نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

پارامترها

  • serviceId

    رشته

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

writeCharacteristicValue()

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

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

پارامترها

  • characteristicId

    رشته

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

  • مقدار

    ArrayBuffer

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

writeDescriptorValue()

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

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

پارامترها

  • descriptorId

    رشته

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

  • مقدار

    ArrayBuffer

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onCharacteristicReadRequest

Chrome نسخه ۵۲ و بالاتر 
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 نسخه ۵۲ و بالاتر 
chrome.bluetoothLowEnergy.onCharacteristicWriteRequest.addListener(
  callback: function,
)

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

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

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

onDescriptorReadRequest

Chrome نسخه ۵۲ و بالاتر 
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 نسخه ۵۲ و بالاتر 
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