esp-nimble-cpp / NimBLE-Arduino  1.3.1
NimBLEEddystoneURL Class Reference

Representation of a beacon. See: More...

Public Member Functions

 NimBLEEddystoneURL ()
 Construct a default EddystoneURL beacon object.
 
std::string getData ()
 Retrieve the data that is being advertised. More...
 
NimBLEUUID getUUID ()
 Get the UUID being advertised. More...
 
int8_t getPower ()
 Get the transmit power being advertised. More...
 
std::string getURL ()
 Get the raw URL being advertised. More...
 
std::string getDecodedURL ()
 Get the full URL being advertised. More...
 
void setData (const std::string &data)
 Set the raw data for the beacon advertisment. More...
 
void setUUID (const NimBLEUUID &l_uuid)
 Set the UUID to advertise. More...
 
void setPower (int8_t advertisedTxPower)
 Set the transmit power to advertise. More...
 
void setURL (const std::string &url)
 Set the URL to advertise. More...
 

Detailed Description

Representation of a beacon. See:

Member Function Documentation

◆ getData()

std::string NimBLEEddystoneURL::getData ( )

Retrieve the data that is being advertised.

Returns
The advertised data.

◆ getDecodedURL()

std::string NimBLEEddystoneURL::getDecodedURL ( )

Get the full URL being advertised.

Returns
The full URL.

◆ getPower()

int8_t NimBLEEddystoneURL::getPower ( )

Get the transmit power being advertised.

Returns
The transmit power.

◆ getURL()

std::string NimBLEEddystoneURL::getURL ( )

Get the raw URL being advertised.

Returns
The raw URL.

◆ getUUID()

NimBLEUUID NimBLEEddystoneURL::getUUID ( )

Get the UUID being advertised.

Returns
The UUID advertised.

◆ setData()

void NimBLEEddystoneURL::setData ( const std::string &  data)

Set the raw data for the beacon advertisment.

Parameters
[in]dataThe raw data to advertise.

◆ setPower()

void NimBLEEddystoneURL::setPower ( int8_t  advertisedTxPower)

Set the transmit power to advertise.

Parameters
[in]advertisedTxPowerThe transmit power level.

◆ setURL()

void NimBLEEddystoneURL::setURL ( const std::string &  url)

Set the URL to advertise.

Parameters
[in]urlThe URL.

◆ setUUID()

void NimBLEEddystoneURL::setUUID ( const NimBLEUUID l_uuid)

Set the UUID to advertise.

Parameters
[in]l_uuidThe UUID.