Roy Want / Mbed OS beaconCompileReadyFork
Embed: (wiki syntax)

« Back to documentation index

EddystoneService::EddystoneParams_t Struct Reference

EddystoneService::EddystoneParams_t Struct Reference

Structure that encapsulates the Eddystone configuration parameters. More...

#include <EddystoneService.h>

Data Fields

Capability_t capabilities
 A buffer describing the capabilities of the beacon.
uint8_t activeSlot
 Defines the slot that advInterval, radioPower, advPower, advSlotData operate on.
SlotAdvIntervals_t slotAdvIntervals
 The Beacon interval for each beacon slot.
PowerLevels_t radioTxPowerLevels
 The Radio TX Powers supported by this beacon.
SlotTxPowerLevels_t slotRadioTxPowerLevels
 The Radio TX Power set for each slot.
PowerLevels_t advTxPowerLevels
 The Calibrated Adv TX Powers supported by this beacon (one for each radio power)
SlotTxPowerLevels_t slotAdvTxPowerLevels
 The Adv TX Power set for each slot.
uint8_t lockState
 The value of the Eddystone-URL Configuration Service Lock State characteristic.
Lock_t unlockToken
 The value of the Eddystone-URL Configuration Service Unlock characteristic that can be used to unlock the beacon and clear the single-use lock-code.
Lock_t unlockKey
 An array holding the 128-bit unlockKey (big endian)
Lock_t challenge
 An array holding the 128-bit challenge (big endian) in the challenge/response unlock protocol.
SlotEidRotationPeriodExps_t slotEidRotationPeriodExps
 EID: An array holding the 256-bit private Ecdh Key (big endian)
SlotEidIdentityKeys_t slotEidIdentityKeys
 EID: An array holding the slot 128-bit EID Identity Key (big endian)
SlotFrameTypes_t slotFrameTypes
 Specifies the type of each frame indexed by slot.
SlotStorage_t slotStorage
 A buffer that contains all slot frames, 32-bytes allocated to each frame.
uint8_t factoryReset
 The state of the recently invoked Factory Reset characteristic.
uint8_t remainConnectable
 The state of the recently invoked Remain Connectable characteristic.

Detailed Description

Structure that encapsulates the Eddystone configuration parameters.

This structure is particularly useful when storing the parameters to persistent storage.

Definition at line 107 of file EddystoneService.h.


Field Documentation

uint8_t activeSlot

Defines the slot that advInterval, radioPower, advPower, advSlotData operate on.

Definition at line 116 of file EddystoneService.h.

PowerLevels_t advTxPowerLevels

The Calibrated Adv TX Powers supported by this beacon (one for each radio power)

Definition at line 138 of file EddystoneService.h.

Capability_t capabilities

A buffer describing the capabilities of the beacon.

Definition at line 111 of file EddystoneService.h.

Lock_t challenge

An array holding the 128-bit challenge (big endian) in the challenge/response unlock protocol.

Definition at line 167 of file EddystoneService.h.

uint8_t factoryReset

The state of the recently invoked Factory Reset characteristic.

Definition at line 207 of file EddystoneService.h.

uint8_t lockState

The value of the Eddystone-URL Configuration Service Lock State characteristic.

Definition at line 149 of file EddystoneService.h.

PowerLevels_t radioTxPowerLevels

The Radio TX Powers supported by this beacon.

Definition at line 128 of file EddystoneService.h.

The state of the recently invoked Remain Connectable characteristic.

Definition at line 212 of file EddystoneService.h.

SlotAdvIntervals_t slotAdvIntervals

The Beacon interval for each beacon slot.

Note:
A value of zero disables Eddystone-URL frame trasmissions.

Definition at line 123 of file EddystoneService.h.

SlotTxPowerLevels_t slotAdvTxPowerLevels

The Adv TX Power set for each slot.

Definition at line 143 of file EddystoneService.h.

SlotEidIdentityKeys_t slotEidIdentityKeys

EID: An array holding the slot 128-bit EID Identity Key (big endian)

Definition at line 192 of file EddystoneService.h.

SlotEidRotationPeriodExps_t slotEidRotationPeriodExps

EID: An array holding the 256-bit private Ecdh Key (big endian)

EID: An array holding the 256-bit public Ecdh Key (big endian) EID: An array holding the slot next rotation times EID: An array holding the slot rotation period exponents

Definition at line 187 of file EddystoneService.h.

SlotFrameTypes_t slotFrameTypes

Specifies the type of each frame indexed by slot.

Definition at line 197 of file EddystoneService.h.

SlotTxPowerLevels_t slotRadioTxPowerLevels

The Radio TX Power set for each slot.

Definition at line 133 of file EddystoneService.h.

SlotStorage_t slotStorage

A buffer that contains all slot frames, 32-bytes allocated to each frame.

Definition at line 202 of file EddystoneService.h.

Lock_t unlockKey

An array holding the 128-bit unlockKey (big endian)

Definition at line 161 of file EddystoneService.h.

Lock_t unlockToken

The value of the Eddystone-URL Configuration Service Unlock characteristic that can be used to unlock the beacon and clear the single-use lock-code.

Definition at line 156 of file EddystoneService.h.