Bluetooth Low Energy Stack Abstraction Data Structures Type Documentation

 

GAPM_ActivityStatus_t

 

Location: ble_gap.h:137

 

GAPM activity status.

 

Data Fields

Type Name Description

uint8_t

actv_idx

Activity identifier.

enum gapm_actv_type

type

GAPM activity type.

enum gapm_activity_state

state

GAPM activity state.

bool

advDataSet

True if advertisement data is set.

bool

scanRspDataSet

True if scan response data is set.

 

GAP_Env_t

 

Location: ble_gap.h:149

 

GAP environment.

 

Data Fields

Type Name Description

enum gapm_state

gapmState

State of GAPM.

uint16_t

profileAddedCount

of standard BLE profile added

struct gapm_set_dev_config_cmd

deviceConfig

Device configuration for GAPM_SET_DEV_CONFIG.

struct gapc_connection_req_ind

connection[APP_MAX_NB_CON]

GAPC_CONNECTION_REQ_IND information of connections.

BondInfo_t

bondInfo[APP_MAX_NB_CON]

Bond information of connections.

GAPM_ActivityStatus_t *

actv[APP_MAX_NB_ACTIVITY]

GAPM activity status of activities.

uint16_t

profileAddedTaskId[APP_MAX_NB_PROFILES]

Task IDs for added profiles.

 

att_db_desc

 

Location: ble_gatt.h:151

 

Custom service attribute database description.

 

Data Fields

Type Name Description

uint16_t

att_idx

Convert into uint8_t.

struct gattm_att_desc

att

GATTM Attribute description structure.

bool

is_service

True if it is service.

uint16_t

length

Total number of characteristics to add.

void *

data

Pointer to data.

uint8_t(*

callback)(uint8_t conidx, uint16_t attidx, uint16_t handle, uint8_t *toData, const uint8_t *fromData, uint16_t lenData, uint16_t operation, uint8_t hl_status, uint8_t *cfm_msg_instr)

Pointer to callback function.

 

cust_svc_desc

 

Location: ble_gatt.h:170

 

Custom service descriptor.

 

Data Fields

Type Name Description

uint16_t

cust_svc_start_hdl

Start handle array of custom services in the stack's attribute database.

const struct att_db_desc *

cust_svc_att_db

Custom services attribute database.

uint16_t

cust_svc_att_db_len

Custom service attribute database length.

 

GATT_Env_t

 

Location: ble_gatt.h:181

 

GATT environment.

 

Data Fields

Type Name Description

uint16_t

addedSvcCount

Counter of successfully added custom service/s in stack.

uint16_t *

discSvcCount

Counter of discovered service/s per connection id.

cust_svc_desc *

cust_svc_db

Custom service database array.

uint16_t

max_cust_svc

Maximum number of custom services.

const struct att_db_desc *

att_db

Attribute database specific to related custom service.

uint16_t

att_db_len

Length of attribute database specific to related custom service.

 

low_power_clock

 

Location: ble_protocol_support.h:46

 

Application defined low power clocks and sources.

 

Data Fields

Type Name Description

uint8_t

low_pwr_clk_xtal32

Value of LPCLK_SRC_XTAL32 from application.

uint8_t

low_pwr_clk_rc32

Value of LPCLK_SRC_RC32 from application.

uint8_t

low_pwr_standby_clk_src

Value of LPCLK_STANDBYCLK_SRC from application.

 

ble_device_parameter

 

Location: ble_protocol_support.h:56

 

Application defined BLE device parameters used by BLE stack.

 

Data Fields

Type Name Description

uint32_t

low_pwr_clk_accuracy

Low power clock accuracy in ppm.

uint32_t

twosc

TWOSC us.

uint32_t

rf_tx_power_dbm

The default TX power in dbm.

struct low_power_clock

low_pwr_clk

Low power clock selection.

 

BASC_Env_t

 

Location: ble_basc.h:36

 

Battery service client environment.

 

Data Fields

Type Name Description

struct gapm_profile_added_ind

profile_added_ind

Profile service handle.

uint32_t

battLevelReqTimeout

Timeout for periodic battery level request.

uint8_t

bas_nb[APP_MAX_NB_CON]

Number of battery instances [1,BASC_NB_BAS_INSTANCES_MAX].

bool

enabled[APP_MAX_NB_CON]

The flag that indicates that service has been enabled.

uint8_t

batt_lvl[APP_MAX_NB_CON][BASC_NB_BAS_INSTANCES_MAX]

Battery level characteristic value.

uint8_t

ntf_cfg[APP_MAX_NB_CON][BASC_NB_BAS_INSTANCES_MAX]

Notification configuration.

uint8_t

req_ntf_cfg[APP_MAX_NB_CON][BASC_NB_BAS_INSTANCES_MAX]

Control notification is required or not.

struct prf_char_pres_fmt

char_pres_format[APP_MAX_NB_CON][BASC_NB_BAS_INSTANCES_MAX]

Battery level characteristic presentation format descriptor value structure

struct bas_content

bas[APP_MAX_NB_CON][BASC_NB_BAS_INSTANCES_MAX]

Battery service content structure.

 

BASS_Env_t

 

Location: ble_bass.h:37

 

Battery service server environment.

 

Data Fields

Type Name Description

uint8_t

bas_nb

Number of battery instances [1,BASS_NB_BAS_INSTANCES_MAX].

uint8_t

batt_ntf_cfg[APP_MAX_NB_CON]

The current value of CCCD of battery value that has been set by the client device.

bool

enabled[APP_MAX_NB_CON]

The flag that indicates that service has been enabled.

uint32_t

battLevelNotificationTimeout

Timeout value for sending batter level notification.

bool

battLevelNotificationTimerEnqueued

Flag that tells whether the timer for battery level notification is enabled or not.

uint32_t

battLevelMonitoringTimeout

Timeout value for battery level monitoring.

bool

battLevelMonitoringTimerEnqueued

Flag that tells whether the timer for monitoring battery level is enabled or not.

uint8_t

lastBattLevel[BASS_NB_BAS_INSTANCES_MAX]

Most recent value of battery level.

uint8_t(*

readBattLevelCallback)(uint8_t bas_nb)

Pointer to an application function that returns the battery level.

struct gapm_profile_added_ind

profile_added_ind

Profile service handle.

 

DISS_DeviceInfoField_t

 

Location: ble_diss.h:37

 

Global DISS specific info structure.

 

Data Fields

Type Name Description

uint8_t

len

Length of data.

uint8_t *

data

Pointer to data.

 

DISS_DeviceInfo_t

 

Location: ble_diss.h:46

 

Global DISS info compilation structure.

 

Data Fields

Type Name Description

struct DISS_DeviceInfoField_t

MANUFACTURER_NAME

Manufacturer name characteristic.

struct DISS_DeviceInfoField_t

MODEL_NB_STR

Model number string characteristic.

struct DISS_DeviceInfoField_t

SERIAL_NB_STR

Serial number string characteristic.

struct DISS_DeviceInfoField_t

FIRM_REV_STR

Firmware revision string characteristic.

struct DISS_DeviceInfoField_t

SYSTEM_ID

System ID characteristic.

struct DISS_DeviceInfoField_t

HARD_REV_STR

Hardware revision string characteristic.

struct DISS_DeviceInfoField_t

SW_REV_STR

Software revision string characteristic.

struct DISS_DeviceInfoField_t

IEEE

IEEE 11073-20601 regulatory certification data characteristic.

struct DISS_DeviceInfoField_t

PNP

PnP ID characteristic.

 

DISS_Env_t

 

Location: ble_diss.h:63

 

DISS state structure.

 

Data Fields

Type Name Description

uint16_t

features

DISS features that will be enabled.

See diss_task.h for reference

bool

serviceAdded

The flag that indicates that service has been added.

const struct DISS_DeviceInfo_t *

deviceInfo

DISS device information compilation structure arm.