My Project
Public Member Functions | Friends | List of all members
BLEAdvertisedDevice Class Reference

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

#include <BLEAdvertisedDevice.h>

Public Member Functions

BLEAddress getAddress ()
 Get the address. More...
 
uint16_t getApperance ()
 Get the appearance. More...
 
std::string getManufacturerData ()
 Get the manufacturer data. More...
 
std::string getName ()
 Get the name. More...
 
int getRSSI ()
 Get the RSSI. More...
 
BLEScangetScan ()
 Get the scan object that created this advertisement. More...
 
BLEUUID getServiceUUID ()
 Get the Service UUID. More...
 
int8_t getTXPower ()
 Get the TX Power. 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 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...
 

Friends

class BLEScan
 

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.

◆ getApperance()

uint16_t BLEAdvertisedDevice::getApperance ( )

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.

◆ getManufacturerData()

std::string BLEAdvertisedDevice::getManufacturerData ( )

Get the manufacturer data.

Returns
The manufacturer data of the advertised device.

◆ getName()

std::string BLEAdvertisedDevice::getName ( )

Get the name.

Returns
The name of the advertised device.

◆ getRSSI()

int BLEAdvertisedDevice::getRSSI ( )

Get the RSSI.

Returns
The RSSI of the advertised device.

◆ getScan()

BLEScan * BLEAdvertisedDevice::getScan ( )

Get the scan object that created this advertisement.

Returns
The scan object.

◆ getServiceUUID()

BLEUUID BLEAdvertisedDevice::getServiceUUID ( )

Get the Service UUID.

Returns
The Service UUID of the advertised device.

◆ getTXPower()

int8_t BLEAdvertisedDevice::getTXPower ( )

Get the TX Power.

Returns
The TX Power of the advertised device.

◆ haveAppearance()

bool BLEAdvertisedDevice::haveAppearance ( )

Does this advertisement have an appearance value?

Returns
True if there is an appearance value present.

◆ haveManufacturerData()

bool BLEAdvertisedDevice::haveManufacturerData ( )

Does this advertisement have manufacturer data?

Returns
True if there is manufacturer data present.

◆ haveName()

bool BLEAdvertisedDevice::haveName ( )

Does this advertisement have a name value?

Returns
True if there is a name value present.

◆ haveRSSI()

bool BLEAdvertisedDevice::haveRSSI ( )

Does this advertisement have a signal strength value?

Returns
True if there is a signal strength value present.

◆ haveServiceUUID()

bool BLEAdvertisedDevice::haveServiceUUID ( )

Does this advertisement have a service UUID value?

Returns
True if there is a service UUID value present.

◆ haveTXPower()

bool BLEAdvertisedDevice::haveTXPower ( )

Does this advertisement have a transmission power value?

Returns
True if there is a transmission power value present.

◆ toString()

std::string BLEAdvertisedDevice::toString ( )

Create a string representation of this device.

Returns
A string representation of this device.

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