Класс QLowEnergyCharacteristic

Класс QLowEnergyCharacteristic хранит информацию о характеристике службы Bluetooth Low Energy. Подробнее...

• Список всех членов, включая унаследованные

Типы публичного доступа

Функции публичного доступа

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

Класс QLowEnergyCharacteristic хранит информацию о характеристике службы Bluetooth Low Energy.

QLowEnergyCharacteristic предоставляет информацию о имени (name()), UUID (uuid()), значении (value()), свойствах (properties()), дескрипторе (handle()) и дескрипторах (descriptors()) характеристики Bluetooth Low Energy. Для получения спецификации и информации о характеристике необходимо подключиться к устройству, используя классы QLowEnergyService и QLowEnergyController.

Значение характеристики можно записать через экземпляр QLowEnergyService, управляющий службой, к которой принадлежит данная характеристика. Функция QLowEnergyService::writeCharacteristic() записывает новое значение. Сигнал QLowEnergyService::characteristicWritten() генерируется при успехе. Значение (value()) этого объекта автоматически обновляется соответствующим образом.

Характеристики могут содержать ноль, один или несколько дескрипторов. Их можно индивидуально получить, используя функцию descriptor(). Функция descriptors() возвращает список всех дескрипторов. Основное назначение дескриптора — добавление контекстной информации к характеристике. Например, дескриптор может предоставить информацию о формате или диапазоне, определяющую, как интерпретировать значение характеристики.

См. также QLowEnergyService и QLowEnergyDescriptor.

Документация по типам членов

перечисление QLowEnergyCharacteristic::PropertyTypeфлаги QLowEnergyCharacteristic::PropertyTypes

Это перечисление описывает свойства характеристики.

Тип PropertyTypes является типом-синонимом для QFlags<PropertyType>. Он хранит результат побитового ИЛИ из значений PropertyType.

См. также properties().

Документация по функциям членов

QLowEnergyCharacteristic::QLowEnergyCharacteristic()

Создаёт новый объект QLowEnergyCharacteristic. Экземпляр, созданный по умолчанию, всегда невалидный.

См. также isValid().

QLowEnergyCharacteristic::QLowEnergyCharacteristic(const QLowEnergyCharacteristic &other)

Создаёт новый объект QLowEnergyCharacteristic, являющийся копией объекта other.

Обе копии по-прежнему используют одну и ту же базовую информацию, которая не отделяется при записи.

QLowEnergyCharacteristic::~QLowEnergyCharacteristic()

Уничтожает объект QLowEnergyCharacteristic.

QLowEnergyDescriptor QLowEnergyCharacteristic::descriptor(const QBluetoothUuid &uuid) const

Возвращает дескриптор для uuid или невалидный QLowEnergyDescriptor экземпляр.

См. также descriptors().

QList<QLowEnergyDescriptor> QLowEnergyCharacteristic::descriptors() const

Возвращает список дескрипторов, принадлежащих этой характеристике; в противном случае — пустой список.

См. также descriptor().

QLowEnergyHandle QLowEnergyCharacteristic::handle() const

Возвращает дескриптор (handle) атрибута значения характеристики; или 0 если handle недоступен на платформе или характеристика невалидна.

Примечание: На macOS и iOS значения handle могут отличаться от 0, но эти значения не имеют специального смысла за пределами внутренних/частных API.

bool QLowEnergyCharacteristic::isValid() const

Возвращает true если объект QLowEnergyCharacteristic валиден, в противном случае возвращает false.

Недействительный объект характеристики не связан ни с каким сервисом (по умолчанию) или связанный сервис больше недействителен из-за разрыва соединения с базовым устройством Bluetooth Low Energy, например. После того, как объект станет недействительным, он больше не может стать действительным.

Примечание: Если экземпляр QLowEnergyCharacteristic становится недействительным из-за разрыва соединения с базовым устройством, информация, содержащаяся в текущем экземпляре, остаётся такой, какой она была в момент разрыва соединения. Поэтому она может быть получена после события разрыва соединения.

QString QLowEnergyCharacteristic::name() const

Возвращает удобочитаемое имя характеристики.

Имя основано на uuid() характеристики, которая должна быть стандартизирована. Полный список типов характеристик можно найти на сайте Bluetooth.org Characteristics.

Возвращаемая строка пустая, если uuid() неизвестно.

См. также QBluetoothUuid::characteristicToString().

QLowEnergyCharacteristic::PropertyTypes QLowEnergyCharacteristic::properties() const

Возвращает свойства характеристики.

Свойства определяют разрешения доступа к характеристике.

QBluetoothUuid QLowEnergyCharacteristic::uuid() const

Возвращает UUID характеристики, если isValid() возвращает true; в противном случае — нулевой UUID.

QByteArray QLowEnergyCharacteristic::value() const

Возвращает кэшированное значение характеристики.

Если свойства характеристики properties() разрешают запись новых значений, значение может быть обновлено с помощью QLowEnergyService::writeCharacteristic().

Кэш обновляется во время открытия деталей связанного сервиса, успешной операции чтения/записи read/write или при получении уведомления об обновлении.

Возвращаемый QByteArray всегда остается пустым, если у характеристики нет разрешения на чтение. В таких случаях только QLowEnergyService::characteristicChanged() или QLowEnergyService::characteristicWritten() могут предоставить информацию о значении этой характеристики.

bool QLowEnergyCharacteristic::operator!=(const QLowEnergyCharacteristic &other) const

Возвращает true , если other не равно этому QLowEnergyCharacteristic; в противном случае false.

Два экземпляра QLowEnergyCharcteristic считаются равными, если они ссылаются на одну и ту же характеристику на одном и том же удаленном устройстве Bluetooth Low Energy или оба экземпляра были созданы по умолчанию.

QLowEnergyCharacteristic &QLowEnergyCharacteristic::operator=(const QLowEnergyCharacteristic &other)

Создает копию other и присваивает ее этому объекту QLowEnergyCharacteristic. Обе копии продолжают совместно использовать те же детали сервиса и контроллера.

bool QLowEnergyCharacteristic::operator==(const QLowEnergyCharacteristic &other) const

Возвращает true , если other равно этому QLowEnergyCharacteristic; в противном случае false.

Два экземпляра QLowEnergyCharacteristic считаются равными, если они ссылаются на одну и ту же характеристику на одном и том же удаленном устройстве Bluetooth Low Energy или оба экземпляра были созданы по умолчанию.