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

BLE EddystoneService example

Embed: (wiki syntax)

« Back to documentation index

EddystoneService::EddystoneParams_t Struct Reference
Data Fields

EddystoneService::EddystoneParams_t Struct Reference

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

#include <EddystoneService.h>

Data Fields

bool lockState
 The value of the Eddystone-URL Configuration Service Lock State characteristic.
Lock_t lock
 The value of the Eddystone-URL Configuration Service Lock characteristic that can be used to lock the beacon and set the single-use lock-code.
Lock_t unlock
 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.
uint8_t flags
 The value of the Eddystone-URL Configuration Service Flags characteristic.
PowerLevels_t advPowerLevels
 The value of the Eddystone-URL Configuration Service Advertised TX Power Levels characteristic that is an array of bytes whose values are put into the advertising packets when in EDDYSTONE_BEACON_MODE.
uint8_t txPowerMode
 The value of the Eddystone-URL Configuration Service TX Power Mode characteristic.
uint16_t urlFramePeriod
 The value of the Eddystone-URL Configuration Service Beacon Period characteristic that is the interval (in milliseconds) of the Eddystone-URL frames.
uint16_t uidFramePeriod
 The configured interval (in milliseconds) of the Eddystone-UID frames.
uint16_t tlmFramePeriod
 The configured interval (in milliseconds) of the Eddystone-TLM frames.
uint8_t tlmVersion
 The configured version of the Eddystone-TLM frames.
uint8_t urlDataLength
 The length of the encoded URL in EddystoneParams_t::urlData used within Eddystone-URL frames.
UrlData_t urlData
 The value of the Eddystone-URL Configuration Service URI Data characteristic that contains an encoded URL as described in the Eddystone Specification at https://github.com/google/eddystone/blob/master/eddystone-url/README.md#eddystone-url-http-url-encoding.
UIDNamespaceID_t uidNamespaceID
 The configured 10-byte namespace ID in Eddystone-UID frames that may be used to group a particular set of beacons.
UIDInstanceID_t uidInstanceID
 The configured 6-byte instance ID that may be used to uniquely identify individual devices in a group.

Detailed Description

Structure that encapsulates the Eddystone configuration parameters.

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

Definition at line 123 of file EddystoneService.h.

Field Documentation

PowerLevels_t advPowerLevels

The value of the Eddystone-URL Configuration Service Advertised TX Power Levels characteristic that is an array of bytes whose values are put into the advertising packets when in EDDYSTONE_BEACON_MODE.

Note:
These are not the same values set internally into the radio tx power.

Definition at line 154 of file EddystoneService.h.

uint8_t flags

The value of the Eddystone-URL Configuration Service Flags characteristic.

This value is currently fixed to 0x10.

Definition at line 145 of file EddystoneService.h.

Lock_t lock

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

Definition at line 134 of file EddystoneService.h.

bool lockState

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

Definition at line 128 of file EddystoneService.h.

uint16_t tlmFramePeriod

The configured interval (in milliseconds) of the Eddystone-TLM frames.

Note:
A value of zero disables Eddystone-TLM frame transmissions.
Currently it is only possible to modify this value by using the setTLMFrameAdvertisingInterval() API.

Definition at line 188 of file EddystoneService.h.

uint8_t tlmVersion

The configured version of the Eddystone-TLM frames.

Definition at line 192 of file EddystoneService.h.

uint8_t txPowerMode

The value of the Eddystone-URL Configuration Service TX Power Mode characteristic.

This value is an index into the EddystoneParams_t::advPowerLevels array.

Definition at line 160 of file EddystoneService.h.

uint16_t uidFramePeriod

The configured interval (in milliseconds) of the Eddystone-UID frames.

Note:
A value of zero disables Eddystone-UID frame transmissions.
Currently it is only possible to modify this value by using the setUIDFrameAdvertisingInterval() API.

Definition at line 178 of file EddystoneService.h.

UIDInstanceID_t uidInstanceID

The configured 6-byte instance ID that may be used to uniquely identify individual devices in a group.

Definition at line 214 of file EddystoneService.h.

UIDNamespaceID_t uidNamespaceID

The configured 10-byte namespace ID in Eddystone-UID frames that may be used to group a particular set of beacons.

Definition at line 209 of file EddystoneService.h.

Lock_t unlock

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 140 of file EddystoneService.h.

UrlData_t urlData

The value of the Eddystone-URL Configuration Service URI Data characteristic that contains an encoded URL as described in the Eddystone Specification at https://github.com/google/eddystone/blob/master/eddystone-url/README.md#eddystone-url-http-url-encoding.

Definition at line 204 of file EddystoneService.h.

uint8_t urlDataLength

The length of the encoded URL in EddystoneParams_t::urlData used within Eddystone-URL frames.

Definition at line 197 of file EddystoneService.h.

uint16_t urlFramePeriod

The value of the Eddystone-URL Configuration Service Beacon Period characteristic that is the interval (in milliseconds) of the Eddystone-URL frames.

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

Definition at line 168 of file EddystoneService.h.

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