Enumerations

S332 SoftDevice v6.1.1 API

Enumerations

enum BLE_GAP_SVCS {
SD_BLE_GAP_ADDR_SET = 0x6C,
SD_BLE_GAP_ADDR_GET = 0x6C + 1,
SD_BLE_GAP_WHITELIST_SET = 0x6C + 2,
SD_BLE_GAP_DEVICE_IDENTITIES_SET = 0x6C + 3,
SD_BLE_GAP_PRIVACY_SET = 0x6C + 4,
SD_BLE_GAP_PRIVACY_GET = 0x6C + 5,
SD_BLE_GAP_ADV_SET_CONFIGURE = 0x6C + 6,
SD_BLE_GAP_ADV_START = 0x6C + 7,
SD_BLE_GAP_ADV_STOP = 0x6C + 8,
SD_BLE_GAP_CONN_PARAM_UPDATE = 0x6C + 9,
SD_BLE_GAP_DISCONNECT = 0x6C + 10,
SD_BLE_GAP_TX_POWER_SET = 0x6C + 11,
SD_BLE_GAP_APPEARANCE_SET = 0x6C + 12,
SD_BLE_GAP_APPEARANCE_GET = 0x6C + 13,
SD_BLE_GAP_PPCP_SET = 0x6C + 14,
SD_BLE_GAP_PPCP_GET = 0x6C + 15,
SD_BLE_GAP_DEVICE_NAME_SET = 0x6C + 16,
SD_BLE_GAP_DEVICE_NAME_GET = 0x6C + 17,
SD_BLE_GAP_AUTHENTICATE = 0x6C + 18,
SD_BLE_GAP_SEC_PARAMS_REPLY = 0x6C + 19,
SD_BLE_GAP_AUTH_KEY_REPLY = 0x6C + 20,
SD_BLE_GAP_LESC_DHKEY_REPLY = 0x6C + 21,
SD_BLE_GAP_KEYPRESS_NOTIFY = 0x6C + 22,
SD_BLE_GAP_LESC_OOB_DATA_GET = 0x6C + 23,
SD_BLE_GAP_LESC_OOB_DATA_SET = 0x6C + 24,
SD_BLE_GAP_ENCRYPT = 0x6C + 25,
SD_BLE_GAP_SEC_INFO_REPLY = 0x6C + 26,
SD_BLE_GAP_CONN_SEC_GET = 0x6C + 27,
SD_BLE_GAP_RSSI_START = 0x6C + 28,
SD_BLE_GAP_RSSI_STOP = 0x6C + 29,
SD_BLE_GAP_SCAN_START = 0x6C + 30,
SD_BLE_GAP_SCAN_STOP = 0x6C + 31,
SD_BLE_GAP_CONNECT = 0x6C + 32,
SD_BLE_GAP_CONNECT_CANCEL = 0x6C + 33,
SD_BLE_GAP_RSSI_GET = 0x6C + 34,
SD_BLE_GAP_PHY_UPDATE = 0x6C + 35,
SD_BLE_GAP_DATA_LENGTH_UPDATE = 0x6C + 36,
SD_BLE_GAP_QOS_CHANNEL_SURVEY_START = 0x6C + 37,
SD_BLE_GAP_QOS_CHANNEL_SURVEY_STOP = 0x6C + 38,
SD_BLE_GAP_ADV_ADDR_GET = 0x6C + 39
}
GAP API SVC numbers. More...
enum BLE_GAP_EVTS {
BLE_GAP_EVT_CONNECTED = 0x10,
BLE_GAP_EVT_DISCONNECTED = 0x10 + 1,
BLE_GAP_EVT_CONN_PARAM_UPDATE = 0x10 + 2,
BLE_GAP_EVT_SEC_PARAMS_REQUEST = 0x10 + 3,
BLE_GAP_EVT_SEC_INFO_REQUEST = 0x10 + 4,
BLE_GAP_EVT_PASSKEY_DISPLAY = 0x10 + 5,
BLE_GAP_EVT_KEY_PRESSED = 0x10 + 6,
BLE_GAP_EVT_AUTH_KEY_REQUEST = 0x10 + 7,
BLE_GAP_EVT_LESC_DHKEY_REQUEST = 0x10 + 8,
BLE_GAP_EVT_AUTH_STATUS = 0x10 + 9,
BLE_GAP_EVT_CONN_SEC_UPDATE = 0x10 + 10,
BLE_GAP_EVT_TIMEOUT = 0x10 + 11,
BLE_GAP_EVT_RSSI_CHANGED = 0x10 + 12,
BLE_GAP_EVT_ADV_REPORT = 0x10 + 13,
BLE_GAP_EVT_SEC_REQUEST = 0x10 + 14,
BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST = 0x10 + 15,
BLE_GAP_EVT_SCAN_REQ_REPORT = 0x10 + 16,
BLE_GAP_EVT_PHY_UPDATE_REQUEST = 0x10 + 17,
BLE_GAP_EVT_PHY_UPDATE = 0x10 + 18,
BLE_GAP_EVT_DATA_LENGTH_UPDATE_REQUEST = 0x10 + 19,
BLE_GAP_EVT_DATA_LENGTH_UPDATE = 0x10 + 20,
BLE_GAP_EVT_QOS_CHANNEL_SURVEY_REPORT = 0x10 + 21,
BLE_GAP_EVT_ADV_SET_TERMINATED = 0x10 + 22
}
GAP Event IDs. IDs that uniquely identify an event coming from the stack to the application. More...
enum BLE_GAP_OPTS {
BLE_GAP_OPT_CH_MAP = 0x20,
BLE_GAP_OPT_LOCAL_CONN_LATENCY = 0x20 + 1,
BLE_GAP_OPT_PASSKEY = 0x20 + 2,
BLE_GAP_OPT_COMPAT_MODE_1 = 0x20 + 3,
BLE_GAP_OPT_AUTH_PAYLOAD_TIMEOUT = 0x20 + 4,
BLE_GAP_OPT_SLAVE_LATENCY_DISABLE = 0x20 + 5
}
GAP Option IDs. IDs that uniquely identify a GAP option. More...
enum BLE_GAP_CFGS {
BLE_GAP_CFG_ROLE_COUNT = 0x40,
BLE_GAP_CFG_DEVICE_NAME = 0x40 + 1
}
GAP Configuration IDs. More...
enum BLE_GAP_TX_POWER_ROLES {
BLE_GAP_TX_POWER_ROLE_ADV = 1,
BLE_GAP_TX_POWER_ROLE_SCAN_INIT = 2,
BLE_GAP_TX_POWER_ROLE_CONN = 3
}
GAP TX Power roles. More...

Detailed Description

Enumeration Type Documentation

GAP Configuration IDs.

IDs that uniquely identify a GAP configuration.

Enumerator
BLE_GAP_CFG_ROLE_COUNT

GAP BLE configuration base. Role count configuration.

BLE_GAP_CFG_DEVICE_NAME

GAP BLE configuration base. Device name configuration.

GAP Event IDs. IDs that uniquely identify an event coming from the stack to the application.

Enumerator
BLE_GAP_EVT_CONNECTED

GAP BLE Event base. Connected to peer.
See ble_gap_evt_connected_t

BLE_GAP_EVT_DISCONNECTED

GAP BLE Event base. Disconnected from peer.
See ble_gap_evt_disconnected_t .

BLE_GAP_EVT_CONN_PARAM_UPDATE

GAP BLE Event base. Connection Parameters updated.
See ble_gap_evt_conn_param_update_t .

BLE_GAP_EVT_SEC_PARAMS_REQUEST

GAP BLE Event base. Request to provide security parameters.
Reply with sd_ble_gap_sec_params_reply .
See ble_gap_evt_sec_params_request_t .

BLE_GAP_EVT_SEC_INFO_REQUEST

GAP BLE Event base. Request to provide security information.
Reply with sd_ble_gap_sec_info_reply .
See ble_gap_evt_sec_info_request_t .

BLE_GAP_EVT_PASSKEY_DISPLAY

GAP BLE Event base. Request to display a passkey to the user.
In LESC Numeric Comparison, reply with sd_ble_gap_auth_key_reply .
See ble_gap_evt_passkey_display_t .

BLE_GAP_EVT_KEY_PRESSED

GAP BLE Event base. Notification of a keypress on the remote device.
See ble_gap_evt_key_pressed_t

BLE_GAP_EVT_AUTH_KEY_REQUEST

GAP BLE Event base. Request to provide an authentication key.
Reply with sd_ble_gap_auth_key_reply .
See ble_gap_evt_auth_key_request_t .

BLE_GAP_EVT_LESC_DHKEY_REQUEST

GAP BLE Event base. Request to calculate an LE Secure Connections DHKey.
Reply with sd_ble_gap_lesc_dhkey_reply .
See ble_gap_evt_lesc_dhkey_request_t

BLE_GAP_EVT_AUTH_STATUS

GAP BLE Event base. Authentication procedure completed with status.
See ble_gap_evt_auth_status_t .

BLE_GAP_EVT_CONN_SEC_UPDATE

GAP BLE Event base. Connection security updated.
See ble_gap_evt_conn_sec_update_t .

BLE_GAP_EVT_TIMEOUT

GAP BLE Event base. Timeout expired.
See ble_gap_evt_timeout_t .

BLE_GAP_EVT_RSSI_CHANGED

GAP BLE Event base. RSSI report.
See ble_gap_evt_rssi_changed_t .

BLE_GAP_EVT_ADV_REPORT

GAP BLE Event base. Advertising report.
See ble_gap_evt_adv_report_t .

BLE_GAP_EVT_SEC_REQUEST

GAP BLE Event base. Security Request.
See ble_gap_evt_sec_request_t .

BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST

GAP BLE Event base. Connection Parameter Update Request.
Reply with sd_ble_gap_conn_param_update .
See ble_gap_evt_conn_param_update_request_t .

BLE_GAP_EVT_SCAN_REQ_REPORT

GAP BLE Event base. Scan request report.
See ble_gap_evt_scan_req_report_t .

BLE_GAP_EVT_PHY_UPDATE_REQUEST

GAP BLE Event base. PHY Update Request.
Reply with sd_ble_gap_phy_update .
See ble_gap_evt_phy_update_request_t .

BLE_GAP_EVT_PHY_UPDATE

GAP BLE Event base. PHY Update Procedure is complete.
See ble_gap_evt_phy_update_t .

BLE_GAP_EVT_DATA_LENGTH_UPDATE_REQUEST

GAP BLE Event base. Data Length Update Request.
Reply with sd_ble_gap_data_length_update .
See ble_gap_evt_data_length_update_request_t .

BLE_GAP_EVT_DATA_LENGTH_UPDATE

GAP BLE Event base. LL Data Channel PDU payload length updated.
See ble_gap_evt_data_length_update_t .

BLE_GAP_EVT_QOS_CHANNEL_SURVEY_REPORT

GAP BLE Event base. Channel survey report.
See ble_gap_evt_qos_channel_survey_report_t .

BLE_GAP_EVT_ADV_SET_TERMINATED

GAP BLE Event base. Advertising set terminated.
See ble_gap_evt_adv_set_terminated_t .

GAP Option IDs. IDs that uniquely identify a GAP option.

Enumerator
BLE_GAP_OPT_CH_MAP

GAP BLE Option base. Channel Map. ble_gap_opt_ch_map_t

BLE_GAP_OPT_LOCAL_CONN_LATENCY

GAP BLE Option base. Local connection latency. ble_gap_opt_local_conn_latency_t

BLE_GAP_OPT_PASSKEY

GAP BLE Option base. Set passkey. ble_gap_opt_passkey_t

BLE_GAP_OPT_COMPAT_MODE_1

GAP BLE Option base. Compatibility mode. ble_gap_opt_compat_mode_1_t

BLE_GAP_OPT_AUTH_PAYLOAD_TIMEOUT

GAP BLE Option base. Set Authenticated payload timeout. ble_gap_opt_auth_payload_timeout_t

BLE_GAP_OPT_SLAVE_LATENCY_DISABLE

GAP BLE Option base. Disable slave latency. ble_gap_opt_slave_latency_disable_t

GAP API SVC numbers.

Enumerator
SD_BLE_GAP_ADDR_SET

GAP BLE SVC base. Set own Bluetooth Address.

SD_BLE_GAP_ADDR_GET

GAP BLE SVC base. Get own Bluetooth Address.

SD_BLE_GAP_WHITELIST_SET

GAP BLE SVC base. Set active whitelist.

SD_BLE_GAP_DEVICE_IDENTITIES_SET

GAP BLE SVC base. Set device identity list.

SD_BLE_GAP_PRIVACY_SET

GAP BLE SVC base. Set Privacy settings

SD_BLE_GAP_PRIVACY_GET

GAP BLE SVC base. Get Privacy settings

SD_BLE_GAP_ADV_SET_CONFIGURE

GAP BLE SVC base. Configure an advertising set.

SD_BLE_GAP_ADV_START

GAP BLE SVC base. Start Advertising.

SD_BLE_GAP_ADV_STOP

GAP BLE SVC base. Stop Advertising.

SD_BLE_GAP_CONN_PARAM_UPDATE

GAP BLE SVC base. Connection Parameter Update.

SD_BLE_GAP_DISCONNECT

GAP BLE SVC base. Disconnect.

SD_BLE_GAP_TX_POWER_SET

GAP BLE SVC base. Set TX Power.

SD_BLE_GAP_APPEARANCE_SET

GAP BLE SVC base. Set Appearance.

SD_BLE_GAP_APPEARANCE_GET

GAP BLE SVC base. Get Appearance.

SD_BLE_GAP_PPCP_SET

GAP BLE SVC base. Set PPCP.

SD_BLE_GAP_PPCP_GET

GAP BLE SVC base. Get PPCP.

SD_BLE_GAP_DEVICE_NAME_SET

GAP BLE SVC base. Set Device Name.

SD_BLE_GAP_DEVICE_NAME_GET

GAP BLE SVC base. Get Device Name.

SD_BLE_GAP_AUTHENTICATE

GAP BLE SVC base. Initiate Pairing/Bonding.

SD_BLE_GAP_SEC_PARAMS_REPLY

GAP BLE SVC base. Reply with Security Parameters.

SD_BLE_GAP_AUTH_KEY_REPLY

GAP BLE SVC base. Reply with an authentication key.

SD_BLE_GAP_LESC_DHKEY_REPLY

GAP BLE SVC base. Reply with an LE Secure Connections DHKey.

SD_BLE_GAP_KEYPRESS_NOTIFY

GAP BLE SVC base. Notify of a keypress during an authentication procedure.

SD_BLE_GAP_LESC_OOB_DATA_GET

GAP BLE SVC base. Get the local LE Secure Connections OOB data.

SD_BLE_GAP_LESC_OOB_DATA_SET

GAP BLE SVC base. Set the remote LE Secure Connections OOB data.

SD_BLE_GAP_ENCRYPT

GAP BLE SVC base. Initiate encryption procedure.

SD_BLE_GAP_SEC_INFO_REPLY

GAP BLE SVC base. Reply with Security Information.

SD_BLE_GAP_CONN_SEC_GET

GAP BLE SVC base. Obtain connection security level.

SD_BLE_GAP_RSSI_START

GAP BLE SVC base. Start reporting of changes in RSSI.

SD_BLE_GAP_RSSI_STOP

GAP BLE SVC base. Stop reporting of changes in RSSI.

SD_BLE_GAP_SCAN_START

GAP BLE SVC base. Start Scanning.

SD_BLE_GAP_SCAN_STOP

GAP BLE SVC base. Stop Scanning.

SD_BLE_GAP_CONNECT

GAP BLE SVC base. Connect.

SD_BLE_GAP_CONNECT_CANCEL

GAP BLE SVC base. Cancel ongoing connection procedure.

SD_BLE_GAP_RSSI_GET

GAP BLE SVC base. Get the last RSSI sample.

SD_BLE_GAP_PHY_UPDATE

GAP BLE SVC base. Initiate or respond to a PHY Update Procedure.

SD_BLE_GAP_DATA_LENGTH_UPDATE

GAP BLE SVC base. Initiate or respond to a Data Length Update Procedure.

SD_BLE_GAP_QOS_CHANNEL_SURVEY_START

GAP BLE SVC base. Start Quality of Service (QoS) channel survey module.

SD_BLE_GAP_QOS_CHANNEL_SURVEY_STOP

GAP BLE SVC base. Stop Quality of Service (QoS) channel survey module.

SD_BLE_GAP_ADV_ADDR_GET

GAP BLE SVC base. Get the Address used on air while Advertising.

GAP TX Power roles.

Enumerator
BLE_GAP_TX_POWER_ROLE_ADV

Advertiser role.

BLE_GAP_TX_POWER_ROLE_SCAN_INIT

Scanner and initiator role.

BLE_GAP_TX_POWER_ROLE_CONN

Connection role.