Cordio Stack and Cordio Profiles  r2p3-02rel0
Uribeacon Configuration Profile

Macros

#define URICFG_UUID_BYTES(id)
 UriBeacon configuration service-related UUIDs. More...
 
#define URICFG_SERVICE_UUID   0xFED8
 UriBeacon service UUID for advertising data.
 

Typedefs

typedef void(* uriCfgAttWriteCback_t) (uint16_t handle, uint16_t valueLen, const uint8_t *pValue)
 Attribute write callback. More...
 
typedef void(* uriCfgLockChangeCback_t) (uint8_t lockState, const uint8_t *pLock)
 Lock change callback. More...
 

Enumerations

enum  {
  URICFG_UUID_SVC = 0x2080,
  URICFG_UUID_CHR_LOCKSTATE = 0x2081,
  URICFG_UUID_CHR_LOCK = 0x2082,
  URICFG_UUID_CHR_UNLOCK = 0x2083,
  URICFG_UUID_CHR_URIDATA = 0x2084,
  URICFG_UUID_CHR_URIFLAGS = 0x2085,
  URICFG_UUID_CHR_TXPWRLEVELS = 0x2086,
  URICFG_UUID_CHR_TXPWRMODE = 0x2087,
  URICFG_UUID_CHR_BEACONPERIOD = 0x2088,
  URICFG_UUID_CHR_RESET = 0x2089
}
 UriBeacon configuration service-related UUIDs.
 
enum  {
  URICFG_ATT_TXPWRMODE_LOWEST = 0,
  URICFG_ATT_TXPWRMODE_LOW = 1,
  URICFG_ATT_TXPWRMODE_MEDIUM = 2,
  URICFG_ATT_TXPWRMODE_HIGH = 3
}
 Transmit power modes.
 

Functions

void UriCfgStart (const uint8_t *pUriData, uint8_t uriDataLen, uint8_t uriFlags, int8_t *pAdvTxPwrLevels, uint8_t txPwrMode, uint16_t beaconPeriod)
 Start UriBeacon configuration service. More...
 
void UriCfgStop (void)
 Stop UriBeacon configuration service. More...
 
void UriCfgAttWriteCbackRegister (uriCfgAttWriteCback_t cback)
 Register callback for written UriBeacon attributes. More...
 
void UriCfgMakeLockable (uint8_t lockState, uint8_t *pLock, uriCfgLockChangeCback_t cback)
 Make UriBeacon lockable. More...
 
void UriCfgSetUriDataResetValue (const uint8_t *pUriData)
 Set reset value of URI data. More...
 

URI Config Attributes Sizes

#define URICFG_MAXSIZE_URIDATA_ATT   18
 Size of URI data attribute.
 
#define URICFG_SIZE_TXPWRLEVELS_ATT   4
 Size of transmit power levels attribute.
 
#define URICFG_SIZE_LOCK_ATT   16
 Size of lock attribute.
 

Beacon period Attribute Values

#define URICFG_ATT_BEACONPERIOD_MIN   20
 Minimum period.
 
#define URICFG_ATT_BEACONPERIOD_MAX   10240
 Maximum period.
 
#define URICFG_ATT_BEACONPERIOD_DISABLE   0
 Value to disable beacon.
 

Default (Reset) Values of Attributes

#define URICFG_ATT_URIFLAGS_DEFAULT   0x00
 Default URI flags.
 
#define URICFG_ATT_TXPWRMODE_DEFAULT   URICFG_ATT_TXPWRMODE_LOW
 Default TX power mode.
 
#define URICFG_ATT_BEACONPERIOD_DEFAULT   1000
 Default beacon period in milliseconds (1 second)
 
#define URICFG_ATT_LOCK_DEFAULT_BYTES
 Default lock bytes. More...
 

Description

Macro Definition Documentation

#define URICFG_UUID_BYTES (   id)
Value:
0xd8, 0x81, 0xc9, 0x1a, 0xb9, 0x99, \
0x96, 0xab, \
0xba, 0x40, \
0x86, 0x87, \
(id & 0xFF), ((id >> 8) & 0xFF), 0x0c, 0xee

UriBeacon configuration service-related UUIDs.

Definition at line 35 of file uricfg_defs.h.

#define URICFG_ATT_LOCK_DEFAULT_BYTES
Value:
0x00, 0x00, 0x00, 0x00, \
0x00, 0x00, \
0x00, 0x00, \
0x00, 0x00, \
0x00, 0x00, 0x00, 0x00, 0x00, 0x00

Default lock bytes.

Definition at line 90 of file uricfg_defs.h.

Typedef Documentation

typedef void(* uriCfgAttWriteCback_t) (uint16_t handle, uint16_t valueLen, const uint8_t *pValue)

Attribute write callback.

Parameters
handleAttribute handle.
valueLenLength of value data.
pValuePointer to value data.
Returns
None.

Definition at line 50 of file uricfg_api.h.

typedef void(* uriCfgLockChangeCback_t) (uint8_t lockState, const uint8_t *pLock)

Lock change callback.

Parameters
lockStateNew lock state.
lockLock value.
Returns
None.

Definition at line 62 of file uricfg_api.h.

Function Documentation

void UriCfgStart ( const uint8_t pUriData,
uint8_t  uriDataLen,
uint8_t  uriFlags,
int8_t pAdvTxPwrLevels,
uint8_t  txPwrMode,
uint16_t  beaconPeriod 
)

Start UriBeacon configuration service.

Parameters
pUriDataInitial URI data value
uriDataLenLength of URI data value
uriFlagsInitial URI flags value
pAdvTxPwrLevelsInitial advertised tx power levels value
txPwrModeInitial tx power mode value
beaconPeriodInitial beacon period value
Returns
None.
void UriCfgStop ( void  )

Stop UriBeacon configuration service.

Returns
None.
void UriCfgAttWriteCbackRegister ( uriCfgAttWriteCback_t  cback)

Register callback for written UriBeacon attributes.

Parameters
cbackCallback to invoke when an attribute changes.
Returns
None.
void UriCfgMakeLockable ( uint8_t  lockState,
uint8_t pLock,
uriCfgLockChangeCback_t  cback 
)

Make UriBeacon lockable.

Parameters
lockStateInitial lock state value.
pLockInitial lock value.
cbackCallback to invoke when lock changes.
Returns
None.
void UriCfgSetUriDataResetValue ( const uint8_t pUriData)

Set reset value of URI data.

Parameters
pUriDataReset value of URI data.
Returns
None.