ST / Mbed OS mbed-os-example-ble-EddystoneService

BLE EddystoneService example

Embed: (wiki syntax)

« Back to documentation index

UIDFrame Class Reference
Public Member Functions

UIDFrame Class Reference

Class that encapsulates data that belongs to the Eddystone-UID frame. More...

#include <UIDFrame.h>

Public Member Functions

 UIDFrame (void)
 Construct a new instance of this class.
 UIDFrame (const UIDNamespaceID_t uidNamespaceIDIn, const UIDInstanceID_t uidInstanceIDIn)
 Construct a new instance of this class.
void setUIDData (const UIDNamespaceID_t &uidNamespaceIDIn, const UIDInstanceID_t &uidInstanceIDIn)
 Set the instance and namespace ID.
void constructUIDFrame (uint8_t *rawFrame, int8_t advPowerLevel)
 Construct the raw bytes of the Eddystone-UID frame that will be directly used in the advertising packets.
size_t getRawFrameSize (void) const
 Get the size of the Eddystone-UID frame constructed with the current state of the UIDFrame object.
uint8_t * getUIDNamespaceID (void)
 Get the Eddystone-UID namespace ID.
uint8_t * getUIDInstanceID (void)
 Get the Eddystone-UID instance ID.

Detailed Description

Class that encapsulates data that belongs to the Eddystone-UID frame.

For more information refer to https://github.com/google/eddystone/tree/master/eddystone-uid.

Definition at line 27 of file UIDFrame.h.

Constructor & Destructor Documentation

UIDFrame ( void   )

Construct a new instance of this class.

Definition at line 19 of file UIDFrame.cpp.

UIDFrame ( const UIDNamespaceID_t  uidNamespaceIDIn,
const UIDInstanceID_t  uidInstanceIDIn 
)

Construct a new instance of this class.

Parameters:
[in]uidNamespaceIDInThe Eddystone-UID namespace ID.
[in]uidInstanceIDInThe Eddystone-UID instance ID.

Definition at line 25 of file UIDFrame.cpp.

Member Function Documentation

void constructUIDFrame ( uint8_t *  rawFrame,
int8_t  advPowerLevel 
)

Construct the raw bytes of the Eddystone-UID frame that will be directly used in the advertising packets.

Parameters:
[in]rawFramePointer to the location where the raw frame will be stored.
[in]advPowerLevelPower level value included withing the raw frame.

Definition at line 37 of file UIDFrame.cpp.

size_t getRawFrameSize ( void   ) const

Get the size of the Eddystone-UID frame constructed with the current state of the UIDFrame object.

Returns:
The size in bytes of the Eddystone-UID frame.

Definition at line 54 of file UIDFrame.cpp.

uint8_t * getUIDInstanceID ( void   )

Get the Eddystone-UID instance ID.

Returns:
A pointer to the instance ID.

Definition at line 64 of file UIDFrame.cpp.

uint8_t * getUIDNamespaceID ( void   )

Get the Eddystone-UID namespace ID.

Returns:
A pointer to the namespace ID.

Definition at line 59 of file UIDFrame.cpp.

void setUIDData ( const UIDNamespaceID_t &  uidNamespaceIDIn,
const UIDInstanceID_t &  uidInstanceIDIn 
)

Set the instance and namespace ID.

Parameters:
[in]uidNamespaceIDInThe new Eddystone-UID namespace ID.
[in]uidInstanceIDInThe new Eddystone-UID instance ID.

Definition at line 31 of file UIDFrame.cpp.

Generated on Tue Jul 12 2022 19:55:16 by  doxygen 1.7.2