 |
MT2523 API Reference
LinkIt SDK v4
|
|
MT2523 API Reference
LinkIt SDK v4
|
Macros | |
| #define | BT_GAP_LE_SMP_DISPLAY_ONLY 0x00 |
| The device has the ability to display or communicate a 6 digit decimal number, but does not have the ability to indicate 'yes' or 'no'. More... | |
| #define | BT_GAP_LE_SMP_DISPLAY_YES_NO 0x01 |
| The device has the ability to display or communicate a 6 digit decimal number. More... | |
| #define | BT_GAP_LE_SMP_KEYBOARD_ONLY 0x02 |
| The device has a numeric keyboard that can input the numbers '0' through '9' and a confirmation. More... | |
| #define | BT_GAP_LE_SMP_NO_INPUT_NO_OUTPUT 0x03 |
| The device does not have the ability to indicate 'yes' or 'no', and does not have the ability to display or communicate a 6 digit decimal number. More... | |
| #define | BT_GAP_LE_SMP_KEYBOARD_DISPLAY 0x04 |
| The device has a numeric keyboard that can input the numbers '0' to '9' and a confirmation. More... | |
| #define | BT_GAP_LE_SMP_IO_CAPABILITY_NUM 0x05 |
| Total number of I/O capability types. More... | |
| #define | BT_GAP_LE_SMP_OOB_DATA_NOT_PRESENTED 0x00 |
| Did not receive Out-of-Band data. More... | |
| #define | BT_GAP_LE_SMP_OOB_DATA_PRESENTED 0x01 |
| Received Out-of-Band data. More... | |
| #define | BT_GAP_LE_SMP_AUTH_REQ_NO_BONDING 0x00 |
| Does not save the IRK, LTK and CSRK. More... | |
| #define | BT_GAP_LE_SMP_AUTH_REQ_BONDING (0x01 << 0) |
| Saves the IRK, LTK and CSRK. More... | |
| #define | BT_GAP_LE_SMP_AUTH_REQ_MITM (0x01 << 2) |
| Requires the MITM protection. More... | |
| #define | BT_GAP_LE_SMP_AUTH_REQ_SECURE_CONNECTION (0x01 << 3) |
| Requires LE secure connection. More... | |
| #define | BT_GAP_LE_SMP_KEY_DISTRIBUTE_ENCKEY (0x01 << 0) |
| Distribute LTK. More... | |
| #define | BT_GAP_LE_SMP_KEY_DISTRIBUTE_IDKEY (0x01 << 1) |
| Distribute IRK. More... | |
| #define | BT_GAP_LE_SMP_KEY_DISTRIBUTE_SIGN (0x01 << 2) |
| Distribute CSRK. More... | |
| #define | BT_GAP_LE_SMP_JUST_WORKS_MASK (0x1 << 0) |
| Using Just Works method. More... | |
| #define | BT_GAP_LE_SMP_AUTHENTICATION_MASK BT_GAP_LE_SECURITY_AUTHENTICATION_MASK |
| Using Authentication (MITM protection). More... | |
| #define | BT_GAP_LE_SMP_PASSKEY_INPUT_MASK (0x1 << 2) |
| Using Passkey Input method. More... | |
| #define | BT_GAP_LE_SMP_PASSKEY_DISPLAY_MASK (0x1 << 3) |
| Using Passkey Display method. More... | |
| #define | BT_GAP_LE_SMP_LESC_MASK BT_GAP_LE_SECURITY_LESC_MASK |
| Using LE Secure Connection. More... | |
| #define | BT_GAP_LE_SMP_PASSKEY_MASK (0x1 << 5) |
| Using Passkey method. More... | |
| #define | BT_GAP_LE_SMP_OOB_MASK (0x1 << 6) |
| Using Out-of-Band method. More... | |
| #define | BT_GAP_LE_SMP_NUMERIC_COMPARISON_MASK (0x1 << 7) |
| Using Numeric Comparison method. More... | |
| #define | BT_GAP_LE_SMP_JUST_WORKS BT_GAP_LE_SMP_JUST_WORKS_MASK |
| Using Legacy Just Works method. More... | |
| #define | BT_GAP_LE_SMP_PASSKEY_INPUT (BT_GAP_LE_SMP_PASSKEY_MASK | BT_GAP_LE_SMP_PASSKEY_INPUT_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK) |
| Using Legacy Passkey Input method. More... | |
| #define | BT_GAP_LE_SMP_PASSKEY_DISPLAY (BT_GAP_LE_SMP_PASSKEY_MASK | BT_GAP_LE_SMP_PASSKEY_DISPLAY_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK) |
| Using Legacy Passkey Display method. More... | |
| #define | BT_GAP_LE_SMP_OOB (BT_GAP_LE_SMP_OOB_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK) |
| Using Legacy Out-of-Band method. More... | |
| #define | BT_GAP_LE_SMP_LESC_JUST_WORKS (BT_GAP_LE_SMP_JUST_WORKS_MASK | BT_GAP_LE_SMP_LESC_MASK) |
| Using LESC Just Works method. More... | |
| #define | BT_GAP_LE_SMP_LESC_PASSKEY_INPUT (BT_GAP_LE_SMP_PASSKEY_MASK | BT_GAP_LE_SMP_PASSKEY_INPUT_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK | BT_GAP_LE_SMP_LESC_MASK) |
| Using LESC Passkey Input method. More... | |
| #define | BT_GAP_LE_SMP_LESC_PASSKEY_DISPLAY (BT_GAP_LE_SMP_PASSKEY_MASK | BT_GAP_LE_SMP_PASSKEY_DISPLAY_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK | BT_GAP_LE_SMP_LESC_MASK) |
| Using LESC Passkey Display method. More... | |
| #define | BT_GAP_LE_SMP_LESC_OOB (BT_GAP_LE_SMP_OOB_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK | BT_GAP_LE_SMP_LESC_MASK) |
| Using LESC Out-of-Band method. More... | |
| #define | BT_GAP_LE_SMP_LESC_NUMERIC_COMPARISON (BT_GAP_LE_SMP_NUMERIC_COMPARISON_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK | BT_GAP_LE_SMP_LESC_MASK) |
| Using LESC Numeric Comparison method. More... | |
| #define | BT_GAP_LE_SET_RANDOM_ADDRESS_CNF (BT_MODULE_GAP | 0x0003) |
| Set random address confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_SET_WHITE_LIST_CNF (BT_MODULE_GAP | 0x0004) |
| Set white list confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_SET_ADVERTISING_IND (BT_MODULE_GAP | 0x0005) |
| Set advertising indication for BT_HCI_STATUS_DIRECTED_ADVERTISING_TIMEOUT with NULL payload. More... | |
| #define | BT_GAP_LE_SET_ADVERTISING_CNF (BT_MODULE_GAP | 0x0006) |
| Set advertising confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_SET_SCAN_CNF (BT_MODULE_GAP | 0x0007) |
| Set scan confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_ADVERTISING_REPORT_IND (BT_MODULE_GAP | 0x0008) |
| Advertising report indication with bt_gap_le_advertising_report_ind_t. More... | |
| #define | BT_GAP_LE_CONNECT_CNF (BT_MODULE_GAP | 0x0009) |
| Connect confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_CONNECT_IND (BT_MODULE_GAP | 0x000a) |
| Connect indication with bt_gap_le_connection_ind_t, indicates a connection is created. More... | |
| #define | BT_GAP_LE_CONNECT_CANCEL_CNF (BT_MODULE_GAP | 0x000b) |
| Connect cancel confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_DISCONNECT_CNF (BT_MODULE_GAP | 0x000c) |
| Disconnect confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_DISCONNECT_IND (BT_MODULE_GAP | 0x000d) |
| Disconnect indication with bt_gap_le_disconnect_ind_t as the payload, indicates a connection is disconnected. More... | |
| #define | BT_GAP_LE_CONNECTION_UPDATE_CNF (BT_MODULE_GAP | 0x000e) |
| Connection update confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_CONNECTION_UPDATE_IND (BT_MODULE_GAP | 0x000f) |
| Connection update indication with bt_gap_le_connection_update_ind_t. More... | |
| #define | BT_GAP_LE_READ_RSSI_CNF (BT_MODULE_GAP | 0x0011) |
| Read RSSI confirmation with bt_hci_evt_cc_read_rssi_t. More... | |
| #define | BT_GAP_LE_UPDATE_DATA_LENGTH_CNF (BT_MODULE_GAP | 0x0012) |
| Update data length confirmation with bt_hci_evt_cc_le_set_data_length_t. More... | |
| #define | BT_GAP_LE_BONDING_REPLY_REQ_IND (BT_MODULE_GAP | 0x0015) |
| Bonding reply request indication with bt_gap_le_bonding_reply_req_ind_t, indicates that the application should reply the passkey or Out-of-Band data by calling bt_gap_le_bonding_reply(). More... | |
| #define | BT_GAP_LE_BONDING_COMPLETE_IND (BT_MODULE_GAP | 0x0016) |
| Bonding complete indication with bt_gap_le_bonding_complete_ind_t, indicates the pairing procedure is complete. More... | |
| #define | BT_GAP_LE_SET_RESOLVING_LIST_CNF (BT_MODULE_GAP | 0x0017) |
| Set (Add one/ Delete one/ Clear all) resolving list confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_SET_ADDRESS_RESOLUTION_ENABLE_CNF (BT_MODULE_GAP | 0x0018) |
| Set (Enable/Disable) address resolution confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_SET_RESOLVABLE_PRIVATE_ADDRESS_TIMEOUT_CNF (BT_MODULE_GAP | 0x0019) |
| Set resolvable private address timeout confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_SET_TX_POWER_CNF (BT_MODULE_GAP | 0x0020) |
| Set TX power confirmation with NULL payload. More... | |
| #define | BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_IND 0x00 |
| Advertising report event type. More... | |
| #define | BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_DIRECT_IND 0x01 |
| Connectable directed advertising indication. More... | |
| #define | BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_SCAN_IND 0x02 |
| Scannable undirected advertising indication. More... | |
| #define | BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_NONCONN_IND 0x03 |
| Non connectable undirected advertising indication. More... | |
| #define | BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_SCAN_RSP 0x04 |
| Scan response. More... | |
| #define | BT_GAP_LE_AD_TYPE_FLAG 0x01 |
| Data types used for the advertising data, please refer to Assigned number for the Generic Access Profile. More... | |
| #define | BT_GAP_LE_AD_TYPE_16_BIT_UUID_PART 0x02 |
| Incomplete list of the 16-bit service class UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_16_BIT_UUID_COMPLETE 0x03 |
| Complete list of the 16-bit service class UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_32_BIT_UUID_PART 0x04 |
| Incomplete list of the 32-bit service class UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_32_BIT_UUID_COMPLETE 0x05 |
| Complete list of the 32-bit service class UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_128_BIT_UUID_PART 0x06 |
| Incomplete list of the 128-bit service class UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_128_BIT_UUID_COMPLETE 0x07 |
| Complete list of the 128-bit service class UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_NAME_SHORT 0x08 |
| Shortened local name. More... | |
| #define | BT_GAP_LE_AD_TYPE_NAME_COMPLETE 0x09 |
| Complete local name. More... | |
| #define | BT_GAP_LE_AD_TYPE_TX_POWER 0x0A |
| Transmit power level. More... | |
| #define | BT_GAP_LE_AD_TYPE_COD 0x0D |
| Class of the device. More... | |
| #define | BT_GAP_LE_AD_TYPE_SM_TK 0x10 |
| Security manager's TK value. More... | |
| #define | BT_GAP_LE_AD_TYPE_SM_OOB_FLAG 0x11 |
| Security manager's Out-of-Band flags. More... | |
| #define | BT_GAP_LE_AD_TYPE_SLAVE_CONNECTION_INTERVAL_RANGE 0x12 |
| Slave connection interval range. More... | |
| #define | BT_GAP_LE_AD_TYPE_16_BIT_SOLICITATION_UUID 0x14 |
| List of the 16-bit service solicitation UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_128_BIT_SOLICITATION_UUID 0x15 |
| List of the 128-bit service solicitation UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_SERVICE_DATA 0x16 |
| Service data. More... | |
| #define | BT_GAP_LE_AD_TYPE_16_BIT_UUID_DATA 0x16 |
| Service data with 16-bit UUID. More... | |
| #define | BT_GAP_LE_AD_TYPE_PUBLIC_TARGET_ADDRESS 0x17 |
| Public target address. More... | |
| #define | BT_GAP_LE_AD_TYPE_RANDOM_TARGET_ADDRESS 0x18 |
| Random target address. More... | |
| #define | BT_GAP_LE_AD_TYPE_APPEARANCE 0x19 |
| Appearance. More... | |
| #define | BT_GAP_LE_AD_TYPE_ADV_INTERVAL 0x1A |
| Advertising interval. More... | |
| #define | BT_GAP_LE_AD_TYPE_LE_BT_DEVICE_ADDRESS 0x1B |
| Bluetooth LE device address. More... | |
| #define | BT_GAP_LE_AD_TYPE_LE_ROLE 0x1C |
| LE role. More... | |
| #define | BT_GAP_LE_AD_TYPE_32_BIT_SOLICITATION_UUID 0x1F |
| List of 32-bit service solicitation UUIDs. More... | |
| #define | BT_GAP_LE_AD_TYPE_32_BIT_UUID_DATA 0x20 |
| Service data - 32-bit UUID. More... | |
| #define | BT_GAP_LE_AD_TYPE_128_BIT_UUID_DATA 0x21 |
| Service data - 128-bit UUID. More... | |
| #define | BT_GAP_LE_AD_TYPE_MANUFACTURER_SPECIFIC 0xFF |
| Manufacturer specific data. More... | |
| #define | BT_GAP_LE_AD_FLAG_LIMITED_DISCOVERABLE (0x01 << 0) |
| LE limited discoverable mode. More... | |
| #define | BT_GAP_LE_AD_FLAG_GENERAL_DISCOVERABLE (0x01 << 1) |
| LE general discoverable mode. More... | |
| #define | BT_GAP_LE_AD_FLAG_BR_EDR_NOT_SUPPORTED (0x01 << 2) |
| BR/EDR not supported. More... | |
| #define | BT_GAP_LE_DIRECT_ADDR_TYPE_INVALID 0 |
| For bt_gap_le_advertising_report_ind_t. More... | |
| #define | BT_GAP_LE_SECURITY_UNAUTH_MASK 0x0 |
| The key is unauthenticated. More... | |
| #define | BT_GAP_LE_SECURITY_AUTHORIZATION_MASK (0x1 << 0) |
| The key is authorized. More... | |
| #define | BT_GAP_LE_SECURITY_AUTHENTICATION_MASK (0x1 << 1) |
| The key is authenticated. More... | |
| #define | BT_GAP_LE_SECURITY_ENCRYPTION_MASK (0x1 << 2) |
| The LTK is available. More... | |
| #define | BT_GAP_LE_SECURITY_SIGN_MASK (0x1 << 3) |
| The CSRK is available. More... | |
| #define | BT_GAP_LE_SECURITY_LESC_MASK (0x1 << 4) |
| Use LE secure connection. More... | |
| #define | BT_GAP_LE_SECURITY_BONDED_MASK (0x1 << 5) |
| Bonded mask. More... | |
| #define | BT_GAP_LE_CLEAR_WHITE_LIST 0x2010 |
| Clear the white list. More... | |
| #define | BT_GAP_LE_ADD_TO_WHITE_LIST 0x2011 |
| Add to the white list. More... | |
| #define | BT_GAP_LE_REMOVE_FROM_WHITE_LIST 0x2012 |
| Remove from the white list. More... | |
| #define | BT_GAP_LE_SECURITY_MODE1_1 (BT_GAP_LE_SECURITY_UNAUTH_MASK) |
| LE security modes. More... | |
| #define | BT_GAP_LE_SECURITY_MODE1_2 (BT_GAP_LE_SECURITY_UNAUTH_MASK | BT_GAP_LE_SECURITY_ENCRYPTION_MASK) |
| Mode 1 level 2, link encryption by unauthenticated key. More... | |
| #define | BT_GAP_LE_SECURITY_MODE1_3 (BT_GAP_LE_SECURITY_AUTHENTICATION_MASK | BT_GAP_LE_SECURITY_ENCRYPTION_MASK) |
| Mode 1 level 3, link encryption by authenticated key. More... | |
| #define | BT_GAP_LE_SECURITY_MODE1_4 (BT_GAP_LE_SECURITY_LESC_MASK | BT_GAP_LE_SECURITY_AUTHENTICATION_MASK | BT_GAP_LE_SECURITY_ENCRYPTION_MASK) |
| Mode 1 level 4, link encryption by authenticated LE secure connection key. More... | |
| #define | BT_GAP_LE_SECURITY_MODE2_1 (BT_GAP_LE_SECURITY_UNAUTH_MASK | BT_GAP_LE_SECURITY_SIGN_MASK) |
| Mode 2 level 1, Data signed by unauthenticated key. More... | |
| #define | BT_GAP_LE_SECURITY_MODE2_2 (BT_GAP_LE_SECURITY_AUTHENTICATION_MASK | BT_GAP_LE_SECURITY_SIGN_MASK) |
| Mode 2 level 2, Data signed by authenticated key. More... | |
Typedefs | |
| typedef uint8_t | bt_gap_le_smp_io_capability_t |
| Device I/O capability. More... | |
| typedef uint8_t | bt_gap_le_smp_oob_data_flag_t |
| Indicates if the Out-of-Band data is received or not. More... | |
| typedef uint8_t | bt_gap_le_smp_auth_req_t |
| Authentication requirement. More... | |
| typedef uint8_t | bt_gap_le_smp_key_distribute_t |
| The key to distribute. More... | |
| typedef uint8_t | bt_gap_le_smp_pairing_method_t |
| The final pairing method. More... | |
| typedef uint8_t | bt_gap_le_adv_report_evt_type_t |
| The type of advertising report event. More... | |
| typedef uint8_t | bt_gap_le_security_mode_t |
| The security mode of the device. More... | |
| typedef uint32_t | bt_gap_le_set_white_list_op_t |
| The operation type to the white list. More... | |
| #define BT_GAP_LE_AD_FLAG_BR_EDR_NOT_SUPPORTED (0x01 << 2) |
BR/EDR not supported.
| #define BT_GAP_LE_AD_FLAG_GENERAL_DISCOVERABLE (0x01 << 1) |
LE general discoverable mode.
| #define BT_GAP_LE_AD_FLAG_LIMITED_DISCOVERABLE (0x01 << 0) |
LE limited discoverable mode.
| #define BT_GAP_LE_AD_TYPE_128_BIT_SOLICITATION_UUID 0x15 |
List of the 128-bit service solicitation UUIDs.
| #define BT_GAP_LE_AD_TYPE_128_BIT_UUID_COMPLETE 0x07 |
Complete list of the 128-bit service class UUIDs.
| #define BT_GAP_LE_AD_TYPE_128_BIT_UUID_DATA 0x21 |
Service data - 128-bit UUID.
| #define BT_GAP_LE_AD_TYPE_128_BIT_UUID_PART 0x06 |
Incomplete list of the 128-bit service class UUIDs.
| #define BT_GAP_LE_AD_TYPE_16_BIT_SOLICITATION_UUID 0x14 |
List of the 16-bit service solicitation UUIDs.
| #define BT_GAP_LE_AD_TYPE_16_BIT_UUID_COMPLETE 0x03 |
Complete list of the 16-bit service class UUIDs.
| #define BT_GAP_LE_AD_TYPE_16_BIT_UUID_DATA 0x16 |
Service data with 16-bit UUID.
| #define BT_GAP_LE_AD_TYPE_16_BIT_UUID_PART 0x02 |
Incomplete list of the 16-bit service class UUIDs.
| #define BT_GAP_LE_AD_TYPE_32_BIT_SOLICITATION_UUID 0x1F |
List of 32-bit service solicitation UUIDs.
| #define BT_GAP_LE_AD_TYPE_32_BIT_UUID_COMPLETE 0x05 |
Complete list of the 32-bit service class UUIDs.
| #define BT_GAP_LE_AD_TYPE_32_BIT_UUID_DATA 0x20 |
Service data - 32-bit UUID.
| #define BT_GAP_LE_AD_TYPE_32_BIT_UUID_PART 0x04 |
Incomplete list of the 32-bit service class UUIDs.
| #define BT_GAP_LE_AD_TYPE_ADV_INTERVAL 0x1A |
Advertising interval.
| #define BT_GAP_LE_AD_TYPE_APPEARANCE 0x19 |
Appearance.
| #define BT_GAP_LE_AD_TYPE_COD 0x0D |
Class of the device.
| #define BT_GAP_LE_AD_TYPE_FLAG 0x01 |
Data types used for the advertising data, please refer to Assigned number for the Generic Access Profile.
Flags
| #define BT_GAP_LE_AD_TYPE_LE_BT_DEVICE_ADDRESS 0x1B |
Bluetooth LE device address.
| #define BT_GAP_LE_AD_TYPE_LE_ROLE 0x1C |
LE role.
| #define BT_GAP_LE_AD_TYPE_MANUFACTURER_SPECIFIC 0xFF |
Manufacturer specific data.
| #define BT_GAP_LE_AD_TYPE_NAME_COMPLETE 0x09 |
Complete local name.
| #define BT_GAP_LE_AD_TYPE_NAME_SHORT 0x08 |
Shortened local name.
| #define BT_GAP_LE_AD_TYPE_PUBLIC_TARGET_ADDRESS 0x17 |
Public target address.
| #define BT_GAP_LE_AD_TYPE_RANDOM_TARGET_ADDRESS 0x18 |
Random target address.
| #define BT_GAP_LE_AD_TYPE_SERVICE_DATA 0x16 |
Service data.
| #define BT_GAP_LE_AD_TYPE_SLAVE_CONNECTION_INTERVAL_RANGE 0x12 |
Slave connection interval range.
| #define BT_GAP_LE_AD_TYPE_SM_OOB_FLAG 0x11 |
Security manager's Out-of-Band flags.
| #define BT_GAP_LE_AD_TYPE_SM_TK 0x10 |
Security manager's TK value.
| #define BT_GAP_LE_AD_TYPE_TX_POWER 0x0A |
Transmit power level.
| #define BT_GAP_LE_ADD_TO_WHITE_LIST 0x2011 |
Add to the white list.
| #define BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_DIRECT_IND 0x01 |
Connectable directed advertising indication.
| #define BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_IND 0x00 |
Advertising report event type.
Connectable undirected advertising indication.
| #define BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_NONCONN_IND 0x03 |
Non connectable undirected advertising indication.
| #define BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_SCAN_IND 0x02 |
Scannable undirected advertising indication.
| #define BT_GAP_LE_ADV_REPORT_EVT_TYPE_ADV_SCAN_RSP 0x04 |
Scan response.
| #define BT_GAP_LE_ADVERTISING_REPORT_IND (BT_MODULE_GAP | 0x0008) |
Advertising report indication with bt_gap_le_advertising_report_ind_t.
| #define BT_GAP_LE_BONDING_COMPLETE_IND (BT_MODULE_GAP | 0x0016) |
Bonding complete indication with bt_gap_le_bonding_complete_ind_t, indicates the pairing procedure is complete.
| #define BT_GAP_LE_BONDING_REPLY_REQ_IND (BT_MODULE_GAP | 0x0015) |
Bonding reply request indication with bt_gap_le_bonding_reply_req_ind_t, indicates that the application should reply the passkey or Out-of-Band data by calling bt_gap_le_bonding_reply().
The passkey or Out-of-Band data should not be NULL.
| #define BT_GAP_LE_CLEAR_WHITE_LIST 0x2010 |
Clear the white list.
| #define BT_GAP_LE_CONNECT_CANCEL_CNF (BT_MODULE_GAP | 0x000b) |
Connect cancel confirmation with NULL payload.
| #define BT_GAP_LE_CONNECT_CNF (BT_MODULE_GAP | 0x0009) |
Connect confirmation with NULL payload.
| #define BT_GAP_LE_CONNECT_IND (BT_MODULE_GAP | 0x000a) |
Connect indication with bt_gap_le_connection_ind_t, indicates a connection is created.
| #define BT_GAP_LE_CONNECTION_UPDATE_CNF (BT_MODULE_GAP | 0x000e) |
Connection update confirmation with NULL payload.
| #define BT_GAP_LE_CONNECTION_UPDATE_IND (BT_MODULE_GAP | 0x000f) |
Connection update indication with bt_gap_le_connection_update_ind_t.
| #define BT_GAP_LE_DIRECT_ADDR_TYPE_INVALID 0 |
| #define BT_GAP_LE_DISCONNECT_CNF (BT_MODULE_GAP | 0x000c) |
Disconnect confirmation with NULL payload.
| #define BT_GAP_LE_DISCONNECT_IND (BT_MODULE_GAP | 0x000d) |
Disconnect indication with bt_gap_le_disconnect_ind_t as the payload, indicates a connection is disconnected.
| #define BT_GAP_LE_READ_RSSI_CNF (BT_MODULE_GAP | 0x0011) |
Read RSSI confirmation with bt_hci_evt_cc_read_rssi_t.
| #define BT_GAP_LE_REMOVE_FROM_WHITE_LIST 0x2012 |
Remove from the white list.
| #define BT_GAP_LE_SECURITY_AUTHENTICATION_MASK (0x1 << 1) |
The key is authenticated.
| #define BT_GAP_LE_SECURITY_AUTHORIZATION_MASK (0x1 << 0) |
The key is authorized.
| #define BT_GAP_LE_SECURITY_BONDED_MASK (0x1 << 5) |
Bonded mask.
| #define BT_GAP_LE_SECURITY_ENCRYPTION_MASK (0x1 << 2) |
The LTK is available.
| #define BT_GAP_LE_SECURITY_LESC_MASK (0x1 << 4) |
Use LE secure connection.
| #define BT_GAP_LE_SECURITY_MODE1_1 (BT_GAP_LE_SECURITY_UNAUTH_MASK) |
LE security modes.
Mode 1 level 1, no security.
| #define BT_GAP_LE_SECURITY_MODE1_2 (BT_GAP_LE_SECURITY_UNAUTH_MASK | BT_GAP_LE_SECURITY_ENCRYPTION_MASK) |
Mode 1 level 2, link encryption by unauthenticated key.
| #define BT_GAP_LE_SECURITY_MODE1_3 (BT_GAP_LE_SECURITY_AUTHENTICATION_MASK | BT_GAP_LE_SECURITY_ENCRYPTION_MASK) |
Mode 1 level 3, link encryption by authenticated key.
| #define BT_GAP_LE_SECURITY_MODE1_4 (BT_GAP_LE_SECURITY_LESC_MASK | BT_GAP_LE_SECURITY_AUTHENTICATION_MASK | BT_GAP_LE_SECURITY_ENCRYPTION_MASK) |
Mode 1 level 4, link encryption by authenticated LE secure connection key.
| #define BT_GAP_LE_SECURITY_MODE2_1 (BT_GAP_LE_SECURITY_UNAUTH_MASK | BT_GAP_LE_SECURITY_SIGN_MASK) |
Mode 2 level 1, Data signed by unauthenticated key.
| #define BT_GAP_LE_SECURITY_MODE2_2 (BT_GAP_LE_SECURITY_AUTHENTICATION_MASK | BT_GAP_LE_SECURITY_SIGN_MASK) |
Mode 2 level 2, Data signed by authenticated key.
| #define BT_GAP_LE_SECURITY_SIGN_MASK (0x1 << 3) |
The CSRK is available.
| #define BT_GAP_LE_SECURITY_UNAUTH_MASK 0x0 |
The key is unauthenticated.
| #define BT_GAP_LE_SET_ADDRESS_RESOLUTION_ENABLE_CNF (BT_MODULE_GAP | 0x0018) |
Set (Enable/Disable) address resolution confirmation with NULL payload.
| #define BT_GAP_LE_SET_ADVERTISING_CNF (BT_MODULE_GAP | 0x0006) |
Set advertising confirmation with NULL payload.
| #define BT_GAP_LE_SET_ADVERTISING_IND (BT_MODULE_GAP | 0x0005) |
Set advertising indication for BT_HCI_STATUS_DIRECTED_ADVERTISING_TIMEOUT with NULL payload.
| #define BT_GAP_LE_SET_RANDOM_ADDRESS_CNF (BT_MODULE_GAP | 0x0003) |
Set random address confirmation with NULL payload.
| #define BT_GAP_LE_SET_RESOLVABLE_PRIVATE_ADDRESS_TIMEOUT_CNF (BT_MODULE_GAP | 0x0019) |
Set resolvable private address timeout confirmation with NULL payload.
| #define BT_GAP_LE_SET_RESOLVING_LIST_CNF (BT_MODULE_GAP | 0x0017) |
Set (Add one/ Delete one/ Clear all) resolving list confirmation with NULL payload.
| #define BT_GAP_LE_SET_SCAN_CNF (BT_MODULE_GAP | 0x0007) |
Set scan confirmation with NULL payload.
| #define BT_GAP_LE_SET_TX_POWER_CNF (BT_MODULE_GAP | 0x0020) |
Set TX power confirmation with NULL payload.
| #define BT_GAP_LE_SET_WHITE_LIST_CNF (BT_MODULE_GAP | 0x0004) |
Set white list confirmation with NULL payload.
| #define BT_GAP_LE_SMP_AUTH_REQ_BONDING (0x01 << 0) |
Saves the IRK, LTK and CSRK.
| #define BT_GAP_LE_SMP_AUTH_REQ_MITM (0x01 << 2) |
Requires the MITM protection.
| #define BT_GAP_LE_SMP_AUTH_REQ_NO_BONDING 0x00 |
Does not save the IRK, LTK and CSRK.
| #define BT_GAP_LE_SMP_AUTH_REQ_SECURE_CONNECTION (0x01 << 3) |
Requires LE secure connection.
| #define BT_GAP_LE_SMP_AUTHENTICATION_MASK BT_GAP_LE_SECURITY_AUTHENTICATION_MASK |
Using Authentication (MITM protection).
| #define BT_GAP_LE_SMP_DISPLAY_ONLY 0x00 |
The device has the ability to display or communicate a 6 digit decimal number, but does not have the ability to indicate 'yes' or 'no'.
| #define BT_GAP_LE_SMP_DISPLAY_YES_NO 0x01 |
The device has the ability to display or communicate a 6 digit decimal number.
Also, the device has at least two buttons, one of which maps to 'yes' and the other to 'no'; or the device has a mechanism whereby the user can indicate either 'yes' or 'no'.
| #define BT_GAP_LE_SMP_IO_CAPABILITY_NUM 0x05 |
Total number of I/O capability types.
| #define BT_GAP_LE_SMP_JUST_WORKS BT_GAP_LE_SMP_JUST_WORKS_MASK |
Using Legacy Just Works method.
| #define BT_GAP_LE_SMP_JUST_WORKS_MASK (0x1 << 0) |
Using Just Works method.
| #define BT_GAP_LE_SMP_KEY_DISTRIBUTE_ENCKEY (0x01 << 0) |
Distribute LTK.
| #define BT_GAP_LE_SMP_KEY_DISTRIBUTE_IDKEY (0x01 << 1) |
Distribute IRK.
| #define BT_GAP_LE_SMP_KEY_DISTRIBUTE_SIGN (0x01 << 2) |
Distribute CSRK.
| #define BT_GAP_LE_SMP_KEYBOARD_DISPLAY 0x04 |
The device has a numeric keyboard that can input the numbers '0' to '9' and a confirmation.
And the device has the ability to display or communicate a 6 digit decimal number.
| #define BT_GAP_LE_SMP_KEYBOARD_ONLY 0x02 |
The device has a numeric keyboard that can input the numbers '0' through '9' and a confirmation.
But, the device does not have the ability to display or communicate a 6 digit decimal number.
| #define BT_GAP_LE_SMP_LESC_JUST_WORKS (BT_GAP_LE_SMP_JUST_WORKS_MASK | BT_GAP_LE_SMP_LESC_MASK) |
Using LESC Just Works method.
| #define BT_GAP_LE_SMP_LESC_MASK BT_GAP_LE_SECURITY_LESC_MASK |
Using LE Secure Connection.
| #define BT_GAP_LE_SMP_LESC_NUMERIC_COMPARISON (BT_GAP_LE_SMP_NUMERIC_COMPARISON_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK | BT_GAP_LE_SMP_LESC_MASK) |
Using LESC Numeric Comparison method.
| #define BT_GAP_LE_SMP_LESC_OOB (BT_GAP_LE_SMP_OOB_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK | BT_GAP_LE_SMP_LESC_MASK) |
Using LESC Out-of-Band method.
| #define BT_GAP_LE_SMP_LESC_PASSKEY_DISPLAY (BT_GAP_LE_SMP_PASSKEY_MASK | BT_GAP_LE_SMP_PASSKEY_DISPLAY_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK | BT_GAP_LE_SMP_LESC_MASK) |
Using LESC Passkey Display method.
| #define BT_GAP_LE_SMP_LESC_PASSKEY_INPUT (BT_GAP_LE_SMP_PASSKEY_MASK | BT_GAP_LE_SMP_PASSKEY_INPUT_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK | BT_GAP_LE_SMP_LESC_MASK) |
Using LESC Passkey Input method.
| #define BT_GAP_LE_SMP_NO_INPUT_NO_OUTPUT 0x03 |
The device does not have the ability to indicate 'yes' or 'no', and does not have the ability to display or communicate a 6 digit decimal number.
| #define BT_GAP_LE_SMP_NUMERIC_COMPARISON_MASK (0x1 << 7) |
Using Numeric Comparison method.
| #define BT_GAP_LE_SMP_OOB (BT_GAP_LE_SMP_OOB_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK) |
Using Legacy Out-of-Band method.
| #define BT_GAP_LE_SMP_OOB_DATA_NOT_PRESENTED 0x00 |
Did not receive Out-of-Band data.
| #define BT_GAP_LE_SMP_OOB_DATA_PRESENTED 0x01 |
Received Out-of-Band data.
| #define BT_GAP_LE_SMP_OOB_MASK (0x1 << 6) |
Using Out-of-Band method.
| #define BT_GAP_LE_SMP_PASSKEY_DISPLAY (BT_GAP_LE_SMP_PASSKEY_MASK | BT_GAP_LE_SMP_PASSKEY_DISPLAY_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK) |
Using Legacy Passkey Display method.
| #define BT_GAP_LE_SMP_PASSKEY_DISPLAY_MASK (0x1 << 3) |
Using Passkey Display method.
| #define BT_GAP_LE_SMP_PASSKEY_INPUT (BT_GAP_LE_SMP_PASSKEY_MASK | BT_GAP_LE_SMP_PASSKEY_INPUT_MASK | BT_GAP_LE_SMP_AUTHENTICATION_MASK) |
Using Legacy Passkey Input method.
| #define BT_GAP_LE_SMP_PASSKEY_INPUT_MASK (0x1 << 2) |
Using Passkey Input method.
| #define BT_GAP_LE_SMP_PASSKEY_MASK (0x1 << 5) |
Using Passkey method.
| #define BT_GAP_LE_UPDATE_DATA_LENGTH_CNF (BT_MODULE_GAP | 0x0012) |
Update data length confirmation with bt_hci_evt_cc_le_set_data_length_t.
| typedef uint8_t bt_gap_le_adv_report_evt_type_t |
The type of advertising report event.
| typedef uint8_t bt_gap_le_security_mode_t |
The security mode of the device.
| typedef uint32_t bt_gap_le_set_white_list_op_t |
The operation type to the white list.
| typedef uint8_t bt_gap_le_smp_auth_req_t |
Authentication requirement.
| typedef uint8_t bt_gap_le_smp_io_capability_t |
Device I/O capability.
| typedef uint8_t bt_gap_le_smp_key_distribute_t |
The key to distribute.
| typedef uint8_t bt_gap_le_smp_oob_data_flag_t |
Indicates if the Out-of-Band data is received or not.
| typedef uint8_t bt_gap_le_smp_pairing_method_t |
The final pairing method.
1.8.11 
