Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Event Code

Detailed Description

Enumerations

enum  e_ble_gap_evt_t {
  BLE_GAP_EVENT_INVALID = 0x1001,
  BLE_GAP_EVENT_STACK_ON,
  BLE_GAP_EVENT_STACK_OFF,
  BLE_GAP_EVENT_LOC_VER_INFO,
  BLE_GAP_EVENT_HW_ERR,
  BLE_GAP_EVENT_CMD_ERR = 0x1101,
  BLE_GAP_EVENT_ADV_REPT_IND,
  BLE_GAP_EVENT_ADV_PARAM_SET_COMP,
  BLE_GAP_EVENT_ADV_DATA_UPD_COMP,
  BLE_GAP_EVENT_ADV_ON,
  BLE_GAP_EVENT_ADV_OFF,
  BLE_GAP_EVENT_PERD_ADV_PARAM_SET_COMP,
  BLE_GAP_EVENT_PERD_ADV_ON,
  BLE_GAP_EVENT_PERD_ADV_OFF,
  BLE_GAP_EVENT_ADV_SET_REMOVE_COMP,
  BLE_GAP_EVENT_SCAN_ON,
  BLE_GAP_EVENT_SCAN_OFF,
  BLE_GAP_EVENT_SCAN_TO,
  BLE_GAP_EVENT_CREATE_CONN_COMP,
  BLE_GAP_EVENT_CONN_IND,
  BLE_GAP_EVENT_DISCONN_IND,
  BLE_GAP_EVENT_CONN_CANCEL_COMP,
  BLE_GAP_EVENT_WHITE_LIST_CONF_COMP,
  BLE_GAP_EVENT_RAND_ADDR_SET_COMP,
  BLE_GAP_EVENT_CH_MAP_RD_COMP,
  BLE_GAP_EVENT_CH_MAP_SET_COMP,
  BLE_GAP_EVENT_RSSI_RD_COMP,
  BLE_GAP_EVENT_GET_REM_DEV_INFO,
  BLE_GAP_EVENT_CONN_PARAM_UPD_COMP,
  BLE_GAP_EVENT_CONN_PARAM_UPD_REQ,
  BLE_GAP_EVENT_AUTH_PL_TO_EXPIRED,
  BLE_GAP_EVENT_SET_DATA_LEN_COMP,
  BLE_GAP_EVENT_DATA_LEN_CHG,
  BLE_GAP_EVENT_RSLV_LIST_CONF_COMP,
  BLE_GAP_EVENT_RPA_EN_COMP,
  BLE_GAP_EVENT_SET_RPA_TO_COMP,
  BLE_GAP_EVENT_RD_RPA_COMP,
  BLE_GAP_EVENT_PHY_UPD,
  BLE_GAP_EVENT_PHY_SET_COMP,
  BLE_GAP_EVENT_DEF_PHY_SET_COMP,
  BLE_GAP_EVENT_PHY_RD_COMP,
  BLE_GAP_EVENT_SCAN_REQ_RECV,
  BLE_GAP_EVENT_CREATE_SYNC_COMP,
  BLE_GAP_EVENT_SYNC_EST,
  BLE_GAP_EVENT_SYNC_TERM,
  BLE_GAP_EVENT_SYNC_LOST,
  BLE_GAP_EVENT_SYNC_CREATE_CANCEL_COMP,
  BLE_GAP_EVENT_PERD_LIST_CONF_COMP,
  BLE_GAP_EVENT_PRIV_MODE_SET_COMP,
  BLE_GAP_EVENT_PAIRING_REQ = 0x1401,
  BLE_GAP_EVENT_PASSKEY_ENTRY_REQ,
  BLE_GAP_EVENT_PASSKEY_DISPLAY_REQ,
  BLE_GAP_EVENT_NUM_COMP_REQ,
  BLE_GAP_EVENT_KEY_PRESS_NTF,
  BLE_GAP_EVENT_PAIRING_COMP,
  BLE_GAP_EVENT_ENC_CHG,
  BLE_GAP_EVENT_PEER_KEY_INFO,
  BLE_GAP_EVENT_EX_KEY_REQ,
  BLE_GAP_EVENT_LTK_REQ,
  BLE_GAP_EVENT_LTK_RSP_COMP,
  BLE_GAP_EVENT_SC_OOB_CREATE_COMP
}
 GAP Event Identifier. More...
 

Enumeration Type Documentation

◆ e_ble_gap_evt_t

GAP Event Identifier.

Enumerator
BLE_GAP_EVENT_INVALID 

Description:

Invalid GAP Event.

Event Code: 0x1001

Event Data:

none

BLE_GAP_EVENT_STACK_ON 

Description:

When initializing host stack by R_BLE_GAP_Init() has been completed, BLE_GAP_EVENT_STACK_ON event is notified.

Event Code: 0x1002

result:

BLE_SUCCESS(0x0000) Success

Event Data:

none

BLE_GAP_EVENT_STACK_OFF 

Description:

When terminating host stack by R_BLE_GAP_Terminate() has been completed, BLE_GAP_EVENT_STACK_OFF event is notified.

Event Code: 0x1003

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_STATE(0x0008) When function was called, host stack has not yet been initialized.

Event Data:

none

BLE_GAP_EVENT_LOC_VER_INFO 

When version information of local device has been acquired by R_BLE_GAP_GetVerInfo(), BLE_GAP_EVENT_LOC_VER_INFO event is notified.

Event Code: 0x1004

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_loc_dev_info_evt_t

BLE_GAP_EVENT_HW_ERR 

When hardware error has been received from Controller, BLE_GAP_EVENT_HW_ERR event is notified.

Event Code: 0x1005

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_hw_err_evt_t

BLE_GAP_EVENT_CMD_ERR 

When the error of HCI Command has occurred after a R_BLE GAP API call, BLE_GAP_EVENT_CMD_ERR event is notified.

Event Code: 0x1101

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_cmd_err_evt_t

BLE_GAP_EVENT_ADV_REPT_IND 

When advertising PDUs has been received after scanning was started by R_BLE_GAP_StartScan().

Event Code: 0x1102

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_adv_rept_evt_t

BLE_GAP_EVENT_ADV_PARAM_SET_COMP 

Advertising parameters have been configured by R_BLE_GAP_SetAdvParam().

Event Code: 0x1103

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The advertising type that doesn't support advertising data/scan response data was specified to the advertising set which has already set advertising data/scan response data.
BLE_ERR_INVALID_OPERATION(0x0009) The reason for this error is as follows.
  • Advertising parameters were configured to the advertising set in advertising.
  • The sec_adv_phy field in adv_paran was not specified when Periodic Advertising was started.

Event Data:

st_ble_gap_adv_set_evt_t

BLE_GAP_EVENT_ADV_DATA_UPD_COMP 

This event notifies that Advertising Data/Scan Response Data/Periodic Advertising Data has been set to the advertising set by R_BLE_GAP_SetAdvSresData().

Event Code: 0x1104

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009) The reason for this error is as follows.
  • The advertising set that doesn't support advertising data/scan response data was set to the data.
  • The advertising set that supports legacy advertising was set to advertising data/scan response data larger than 31 bytes.
  • The advertising set that has advertising data/scan response data greater than or equal to 252 bytes was set the data in advertising.
  • The advertising set that has periodic advertising data greater than or equal to 253 bytes was set the data in advertising.
BLE_ERR_MEM_ALLOC_FAILED(0x000C) Length exceeded the length that the advertising set could be set.
BLE_ERR_INVALID_HDL(0x000E) The advertising set specified by R_BLE_GAP_SetAdvSresData() has not been created.

Event Data:

st_ble_gap_adv_data_evt_t

BLE_GAP_EVENT_ADV_ON 

When advertising has been started by R_BLE_GAP_StartAdv(), this event is notified to the application layer.

Event Code: 0x1105

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The reason for this error is as follows.
  • The advertising data length set to the advertising set for connectable extended advertising was invalid.
  • If o_addr_type field in adv_param used in R_BLE_GAP_SetAdvParam() is 0x03, the address which is set in o_addr field of adv_param has not been registered in Resolving List.
BLE_ERR_INVALID_OPERATION(0x0009) Setting of advertising data/scan response data has not been completed.
BLE_ERR_INVALID_HDL(0x000E) The advertising set specified by R_BLE_GAP_StartAdv() has not been created.
BLE_ERR_LIMIT_EXCEEDED(0x0010) When the maximum connections are established, a new connectable advertising tried starting.

Event Data:

st_ble_gap_adv_set_evt_t

BLE_GAP_EVENT_ADV_OFF 

This event notifies the application layer that advertising has stopped.

Event Code: 0x1106

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The advertising set specified by R_BLE_GAP_StopAdv() has not been created.

Event Data:

st_ble_gap_adv_off_evt_t

BLE_GAP_EVENT_PERD_ADV_PARAM_SET_COMP 

This event notifies the application layer that Periodic Advertising Parameters has been configured by R_BLE_GAP_SetPerdAdvParam().

Event Code: 0x1107

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The advertising set was the setting for anonymous advertising.
BLE_ERR_INVALID_OPERATION(0x0009) The advertising set was configured to the parameters in periodic advertising.
BLE_ERR_INVALID_HDL(0x000E) The advertising set specified by R_BLE_GAP_SetPerdAdvParam() has not been created.

Event Data:

st_ble_gap_adv_set_evt_t

BLE_GAP_EVENT_PERD_ADV_ON 

When Periodic Advertising has been started by R_BLE_GAP_StartPerdAdv(), this event is notified to the application layer.

Event Code: 0x1108

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009) The periodic advertising data set in the advertising set has not been completed.
BLE_ERR_INVALID_HDL(0x000E) The advertising set specified by R_BLE_GAP_StartPerdAdv() has not been created.

Event Data:

st_ble_gap_adv_set_evt_t

BLE_GAP_EVENT_PERD_ADV_OFF 

When Periodic Advertising has terminated by R_BLE_GAP_StopPerdAdv(), this event is notified to the application layer.

Event Code: 0x1109

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The advertising set specified by R_BLE_GAP_StopPerdAdv() has not been created.

Event Data:

st_ble_gap_adv_set_evt_t

BLE_GAP_EVENT_ADV_SET_REMOVE_COMP 

When the advertising set has been removed by R_BLE_GAP_RemoveAdvSet(), this event is notified to the application layer.

Event Code: 0x110A

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009) When the advertising set was in advertising, R_BLE_GAP_RemoveAdvSet() was called.
BLE_ERR_INVALID_HDL(0x000E) The advertising set specified by R_BLE_GAP_RemoveAdvSet() has not been created.

Event Data:

st_ble_gap_rem_adv_set_evt_t

BLE_GAP_EVENT_SCAN_ON 

When scanning has started by R_BLE_GAP_StartScan(), this event is notified to the application layer.

Event Code: 0x110B

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The reason for this error is as follows:
BLE_ERR_INVALID_OPERATION(0x0009) In scanning, R_BLE_GAP_StartScan() was called.

Event Data:

none

BLE_GAP_EVENT_SCAN_OFF 

When scanning has been stopped by R_BLE_GAP_StopScan(), this event is notified to the application layer.

Event Code: 0x110C

result:

BLE_SUCCESS(0x0000) Success

Event Data:

none

BLE_GAP_EVENT_SCAN_TO 

When the scan duration specified by R_BLE_GAP_StartScan() has expired, this event notifies scanning has stopped.

Event Code: 0x110D

result:

BLE_SUCCESS(0x0000) Success

Event Data:

none

BLE_GAP_EVENT_CREATE_CONN_COMP 

This event notifies a request for a connection has been sent to Controller.

Event Code: 0x110E

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The reason for this error is as follows:
  • Scan interval or scan windows specified by R_BLE_GAP_CreateConn() is invalid.
  • Although the own_addr_type field in p_param was set to 0x03, random address had not been registered in Resolving List.
BLE_ERR_INVALID_OPERATION(0x0009) R_BLE_GAP_CreateConn() was called while creating a link by previous R_BLE_GAP_CreateConn() call .
BLE_ERR_LIMIT_EXCEEDED(0x0010) When the maximum connections are established, R_BLE_GAP_CreateConn() was called.

Event Data:

none

BLE_GAP_EVENT_CONN_IND 

This event notifies a link has been established.

Event Code: 0x110F

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The request for a connection has been cancelled by R_BLE_GAP_CancelCreateConn().

Event Data:

st_ble_gap_conn_evt_t

BLE_GAP_EVENT_DISCONN_IND 

This event notifies a link has been disconnected.

Event Code: 0x1110

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_disconn_evt_t

BLE_GAP_EVENT_CONN_CANCEL_COMP 

This event notifies the request for a connection has been cancelled by R_BLE_GAP_CancelCreateConn().

Event Code: 0x1111

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009) When a request for a connection has not been sent to Controller, R_BLE_GAP_CancelCreateConn() was called.

Event Data:

none

BLE_GAP_EVENT_WHITE_LIST_CONF_COMP 

When White List has been configured, this event is notified to the application layer.

Event Code: 0x1112

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_STATE(0x0008) The add or delete operation was called, before the previous clear operation has been completed.
BLE_ERR_INVALID_OPERATION(0x0009) While doing advertising or scanning or creating a link with the White List, R_BLE_GAP_ConfWhiteList() was called.
BLE_ERR_MEM_ALLOC_FAILED(0x000C) White List has already registered the maximum number of devices.

Event Data:

st_ble_gap_white_list_conf_evt_t

BLE_GAP_EVENT_RAND_ADDR_SET_COMP 

This event notifies Controller has been set the random address by R_BLE_GAP_SetRandAddr().

Event Code: 0x1113

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009) When local device was in legacy advertising, R_BLE_GAP_SetRandAddr() was called.

Event Data:

none

BLE_GAP_EVENT_CH_MAP_RD_COMP 

This event notifies Channel Map has been acquired by R_BLE_GAP_ReadChMap().

Event Code: 0x1114

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The remote device specified by R_BLE_GAP_ReadChMap() was not found.

Event Data:

st_ble_gap_rd_ch_map_evt_t

BLE_GAP_EVENT_CH_MAP_SET_COMP 

This event notifies Channel Map has been configured by R_BLE_GAP_SetChMap().

Event Code: 0x1115

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The channel map specified by R_BLE_GAP_SetChMap() was all-zero.

Event Data:

none

BLE_GAP_EVENT_RSSI_RD_COMP 

This event notifies RSSI has been acquired by R_BLE_GAP_ReadRssi().

Event Code: 0x1116

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The remote device specified by R_BLE_GAP_ReadRssi() was not found.

Event Data:

st_ble_gap_rd_rssi_evt_t

BLE_GAP_EVENT_GET_REM_DEV_INFO 

This event notifies information about the remote device has been acquired by R_BLE_GAP_GetRemDevInfo().

Event Code: 0x1117

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_dev_info_evt_t

BLE_GAP_EVENT_CONN_PARAM_UPD_COMP 

This event notifies the connection parameters has been updated.

Event Code: 0x1118

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_DATA(0x0002) Local device rejected the request for updating connection parameters.
BLE_ERR_INVALID_ARG(0x0003) The remote device rejected the connection parameters suggested from local device.
BLE_ERR_UNSUPPORTED(0x0007) The remote device doesn't support connection parameters update feature.

Event Data:

st_ble_gap_conn_upd_evt_t

BLE_GAP_EVENT_CONN_PARAM_UPD_REQ 

This event notifies the request for connection parameters update has been received.

Event Code: 0x1119

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_conn_upd_req_evt_t

BLE_GAP_EVENT_AUTH_PL_TO_EXPIRED 

This event notifies Authenticated Payload Timeout has occurred.

Event Code: 0x111A

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_conn_hdl_evt_t

BLE_GAP_EVENT_SET_DATA_LEN_COMP 

This event notifies a request for updating packet data length and transmission timer has been sent to Controller.

Event Code: 0x111B

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The tx_octets or tx_time parameter specified by R_BLE_GAP_SetDataLen() is invalid.
BLE_ERR_UNSUPPORTED(0x0007) The remote device does not support updating packet data length and transmission time.
BLE_ERR_INVALID_HDL(0x000E) When R_BLE_GAP_SetDataLen() was called, the connection was not established.

Event Data:

st_ble_gap_conn_hdl_evt_t

BLE_GAP_EVENT_DATA_LEN_CHG 

This event notifies packet data length and transmission time have been updated.

Event Code: 0x111C

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_data_len_chg_evt_t

BLE_GAP_EVENT_RSLV_LIST_CONF_COMP 

When Resolving List has been configured by R_BLE_GAP_ConfRslvList(), this event is notified to the application layer.

Event Code: 0x111D

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_STATE(0x0008) The add or delete operation was called, before the previous clear operation has been completed.
BLE_ERR_INVALID_OPERATION(0x0009) While doing advertising or scanning or creating a link with resolvable private address, R_BLE_GAP_ConfRslvList() was called.
BLE_ERR_MEM_ALLOC_FAILED(0x000C) Resolving List has already registered the maximum number of devices.
BLE_ERR_INVALID_HDL(0x000E) The specified Identity Address was not found in Resolving List.

Event Data:

st_ble_gap_rslv_list_conf_evt_t

BLE_GAP_EVENT_RPA_EN_COMP 

When Resolvable Private Address function in Controller has been enabled by R_BLE_GAP_EnableRpa(), this event is notified to the application layer.

Event Code: 0x111E

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009) While advertising, scanning, or establishing a link with resolvable private address, R_BLE_GAP_EnableRpa() was called.

Event Data:

none

BLE_GAP_EVENT_SET_RPA_TO_COMP 

When Resolvable Private Address Timeout in Controller has been updated by R_BLE_GAP_SetRpaTo(), this event is notified to the application layer.

Event Code: 0x111F

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The rpa_timeout parameter specified by R_BLE_GAP_SetRpaTo() is out of range.

Event Data:

none

BLE_GAP_EVENT_RD_RPA_COMP 

When the resolvable private address of local device has been acquired by R_BLE_GAP_ReadRpa(), this event is notified to the application layer.

Event Code: 0x1120

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The identity address specified by R_BLE_GAP_ReadRpa() was not registered in Resolving List.

Event Data:

st_ble_gap_rd_rpa_evt_t

BLE_GAP_EVENT_PHY_UPD 

This event notifies the application layer that PHY for a connection has been updated.

Event Code: 0x1121

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_phy_upd_evt_t

BLE_GAP_EVENT_PHY_SET_COMP 

When Controller has received a request for updating PHY for a connection by R_BLE_GAP_SetPhy(), this event is notified to the application layer.

Event Code: 0x1122

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The remote device specified by R_BLE_GAP_SetPhy() was not found.

Event Data:

st_ble_gap_conn_hdl_evt_t

BLE_GAP_EVENT_DEF_PHY_SET_COMP 

When the PHY preferences which a remote device may change has been configured by R_BLE_GAP_SetDefPhy(), this event is notified to the application layer.

Event Code: 0x1123

result:

BLE_SUCCESS(0x0000) Success

Event Data:

none

BLE_GAP_EVENT_PHY_RD_COMP 

When the PHY settings has been acquired by R_BLE_GAP_ReadPhy(), this event is notified to the application layer.

Event Code: 0x1124

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The link specified by R_BLE_GAP_ReadPhy() was not found.

Event Data:

st_ble_gap_phy_rd_evt_t

BLE_GAP_EVENT_SCAN_REQ_RECV 

This event notifies the application layer that a Scan Request packet has been received from a Scanner.

Event Code: 0x1125

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_scan_req_recv_evt_t

BLE_GAP_EVENT_CREATE_SYNC_COMP 

This event notifies the application layer that Controller has received a request for a Periodic Sync establishment.

Event Code: 0x1126

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009)

When R_BLE_GAP_CreateSync() was called, this event for previous the API call has not been received.

BLE_ERR_ALREADY_IN_PROGRESS(0x000A) The advertising set specified by R_BLE_GAP_CreateSync() has already established a periodic sync.

Event Data:

none

BLE_GAP_EVENT_SYNC_EST 

This event notifies the application layer that a Periodic sync has been established.

Event Code: 0x1127

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_NOT_YET_READY(0x0012) The request for a Periodic Sync establishment was cancelled by R_BLE_GAP_CancelCreateSync().

Event Data:

st_ble_gap_sync_est_evt_t

BLE_GAP_EVENT_SYNC_TERM 

This event notifies the application layer that the Periodic Sync has been terminated by R_BLE_GAP_TerminateSync().

Event Code: 0x1128

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009) While establishing a Periodic Sync by R_BLE_GAP_CreateSync(), R_BLE_GAP_TerminateSync() was called.
BLE_ERR_INVALID_HDL(0x000E) The sync handle specified by R_BLE_GAP_TerminateSync() was not found.

Event Data:

st_ble_gap_sync_hdl_evt_t

BLE_GAP_EVENT_SYNC_LOST 

This event notifies the application layer that the Periodic Sync has been lost.

Event Code: 0x1129

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_sync_hdl_evt_t

BLE_GAP_EVENT_SYNC_CREATE_CANCEL_COMP 

This event notifies the request for a Periodic Sync establishment has been cancelled by R_BLE_GAP_CancelCreateSync().

Event Code: 0x112A

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_OPERATION(0x0009) When R_BLE_GAP_CancelCreateSync() was called, a request for a Periodic Sync establishment by R_BLE_GAP_CreateSync() has not been sent to Controller.

Event Data:

none

BLE_GAP_EVENT_PERD_LIST_CONF_COMP 

When Periodic Advertiser List has been configured by R_BLE_GAP_ConfPerdAdvList(), this event is notified to the application layer.

Event Code: 0x112B

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The advertiser has already been registered in Periodic Advertiser List.
BLE_ERR_INVALID_STATE(0x0008) The add or delete operation was called, before the previous clear operation has been completed.
BLE_ERR_INVALID_OPERATION(0x0009) When establishing a periodic sync by R_BLE_GAP_CreateSync(), R_BLE_GAP_ConfPerdAdvList() was called.
BLE_ERR_MEM_ALLOC_FAILED(0x000C) Periodic Advertiser List has already registered the maximum number of devices.
BLE_ERR_INVALID_HDL(0x000E) The device specified by R_BLE_GAP_ConfPerdAdvList() was not found.

Event Data:

st_ble_gap_perd_list_conf_evt_t

BLE_GAP_EVENT_PRIV_MODE_SET_COMP 

This event notifies the application layer that the Privacy Mode has been configured by R_BLE_GAP_SetPrivMode().

Event Code: 0x112B

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) Address type or privacy mode is out of range.
BLE_ERR_INVALID_OPERATION(0x0009) While advertising, scanning, or establishing a link with resolvable private address, R_BLE_GAP_SetPrivMode() was called.
BLE_ERR_INVALID_HDL(0x000E) The address specified by R_BLE_GAP_SetPrivMode() has not been registered in Resolving List.

Event Data:

none

BLE_GAP_EVENT_PAIRING_REQ 

This event notifies the application layer that a pairing request from a remote device has been received.

Event Code: 0x1401

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_pairing_info_evt_t

BLE_GAP_EVENT_PASSKEY_ENTRY_REQ 

This event notifies that a request for Passkey input in pairing has been received.

Event Code: 0x1402

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_conn_hdl_evt_t

BLE_GAP_EVENT_PASSKEY_DISPLAY_REQ 

This event notifies that a request for Passkey display in pairing has been received.

Event Code: 0x1403

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_passkey_display_evt_t

BLE_GAP_EVENT_NUM_COMP_REQ 

This event notifies that a request for Numeric Comparison in pairing has been received.

Event Code: 0x1404

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_num_comp_evt_t

BLE_GAP_EVENT_KEY_PRESS_NTF 

This event notifies the application layer that the remote device has input a key in Passkey Entry.

Event Code: 0x1405

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_key_press_ntf_evt_t

BLE_GAP_EVENT_PAIRING_COMP 

This event notifies the application layer that the pairing has completed.

Event Code: 0x1406

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_SMP_LE_PASSKEY_ENTRY_FAIL(0x2001) PassKey Entry is failed.
BLE_ERR_SMP_LE_OOB_DATA_NOT_AVAILABLE(0x2002) OOB Data is not available.
BLE_ERR_SMP_LE_AUTH_REQ_NOT_MET(0x2003) The requested pairing can not be performed because of IO Capability.
BLE_ERR_SMP_LE_CONFIRM_VAL_NOT_MATCH(0x2004) Confirmation value does not match.
BLE_ERR_SMP_LE_PAIRING_NOT_SPRT(0x2005) Pairing is not supported.
BLE_ERR_SMP_LE_INSUFFICIENT_ENC_KEY_SIZE(0x2006) Encryption Key Size is insufficient.
BLE_ERR_SMP_LE_CMD_NOT_SPRT(0x2007) The pairing command received is not supported.
BLE_ERR_SMP_LE_UNSPECIFIED_REASON(0x2008) Pairing failed with an unspecified reason.
BLE_ERR_SMP_LE_REPEATED_ATTEMPTS(0x2009) The number of repetition exceeded the upper limit.
BLE_ERR_SMP_LE_INVALID_PARAM(0x200A) Invalid parameter is set.
BLE_ERR_SMP_LE_DHKEY_CHECK_FAIL(0x200B) DHKey Check error.
BLE_ERR_SMP_LE_NUM_COMP_FAIL(0x200C) Numeric Comparison failure.
BLE_ERR_SMP_LE_DISCONNECTED(0x200F) Disconnection in pairing.
BLE_ERR_SMP_LE_TO(0x2011) Failure due to timeout.
BLE_ERR_SMP_LE_LOC_KEY_MISSING(0x2014) Pairing/Encryption failure because local device lost the LTK.

Event Data:

st_ble_gap_pairing_info_evt_t

BLE_GAP_EVENT_ENC_CHG 

This event notifies the application layer that the encryption status of a link has been changed.

Event Code: 0x1407

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_enc_chg_evt_t

BLE_GAP_EVENT_PEER_KEY_INFO 

This event notifies the application layer that the remote device has distributed the keys.

Event Code: 0x1408

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_peer_key_info_evt_t

BLE_GAP_EVENT_EX_KEY_REQ 

When local device has been received a request for key distribution to remote device, this event is notified to the application layer.

Event Code: 0x1409

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_conn_hdl_evt_t

BLE_GAP_EVENT_LTK_REQ 

When local device has been received a LTK request from a remote device, this event is notified to the application layer.

Event Code: 0x140A

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_ltk_req_evt_t

BLE_GAP_EVENT_LTK_RSP_COMP 

When local device has replied to the LTK request from the remote device, this event is notified to the application layer.

Event Code: 0x140B

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_ltk_rsp_evt_t

BLE_GAP_EVENT_SC_OOB_CREATE_COMP 

This event notifies OOB data for Secure Connections has been generated by R_BLE_GAP_CreateScOobData().

Event Code: 0x140C

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_gap_sc_oob_data_evt_t