Enumerations
Enumerations
BLE » Generic Access Profile (GAP) » Generic Access Profile (GAP) Management

## Enumerations
enum | ble_gap_role_t { BLE_GAP_ROLE_NONE = 0x00, BLE_GAP_ROLE_OBSERVER = 0x01, BLE_GAP_ROLE_BROADCASTER = 0x02, BLE_GAP_ROLE_CENTRAL = (0x04 | BLE_GAP_ROLE_OBSERVER), BLE_GAP_ROLE_PERIPHERAL = (0x08 | BLE_GAP_ROLE_BROADCASTER), BLE_GAP_ROLE_ALL = (BLE_GAP_ROLE_CENTRAL | BLE_GAP_ROLE_PERIPHERAL) }
| GAP role options. More...
enum | ble_gap_own_addr_t { BLE_GAP_OWN_ADDR_STATIC = 0, BLE_GAP_OWN_ADDR_GEN_RSLV, BLE_GAP_OWN_ADDR_GEN_NON_RSLV }
| Own BD address source of the device. More...
enum | ble_gap_dev_name_write_perm_t { BLE_GAP_WRITE_PERM_DISABLE = 0, BLE_GAP_WRITE_PERM_NOAUTH, BLE_GAP_WRITE_PERM_UNAUTH, BLE_GAP_WRITE_PERM_AUTH, BLE_GAP_WRITE_PERM_SEC_CON }
| Write permissions of the device name characteristic. More...
enum | ble_gap_adv_data_type_t { BLE_GAP_ADV_DATA_TYPE_DATA = 0, BLE_GAP_ADV_DATA_TYPE_SCAN_RSP, BLE_GAP_ADV_DATA_TYPE_PER_DATA }
| Advertising data type. More...
enum | ble_gap_dev_info_get_type_t { BLE_GAP_GET_DEV_VERSION = 0, BLE_GAP_GET_DEV_BDADDR, BLE_GAP_GET_SUGGESTED_DFLT_LE_DATA_LEN, BLE_GAP_GET_MAX_LE_DATA_LEN, BLE_GAP_GET_NB_ADV_SETS, BLE_GAP_GET_MAX_LE_ADV_DATA_LEN, BLE_GAP_GET_DEV_TX_POWER, BLE_GAP_GET_DEV_RF_RF_PATH_COMP, BLE_GAP_GET_ANTENNA_INFO }
| Get device parameters operation code. More...
enum | ble_gap_adv_mode_t { BLE_GAP_ADV_TYPE_ADV_IND = 0, BLE_GAP_ADV_TYPE_ADV_NONCONN_IND, BLE_GAP_ADV_TYPE_ADV_SCAN_IND, BLE_GAP_ADV_TYPE_ADV_HIGH_DIRECT_IND, BLE_GAP_ADV_TYPE_ADV_LOW_DIRECT_IND }
| GAP advertising modes. More...
enum | ble_gap_disc_mode_t { BLE_GAP_DISC_MODE_NON_DISCOVERABLE = 0, BLE_GAP_DISC_MODE_GEN_DISCOVERABLE, BLE_GAP_DISC_MODE_LIM_DISCOVERABLE, BLE_GAP_DISC_MODE_BROADCASTER }
| GAP discoverability modes. More...
enum | ble_gap_adv_filter_policy_t { BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_ANY = 0, BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_ANY, BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_WLST, BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_WLST }
| Advertising filter policy. More...
enum | ble_gap_le_phy_value_t { BLE_GAP_PHY_UNDEF_VALUE = 0, BLE_GAP_PHY_1MBPS_VALUE = 1, BLE_GAP_PHY_2MBPS_VALUE = 2, BLE_GAP_PHY_CODED_VALUE = 3 }
| Specify what PHY the Controller has changed for TX/RX. HCI:7.7.65.12. More...
enum | ble_gap_adv_type_t { BLE_GAP_ADV_TYPE_LEGACY = 0, BLE_GAP_ADV_TYPE_EXTENDED, BLE_GAP_ADV_TYPE_PERIODIC }
| Advertising type. More...
enum | ble_gap_adv_prop_pos_t { BLE_GAP_ADV_PROP_CONNECTABLE_POS = 0, BLE_GAP_ADV_PROP_SCANNABLE_POS, BLE_GAP_ADV_PROP_DIRECTED_POS, BLE_GAP_ADV_PROP_HDC_POS, BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_POS, BLE_GAP_ADV_PROP_ANONYMOUS_POS, BLE_GAP_ADV_PROP_TX_PWR_POS, BLE_GAP_ADV_PROP_PER_TX_PWR_POS, BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_POS }
| Advertising properties bit field and bit positions. More...
enum | ble_gap_adv_prop_t { BLE_GAP_ADV_PROP_CONNECTABLE_BIT = CO_BIT(BLE_GAP_ADV_PROP_CONNECTABLE_POS), BLE_GAP_ADV_PROP_SCANNABLE_BIT = CO_BIT(BLE_GAP_ADV_PROP_SCANNABLE_POS), BLE_GAP_ADV_PROP_DIRECTED_BIT = CO_BIT(BLE_GAP_ADV_PROP_DIRECTED_POS), BLE_GAP_ADV_PROP_HDC_BIT = CO_BIT(BLE_GAP_ADV_PROP_HDC_POS), BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_BIT = CO_BIT(BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_POS), BLE_GAP_ADV_PROP_ANONYMOUS_BIT = CO_BIT(BLE_GAP_ADV_PROP_ANONYMOUS_POS), BLE_GAP_ADV_PROP_TX_PWR_BIT = CO_BIT(BLE_GAP_ADV_PROP_TX_PWR_POS), BLE_GAP_ADV_PROP_PER_TX_PWR_BIT = CO_BIT(BLE_GAP_ADV_PROP_PER_TX_PWR_POS), BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_BIT = CO_BIT(BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_POS) }
| Advertising properties bit field bit value. More...
enum | ble_gap_scan_type_t { BLE_GAP_SCAN_ACTIVE = 0, BLE_GAP_SCAN_PASSIVE }
| Scanning types. More...
enum | ble_gap_scan_mode_t { BLE_GAP_SCAN_GEN_DISC_MODE = 0, BLE_GAP_SCAN_LIM_DISC_MODE, BLE_GAP_SCAN_OBSERVER_MODE }
| Scanning modes. More...
enum | ble_gap_scan_dup_filt_policy_t { BLE_GAP_SCAN_FILT_DUPLIC_DIS = 0, BLE_GAP_SCAN_FILT_DUPLIC_EN }
| Duplicate filter policy. More...
enum | ble_gap_ext_scan_type_t { BLE_GAP_EXT_SCAN_TYPE_GEN_DISC = 0, BLE_GAP_EXT_SCAN_TYPE_LIM_DISC, BLE_GAP_EXT_SCAN_TYPE_OBSERVER, BLE_GAP_EXT_SCAN_TYPE_SEL_OBSERVER, BLE_GAP_EXT_SCAN_TYPE_CONN_DISC, BLE_GAP_EXT_SCAN_TYPE_SEL_CONN_DISC }
| Extended scanning types. More...
enum | ble_gap_scan_prop_t { BLE_GAP_EXT_SCAN_PROP_PHY_1M_BIT = (1 << 0), BLE_GAP_EXT_SCAN_PROP_PHY_CODED_BIT = (1 << 1), BLE_GAP_EXT_SCAN_PROP_ACTIVE_1M_BIT = (1 << 2), BLE_GAP_EXT_SCAN_PROP_ACTIVE_CODED_BIT = (1 << 3), BLE_GAP_EXT_SCAN_PROP_ACCEPT_RPA_BIT = (1 << 4), BLE_GAP_EXT_SCAN_PROP_FILT_TRUNC_BIT = (1 << 5) }
| Scanning properties bit field bit value. More...
enum | ble_gap_ext_scan_dup_filt_policy_t { BLE_GAP_EXT_DUP_FILT_DIS = 0, BLE_GAP_EXT_DUP_FILT_EN, BLE_GAP_EXT_DUP_FILT_EN_PERIOD }
| Filtering policy for duplicated packets. More...
enum | ble_gap_init_type_t { BLE_GAP_INIT_TYPE_DIRECT_CONN_EST = 0, BLE_GAP_INIT_TYPE_AUTO_CONN_EST, BLE_GAP_INIT_TYPE_NAME_DISC }
| Initiating types. More...
enum | ble_gap_init_prop_t { BLE_GAP_INIT_PROP_1M_BIT = (1 << 0), BLE_GAP_INIT_PROP_2M_BIT = (1 << 1), BLE_GAP_INIT_PROP_CODED_BIT = (1 << 2) }
| Initiating properties. More...
enum | ble_gap_per_sync_type_t { BLE_GAP_PER_SYNC_TYPE_GENERAL = 0, BLE_GAP_PER_SYNC_TYPE_SELECTIVE, BLE_GAP_PER_SYNC_TYPE_PAST }
| Periodic synchronization types. More...
enum | gap_sync_cte_type { BLE_GAP_NO_SYNC_IGNORE = 0, BLE_GAP_NO_SYNC_WITH_AOA = (1 << 0), BLE_GAP_NO_SYNC_WITH_AOD_1US_SLOT = (1 << 1), BLE_GAP_NO_SYNC_WITH_AOD_2US_SLOT = (1 << 2), BLE_GAP_NO_SYNC_WITHOUT_CTE = (1 << 4) }
| Constant Tone Extension sync filtering type. More...
enum | gap_per_adv_sync_info_rec_mode { BLE_GAP_SYNC_REP_DIS = 0x01, BLE_GAP_SYNC_REP_EN = 0x02, BLE_GAP_SYNC_REP_EN_DUP = 0x03 }
| Periodic advertising sync information reception mode. More...
enum | gap_switch_sampling_rate { BLE_GAP_AOD_TX_1_US = (1 << 0), BLE_GAP_AOD_RX_1_US = (1 << 1), BLE_GAP_AOA_RX_1_US = (1 << 2) }
| Supported AoA AoD switching sampling rate. More...
enum | gap_slot_dur_type { BLE_GAP_SLOT_DURA_1US = 0x01, BLE_GAP_SLOT_DURA_2US = 0x02 }
| Slot duration type for IQ sampling. More...
enum | gap_sec_lvl_type { BLE_GAP_SEC_LVL_NO_SECURITY = 0, BLE_GAP_SEC_LVL_ENC_NO_AUTH, BLE_GAP_SEC_LVL_LE_ENC_AUTH, BLE_GAP_SEC_LVL_SC_ENC_AUTH }
| Security level types. More...
enum | ble_gap_ad_type_t { BLE_GAP_AD_TYPE_FLAGS = 0x01, BLE_GAP_AD_TYPE_MORE_16_BIT_UUID = 0x02, BLE_GAP_AD_TYPE_COMPLETE_LIST_16_BIT_UUID = 0x03, BLE_GAP_AD_TYPE_MORE_32_BIT_UUID = 0x04, BLE_GAP_AD_TYPE_COMPLETE_LIST_32_BIT_UUID = 0x05, BLE_GAP_AD_TYPE_MORE_128_BIT_UUID = 0x06, BLE_GAP_AD_TYPE_COMPLETE_LIST_128_BIT_UUID = 0x07, BLE_GAP_AD_TYPE_SHORTENED_NAME = 0x08, BLE_GAP_AD_TYPE_COMPLETE_NAME = 0x09, BLE_GAP_AD_TYPE_TRANSMIT_POWER = 0x0A, BLE_GAP_AD_TYPE_CLASS_OF_DEVICE = 0x0D, BLE_GAP_AD_TYPE_SP_HASH_C = 0x0E, BLE_GAP_AD_TYPE_SP_RANDOMIZER_R = 0x0F, BLE_GAP_AD_TYPE_TK_VALUE = 0x10, BLE_GAP_AD_TYPE_OOB_FLAGS = 0x11, BLE_GAP_AD_TYPE_SLAVE_CONN_INT_RANGE = 0x12, BLE_GAP_AD_TYPE_RQRD_16_BIT_SVC_UUID = 0x14, BLE_GAP_AD_TYPE_RQRD_32_BIT_SVC_UUID = 0x1F, BLE_GAP_AD_TYPE_RQRD_128_BIT_SVC_UUID = 0x15, BLE_GAP_AD_TYPE_SERVICE_16_BIT_DATA = 0x16, BLE_GAP_AD_TYPE_SERVICE_32_BIT_DATA = 0x20, BLE_GAP_AD_TYPE_SERVICE_128_BIT_DATA = 0x21, BLE_GAP_AD_TYPE_PUB_TGT_ADDR = 0x17, BLE_GAP_AD_TYPE_RAND_TGT_ADDR = 0x18, BLE_GAP_AD_TYPE_APPEARANCE = 0x19, BLE_GAP_AD_TYPE_ADV_INTV = 0x1A, BLE_GAP_AD_TYPE_LE_BT_ADDR = 0x1B, BLE_GAP_AD_TYPE_LE_ROLE = 0x1C, BLE_GAP_AD_TYPE_SPAIR_HASH = 0x1D, BLE_GAP_AD_TYPE_SPAIR_RAND = 0x1E, BLE_GAP_AD_TYPE_3D_INFO = 0x3D, BLE_GAP_AD_TYPE_MANU_SPECIFIC_DATA = 0xFF }
| GAP advertising types. More...
enum | ble_gap_adv_flags_t { BLE_GAP_ADV_FLAG_LE_LIMITED_DISC_MODE = 0x01, BLE_GAP_ADV_FLAG_LE_GENERAL_DISC_MODE = 0x02, BLE_GAP_ADV_FLAG_BR_EDR_NOT_SUPPORTED = 0x04, BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_CONTROLLER = 0x08, BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_HOST = 0x10 }
| AD Type Flag - Bit mask. More...
enum | ble_gap_privacy_mode_t { BLE_GAP_PRIVACY_MODE_NETWORK = 0x00, BLE_GAP_PRIVACY_MODE_DEVICE = 0x01 }
| Privacy mode. More...
enum | ble_gap_actv_role_t { BLE_GAP_ACTIVITY_ROLE_ADV = 0, BLE_GAP_ACTIVITY_ROLE_CON = 1, BLE_GAP_ACTIVITY_ROLE_SCAN_INIT = 2, BLE_GAP_ACTIVITY_ROLE_UNKNOWN = 0xf }
| Possible roles of the activity. More...
enum | ble_gap_actv_type_t { BLE_GAP_ACTV_TYPE_ADV = 0, BLE_GAP_ACTV_TYPE_SCAN, BLE_GAP_ACTV_TYPE_INIT, BLE_GAP_ACTV_TYPE_PER_SYNC }
| Activity type. More...

## Detailed Description

## Enumeration Type Documentation

## ◆ ble_gap_actv_role_t

enum ble_gap_actv_role_t

Possible roles of the activity.

Enumerator
BLE_GAP_ACTIVITY_ROLE_ADV | Adertise role.
BLE_GAP_ACTIVITY_ROLE_CON | Connect role.
BLE_GAP_ACTIVITY_ROLE_SCAN_INIT | Scann role.
BLE_GAP_ACTIVITY_ROLE_UNKNOWN | Unknown role.

Definition at line 511 of file ble_gapm.h.

## ◆ ble_gap_actv_type_t

enum ble_gap_actv_type_t

Activity type.

Enumerator
BLE_GAP_ACTV_TYPE_ADV |
BLE_GAP_ACTV_TYPE_SCAN |
BLE_GAP_ACTV_TYPE_INIT |
BLE_GAP_ACTV_TYPE_PER_SYNC |

Definition at line 522 of file ble_gapm.h.

## ◆ ble_gap_ad_type_t

enum ble_gap_ad_type_t

GAP advertising types.

Enumerator
BLE_GAP_AD_TYPE_FLAGS | Flag.
BLE_GAP_AD_TYPE_MORE_16_BIT_UUID | Use of more than 16-bit UUID.
BLE_GAP_AD_TYPE_COMPLETE_LIST_16_BIT_UUID | Complete List of 16-bit UUID.
BLE_GAP_AD_TYPE_MORE_32_BIT_UUID | Use of more than 32-bit UUD.
BLE_GAP_AD_TYPE_COMPLETE_LIST_32_BIT_UUID | Complete List of 32-bit UUID.
BLE_GAP_AD_TYPE_MORE_128_BIT_UUID | Use of more than 128-bit UUID.
BLE_GAP_AD_TYPE_COMPLETE_LIST_128_BIT_UUID | Complete List of 128-bit UUID.
BLE_GAP_AD_TYPE_SHORTENED_NAME | Shortened Device name.
BLE_GAP_AD_TYPE_COMPLETE_NAME | Complete Device name.
BLE_GAP_AD_TYPE_TRANSMIT_POWER | Transmit power.
BLE_GAP_AD_TYPE_CLASS_OF_DEVICE | Class of device.
BLE_GAP_AD_TYPE_SP_HASH_C | Simple Pairing Hash C.
BLE_GAP_AD_TYPE_SP_RANDOMIZER_R | Simple Pairing Randomizer.
BLE_GAP_AD_TYPE_TK_VALUE | Temporary key value.
BLE_GAP_AD_TYPE_OOB_FLAGS | Out of Band Flag.
BLE_GAP_AD_TYPE_SLAVE_CONN_INT_RANGE | Slave connection interval range.
BLE_GAP_AD_TYPE_RQRD_16_BIT_SVC_UUID | Require 16-bit service UUID.
BLE_GAP_AD_TYPE_RQRD_32_BIT_SVC_UUID | Require 32-bit service UUID.
BLE_GAP_AD_TYPE_RQRD_128_BIT_SVC_UUID | Require 128-bit service UUID.
BLE_GAP_AD_TYPE_SERVICE_16_BIT_DATA | Service data 16-bit UUID.
BLE_GAP_AD_TYPE_SERVICE_32_BIT_DATA | Service data 32-bit UUID.
BLE_GAP_AD_TYPE_SERVICE_128_BIT_DATA | Service data 128-bit UUID.
BLE_GAP_AD_TYPE_PUB_TGT_ADDR | Public Target Address.
BLE_GAP_AD_TYPE_RAND_TGT_ADDR | Random Target Address.
BLE_GAP_AD_TYPE_APPEARANCE | Appearance.
BLE_GAP_AD_TYPE_ADV_INTV | Advertising Interval.
BLE_GAP_AD_TYPE_LE_BT_ADDR | LE Bluetooth Device Address.
BLE_GAP_AD_TYPE_LE_ROLE | LE Role.
BLE_GAP_AD_TYPE_SPAIR_HASH | Simple Pairing Hash C-256.
BLE_GAP_AD_TYPE_SPAIR_RAND | Simple Pairing Randomizer R-256.
BLE_GAP_AD_TYPE_3D_INFO | 3D Information Data.
BLE_GAP_AD_TYPE_MANU_SPECIFIC_DATA | Manufacturer specific data.

Definition at line 449 of file ble_gapm.h.

## ◆ ble_gap_adv_data_type_t

enum ble_gap_adv_data_type_t

Advertising data type.

Enumerator
BLE_GAP_ADV_DATA_TYPE_DATA | Advertising data.
BLE_GAP_ADV_DATA_TYPE_SCAN_RSP | Scan response data.
BLE_GAP_ADV_DATA_TYPE_PER_DATA | Periodic advertising data.

Definition at line 183 of file ble_gapm.h.

## ◆ ble_gap_adv_filter_policy_t

enum ble_gap_adv_filter_policy_t

Advertising filter policy.

Enumerator
BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_ANY | Allow both scan and connection requests from anyone.
BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_ANY | Allow scan req from white-list devices only and connection req from anyone.
BLE_GAP_ADV_ALLOW_SCAN_ANY_CON_WLST | Allow scan req from anyone and connection req from white-list devices only.
BLE_GAP_ADV_ALLOW_SCAN_WLST_CON_WLST | Allow scan and connection requests from white-list devices only.

Definition at line 232 of file ble_gapm.h.

## ◆ ble_gap_adv_flags_t

enum ble_gap_adv_flags_t

AD Type Flag - Bit mask.

Enumerator
BLE_GAP_ADV_FLAG_LE_LIMITED_DISC_MODE | Limited discovery flag: AD Flag.
BLE_GAP_ADV_FLAG_LE_GENERAL_DISC_MODE | General discovery flag: AD Flag.
BLE_GAP_ADV_FLAG_BR_EDR_NOT_SUPPORTED | Legacy BT not supported: AD Flag.
BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_CONTROLLER | Dual mode for controller supported (BR/EDR/LE): AD Flag.
BLE_GAP_ADV_FLAG_SIMUL_BR_EDR_LE_HOST | Dual mode for host supported (BR/EDR/LE): AD Flag.

Definition at line 489 of file ble_gapm.h.

## ◆ ble_gap_adv_mode_t

enum ble_gap_adv_mode_t

GAP advertising modes.

Enumerator
BLE_GAP_ADV_TYPE_ADV_IND | Undirected connectable and scannable mode.
BLE_GAP_ADV_TYPE_ADV_NONCONN_IND | Non-connectable and non-scanable mode.
BLE_GAP_ADV_TYPE_ADV_SCAN_IND | Undirected scannable mode.
BLE_GAP_ADV_TYPE_ADV_HIGH_DIRECT_IND | Directed high duty cycle mode.
BLE_GAP_ADV_TYPE_ADV_LOW_DIRECT_IND | Directed low duty cycle mode.

Definition at line 211 of file ble_gapm.h.

## ◆ ble_gap_adv_prop_pos_t

enum ble_gap_adv_prop_pos_t

Advertising properties bit field and bit positions.

Enumerator
BLE_GAP_ADV_PROP_CONNECTABLE_POS | Indicate that advertising is connectable, reception of CONNECT_REQ or UX_CONNECT_REQ PDUs is accepted. Not applicable for periodic advertising.
BLE_GAP_ADV_PROP_SCANNABLE_POS | Indicate that advertising is scannable, reception of SCAN_REQ or AUX_SCAN_REQ PDUs is accepted.
BLE_GAP_ADV_PROP_DIRECTED_POS | Indicate that advertising targets at a specific device. Only applicable in following cases: Legacy advertising: if connectable Extended advertising: connectable or (non-connectable and non-discoverable).
BLE_GAP_ADV_PROP_HDC_POS | Indicate that High Duty Cycle has to be used for advertising on primary channel, applicable only if created advertising is not an extended advertising.
BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_POS | Use legacy advertising PDUs.
BLE_GAP_ADV_PROP_ANONYMOUS_POS | Enable anonymous mode. Device address will not appear in sending PDUs. Valid only if the created advertising is an extended advertising.
BLE_GAP_ADV_PROP_TX_PWR_POS | Include TX power in the extended header of the advertising PDU. Valid only if the created advertising is not a legacy advertising.
BLE_GAP_ADV_PROP_PER_TX_PWR_POS | Include TX power in the periodic advertising PDU. Valid only if the created advertising is a periodic advertising.
BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_POS | Indicate if application must be informed about receiving scan request PDUs.

Definition at line 264 of file ble_gapm.h.

## ◆ ble_gap_adv_prop_t

enum ble_gap_adv_prop_t

Advertising properties bit field bit value.

Enumerator
BLE_GAP_ADV_PROP_CONNECTABLE_BIT |
BLE_GAP_ADV_PROP_SCANNABLE_BIT |
BLE_GAP_ADV_PROP_DIRECTED_BIT |
BLE_GAP_ADV_PROP_HDC_BIT |
BLE_GAP_ADV_PROP_USE_LEGACY_PDUS_BIT |
BLE_GAP_ADV_PROP_ANONYMOUS_BIT |
BLE_GAP_ADV_PROP_TX_PWR_BIT |
BLE_GAP_ADV_PROP_PER_TX_PWR_BIT |
BLE_GAP_ADV_PROP_SCAN_REQ_NTF_EN_BIT |

Definition at line 287 of file ble_gapm.h.

## ◆ ble_gap_adv_type_t

enum ble_gap_adv_type_t

Advertising type.

Enumerator
BLE_GAP_ADV_TYPE_LEGACY | Legacy advertising.
BLE_GAP_ADV_TYPE_EXTENDED | Extended advertising.
BLE_GAP_ADV_TYPE_PERIODIC | Periodic advertising.

Definition at line 254 of file ble_gapm.h.

## ◆ ble_gap_dev_info_get_type_t

enum ble_gap_dev_info_get_type_t

Get device parameters operation code.

Enumerator
BLE_GAP_GET_DEV_VERSION | Get version information for the local Controller.
BLE_GAP_GET_DEV_BDADDR | Get local device BD Address.
BLE_GAP_GET_SUGGESTED_DFLT_LE_DATA_LEN | Get suggested values (SuggestedMaxTxOctets and SuggestedMaxTxTime) for the Controller's maximum transmitted number of payload octets and maximum packet transmission time to be used for new connections.
BLE_GAP_GET_MAX_LE_DATA_LEN | Get the Controller' maximum supported payload octets and packet duration times for transmission and reception (supportedMaxTxOctets and supportedMaxTxTime, supportedMaxRxOctets, and supportedMaxRxTime).
BLE_GAP_GET_NB_ADV_SETS | Read the maximum number of advertising sets currently supported by the controller.
BLE_GAP_GET_MAX_LE_ADV_DATA_LEN | Get maximum data length for advertising data.
BLE_GAP_GET_DEV_TX_POWER | Read the minimum and maximum transmit powers supported by the Controller.
BLE_GAP_GET_DEV_RF_RF_PATH_COMP | Get RF path compensation values.
BLE_GAP_GET_ANTENNA_INFO | Get antenna information.

Definition at line 192 of file ble_gapm.h.

## ◆ ble_gap_dev_name_write_perm_t

enum ble_gap_dev_name_write_perm_t

Write permissions of the device name characteristic.

Enumerator
BLE_GAP_WRITE_PERM_DISABLE | Disable write access.
BLE_GAP_WRITE_PERM_NOAUTH | LE Security Mode 1, Level 1. Link does not need to be encrypted or authenticated.
BLE_GAP_WRITE_PERM_UNAUTH | LE Security Mode 1, Level 2. Link needs to be encrypted, but not to be authenticated.
BLE_GAP_WRITE_PERM_AUTH | LE Security Mode 1, Level 3. Link needs to be encrypted and authenticated (MITM).
BLE_GAP_WRITE_PERM_SEC_CON | LE Security Mode 1, Level 4. Link needs to be encrypted and authenticated (secure connections).

Definition at line 171 of file ble_gapm.h.

## ◆ ble_gap_disc_mode_t

enum ble_gap_disc_mode_t

GAP discoverability modes.

Enumerator
BLE_GAP_DISC_MODE_NON_DISCOVERABLE | Non-discoverable mode.
BLE_GAP_DISC_MODE_GEN_DISCOVERABLE | General-discoverable mode.
BLE_GAP_DISC_MODE_LIM_DISCOVERABLE | Limited-discoverable mode.
BLE_GAP_DISC_MODE_BROADCASTER | Broadcaster mode.

Definition at line 221 of file ble_gapm.h.

## ◆ ble_gap_ext_scan_dup_filt_policy_t

enum ble_gap_ext_scan_dup_filt_policy_t

Filtering policy for duplicated packets.

Enumerator
BLE_GAP_EXT_DUP_FILT_DIS | Disable filtering of duplicated packets.
BLE_GAP_EXT_DUP_FILT_EN | Enable filtering of duplicated packets.
BLE_GAP_EXT_DUP_FILT_EN_PERIOD | Enable filtering of duplicated packets, reset for each scan period.

Definition at line 357 of file ble_gapm.h.

## ◆ ble_gap_ext_scan_type_t

enum ble_gap_ext_scan_type_t

Extended scanning types.

Enumerator
BLE_GAP_EXT_SCAN_TYPE_GEN_DISC | General discovery.
BLE_GAP_EXT_SCAN_TYPE_LIM_DISC | Limited discovery.
BLE_GAP_EXT_SCAN_TYPE_OBSERVER | Observer.
BLE_GAP_EXT_SCAN_TYPE_SEL_OBSERVER | Selective observer.
BLE_GAP_EXT_SCAN_TYPE_CONN_DISC | Connectable discovery.
BLE_GAP_EXT_SCAN_TYPE_SEL_CONN_DISC | Selective connectable discovery.

Definition at line 331 of file ble_gapm.h.

## ◆ ble_gap_init_prop_t

enum ble_gap_init_prop_t

Initiating properties.

Enumerator
BLE_GAP_INIT_PROP_1M_BIT | Scan connectable advertisements on the LE 1M PHY. Connection parameters for the LE 1M PHY are provided.
BLE_GAP_INIT_PROP_2M_BIT | Connection parameters for the LE 2M PHY are provided.
BLE_GAP_INIT_PROP_CODED_BIT | Scan connectable advertisements on the LE Coded PHY. Connection parameters for the LE Coded PHY are provided.

Definition at line 377 of file ble_gapm.h.

## ◆ ble_gap_init_type_t

enum ble_gap_init_type_t

Initiating types.

Enumerator
BLE_GAP_INIT_TYPE_DIRECT_CONN_EST | Direct connection establishment: establish a connection with an indicated device.
BLE_GAP_INIT_TYPE_AUTO_CONN_EST | Automatic connection establishment: establish a connection with all devices whose address is present in the white list.
BLE_GAP_INIT_TYPE_NAME_DISC | Name discovery: establish a connection with an indicated device in order to read content of its device name characteristic. Connection is closed once this operation is stopped.

Definition at line 367 of file ble_gapm.h.

## ◆ ble_gap_le_phy_value_t

enum ble_gap_le_phy_value_t

Specify what PHY the Controller has changed for TX/RX. HCI:7.7.65.12.

Enumerator
BLE_GAP_PHY_UNDEF_VALUE | Undefined LE PHY.
BLE_GAP_PHY_1MBPS_VALUE | LE 1M PHY.
BLE_GAP_PHY_2MBPS_VALUE | LE 2M PHY.
BLE_GAP_PHY_CODED_VALUE | LE Coded PHY.

Definition at line 243 of file ble_gapm.h.

## ◆ ble_gap_own_addr_t

enum ble_gap_own_addr_t

Own BD address source of the device.

Enumerator
BLE_GAP_OWN_ADDR_STATIC | Public or Private Static Address according to device address configuration.
BLE_GAP_OWN_ADDR_GEN_RSLV | Generated resolvable private random address.
BLE_GAP_OWN_ADDR_GEN_NON_RSLV | Generated non-resolvable private random address.

Definition at line 161 of file ble_gapm.h.

## ◆ ble_gap_per_sync_type_t

enum ble_gap_per_sync_type_t

Periodic synchronization types.

Enumerator
BLE_GAP_PER_SYNC_TYPE_GENERAL | Do not use periodic advertiser list for synchronization.
BLE_GAP_PER_SYNC_TYPE_SELECTIVE | Use periodic advertiser list for synchronization.
BLE_GAP_PER_SYNC_TYPE_PAST | Use Periodic advertising sync transfer information send through connection for synchronization.

Definition at line 387 of file ble_gapm.h.

## ◆ ble_gap_privacy_mode_t

enum ble_gap_privacy_mode_t

Privacy mode.

Enumerator
BLE_GAP_PRIVACY_MODE_NETWORK | Set to the network privacy mode for the peer device.
BLE_GAP_PRIVACY_MODE_DEVICE | Set to the device privacy mode for the peer device.

Definition at line 502 of file ble_gapm.h.

## ◆ ble_gap_role_t

enum ble_gap_role_t

GAP role options.

Enumerator
BLE_GAP_ROLE_NONE | No role set yet.
BLE_GAP_ROLE_OBSERVER | Observer role.
BLE_GAP_ROLE_BROADCASTER | Broadcaster role.
BLE_GAP_ROLE_CENTRAL | Master/Central role.
BLE_GAP_ROLE_PERIPHERAL | Peripheral/Slave role.
BLE_GAP_ROLE_ALL | Device has all roles, both peripheral and central.

Definition at line 148 of file ble_gapm.h.

## ◆ ble_gap_scan_dup_filt_policy_t

enum ble_gap_scan_dup_filt_policy_t

Duplicate filter policy.

Enumerator
BLE_GAP_SCAN_FILT_DUPLIC_DIS | Disable filtering of duplicate packets.
BLE_GAP_SCAN_FILT_DUPLIC_EN | Enable filtering of duplicate packets.

Definition at line 322 of file ble_gapm.h.

## ◆ ble_gap_scan_mode_t

enum ble_gap_scan_mode_t

Scanning modes.

Enumerator
BLE_GAP_SCAN_GEN_DISC_MODE | General discoverable mode.
BLE_GAP_SCAN_LIM_DISC_MODE | Limited discoverable mode.
BLE_GAP_SCAN_OBSERVER_MODE | Observer mode.

Definition at line 312 of file ble_gapm.h.

## ◆ ble_gap_scan_prop_t

enum ble_gap_scan_prop_t

Scanning properties bit field bit value.

Enumerator
BLE_GAP_EXT_SCAN_PROP_PHY_1M_BIT | Scan advertisement on the LE 1M PHY.
BLE_GAP_EXT_SCAN_PROP_PHY_CODED_BIT | Scan advertisement on the LE Coded PHY.
BLE_GAP_EXT_SCAN_PROP_ACTIVE_1M_BIT | Active scan on LE 1M PHY (scan request PDUs may be sent).
BLE_GAP_EXT_SCAN_PROP_ACTIVE_CODED_BIT | Active scan on LE Coded PHY (scan request PDUs may be sent).
BLE_GAP_EXT_SCAN_PROP_ACCEPT_RPA_BIT | Accept directed advertising packets if the uesd RPA and target address cannot be solved by the controller.
BLE_GAP_EXT_SCAN_PROP_FILT_TRUNC_BIT | Filter truncated advertising or scan response reports.

Definition at line 344 of file ble_gapm.h.

## ◆ ble_gap_scan_type_t

enum ble_gap_scan_type_t

Scanning types.

Enumerator
BLE_GAP_SCAN_ACTIVE | Active scan type.
BLE_GAP_SCAN_PASSIVE | Passive scan type.

Definition at line 303 of file ble_gapm.h.

## ◆ gap_per_adv_sync_info_rec_mode

enum gap_per_adv_sync_info_rec_mode

Periodic advertising sync information reception mode.

Enumerator
BLE_GAP_SYNC_REP_DIS | synchronize to the periodic advertising, per adv report events will be disabled.
BLE_GAP_SYNC_REP_EN | synchronize to the periodic advertising, per adv report events will be enabled, duplicate filtering disabled.
BLE_GAP_SYNC_REP_EN_DUP | synchronize to the periodic advertising, per adv report events will be enabled, duplicate filtering enabled.

Definition at line 409 of file ble_gapm.h.

## ◆ gap_sec_lvl_type

enum gap_sec_lvl_type

Security level types.

Enumerator
BLE_GAP_SEC_LVL_NO_SECURITY | No encryption or auth.
BLE_GAP_SEC_LVL_ENC_NO_AUTH | Encryption with no auth.
BLE_GAP_SEC_LVL_LE_ENC_AUTH | Legacy encryption with auth.
BLE_GAP_SEC_LVL_SC_ENC_AUTH | Security connection encryption with auth.

Definition at line 438 of file ble_gapm.h.

## ◆ gap_slot_dur_type

enum gap_slot_dur_type

Slot duration type for IQ sampling.

Enumerator
BLE_GAP_SLOT_DURA_1US | Switching and sampling slots are 1 us each.
BLE_GAP_SLOT_DURA_2US | Switching and sampling slots are 2 us each.

Definition at line 429 of file ble_gapm.h.

## ◆ gap_switch_sampling_rate

enum gap_switch_sampling_rate

Supported AoA AoD switching sampling rate.

Enumerator
BLE_GAP_AOD_TX_1_US | 1 us switching supported for AoD transmission.
BLE_GAP_AOD_RX_1_US | 1 us switching supported for AoD reception.
BLE_GAP_AOA_RX_1_US | 1 us switching and sampling supported for AoA reception.

Definition at line 419 of file ble_gapm.h.

## ◆ gap_sync_cte_type

enum gap_sync_cte_type

Constant Tone Extension sync filtering type.

Enumerator
BLE_GAP_NO_SYNC_IGNORE | The presence or absence of a Constant Tone Extension is irrelevant.
BLE_GAP_NO_SYNC_WITH_AOA | Do not sync to packets with an AoA Constant Tone Extension.
BLE_GAP_NO_SYNC_WITH_AOD_1US_SLOT | Do not sync to packets with an AoD Constant Tone Extension with 1us slots.
BLE_GAP_NO_SYNC_WITH_AOD_2US_SLOT | Do not sync to packets with an AoD Constant Tone Extension with 2us slots.
BLE_GAP_NO_SYNC_WITHOUT_CTE | Do not sync to packets without a Constant Tone Extension.

Definition at line 397 of file ble_gapm.h.