D-Bus интерфейс LEAdvertisement1

Интерфейс описывает публичные данные для трансляции и их параметры.

Шина:	системная
Служба:	org.bluez
Объект:	свободно определяемый
Интерфейс:	org.bluez.LEAdvertisement1

Свойства

• Appearance : uint16
• Data : dict [экспериментально]
• Discoverable : bool [экспериментально]
• DiscoverableTimeout : uint16 [экспериментально]
• Duration : uint16_t
• Includes : array
• LocalName : string
• ManufacturerData : dict
• MaxInterval : uint32 [экспериментально]
• MinInterval : uint32 [экспериментально]
• SecondaryChannel : string [экспериментально]
• ServiceData : dict
• ServiceUUIDs : array
• SolicitUUIDs : array
• Timeout : uint16_t
• TxPower : uint16 [экспериментально]
• Type : string

Методы

• Release() [без ответа]

Подробное описание

Описывает публичные данные для передачи и их параметры. Отсутствующие свойства не будут включены в данные. Требуемые типы публичных данных всегда будут включены. Все UUID в API являются 128-битными версиями, а 16- или 32-битные версии одного и того же UUID будут использоваться в публичных данных по мере необходимости.

Описание свойств

Appearance : uint16

Внешний вид для использования в публичном отчёте.

Возможные значения: как указано в сервисе GAP.

Data : dict [экспериментально]

Тип публичных данных для включения в пакет. Ключ — тип данных, а значение — данные в виде массива байтов.

Примечание. Типы, уже обработанные другими свойствами, не должны использоваться.

Возможные значения:

<тип> <байтовый массив>
...

Пример:

<Transport Discovery> <Organization Flags...>
0x26                   0x01         0x01...

Discoverable : bool [экспериментально]

Маркируется как общедоступный. Это свойство при наличии переопределяет свойство Discoverable у адаптера.

Примечание. Это свойство не должно устанавливаться, если для Type установлено значение broadcast.

DiscoverableTimeout : uint16 [экспериментально]

Тайм-аут поиска в секундах. Нулевое значение означает, что тайм-аут отключён, и адаптер навсегда останется в режиме обнаружения/ограничения.

Примечание. Это свойство не должно устанавливаться, если для Type установлено значение broadcast.

Duration : uint16_t

Продолжительность ротации данных в секундах. Если есть другие приложения, не указывающие продолжительность, по умолчанию она составляет 2 секунды.

Includes : array{string}

Список функций, которые должны быть включены в публичный пакет.

Возможные значения: как указано в SupportedIncludes.

LocalName : string

Локальное название для использования в публичном отчёте. Если строка слишком велика для размещения в пакете, она будет усечена.

Если это свойство доступно, local-name не может присутствовать в Includes.

ManufacturerData : dict

Поля данных производителя для включения в публичные данные. Ключи — это идентификаторы производителя, которые нужно связать с данными.

MaxInterval : uint32 [экспериментально]

Максимальный интервал рассылки в миллисекундах, используемый публичным пакетом. Допустимые значения находятся в диапазоне от 20 мс, до 10485 с. Если предоставленный MinInterval больше предоставленного MaxInterval, регистрация вернёт ошибку.

MinInterval : uint32 [экспериментально]

Минимальный интервал рассылки в миллисекундах, используемый публичным пакетом. Допустимые значения находятся в диапазоне от 20 мс, до 10485 с. Если предоставленный MinInterval больше предоставленного MaxInterval, регистрация вернёт ошибку.

SecondaryChannel : string [экспериментально]

Вторичный канал, который будет использоваться. Первичный канал всегда устанавливается как 1M, за исключением случаев, когда установлен Coded.

Возможное значение: 1M (по умолчанию), 2M, Coded.

ServiceData : dict

Фрагменты служебных данных для включения. Ключи — это UUID для связи с данными.

ServiceUUIDs : array{string}

Список UUID для включения в поле Service UUID публичных данных.

SolicitUUIDs : array{string}

Массив UUID для включения в поле Service Solicitation публичных данных.

Timeout : uint16_t

Тайм-аут публичных данных в секундах. Он определяет время их жизни.

TxPower : uint16 [экспериментально]

Запрашиваемая мощность передачи этого пакета данных. Предоставленное значение используется только в том случае, если в менеджере включена функция CanSetTxPower. Предоставленное значение должно находиться в диапазоне от -127 до +20, где единицы измерения указаны в дБм.

Type : string

Определяет тип запрошенного публичного пакета.

Возможные значения: broadcast или peripheral.

Описание методов

Release() [без ответа]

Вызывается, когда служба-демон удаляет объект Advertisement. Клиент может использовать его для выполнения задач по очистке. Нет необходимости вызывать UnregisterAdvertisement, потому что когда этот метод вызывается, объект уже не зарегистрирован.