org.bluez.LEAdvertisement(5) مدیریت سیستم لینوکس org.bluez.LEAdvertisement(5)

org.bluez.LEAdvertisement - مستندات واسط D-Bus برای LEAdvertisement در BlueZ

بسته‌های تبلیغاتی (Advertising packets)، داده‌های ساختاریافته‌ای هستند که روی کانال‌های تبلیغاتی بلوتوث کم‌مصرف (LE) همه‌پخشی (broadcast) شده و برای تمام دستگاه‌های درون محدوده در دسترس هستند. به دلیل فضای محدود موجود در بسته‌های تبلیغاتی LE، محتوای هر بسته باید با دقت کنترل شود.

bluetoothd(8) به عنوان ذخیره‌گاهی برای داده‌های تبلیغاتی (Advertisement Data) که قرار است ارسال شوند عمل می‌کند. این برنامه داده‌های تبلیغاتی صحیح را از روی داده‌های ساختاریافته تولید کرده و هسته را برای ارسال تبلیغات مناسب پیکربندی می‌کند.

داده‌های تبلیغاتی برای انتشار و برخی از پارامترهای تبلیغاتی را مشخص می‌کند. ویژگی‌هایی که وجود ندارند در داده‌ها گنجانده نخواهند شد. انواع داده‌های تبلیغاتی الزامی همیشه لحاظ می‌شوند. تمام UUIDها در واسط برنامه‌نویسی نسخه‌های ۱۲۸ بیتی هستند و نسخه‌های ۱۶ یا ۳۲ بیتی همان UUID در صورت لزوم در داده‌های تبلیغاتی استفاده خواهند شد.

سرویس (Service)
org.bluez
واسط (Interface)
org.bluez.LEAdvertisement1
مسیر شیء (Object path)
به‌صورت آزاد قابل تعریف است (freely definable)
مورد استفاده توسط (Used by)
bluetoothctl-advertise(1)

این متد هنگامی که bluetoothd(8) تبلیغ را حذف می‌کند فراخوانی می‌شود.

یک کلاینت می‌تواند از آن برای انجام وظایف پاک‌سازی استفاده کند. نیازی به فراخوانی UnregisterAdvertisement() نیست، زیرا هنگام فراخوانی این متد، تبلیغ از پیش لغو ثبت شده است.

نوع بسته تبلیغاتی درخواستی را تعیین می‌کند.

مقادیر ممکن:

"broadcast"
"peripheral"

فهرستی از UUIDها برای گنجاندن در فیلد "Service UUID" داده‌های تبلیغاتی.

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

کلیدها شناسه تولیدکننده (Manufacturer ID) هستند که با داده‌ها مرتبط می‌شوند.

فهرستی از UUIDها برای گنجاندن در فیلد "Service Solicitation" داده‌های تبلیغاتی.

عناصر داده‌های سرویس برای گنجاندن در داده‌های تبلیغاتی.

کلیدها UUIDهایی هستند که با داده‌ها مرتبط می‌شوند.

داده‌های تبلیغاتی جهت گنجاندن.

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

نکته: انواع داده‌ای که پیش‌تر توسط ویژگی‌های دیگر مدیریت شده‌اند نباید استفاده شوند.

مقادیر ممکن:

<type>
<byte array>
مثال:
<Transport Discovery> <Organization Flags...>
0x26                   0x01         0x01...

فهرستی از UUIDها برای گنجاندن در فیلد "Service UUID" داده‌های پاسخ پویش (Scan Response Data).

فیلدهای داده‌های تولیدکننده برای گنجاندن در داده‌های پاسخ پویش.

کلیدها شناسه تولیدکننده هستند که با داده‌ها مرتبط می‌شوند.

فهرستی از UUIDها برای گنجاندن در فیلد "Service Solicitation" داده‌های پاسخ پویش.

عناصر داده‌های سرویس برای گنجاندن در داده‌های پاسخ پویش.

کلیدها UUIDهایی هستند که با داده‌ها مرتبط می‌شوند.

داده‌های پاسخ پویش جهت گنجاندن.

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

تبلیغ به‌صورت عمومی قابل کشف (general discoverable). در صورت وجود، این ویژگی تنظیم Discoverable آداپتور را بازنویسی خواهد کرد.

نکته: هنگامی که Type روی "broadcast" تنظیم شده باشد، این ویژگی نباید مقداردهی شود.

مهلت زمانی قابلیت کشف برحسب ثانیه. مقدار صفر به این معنی است که مهلت زمانی غیرفعال بوده و برای همیشه در حالت قابل کشف/محدود (discoverable/limited) باقی خواهد ماند.

نکته: هنگامی که Type روی "broadcast" تنظیم شده باشد، این ویژگی نباید مقداردهی شود.

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

مقادیر ممکن:

ویژگی SupportedIncludes در org.bluez.LEAdvertisingManager(5) را ببینید.

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

اگر این ویژگی موجود باشد، 'local-name' نمی‌تواند در Includes وجود داشته باشد.

ظاهر (Appearance) مورد استفاده در گزارش تبلیغاتی.

مقادیر ممکن: همان‌طور که در سرویس GAP تعریف شده است.

مدت‌زمان چرخش تبلیغ برحسب ثانیه.

اگر برنامه‌های دیگری در حال تبلیغ باشند و هیچ مدت‌زمانی تعیین نشده باشد، مقدار پیش‌فرض ۲ ثانیه است.

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

کانال ثانویه مورد استفاده.

کانال اولیه همیشه روی "1M" تنظیم شده است مگر اینکه "Coded" تنظیم شده باشد.

مقدار ممکن:

"1M" (پیش‌فرض)
"2M"
"Coded"

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

مقادیر قابل قبول در محدوده [20ms, 10,485s] هستند.

اگر MinInterval ارائه‌شده بزرگ‌تر از MaxInterval ارائه‌شده باشد، فرآیند ثبت با شکست مواجه خواهد شد.

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

مقادیر قابل قبول در محدوده [20ms, 10,485s] هستند.

اگر MinInterval ارائه‌شده بزرگ‌تر از MaxInterval ارائه‌شده باشد، فرآیند ثبت با شکست مواجه خواهد شد.

توان ارسال درخواستی برای این مجموعه تبلیغاتی.

مقدار ارائه‌شده تنها در صورتی استفاده می‌شود که ویژگی "CanSetTxPower" در org.bluez.LEAdvertisingManager(5) فعال باشد.

مقادیر باید در محدوده [-127 تا +20] باشند، که واحد آن برحسب dBm است.

نمونه (Instance) تبلیغ. پس از ثبت تبلیغ در org.bluez.LEAdvertisingManager(5) توسط دیمن bluetoothd تنظیم می‌شود.

اکتبر 2023 BlueZ