BLE-Stack APIs  3.00.00
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Enumerations | Functions
peripheral.h File Reference

Detailed Description

Peripheral layer interface.

Go to the source code of this file.

Data Structures

struct  gapRolesCBs_t
 Peripheral GAPRole Callback structure. More...
 

Macros

#define GAPROLE_ADV_CHANNEL_MAP   0x30C
 Which channels to advertise on (Read/Write) More...
 
#define GAPROLE_ADV_DIRECT_ADDR   0x30B
 Direct Advertisement Address (Read/Write) More...
 
#define GAPROLE_ADV_DIRECT_TYPE   0x30A
 Direct Advertisement Type (Read/Write) More...
 
#define GAPROLE_ADV_EVENT_TYPE   0x309
 Advertisement Types (Read/Write) More...
 
#define GAPROLE_ADV_FILTER_POLICY   0x30D
 Policy for filtering advertisements (Read/Write) More...
 
#define GAPROLE_ADV_NONCONN_ENABLED   0x31B
 Enable / Disable non-connectable advertising (Read/Write) More...
 
#define GAPROLE_ADVERT_DATA   0x307
 Advertisement data (Read/Write) More...
 
#define GAPROLE_ADVERT_ENABLED   0x305
 Enable/Disable Connectable Advertising (Read/Write) More...
 
#define GAPROLE_ADVERT_OFF_TIME   0x306
 How long to remain off (in sec) after advertising stops before starting again (Read/Write) More...
 
#define GAPROLE_BD_ADDR   0x304
 Device Address read from the controller (Read-only) More...
 
#define GAPROLE_BD_ADDR_TYPE   0x31C
 Address type of connected device (Read-only) More...
 
#define GAPROLE_CONN_BD_ADDR   0x315
 Address of connected device (Read-only) More...
 
#define GAPROLE_CONN_INTERVAL   0x316
 Connection Interval (n x 1.25 ms) of current connection (Read-only) More...
 
#define GAPROLE_CONN_LATENCY   0x317
 Slave Latency of current connection (Read-only) More...
 
#define GAPROLE_CONN_TERM_REASON   0x31D
 Reason of the last connection terminated event. More...
 
#define GAPROLE_CONN_TIMEOUT   0x318
 Connection Interval (n x 10 ms) of current connection (Read-only) More...
 
#define GAPROLE_CONNHANDLE   0x30E
 Connection Handle of current connected device (Read-only) More...
 
#define GAPROLE_IRK   0x301
 Identity Resolving Key (Read/Write) Size is uint8_t[KEYLEN]. More...
 
#define GAPROLE_LINK_PARAM_UPDATE_INITIATE_APP_PARAMS   2
 Initiate parameter update request, respond with local requested parameters only.
 
#define GAPROLE_LINK_PARAM_UPDATE_INITIATE_BOTH_PARAMS   1
 Initiate parameter update request, respond with best combination of local and remote parameters.
 
#define GAPROLE_LINK_PARAM_UPDATE_NUM_OPTIONS   6
 Used for parameter checking.
 
#define GAPROLE_LINK_PARAM_UPDATE_REJECT_REQUEST   5
 Reject all parameter update requests.
 
#define GAPROLE_LINK_PARAM_UPDATE_WAIT_APP_PARAMS   3
 Wait for parameter update request, respond with local requested parameters only.
 
#define GAPROLE_LINK_PARAM_UPDATE_WAIT_BOTH_PARAMS   4
 Wait for parameter update request, respond with best combination of local and remote parameters.
 
#define GAPROLE_LINK_PARAM_UPDATE_WAIT_REMOTE_PARAMS   0
 Wait for parameter update request, respond with remote's requested parameters.
 
#define GAPROLE_MAX_CONN_INTERVAL   0x312
 Maximum connection interval (n * 1.25 ms) to use when performing param update (Read/Write) More...
 
#define GAPROLE_MIN_CONN_INTERVAL   0x311
 Minimum connection interval (n * 1.25 ms) to use when performing param update (Read/Write) More...
 
#define GAPROLE_NO_ACTION   0
 Take no action upon unsuccessful parameter updates.
 
#define GAPROLE_PARAM_UPDATE_ENABLE   0x310
 Whether to request a connection parameter update upon connection (Read/Write) More...
 
#define GAPROLE_PARAM_UPDATE_REQ   0x319
 Used to send a Parameter Update Request (Write-only) More...
 
#define GAPROLE_PROFILEROLE   0x300
 This parameter will return GAP Role type (Read-only) More...
 
#define GAPROLE_RESEND_PARAM_UPDATE   1
 Continue to resend request until successful update.
 
#define GAPROLE_SCAN_RSP_DATA   0x308
 Scan Response Data (Read/Write) More...
 
#define GAPROLE_SIGNCOUNTER   0x303
 Sign Counter (Read/Write) More...
 
#define GAPROLE_SLAVE_LATENCY   0x313
 Slave latency to use when performing param update (Read/Write) More...
 
#define GAPROLE_SRK   0x302
 Signature Resolving Key (Read/Write) More...
 
#define GAPROLE_STATE   0x31A
 Current Peripheral GAPRole state (Read-only) More...
 
#define GAPROLE_TERMINATE_LINK   2
 Terminate link upon unsuccessful parameter updates.
 
#define GAPROLE_TIMEOUT_MULTIPLIER   0x314
 Supervision timeout (n x 10 ms) to use when performing param update (Read/Write) More...
 

Typedefs

typedef void(* gapRolesParamUpdateCB_t )(uint16_t connInterval, uint16_t connSlaveLatency, uint16_t connTimeout)
 
typedef void(* gapRolesStateNotify_t )(gaprole_States_t newState)
 State Change Callback Type. More...
 

Enumerations

enum  gaprole_States_t {
  GAPROLE_INIT = 0, GAPROLE_STARTED, GAPROLE_ADVERTISING, GAPROLE_ADVERTISING_NONCONN,
  GAPROLE_WAITING, GAPROLE_WAITING_AFTER_TIMEOUT, GAPROLE_CONNECTED, GAPROLE_CONNECTED_ADV,
  GAPROLE_ERROR
}
 GAP Peripheral Role States. More...
 

Functions

bStatus_t GAPRole_GetParameter (uint16_t param, void *pValue)
 Get a GAP Role parameter. More...
 
void GAPRole_RegisterAppCBs (gapRolesParamUpdateCB_t *pParamUpdateCB)
 Register application's callbacks. More...
 
bStatus_t GAPRole_SendUpdateParam (uint16_t minConnInterval, uint16_t maxConnInterval, uint16_t latency, uint16_t connTimeout, uint8_t handleFailure)
 Update the parameters of an existing connection. More...
 
bStatus_t GAPRole_SetParameter (uint16_t param, uint8_t len, void *pValue)
 Set a GAP Role parameter. More...
 
bStatus_t GAPRole_StartDevice (gapRolesCBs_t *pAppCallbacks)
 Initialize the GAP layer. More...
 
bStatus_t GAPRole_TerminateConnection (void)
 Terminates the existing connection. More...
 
Copyright 2016, Texas Instruments Incorporated