Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Public Member Functions | Static Public Attributes
URIBeaconConfigService Class Reference

UriBeacon Configuration Service. More...

#include <URIBeaconConfigService.h>

Data Structures

struct  Params_t
 

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. More...
 
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.

You can use this to set URL, adjust power levels and set flags. See http://uribeacon.org

Deprecated:
This service is deprecated, and no replacement is currently available.

Definition at line 55 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.
Deprecated:
This service is deprecated, and no replacement is currently available.

Definition at line 107 of file URIBeaconConfigService.h.

Field Documentation

const unsigned NUM_POWER_MODES = 4
static

Number of power modes defined.

Definition at line 64 of file URIBeaconConfigService.h.

const uint8_t TX_POWER_MODE_HIGH = 3
static

High TX power mode.

Definition at line 63 of file URIBeaconConfigService.h.

const uint8_t TX_POWER_MODE_LOW = 1
static

Low TX power mode.

Definition at line 61 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 60 of file URIBeaconConfigService.h.

const uint8_t TX_POWER_MODE_MEDIUM = 2
static

Medium TX power mode.

Definition at line 62 of file URIBeaconConfigService.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.