NimBLEEddystoneTLM Class Reference

Representation of a beacon. See: More...

#include <NimBLEEddystoneTLM.h>

Public Member Functions
const BeaconData	getData ()
	Retrieve the data that is being advertised.
NimBLEUUID	getUUID ()
	Get the UUID being advertised.
uint8_t	getVersion ()
	Get the version being advertised.
uint16_t	getVolt ()
	Get the battery voltage.
int16_t	getTemp ()
	Get the temperature being advertised.
uint32_t	getCount ()
	Get the count of advertisements sent.
uint32_t	getTime ()
	Get the advertisement time.
std::string	toString ()
	Get a string representation of the beacon.
void	setData (const uint8_t *data, uint8_t length)
	Set the raw data for the beacon advertisement.
void	setData (const BeaconData &data)
	Set the raw data for the beacon advertisement.
void	setUUID (const NimBLEUUID &l_uuid)
	Set the UUID to advertise.
void	setVersion (uint8_t version)
	Set the version to advertise.
void	setVolt (uint16_t volt)
	Set the battery voltage to advertise.
void	setTemp (int16_t temp)
	Set the temperature to advertise.
void	setCount (uint32_t advCount)
	Set the advertisement count.
void	setTime (uint32_t tmil)
	Set the advertisement time.

Detailed Description

Representation of a beacon. See:

• https://github.com/google/eddystone

Member Function Documentation

getCount()

uint32_t NimBLEEddystoneTLM::getCount

(

)

Get the count of advertisements sent.

Returns

The number of advertisements.

getData()

const NimBLEEddystoneTLM::BeaconData NimBLEEddystoneTLM::getData

(

)

Retrieve the data that is being advertised.

Returns

The advertised data.

getTemp()

int16_t NimBLEEddystoneTLM::getTemp

(

)

Get the temperature being advertised.

Returns

The temperature value.

getTime()

uint32_t NimBLEEddystoneTLM::getTime

(

)

Get the advertisement time.

Returns

The advertisement 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 advertisement count.

Parameters

[in]

advCount

The advertisement number.

setData() [1/2]

void NimBLEEddystoneTLM::setData

(

const BeaconData &

data

)

Set the raw data for the beacon advertisement.

Parameters

[in]

data

The raw data to advertise.

setData() [2/2]

void NimBLEEddystoneTLM::setData	(	const uint8_t *	data,
		uint8_t	length
	)

Set the raw data for the beacon advertisement.

Parameters

[in]	data	A pointer to the data to advertise.
[in]	length	The length of the data.

setTemp()

void NimBLEEddystoneTLM::setTemp

(

int16_t

temp

)

Set the temperature to advertise.

Parameters

[in]

temp

The temperature value in 8.8 fixed point format.

setTime()

void NimBLEEddystoneTLM::setTime

(

uint32_t

tmil

)

Set the advertisement time.

Parameters

[in]

tmil

The advertisement time in milliseconds.

setUUID()

void NimBLEEddystoneTLM::setUUID

(

const NimBLEUUID &

uuid

)

Set the UUID to advertise.

Parameters

[in]

uuid

The UUID.

setVersion()

void NimBLEEddystoneTLM::setVersion

(

uint8_t

version

)

Set the version to advertise.

Parameters

[in]

version

The version number.

setVolt()

void NimBLEEddystoneTLM::setVolt

(

uint16_t

volt

)

Set the battery voltage to advertise.

Parameters

[in]

volt

The voltage in millivolts.

toString()

std::string NimBLEEddystoneTLM::toString

(

)

Get a string representation of the beacon.

Returns

The string representation.