BA / Mbed OS BaBoRo1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

URIBeaconConfigService Class Reference
Public Member Functions | Static Public Attributes

URIBeaconConfigService Class Reference

UriBeacon Configuration Service. More...

#include <URIBeaconConfigService.h>

Public Member Functions

 URIBeaconConfigService (BLE &bleIn, Params_t &paramsIn, bool resetToDefaultsFlag, const char *defaultURIDataIn, PowerLevels_t &defaultAdvPowerLevelsIn)

Static Public Attributes

static const uint8_t TX_POWER_MODE_LOWEST = 0
 Transmission power modes for UriBeacon.
static const uint8_t TX_POWER_MODE_LOW = 1
static const uint8_t TX_POWER_MODE_MEDIUM = 2
static const uint8_t TX_POWER_MODE_HIGH = 3
static const unsigned NUM_POWER_MODES = 4

Detailed Description

UriBeacon Configuration Service.

Can be used to set URL, adjust power levels, and set flags. See http://uribeacon.org

Definition at line 47 of file URIBeaconConfigService.h.

Constructor & Destructor Documentation

URIBeaconConfigService ( BLE &  bleIn,
Params_t &  paramsIn,
bool  resetToDefaultsFlag,
const char *  defaultURIDataIn,
PowerLevels_t &  defaultAdvPowerLevelsIn 
)
Parameters:
[in]bleInBLE object for the underlying controller.
[in,out]paramsInReference to application-visible beacon state, loaded from persistent storage at startup.
[in]resetToDefaultsFlagApplies to the state of the 'paramsIn' parameter. If true, it indicates that paramsIn is potentially un-initialized, and default values should be used instead. Otherwise, paramsIn overrides the defaults.
[in]defaultURIDataInDefault un-encoded URI. Applies only if the resetToDefaultsFlag is true.
[in]defaultAdvPowerLevelsInDefault power-levels array. Applies only if the resetToDefaultsFlag is true.

Definition at line 93 of file URIBeaconConfigService.h.

Field Documentation

const unsigned NUM_POWER_MODES = 4 [static]

Number of power modes defined.

Definition at line 56 of file URIBeaconConfigService.h.

const uint8_t TX_POWER_MODE_HIGH = 3 [static]

High TX power mode.

Definition at line 55 of file URIBeaconConfigService.h.

const uint8_t TX_POWER_MODE_LOW = 1 [static]

Low TX power mode.

Definition at line 53 of file URIBeaconConfigService.h.

const uint8_t TX_POWER_MODE_LOWEST = 0 [static]

Transmission power modes for UriBeacon.

Lowest TX power mode.

Definition at line 52 of file URIBeaconConfigService.h.

const uint8_t TX_POWER_MODE_MEDIUM = 2 [static]

Medium TX power mode.

Definition at line 54 of file URIBeaconConfigService.h.

Generated on Tue Jul 12 2022 12:22:51 by  doxygen 1.7.2