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

#include <EIDFrame.h>

Public Member Functions
	EIDFrame ()
	Construct a new instance of this class.
void	clearFrame (uint8_t *frame)
	Clear frame (intervally indicated by length = 0 )
void	setData (uint8_t rawFrame, int8_t advTxPower, const uint8_t eidData)
	Construct the raw bytes of the Eddystone-EID frame that will be directly used in the advertising packets.
uint8_t *	getData (uint8_t *rawFrame)
	Get the EID frame data from the Eddystone-EID frame.
uint8_t	getDataLength (uint8_t *rawFrame)
	Get the length of the EID frame data from the Eddystone-EID frame.
uint8_t *	getAdvFrame (uint8_t *rawFrame)
	Get the EID Adv data from the Eddystone-EID frame.
uint8_t	getAdvFrameLength (uint8_t *rawFrame)
	Get the length of the EID Adv data from the Eddystone-EID frame.
uint8_t *	getEid (uint8_t *rawFrame)
	Get just the EID data from the Eddystone-EID frame.
uint8_t	getEidLength (uint8_t *rawFrame)
	Get the length of just the EID data from the Eddystone-EID frame.
void	setAdvTxPower (uint8_t *rawFrame, int8_t advTxPower)
	Set the Adv TX Power in the frame.
int	genBeaconKeys (PrivateEcdhKey_t beaconPrivateEcdhKey, PublicEcdhKey_t beaconPublicEcdhKey)
	Generate the beacon private and public keys.
void	update (uint8_t rawFrame, uint8_t eidIdentityKey, uint8_t rotationPeriodExp, uint32_t timeSecs)
	Update the EID frame.
int	genEcdhSharedKey (PrivateEcdhKey_t beaconPrivateEcdhKey, PublicEcdhKey_t beaconPublicEcdhKey, PublicEcdhKey_t serverPublicEcdhKey, EidIdentityKey_t eidIdentityKey)
	genEcdhSharedKey generates the eik value for inclusion in the EID ADV packet
Static Public Attributes
static const uint8_t	FRAME_TYPE_EID = 0x30
	The byte ID of an Eddystone-EID frame.

Detailed Description

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

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

Definition at line 34 of file EIDFrame.h.

Constructor & Destructor Documentation

EIDFrame ( )

Construct a new instance of this class.

Definition at line 22 of file EIDFrame.cpp.

Member Function Documentation

void clearFrame ( uint8_t * frame )

Clear frame (intervally indicated by length = 0 )

Definition at line 31 of file EIDFrame.cpp.

int genBeaconKeys	(	PrivateEcdhKey_t	beaconPrivateEcdhKey,
		PublicEcdhKey_t	beaconPublicEcdhKey
	)

Generate the beacon private and public keys.

This should be called on every restart of the beacon.

Parameters:

[out]	beaconPrivateEcdhKey	Pointer to the beacon private key array.
[out]	beaconPublicEcdhKey	Pointer to the beacon public key array.

Definition at line 121 of file EIDFrame.cpp.

int genEcdhSharedKey	(	PrivateEcdhKey_t	beaconPrivateEcdhKey,
		PublicEcdhKey_t	beaconPublicEcdhKey,
		PublicEcdhKey_t	serverPublicEcdhKey,
		EidIdentityKey_t	eidIdentityKey
	)

genEcdhSharedKey generates the eik value for inclusion in the EID ADV packet

Parameters:

[in]	beaconPrivateEcdhKey	The beacon's private ECDH key, generated by genBeaconKeys()
[in]	beaconPublicEcdhKey	The beacon's public ECDH key, generated by genBeaconKeys()
[in]	serverPublicEcdhKey	The server's public ECDH key
[out]	eidIdentityKey	Identity key for this beacon and server combination

Definition at line 143 of file EIDFrame.cpp.

uint8_t * getAdvFrame ( uint8_t * rawFrame )

Get the EID Adv data from the Eddystone-EID frame.

This is the full service data included in the BLE service data params

Parameters: