A representation of a BLE advertised device found by a scan. More...

#include <BLEAdvertisedDevice.hpp>

Public Member Functions
BLEAddress	getAddress ()
	Get the address. More...

uint16_t	getAppearance ()
	Get the appearance. More...

std::string	getManufacturerData ()
	Get the manufacturer data. More...

std::string	getName ()
	Get the name. More...

int16_t	getRSSI ()
	Get the RSSI. More...

BLEScan *	getScan ()
	Get the scan object that created this advertisement. More...

std::string	getServiceData ()
	Get the service data. More...

BLEUUID	getServiceDataUUID ()
	Get the service data UUID. More...

BLEUUID	getServiceUUID ()
	Get the Service UUID. More...

int8_t	getTXPower ()
	Get the TX Power. More...

const uint8_t *	getPayload ()
	Get the advertised payload. More...

size_t	getPayloadLength ()
	Get the advertised payload length. More...

BLEAddress::Type_t	getAddressType ()

void	setAddressType (BLEAddress::Type_t type)

bool	isAdvertisingService (BLEUUID uuid)
	Check advertised serviced for existence required UUID. More...

bool	haveAppearance ()
	Does this advertisement have an appearance value? More...

bool	haveManufacturerData ()
	Does this advertisement have manufacturer data? More...

bool	haveName ()
	Does this advertisement have a name value? More...

bool	haveRSSI ()
	Does this advertisement have a signal strength value? More...

bool	haveServiceData ()
	Does this advertisement have a service data value? More...

bool	haveServiceUUID ()
	Does this advertisement have a service UUID value? More...

bool	haveTXPower ()
	Does this advertisement have a transmission power value? More...

std::string	toString ()
	Create a string representation of this device. More...

Detailed Description

A representation of a BLE advertised device found by a scan.

When we perform a BLE scan, the result will be a set of devices that are advertising. This class provides a model of a detected device.

Member Function Documentation

◆ getAddress()

BLEAddress BLEAdvertisedDevice::getAddress ( )

Get the address.

Every BLE device exposes an address that is used to identify it and subsequently connect to it. Call this function to obtain the address of the advertised device.

Returns: The address of the advertised device.

                                            {
     return m_address;
 } // getAddress

◆ getAppearance()

uint16_t BLEAdvertisedDevice::getAppearance ( )

Get the appearance.

A BLE device can declare its own appearance. The appearance is how it would like to be shown to an end user typcially in the form of an icon.

Returns: The appearance of the advertised device.

                                             {
     return m_appearance;
 } // getAppearance

◆ getManufacturerData()

std::string BLEAdvertisedDevice::getManufacturerData ( )

Get the manufacturer data.

Returns: The manufacturer data of the advertised device.

                                                    {
     return m_manufacturerData;
 } // getManufacturerData

◆ getName()

std::string BLEAdvertisedDevice::getName ( )

Get the name.

Returns: The name of the advertised device.

                                        {
     return m_name;
 } // getName

◆ getPayload()

const uint8_t * BLEAdvertisedDevice::getPayload ( )

Get the advertised payload.

The payload includes both a advertisement and a scan response.

Note: This is modified by CoXlab Inc.

                                                {
     return (const uint8_t *) m_payload.data();
 }

◆ getPayloadLength()

size_t BLEAdvertisedDevice::getPayloadLength ( )

Get the advertised payload length.

The payload length will be equal or less than 62.

31 (maximum length of an advertisement) + 31 (maximum length of a scan response)

Note: This is modified by CoXlab Inc.

                                              {
     return m_payload.size();
 }

◆ getRSSI()

int16_t BLEAdvertisedDevice::getRSSI ( )

Get the RSSI.

Returns: The RSSI of the advertised device.

                                      {
     return m_rssi;
 } // getRSSI

◆ getScan()

BLEScan * BLEAdvertisedDevice::getScan ( )

Get the scan object that created this advertisement.

Returns: The scan object.

                                       {
     return m_pScan;
 } // getScan

◆ getServiceData()

std::string BLEAdvertisedDevice::getServiceData ( )

Get the service data.

Returns: The ServiceData of the advertised device.

                                               {
     return m_serviceData;
 } //getServiceData

◆ getServiceDataUUID()

BLEUUID BLEAdvertisedDevice::getServiceDataUUID ( )

Get the service data UUID.

Returns: The service data UUID.

                                                 {
     return m_serviceDataUUID;
 } // getServiceDataUUID

◆ getServiceUUID()

BLEUUID BLEAdvertisedDevice::getServiceUUID ( )

Get the Service UUID.

Returns: The Service UUID of the advertised device.

                                             {  //TODO Remove it eventually, is no longer useful
     return m_serviceUUIDs[0];
 } // getServiceUUID

◆ getTXPower()

int8_t BLEAdvertisedDevice::getTXPower ( )

Get the TX Power.

Returns: The TX Power of the advertised device.

                                        {
     return m_txPower;
 } // getTXPower

◆ haveAppearance()

bool BLEAdvertisedDevice::haveAppearance ( )

Does this advertisement have an appearance value?

Returns: True if there is an appearance value present.

                                          {
     return m_haveAppearance;
 } // haveAppearance

◆ haveManufacturerData()

bool BLEAdvertisedDevice::haveManufacturerData ( )

Does this advertisement have manufacturer data?

Returns: True if there is manufacturer data present.

                                                {
     return (m_manufacturerData.length() > 0);
 } // haveManufacturerData

◆ haveName()

bool BLEAdvertisedDevice::haveName ( )

Does this advertisement have a name value?

Returns: True if there is a name value present.

                                    {
     return (m_name.length() > 0);
 } // haveName

◆ haveRSSI()

bool BLEAdvertisedDevice::haveRSSI ( )

Does this advertisement have a signal strength value?

Returns: True if there is a signal strength value present.

                                    {
     return (m_rssi > SHRT_MIN);
 } // haveRSSI

◆ haveServiceData()

bool BLEAdvertisedDevice::haveServiceData ( )

Does this advertisement have a service data value?

Returns: True if there is a service data value present.

                                           {
     return m_haveServiceData;
 } // haveServiceData

◆ haveServiceUUID()

bool BLEAdvertisedDevice::haveServiceUUID ( )

Does this advertisement have a service UUID value?

Returns: True if there is a service UUID value present.

                                           {
     return (m_serviceUUIDs.size() > 0);
 } // haveServiceUUID

◆ haveTXPower()

bool BLEAdvertisedDevice::haveTXPower ( )

Does this advertisement have a transmission power value?

Returns: True if there is a transmission power value present.

                                       {
     return (m_txPower > CHAR_MIN);
 } // haveTXPower

◆ isAdvertisingService()

bool BLEAdvertisedDevice::isAdvertisingService ( BLEUUID uuid )

Check advertised serviced for existence required UUID.

Returns: Return true if service is advertised

                                                           {
     for (unsigned i = 0; i < m_serviceUUIDs.size(); i++) {
         if (m_serviceUUIDs[i].equals(uuid)) return true;
     }
     return false;
 }

◆ toString()

std::string BLEAdvertisedDevice::toString ( )

Create a string representation of this device.

Returns: A string representation of this device.

                                         {
     std::stringstream ss;
     ss << "{address: " << getAddress().toString();
     if (haveName()) {
         ss << ", name: " << m_name;
     }
     if (haveAppearance()) {
         ss << ", appearance: " << getAppearance();
     }
     if (haveManufacturerData()) {
         ss << ", manufacturer data:";
         for (uint8_t i = 0; i < getManufacturerData().length(); i++) {
             ss << ' ' << std::setfill('0') << std::setw(2) << std::hex << (int)((uint8_t *) getManufacturerData().data())[i];
         }
         ss << std::setw(0) << std::dec;
     }
     if (haveServiceUUID()) {
         ss << ", serviceUUID: " << getServiceUUID().toString();
     }
     if (haveTXPower()) {
         ss << ", txPower: " << (int)getTXPower();
     }
     ss << "}";
     return ss.str();
 } // toString

The documentation for this class was generated from the following files:

nola-sdk/include/BLEAdvertisedDevice.hpp
src/net/BluetoothLE/BLEAdvertisedDevice.cpp

Public Member Functions