esp-nimble-cpp  1.4.1
NimBLEBeacon Class Reference

Representation of a beacon. See: More...

Public Member Functions

 NimBLEBeacon ()
 Construct a default beacon object.
 
std::string getData ()
 Retrieve the data that is being advertised. More...
 
uint16_t getMajor ()
 Get the major value being advertised. More...
 
uint16_t getMinor ()
 Get the minor value being advertised. More...
 
uint16_t getManufacturerId ()
 Get the manufacturer ID being advertised. More...
 
NimBLEUUID getProximityUUID ()
 Get the proximity UUID being advertised. More...
 
int8_t getSignalPower ()
 Get the signal power being advertised. More...
 
void setData (const std::string &data)
 Set the raw data for the beacon record. More...
 
void setMajor (uint16_t major)
 Set the major value. More...
 
void setMinor (uint16_t minor)
 Set the minor value. More...
 
void setManufacturerId (uint16_t manufacturerId)
 Set the manufacturer ID. More...
 
void setProximityUUID (const NimBLEUUID &uuid)
 Set the proximity UUID. More...
 
void setSignalPower (int8_t signalPower)
 Set the signal power. More...
 

Detailed Description

Representation of a beacon. See:

Member Function Documentation

◆ getData()

std::string NimBLEBeacon::getData ( )

Retrieve the data that is being advertised.

Returns
The advertised data.

◆ getMajor()

uint16_t NimBLEBeacon::getMajor ( )

Get the major value being advertised.

Returns
The major value advertised.

◆ getManufacturerId()

uint16_t NimBLEBeacon::getManufacturerId ( )

Get the manufacturer ID being advertised.

Returns
The manufacturer ID value advertised.

◆ getMinor()

uint16_t NimBLEBeacon::getMinor ( )

Get the minor value being advertised.

Returns
minor value advertised.

◆ getProximityUUID()

NimBLEUUID NimBLEBeacon::getProximityUUID ( )

Get the proximity UUID being advertised.

Returns
The UUID advertised.

◆ getSignalPower()

int8_t NimBLEBeacon::getSignalPower ( )

Get the signal power being advertised.

Returns
signal power level advertised.

◆ setData()

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

Set the raw data for the beacon record.

Parameters
[in]dataThe raw beacon data.

◆ setMajor()

void NimBLEBeacon::setMajor ( uint16_t  major)

Set the major value.

Parameters
[in]majorThe major value.

◆ setManufacturerId()

void NimBLEBeacon::setManufacturerId ( uint16_t  manufacturerId)

Set the manufacturer ID.

Parameters
[in]manufacturerIdThe manufacturer ID value.

◆ setMinor()

void NimBLEBeacon::setMinor ( uint16_t  minor)

Set the minor value.

Parameters
[in]minorThe minor value.

◆ setProximityUUID()

void NimBLEBeacon::setProximityUUID ( const NimBLEUUID uuid)

Set the proximity UUID.

Parameters
[in]uuidThe proximity UUID.

◆ setSignalPower()

void NimBLEBeacon::setSignalPower ( int8_t  signalPower)

Set the signal power.

Parameters
[in]signalPowerThe signal power value.