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

Representation of a beacon. See: More...

Public Member Functions

 NimBLEEddystoneTLM ()
 Construct a default EddystoneTLM beacon object.
 
std::string getData ()
 Retrieve the data that is being advertised. More...
 
NimBLEUUID getUUID ()
 Get the UUID being advertised. More...
 
uint8_t getVersion ()
 Get the version being advertised. More...
 
uint16_t getVolt ()
 Get the battery voltage. More...
 
float getTemp ()
 Get the temperature being advertised. More...
 
uint32_t getCount ()
 Get the count of advertisments sent. More...
 
uint32_t getTime ()
 Get the advertisment time. More...
 
std::string toString ()
 Get a string representation of the beacon. 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 setVersion (uint8_t version)
 Set the version to advertise. More...
 
void setVolt (uint16_t volt)
 Set the battery voltage to advertise. More...
 
void setTemp (float temp)
 Set the temperature to advertise. More...
 
void setCount (uint32_t advCount)
 Set the advertisment count. More...
 
void setTime (uint32_t tmil)
 Set the advertisment time. More...
 

Detailed Description

Representation of a beacon. See:

Member Function Documentation

◆ getCount()

uint32_t NimBLEEddystoneTLM::getCount ( )

Get the count of advertisments sent.

Returns
The number of advertisments.

◆ getData()

std::string NimBLEEddystoneTLM::getData ( )

Retrieve the data that is being advertised.

Returns
The advertised data.

◆ getTemp()

float NimBLEEddystoneTLM::getTemp ( )

Get the temperature being advertised.

Returns
The temperature value.

◆ getTime()

uint32_t NimBLEEddystoneTLM::getTime ( )

Get the advertisment time.

Returns
The advertisment time.

◆ getUUID()

NimBLEUUID NimBLEEddystoneTLM::getUUID ( )

Get the UUID being advertised.

Returns
The UUID advertised.

◆ getVersion()

uint8_t NimBLEEddystoneTLM::getVersion ( )

Get the version being advertised.

Returns
The version number.

◆ getVolt()

uint16_t NimBLEEddystoneTLM::getVolt ( )

Get the battery voltage.

Returns
The battery voltage.

◆ setCount()

void NimBLEEddystoneTLM::setCount ( uint32_t  advCount)

Set the advertisment count.

Parameters
[in]advCountThe advertisment number.

◆ setData()

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

Set the raw data for the beacon advertisment.

Parameters
[in]dataThe raw data to advertise.

◆ setTemp()

void NimBLEEddystoneTLM::setTemp ( float  temp)

Set the temperature to advertise.

Parameters
[in]tempThe temperature value.

◆ setTime()

void NimBLEEddystoneTLM::setTime ( uint32_t  tmil)

Set the advertisment time.

Parameters
[in]tmilThe advertisment time in milliseconds.

◆ setUUID()

void NimBLEEddystoneTLM::setUUID ( const NimBLEUUID l_uuid)

Set the UUID to advertise.

Parameters
[in]l_uuidThe UUID.

◆ setVersion()

void NimBLEEddystoneTLM::setVersion ( uint8_t  version)

Set the version to advertise.

Parameters
[in]versionThe version number.

◆ setVolt()

void NimBLEEddystoneTLM::setVolt ( uint16_t  volt)

Set the battery voltage to advertise.

Parameters
[in]voltThe voltage in millivolts.

◆ toString()

std::string NimBLEEddystoneTLM::toString ( )

Get a string representation of the beacon.

Returns
The string representation.