Класс QLowEnergyAdvertisingData
Класс QLowEnergyAdvertisingData представляет данные, которые необходимо транслировать во время рекламы Bluetooth Low Energy. Подробнее...
| Заголовок: | #include <QLowEnergyAdvertisingData> |
| qmake: | QT += bluetooth |
| С версии: | Qt 5.7 |
Типы
| Перечисление | Discoverability { DiscoverabilityNone, DiscoverabilityLimited, DiscoverabilityGeneral } |
Публичные функции
| QLowEnergyAdvertisingData() | |
| QLowEnergyAdvertisingData(const QLowEnergyAdvertisingData &other) | |
| ~QLowEnergyAdvertisingData() | |
| Discoverability | discoverability() const |
| bool | includePowerLevel() const |
| QString | localName() const |
| QByteArray | manufacturerData() const |
| quint16 | manufacturerId() const |
| QByteArray | rawData() const |
| QList<QBluetoothUuid> | services() const |
| void | setDiscoverability(Discoverability mode) |
| void | setIncludePowerLevel(bool doInclude) |
| void | setLocalName(const QString &name) |
| void | setManufacturerData(quint16 id, const QByteArray &data) |
| void | setRawData(const QByteArray &data) |
| void | setServices(const QList<QBluetoothUuid> &services) |
| void | swap(QLowEnergyAdvertisingData &other) |
| QLowEnergyAdvertisingData & | operator=(const QLowEnergyAdvertisingData &other) |
Статические публичные члены
| quint16 | invalidManufacturerId() |
Подробное описание
Класс QLowEnergyAdvertisingData представляет данные, которые необходимо транслировать во время рекламы Bluetooth Low Energy.
Эти данные могут включать имя устройства, предлагаемые GATT-сервисы устройства и так далее. Набор данных через этот класс будет использоваться при запуске рекламы вызовом QLowEnergyController::startAdvertising(). Объекты этого класса могут представлять пакет Advertising Data или пакет Scan Response.
Примечание: фактические пакеты данных, отправленные по каналу рекламы, не могут содержать более 31 байта. Если набор данных переменной длины, заданный через этот класс, превышает этот предел, он будет исключен из пакета или усечен, в зависимости от типа.
См. также QLowEnergyAdvertisingParameters и QLowEnergyController::startAdvertising().
Документация по типу члена
Перечисление QLowEnergyAdvertisingData::Discoverability
Указывает на видимость рекламируемого устройства, как определено профилем Generic Access.
| Константа | Значение | Описание |
|---|---|---|
QLowEnergyAdvertisingData::DiscoverabilityNone |
0 |
Рекламируемое устройство не хочет быть обнаруживаемым сканирующими устройствами. |
QLowEnergyAdvertisingData::DiscoverabilityLimited |
1 |
Рекламируемое устройство хочет быть обнаруживаемым с высоким приоритетом. Обратите внимание, что этот режим несовместим с использованием белого списка. Значение QLowEnergyAdvertisingParameters::filterPolicy() всегда предполагается как QLowEnergyAdvertisingParameters::IgnoreWhiteList при использовании ограниченной обнаруживаемости. |
QLowEnergyAdvertisingData::DiscoverabilityGeneral |
2 |
Рекламируемое устройство хочет быть обнаруживаемым сканирующими устройствами. |
Документация по функции-члену
QLowEnergyAdvertisingData::QLowEnergyAdvertisingData()
Создает новый объект этого класса. Все значения инициализированы их значениями по умолчанию в соответствии со спецификацией Bluetooth Low Energy.
QLowEnergyAdvertisingData::QLowEnergyAdvertisingData(const QLowEnergyAdvertisingData &other)
Создает новый объект этого класса, который является копией other.
QLowEnergyAdvertisingData::~QLowEnergyAdvertisingData()
Уничтожает этот объект.
Discoverability QLowEnergyAdvertisingData::discoverability() const
Возвращает режим обнаруживаемости рекламируемого устройства. По умолчанию — DiscoverabilityNone.
См. также setDiscoverability().
bool QLowEnergyAdvertisingData::includePowerLevel() const
Возвращает значение, указывающее, следует ли включать уровень передаваемой мощности устройства в рекламные данные. По умолчанию — false.
См. также setIncludePowerLevel().
[static] quint16 QLowEnergyAdvertisingData::invalidManufacturerId()
Возвращает недопустимый идентификатор производителя. Если это значение установлено в качестве идентификатора производителя (что по умолчанию), рекламные данные не будут содержать данные производителя.
QString QLowEnergyAdvertisingData::localName() const
Возвращает имя локального устройства, которое будет рекламироваться.
См. также setLocalName().
QByteArray QLowEnergyAdvertisingData::manufacturerData() const
Возвращает данные производителя. По умолчанию — пустой массив байтов.
См. также setManufacturerData().
quint16 QLowEnergyAdvertisingData::manufacturerId() const
Возвращает идентификатор производителя. По умолчанию — QLowEnergyAdvertisingData::invalidManufacturerId(), что означает, что данные не будут рекламироваться.
QByteArray QLowEnergyAdvertisingData::rawData() const
Возвращает предоставленные пользователем необработанные данные, которые будут рекламироваться. По умолчанию — пустой массив байтов.
См. также setRawData().
QList<QBluetoothUuid> QLowEnergyAdvertisingData::services() const
Возвращает список UUID служб, которые будут рекламироваться. По умолчанию этот список пуст.
См. также setServices().
END_OF_DOCUMENT_MARKERvoid QLowEnergyAdvertisingData::setDiscoverability(Discoverability mode)
Устанавливает тип обнаружения устройства для рекламы в mode.
Примечание: Информация об обнаружении может появиться только в реальном пакете данных рекламы. Если этот объект действует как данные ответа на сканирование, вызов этой функции не повлияет на отправленные данные ответа на сканирование.
См. также discoverability().
void QLowEnergyAdvertisingData::setIncludePowerLevel(bool doInclude)
Определяет, следует ли включать уровень мощности передачи устройства в данные рекламы. Если doInclude равно true, данные будут включены, в противном случае — нет.
См. также includePowerLevel().
void QLowEnergyAdvertisingData::setLocalName(const QString &name)
Указывает, что name должно транслироваться в качестве имени устройства. Если полное имя не помещается в пакет данных рекламы, отправляется сокращённое имя в соответствии со спецификацией Bluetooth Low Energy.
В Android локальное имя изменить нельзя. Android всегда использует имя устройства. Если это локальное имя не пустое, реализация Android включает имя устройства в пакет объявления; в противном случае имя устройства из пакета объявления исключается.
См. также localName().
void QLowEnergyAdvertisingData::setManufacturerData(quint16 id, const QByteArray &data)
Устанавливает идентификатор производителя и данные. Параметр id — это идентификатор компании, присвоенный Bluetooth SIG. Параметр data — произвольное значение.
См. также manufacturerData().
void QLowEnergyAdvertisingData::setRawData(const QByteArray &data)
Устанавливает данные для рекламы в data. Если значение не пустой массив байтов, он будет отправлен как есть в качестве данных рекламы, и все другие данные в этом объекте будут проигнорированы. Это можно использовать для отправки данных, не соответствующих стандартам.
Примечание: Если data длиннее 31 байта, он будет усечён. Ответственность за обеспечение корректности данных data лежит на вызывающей стороне.
См. также rawData().
void QLowEnergyAdvertisingData::setServices(const QList<QBluetoothUuid> &services)
Указывает, что идентификаторы UUID служб в services должны быть рекламируемыми. Если весь список не помещается в пакет, отправляется неполный список в соответствии со спецификацией Bluetooth Low Energy.
См. также services().
void QLowEnergyAdvertisingData::swap(QLowEnergyAdvertisingData &other)
Меняет местами этот объект с other.
QLowEnergyAdvertisingData &QLowEnergyAdvertisingData::operator=(const QLowEnergyAdvertisingData &other)
Делает этот объект копией other и возвращает новое значение этого объекта.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qlowenergyadvertisingdata.html