Enumerations

S140 SoftDevice v5.0.0-2.alpha API

Enumerations

enum BLE_GAP_SVCS {
SD_BLE_GAP_ADDR_SET = 0x6C,
SD_BLE_GAP_ADDR_GET ,
SD_BLE_GAP_WHITELIST_SET ,
SD_BLE_GAP_DEVICE_IDENTITIES_SET ,
SD_BLE_GAP_PRIVACY_SET ,
SD_BLE_GAP_PRIVACY_GET ,
SD_BLE_GAP_ADV_DATA_SET ,
SD_BLE_GAP_ADV_START ,
SD_BLE_GAP_ADV_STOP ,
SD_BLE_GAP_CONN_PARAM_UPDATE ,
SD_BLE_GAP_DISCONNECT ,
SD_BLE_GAP_TX_POWER_SET ,
SD_BLE_GAP_APPEARANCE_SET ,
SD_BLE_GAP_APPEARANCE_GET ,
SD_BLE_GAP_PPCP_SET ,
SD_BLE_GAP_PPCP_GET ,
SD_BLE_GAP_DEVICE_NAME_SET ,
SD_BLE_GAP_DEVICE_NAME_GET ,
SD_BLE_GAP_AUTHENTICATE ,
SD_BLE_GAP_SEC_PARAMS_REPLY ,
SD_BLE_GAP_AUTH_KEY_REPLY ,
SD_BLE_GAP_LESC_DHKEY_REPLY ,
SD_BLE_GAP_KEYPRESS_NOTIFY ,
SD_BLE_GAP_LESC_OOB_DATA_GET ,
SD_BLE_GAP_LESC_OOB_DATA_SET ,
SD_BLE_GAP_ENCRYPT ,
SD_BLE_GAP_SEC_INFO_REPLY ,
SD_BLE_GAP_CONN_SEC_GET ,
SD_BLE_GAP_RSSI_START ,
SD_BLE_GAP_RSSI_STOP ,
SD_BLE_GAP_SCAN_START ,
SD_BLE_GAP_SCAN_STOP ,
SD_BLE_GAP_CONNECT ,
SD_BLE_GAP_CONNECT_CANCEL ,
SD_BLE_GAP_RSSI_GET ,
SD_BLE_GAP_PHY_REQUEST ,
SD_BLE_GAP_DATA_LENGTH_UPDATE
}
GAP API SVC numbers. More...
enum BLE_GAP_EVTS {
BLE_GAP_EVT_CONNECTED = 0x10,
BLE_GAP_EVT_DISCONNECTED ,
BLE_GAP_EVT_CONN_PARAM_UPDATE ,
BLE_GAP_EVT_SEC_PARAMS_REQUEST ,
BLE_GAP_EVT_SEC_INFO_REQUEST ,
BLE_GAP_EVT_PASSKEY_DISPLAY ,
BLE_GAP_EVT_KEY_PRESSED ,
BLE_GAP_EVT_AUTH_KEY_REQUEST ,
BLE_GAP_EVT_LESC_DHKEY_REQUEST ,
BLE_GAP_EVT_AUTH_STATUS ,
BLE_GAP_EVT_CONN_SEC_UPDATE ,
BLE_GAP_EVT_TIMEOUT ,
BLE_GAP_EVT_RSSI_CHANGED ,
BLE_GAP_EVT_ADV_REPORT ,
BLE_GAP_EVT_SEC_REQUEST ,
BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST ,
BLE_GAP_EVT_SCAN_REQ_REPORT ,
BLE_GAP_EVT_PHY_UPDATE ,
BLE_GAP_EVT_DATA_LENGTH_UPDATE_REQUEST ,
BLE_GAP_EVT_DATA_LENGTH_UPDATE
}
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 ,
BLE_GAP_OPT_PASSKEY ,
BLE_GAP_OPT_SCAN_REQ_REPORT ,
BLE_GAP_OPT_COMPAT_MODE_1 ,
BLE_GAP_OPT_COMPAT_MODE_2 ,
BLE_GAP_OPT_AUTH_PAYLOAD_TIMEOUT ,
BLE_GAP_OPT_PREFERRED_PHYS_SET ,
BLE_GAP_OPT_SLAVE_LATENCY_DISABLE
}
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
}
GAP Configuration IDs. 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

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. Connection established.
See ble_gap_evt_connected_t .

BLE_GAP_EVT_DISCONNECTED

Disconnected from peer.
See ble_gap_evt_disconnected_t .

BLE_GAP_EVT_CONN_PARAM_UPDATE

Connection Parameters updated.
See ble_gap_evt_conn_param_update_t .

BLE_GAP_EVT_SEC_PARAMS_REQUEST

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

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

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

Notification of a keypress on the remote device.
See ble_gap_evt_key_pressed_t

BLE_GAP_EVT_AUTH_KEY_REQUEST

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

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

Authentication procedure completed with status.
See ble_gap_evt_auth_status_t .

BLE_GAP_EVT_CONN_SEC_UPDATE

Connection security updated.
See ble_gap_evt_conn_sec_update_t .

BLE_GAP_EVT_TIMEOUT

Timeout expired.
See ble_gap_evt_timeout_t .

BLE_GAP_EVT_RSSI_CHANGED

RSSI report.
See ble_gap_evt_rssi_changed_t .

BLE_GAP_EVT_ADV_REPORT

Advertising report.
See ble_gap_evt_adv_report_t .

BLE_GAP_EVT_SEC_REQUEST

Security Request.
See ble_gap_evt_sec_request_t .

BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST

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

Scan request report.
See ble_gap_evt_scan_req_report_t .

BLE_GAP_EVT_PHY_UPDATE

PHY have been updated
See ble_gap_evt_phy_update_t .

BLE_GAP_EVT_DATA_LENGTH_UPDATE_REQUEST

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

LL Data Channel PDU payload length updated.
See ble_gap_evt_data_length_update_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

Local connection latency. ble_gap_opt_local_conn_latency_t

BLE_GAP_OPT_PASSKEY

Set passkey. ble_gap_opt_passkey_t

BLE_GAP_OPT_SCAN_REQ_REPORT

Scan request report. ble_gap_opt_scan_req_report_t

BLE_GAP_OPT_COMPAT_MODE_1

Compatibility mode. ble_gap_opt_compat_mode_1_t

BLE_GAP_OPT_COMPAT_MODE_2

Compatibility mode. ble_gap_opt_compat_mode_2_t

BLE_GAP_OPT_AUTH_PAYLOAD_TIMEOUT

Set Authenticated payload timeout. ble_gap_opt_auth_payload_timeout_t

BLE_GAP_OPT_PREFERRED_PHYS_SET

Set the preferred PHYs for all new connections. ble_gap_opt_preferred_phys_t

BLE_GAP_OPT_SLAVE_LATENCY_DISABLE

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

Get own Bluetooth Address.

SD_BLE_GAP_WHITELIST_SET

Set active whitelist.

SD_BLE_GAP_DEVICE_IDENTITIES_SET

Set device identity list.

SD_BLE_GAP_PRIVACY_SET

Set Privacy settings

SD_BLE_GAP_PRIVACY_GET

Get Privacy settings

SD_BLE_GAP_ADV_DATA_SET

Set Advertising Data.

SD_BLE_GAP_ADV_START

Start Advertising.

SD_BLE_GAP_ADV_STOP

Stop Advertising.

SD_BLE_GAP_CONN_PARAM_UPDATE

Connection Parameter Update.

SD_BLE_GAP_DISCONNECT

Disconnect.

SD_BLE_GAP_TX_POWER_SET

Set TX Power.

SD_BLE_GAP_APPEARANCE_SET

Set Appearance.

SD_BLE_GAP_APPEARANCE_GET

Get Appearance.

SD_BLE_GAP_PPCP_SET

Set PPCP.

SD_BLE_GAP_PPCP_GET

Get PPCP.

SD_BLE_GAP_DEVICE_NAME_SET

Set Device Name.

SD_BLE_GAP_DEVICE_NAME_GET

Get Device Name.

SD_BLE_GAP_AUTHENTICATE

Initiate Pairing/Bonding.

SD_BLE_GAP_SEC_PARAMS_REPLY

Reply with Security Parameters.

SD_BLE_GAP_AUTH_KEY_REPLY

Reply with an authentication key.

SD_BLE_GAP_LESC_DHKEY_REPLY

Reply with an LE Secure Connections DHKey.

SD_BLE_GAP_KEYPRESS_NOTIFY

Notify of a keypress during an authentication procedure.

SD_BLE_GAP_LESC_OOB_DATA_GET

Get the local LE Secure Connections OOB data.

SD_BLE_GAP_LESC_OOB_DATA_SET

Set the remote LE Secure Connections OOB data.

SD_BLE_GAP_ENCRYPT

Initiate encryption procedure.

SD_BLE_GAP_SEC_INFO_REPLY

Reply with Security Information.

SD_BLE_GAP_CONN_SEC_GET

Obtain connection security level.

SD_BLE_GAP_RSSI_START

Start reporting of changes in RSSI.

SD_BLE_GAP_RSSI_STOP

Stop reporting of changes in RSSI.

SD_BLE_GAP_SCAN_START

Start Scanning.

SD_BLE_GAP_SCAN_STOP

Stop Scanning.

SD_BLE_GAP_CONNECT

Connect.

SD_BLE_GAP_CONNECT_CANCEL

Cancel ongoing connection procedure.

SD_BLE_GAP_RSSI_GET

Get the last RSSI sample.

SD_BLE_GAP_PHY_REQUEST

Initiate PHY Update procedure.

SD_BLE_GAP_DATA_LENGTH_UPDATE

Initiate or respond to a Data Length Update Procedure.