Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
COMMON

Macros

#define AT_BLE_ADDR_LEN   6
 BLE address length. More...
 
#define AT_BLE_ADV_INTERVAL_MAX   0x4000
 Maximum Advertising interval in 625 us units, i.e. More...
 
#define AT_BLE_ADV_INTERVAL_MIN   0x0020
 Minimum Advertising interval in 625 us units, i.e. More...
 
#define AT_BLE_ADV_MAX_SIZE   31
 Maximum size of advertising data in octets. More...
 
#define AT_BLE_ADV_NONCON_INTERVAL_MIN   0x00A0
 Minimum Advertising interval in 625 us units for non connectable mode, i.e. More...
 
#define AT_BLE_GAP_WHITELIST_ADDR_MAX_COUNT   (8)
 Maximum amount of addresses in a white-list. More...
 
#define AT_BLE_GAP_WHITELIST_IRK_MAX_COUNT   (8)
 Maximum amount of IRKs in a white-list. More...
 
#define AT_BLE_MAX_ATT_LEN   512
 ATT Maximum Attribute Length. More...
 
#define AT_BLE_MAX_KEY_LEN   (16)
 BLE security key maximum length. More...
 
#define AT_BLE_PASSKEY_LEN   (6)
 GAP Security Key Length. More...
 
#define AT_BLE_SCAN_INTERVAL_MAX   0x4000
 Maximum scanning interval in 625 us units , i.e. More...
 
#define AT_BLE_SCAN_INTERVAL_MIN   0x0004
 Minimum scanning interval in 625 us units , i.e. More...
 
#define AT_BLE_SCAN_WINDOW_MAX   0x4000
 Maximum scanning window in 625 us units , i.e. More...
 
#define AT_BLE_SCAN_WINDOW_MIN   0x0004
 Minimum scanning window in 625 us units , i.e. More...
 
#define AT_BLE_UUID_128_LEN   (16)
 UUID 128 size in bytes. More...
 
#define AT_BLE_UUID_16_LEN   (2)
 UUID 16 size in bytes. More...
 
#define AT_BLE_UUID_32_LEN   (4)
 UUID 32 size in bytes. More...
 
#define AT_CNX_INTERVAL_MAX   3200
 Maximum Connection interval in 1.250ms units, i.e. More...
 
#define AT_CNX_INTERVAL_MIN   6
 Minimum Connection interval in 1.250ms units, i.e. More...
 
#define AT_CNX_LATENCY_MAX   499
 Maximum Connection latency (number of connection events that may be missed). More...
 
#define AT_CNX_LATENCY_MIN   0
 Minimum Connection latency (number of connection events that may be missed). More...
 
#define AT_CNX_SUP_TO_MAX   3200
 Maximum Supervision timeout in 10ms units, i.e. More...
 
#define AT_CNX_SUP_TO_MIN   10
 Minimum Supervision timeout in 10ms units, i.e. More...
 
#define AT_DEFAULT_MTU   0x0017
 Maximum Transmission Unit. More...
 

Typedefs

typedef uint16_t at_ble_handle_t
 BLE connection handle. More...
 

Enumerations

enum  at_ble_addr_type_t {
  AT_BLE_ADDRESS_PUBLIC,
  AT_BLE_ADDRESS_RANDOM_STATIC,
  AT_BLE_ADDRESS_RANDOM_PRIVATE_RESOLVABLE,
  AT_BLE_ADDRESS_RANDOM_PRIVATE_NON_RESOLVABLE,
  AT_BLE_ADDRESS_INVALID
}
 BLE can accept either public or random addresses. More...
 
enum  at_ble_adv_mode_t {
  AT_BLE_ADV_NON_DISCOVERABLE,
  AT_BLE_ADV_GEN_DISCOVERABLE,
  AT_BLE_ADV_LIM_DISCOVERABLE,
  AT_BLE_ADV_BROADCASTER_MODE
}
 Advertising Mode. More...
 
enum  at_ble_adv_type_t {
  AT_BLE_ADV_TYPE_UNDIRECTED = 0x00,
  AT_BLE_ADV_TYPE_DIRECTED,
  AT_BLE_ADV_TYPE_SCANNABLE_UNDIRECTED,
  AT_BLE_ADV_TYPE_NONCONN_UNDIRECTED,
  AT_BLE_ADV_TYPE_SCAN_RESPONSE
}
 GAP Advertising types. More...
 
enum  at_ble_att_write_perm_t {
  AT_BLE_WRITE_DISABLE,
  AT_BLE_WRITE_ENABLE,
  AT_BLE_WRITE_UNAUTH,
  AT_BLE_WRITE_AUTH
}
 Write access. More...
 
enum  at_ble_attr_permissions_t {
  AT_BLE_ATTR_NO_PERMISSIONS = 0x00,
  AT_BLE_ATTR_READABLE_NO_AUTHN_NO_AUTHR = 0x01,
  AT_BLE_ATTR_READABLE_REQ_AUTHN_NO_AUTHR = 0x02,
  AT_BLE_ATTR_READABLE_NO_AUTHN_REQ_AUTHR = 0x03,
  AT_BLE_ATTR_READABLE_REQ_AUTHN_REQ_AUTHR = 0x04,
  AT_BLE_ATTR_WRITABLE_NO_AUTHN_NO_AUTHR = 0x10,
  AT_BLE_ATTR_WRITABLE_REQ_AUTHN_NO_AUTHR = 0x20,
  AT_BLE_ATTR_WRITABLE_NO_AUTHN_REQ_AUTHR = 0x30,
  AT_BLE_ATTR_WRITABLE_REQ_AUTHN_REQ_AUTHR = 0x40
}
 Attribute Permissions. More...
 
enum  at_ble_auth_levels_t {
  AT_BLE_NO_SEC = 0x00,
  AT_BLE_MODE1_L2_NOAUTH_PAIR_ENC,
  AT_BLE_MODE1_L3_AUTH_PAIR_ENC,
  AT_BLE_MODE2_L1_NOAUTH_DATA_SGN,
  AT_BLE_MODE2_L2_AUTH_DATA_SGN,
  AT_BLE_MODE1_L2_AUTH_PAIR_ENC
}
 Security authentication level. More...
 
enum  at_ble_auth_t {
  AT_BLE_AUTH_NO_MITM_NO_BOND,
  AT_BLE_AUTH_NO_MITM_BOND = 0x01,
  AT_BLE_AUTH_MITM_NO_BOND = 0x04,
  AT_BLE_AUTH_MITM_BOND = 0x05
}
 Authorization Types. More...
 
enum  at_ble_author_t {
  GAP_AUTHZ_NOT_SET = 0x00,
  GAP_AUTHZ_ACCEPT = 0x01,
  GAP_AUTHZ_REJECT = 0x02
}
 Authorization setting. More...
 
enum  at_ble_char_pres_format_t {
  AT_BLE_PRES_FORMAT_BOOLEAN = 0X01,
  AT_BLE_PRES_FORMAT_2BIT = 0X02,
  AT_BLE_PRES_FORMAT_NIBBLE = 0X03,
  AT_BLE_PRES_FORMAT_UINT8 = 0X04,
  AT_BLE_PRES_FORMAT_UINT12 = 0X05,
  AT_BLE_PRES_FORMAT_UINT16 = 0X06,
  AT_BLE_PRES_FORMAT_UINT24 = 0X07,
  AT_BLE_PRES_FORMAT_UINT32 = 0X08,
  AT_BLE_PRES_FORMAT_UINT48 = 0X09,
  AT_BLE_PRES_FORMAT_UINT64 = 0X0A,
  AT_BLE_PRES_FORMAT_UINT128 = 0X0B,
  AT_BLE_PRES_FORMAT_SINT8 = 0X0C,
  AT_BLE_PRES_FORMAT_SINT12 = 0X0D,
  AT_BLE_PRES_FORMAT_SINT16 = 0X0E,
  AT_BLE_PRES_FORMAT_SINT24 = 0X0F,
  AT_BLE_PRES_FORMAT_SINT32 = 0X10,
  AT_BLE_PRES_FORMAT_SINT48 = 0X11,
  AT_BLE_PRES_FORMAT_SINT64 = 0X12,
  AT_BLE_PRES_FORMAT_SINT128 = 0X13,
  AT_BLE_PRES_FORMAT_FLOAT32 = 0X14,
  AT_BLE_PRES_FORMAT_FLOAT64 = 0X15,
  AT_BLE_PRES_FORMAT_SFLOAT = 0X16,
  AT_BLE_PRES_FORMAT_FLOAT = 0X17,
  AT_BLE_PRES_FORMAT_DUINT16 = 0X18,
  AT_BLE_PRES_FORMAT_UTF8S = 0X19,
  AT_BLE_PRES_FORMAT_UTF16S = 0X1A,
  AT_BLE_PRES_FORMAT_STRUCT = 0X1B
}
 Presentation Formats. More...
 
enum  at_ble_char_properties_t {
  AT_BLE_CHAR_BROADCST = (1 << 0),
  AT_BLE_CHAR_READ = (1 << 1),
  AT_BLE_CHAR_WRITE_WITHOUT_RESPONSE = (1 << 2),
  AT_BLE_CHAR_WRITE = (1 << 3),
  AT_BLE_CHAR_NOTIFY = (1 << 4),
  AT_BLE_CHAR_INDICATE = (1 << 5),
  AT_BLE_CHAR_SIGNED_WRITE = (1 << 6),
  AT_BLE_CHAR_RELIABLE_WRITE = (1 << 7),
  AT_BLE_CHAR_WRITEABLE_AUX = (1 << 8)
}
 Characteristic properties (Each enum value is a single bit; multiple properties can be indicated simultaneously.) More...
 
enum  at_ble_disconnect_reason_t {
  AT_BLE_TERMINATED_BY_USER,
  AT_BLE_UNACCEPTABLE_INTERVAL
}
 Disconnection reasons. More...
 
enum  at_ble_events_t {
  AT_BLE_UNDEFINED_EVENT,
  AT_BLE_SCAN_INFO,
  AT_BLE_SCAN_REPORT,
  AT_BLE_RAND_ADDR_CHANGED,
  AT_BLE_CONNECTED,
  AT_BLE_DISCONNECTED,
  AT_BLE_CONN_PARAM_UPDATE_DONE,
  AT_BLE_CONN_PARAM_UPDATE_REQUEST,
  AT_BLE_RX_POWER_VALUE,
  AT_BLE_PAIR_DONE,
  AT_BLE_PAIR_REQUEST,
  AT_BLE_SLAVE_SEC_REQUEST,
  AT_BLE_PAIR_KEY_REQUEST,
  AT_BLE_ENCRYPTION_REQUEST,
  AT_BLE_ENCRYPTION_STATUS_CHANGED,
  AT_BLE_RESOLV_RAND_ADDR_STATUS,
  AT_BLE_PRIMARY_SERVICE_FOUND,
  AT_BLE_INCLUDED_SERVICE_FOUND,
  AT_BLE_CHARACTERISTIC_FOUND,
  AT_BLE_DESCRIPTOR_FOUND,
  AT_BLE_DISCOVERY_COMPLETE,
  AT_BLE_CHARACTERISTIC_READ_RESPONSE,
  AT_BLE_CHARACTERISTIC_READ_MULTIBLE_RESPONSE,
  AT_BLE_CHARACTERISTIC_WRITE_RESPONSE,
  AT_BLE_NOTIFICATION_RECEIVED,
  AT_BLE_INDICATION_RECEIVED,
  AT_BLE_INDICATION_CONFIRMED,
  AT_BLE_CHARACTERISTIC_CHANGED,
  AT_BLE_SERVICE_CHANGED_NOTIFICATION_CONFIRMED,
  AT_BLE_WRITE_AUTHORIZE_REQUEST,
  AT_BLE_READ_AUTHORIZE_REQUEST,
  AT_BLE_L2CAP_RX,
  AT_BLE_WIFIPROV_SCAN_MODE_CHANGE_IND = AT_BLE_L2CAP_RX+7,
  AT_BLE_WIFIPROV_COMPLETE_IND,
  AT_BLE_CUSTOM_EVENT,
  AT_BLE_TX_POWER_VALUE,
  AT_BLE_TX_POWER_SET,
  AT_BLE_MAX_PA_GAIN_VALUE,
  AT_BLE_MTU_CHANGED_CMD_COMPLETE,
  AT_BLE_CHARACTERISTIC_WRITE_CMD_CMP,
  AT_BLE_NOTIFICATION_CONFIRMED
}
 Events delivered from BLE stack to the application layer. More...
 
enum  at_ble_filter_type_t {
  AT_BLE_ADV_FP_ANY,
  AT_BLE_ADV_FP_FILTER_SCANREQ,
  AT_BLE_ADV_FP_FILTER_CONNREQ,
  AT_BLE_ADV_FP_FILTER_BOTH
}
 Advertising Filter Policy. More...
 
enum  at_ble_gap_role {
  AT_BLE_GAP_NO_ROLE = 0x00,
  AT_BLE_GAP_OBSERVER_SCA = 0x01,
  AT_BLE_GAP_BROADCASTER_ADV = 0x02,
  AT_BLE_GAP_CENTRAL_MST = (0x04 | AT_BLE_GAP_OBSERVER_SCA),
  AT_BLE_GAP_PERIPHERAL_SLV = (0x08 | AT_BLE_GAP_BROADCASTER_ADV)
}
 GAP Role. More...
 
enum  at_ble_gattc_discovery_complete_status_t {
  AT_BLE_DISCOVERY_SUCCESS =0x00,
  AT_BLE_DISCOVERY_FAILURE
}
 Discovery status. More...
 
enum  at_ble_iocab_t {
  AT_BLE_IO_CAP_DISPLAY_ONLY,
  AT_BLE_IO_CAP_DISPLAY_YES_NO,
  AT_BLE_IO_CAP_KB_ONLY,
  AT_BLE_IO_CAP_NO_INPUT_NO_OUTPUT,
  AT_BLE_IO_CAP_KB_DISPLAY
}
 IO capabilities of a device. More...
 
enum  at_ble_key_dis_t {
  AT_BLE_KEY_DIST_NONE = 0x00,
  AT_BLE_KEY_DIST_ENC = (1 << 0),
  AT_BLE_KEY_DIST_ID = (1 << 1),
  AT_BLE_KEY_DIST_SIGN = (1 << 2),
  AT_BLE_KEY_DIS_ALL
}
 Security keys distribution list. More...
 
enum  at_ble_pair_key_type_t {
  AT_BLE_PAIR_PASSKEY,
  AT_BLE_PAIR_OOB
}
 Pairing Key Types. More...
 
enum  at_ble_parameters_t {
  AT_BLE_GAP_GEN_DISC_ADV_MIN =0,
  AT_BLE_GAP_LIM_ADV_TIMEOUT,
  AT_BLE_GAP_GEN_DISC_SCAN,
  AT_BLE_GAP_LIM_DISC_SCAN,
  AT_BLE_GAP_CONN_EST_ADV_TIMEOUT,
  AT_BLE_GAP_CONN_PARAM_TIMEOUT,
  AT_BLE_GAP_LIM_DISC_ADV_INT_MIN,
  AT_BLE_GAP_LIM_DISC_ADV_INT_MAX,
  AT_BLE_GAP_GEN_DISC_ADV_INT_MIN,
  AT_BLE_GAP_GEN_DISC_ADV_INT_MAX,
  AT_BLE_GAP_CONN_ADV_INT_MIN,
  AT_BLE_GAP_CONN_ADV_INT_MAX,
  AT_BLE_GAP_CONN_SCAN_INT,
  AT_BLE_GAP_CONN_SCAN_WIND,
  AT_BLE_GAP_CONN_HIGH_SCAN_INT,
  AT_BLE_GAP_CONN_HIGH_SCAN_WIND,
  AT_BLE_GAP_GEN_DISC_SCAN_INT,
  AT_BLE_GAP_GEN_DISC_SCAN_WIND,
  AT_BLE_GAP_LIM_DISC_SCAN_INT,
  AT_BLE_GAP_LIM_DISC_SCAN_WIND,
  AT_BLE_GAP_CONN_EST_ADV,
  AT_BLE_GAP_CONN_EST_INT_MIN,
  AT_BLE_GAP_CONN_EST_INT_MAX,
  AT_BLE_GAP_CONN_EST_SCAN_INT,
  AT_BLE_GAP_CONN_EST_SCAN_WIND,
  AT_BLE_GAP_CONN_EST_SUPERV_TIMEOUT,
  AT_BLE_GAP_CONN_EST_LATENCY,
  AT_BLE_GAP_CONN_EST_MIN_CE_LEN,
  AT_BLE_GAP_CONN_EST_MAX_CE_LEN,
  AT_BLE_GAP_PRIVATE_ADDR_INT,
  AT_BLE_GAP_CONN_PAUSE_CENTRAL,
  AT_BLE_GAP_CONN_PAUSE_PERIPHERAL
}
 Enumeration for GAP Parameters. More...
 
enum  at_ble_passkey_type_t {
  AT_BLE_PAIR_PASSKEY_ENTRY,
  AT_BLE_PAIR_PASSKEY_DISPLAY
}
 Passkey Types. More...
 
enum  at_ble_prf_con_type_t {
  PRF_CON_DISCOVERY = 0x00,
  PRF_CON_NORMAL = 0x01
}
 Connection type. More...
 
enum  at_ble_scan_mode_t {
  AT_BLE_SCAN_GEN_DISCOVERY,
  AT_BLE_SCAN_LIM_DISCOVERY,
  AT_BLE_SCAN_OBSERVER_MODE
}
 Scan modes used at at_ble_scan_start. More...
 
enum  at_ble_scan_type_t {
  AT_BLE_SCAN_PASSIVE,
  AT_BLE_SCAN_ACTIVE
}
 Scan types used at at_ble_scan_start. More...
 
enum  at_ble_status_t {
  AT_BLE_SUCCESS =0,
  AT_BLE_FAILURE,
  AT_BLE_INVALID_PARAM,
  AT_BLE_PRIVACY_CFG_PB,
  AT_BLE_COMMAND_DISALLOWED,
  AT_BLE_INVALID_STATE,
  AT_BLE_INVALID_HANDLE,
  AT_BLE_INSUFF_RESOURCE,
  AT_BLE_INVALID_ATTRIBUTE_VAL_LEN,
  AT_BLE_TIMEOUT,
  AT_BLE_FW_INCOMPAT
}
 Enumeration for BLE Status. More...
 
enum  at_ble_uuid_type_t {
  AT_BLE_UUID_16,
  AT_BLE_UUID_32,
  AT_BLE_UUID_128,
  AT_BLE_UUID_INVALID
}
 UUID Type. More...
 

#define AT_BLE_ADV_INTERVAL_MAX   0x4000

Maximum Advertising interval in 625 us units, i.e.

10.24 s.

Referenced by at_ble_adv_start().

#define AT_BLE_ADV_INTERVAL_MIN   0x0020

Minimum Advertising interval in 625 us units, i.e.

20 ms.

Referenced by at_ble_adv_start().

#define AT_BLE_ADV_MAX_SIZE   31

Maximum size of advertising data in octets.

Referenced by at_ble_adv_data_set(), and gapm_adv_report_evt_handler().

#define AT_BLE_ADV_NONCON_INTERVAL_MIN   0x00A0

Minimum Advertising interval in 625 us units for non connectable mode, i.e.

100 ms.

Referenced by at_ble_adv_start().

#define AT_BLE_GAP_WHITELIST_ADDR_MAX_COUNT   (8)

Maximum amount of addresses in a white-list.

#define AT_BLE_GAP_WHITELIST_IRK_MAX_COUNT   (8)

Maximum amount of IRKs in a white-list.

Note
The number of IRKs is limited to 8, even if the hardware supports more.
#define AT_BLE_MAX_ATT_LEN   512

ATT Maximum Attribute Length.

#define AT_BLE_MAX_KEY_LEN   (16)

BLE security key maximum length.

Referenced by at_ble_init(), at_ble_set_privacy_key(), gapc_key_exch(), and gapm_addr_solved_ind_handler().

#define AT_BLE_PASSKEY_LEN   (6)

GAP Security Key Length.

Referenced by at_ble_pair_key_reply(), and ble_pair_key_request_handler().

#define AT_BLE_SCAN_INTERVAL_MAX   0x4000

Maximum scanning interval in 625 us units , i.e.

10.24 s.

Referenced by at_ble_scan_start().

#define AT_BLE_SCAN_INTERVAL_MIN   0x0004

Minimum scanning interval in 625 us units , i.e.

2.5 ms.

Referenced by at_ble_scan_start().

#define AT_BLE_SCAN_WINDOW_MAX   0x4000

Maximum scanning window in 625 us units , i.e.

10.24 s.

Referenced by at_ble_scan_start().

#define AT_BLE_SCAN_WINDOW_MIN   0x0004

Minimum scanning window in 625 us units , i.e.

2.5 ms.

Referenced by at_ble_scan_start().

#define AT_BLE_UUID_128_LEN   (16)

UUID 128 size in bytes.

Referenced by at_ble_service_define(), at_ble_uuid_type2len(), and scan_info_parse().

#define AT_BLE_UUID_16_LEN   (2)

UUID 16 size in bytes.

Referenced by at_ble_uuid_len2type(), at_ble_uuid_type2len(), and scan_info_parse().

#define AT_BLE_UUID_32_LEN   (4)

UUID 32 size in bytes.

Referenced by at_ble_uuid_len2type(), at_ble_uuid_type2len(), and scan_info_parse().

#define AT_CNX_INTERVAL_MAX   3200

Maximum Connection interval in 1.250ms units, i.e.

4s.

Referenced by at_ble_connect(), and at_ble_connection_param_update().

#define AT_CNX_INTERVAL_MIN   6

Minimum Connection interval in 1.250ms units, i.e.

7.5ms.

Referenced by at_ble_connect(), and at_ble_connection_param_update().

#define AT_CNX_LATENCY_MAX   499

Maximum Connection latency (number of connection events that may be missed).

Referenced by at_ble_connect(), and at_ble_connection_param_update().

#define AT_CNX_LATENCY_MIN   0

Minimum Connection latency (number of connection events that may be missed).

#define AT_CNX_SUP_TO_MAX   3200

Maximum Supervision timeout in 10ms units, i.e.

32s.

Referenced by at_ble_connect(), and at_ble_connection_param_update().

#define AT_CNX_SUP_TO_MIN   10

Minimum Supervision timeout in 10ms units, i.e.

100ms.

Referenced by at_ble_connect(), and at_ble_connection_param_update().

#define AT_DEFAULT_MTU   0x0017

Maximum Transmission Unit.

typedef uint16_t at_ble_handle_t

BLE connection handle.

BLE can accept either public or random addresses.

Enumerator
AT_BLE_ADDRESS_PUBLIC 

a public static address

AT_BLE_ADDRESS_RANDOM_STATIC 

a random static address

AT_BLE_ADDRESS_RANDOM_PRIVATE_RESOLVABLE 

resolvable private random address

AT_BLE_ADDRESS_RANDOM_PRIVATE_NON_RESOLVABLE 

non-resolvable private random address

AT_BLE_ADDRESS_INVALID 

Invalid address.

Advertising Mode.

Enumerator
AT_BLE_ADV_NON_DISCOVERABLE 

Mode in non-discoverable.

AT_BLE_ADV_GEN_DISCOVERABLE 

Mode in general discoverable, AD type general flag in Flags set to 1.

AT_BLE_ADV_LIM_DISCOVERABLE 

Mode in limited discoverable, AD type limited flag in Flags set to 1 (This mode is automatically stopped after 180 sec of activity)

AT_BLE_ADV_BROADCASTER_MODE 

Broadcaster mode which is a non discoverable and non connectable mode.

GAP Advertising types.

Enumerator
AT_BLE_ADV_TYPE_UNDIRECTED 

Connectable undirected.

AT_BLE_ADV_TYPE_DIRECTED 

Connectable directed.

AT_BLE_ADV_TYPE_SCANNABLE_UNDIRECTED 

Scannable undirected.

AT_BLE_ADV_TYPE_NONCONN_UNDIRECTED 

Non connectable undirected.

AT_BLE_ADV_TYPE_SCAN_RESPONSE 

(Only used in AT_BLE_SCAN_INFO event.) Signifies a scan response.

Write access.

Enumerator
AT_BLE_WRITE_DISABLE 

Disable write access.

AT_BLE_WRITE_ENABLE 

Enable write access.

AT_BLE_WRITE_UNAUTH 

Write access require unauthenticated link.

AT_BLE_WRITE_AUTH 

Write access require authenticated link.

Attribute Permissions.

Enumerator
AT_BLE_ATTR_NO_PERMISSIONS 
AT_BLE_ATTR_READABLE_NO_AUTHN_NO_AUTHR 
AT_BLE_ATTR_READABLE_REQ_AUTHN_NO_AUTHR 
AT_BLE_ATTR_READABLE_NO_AUTHN_REQ_AUTHR 
AT_BLE_ATTR_READABLE_REQ_AUTHN_REQ_AUTHR 
AT_BLE_ATTR_WRITABLE_NO_AUTHN_NO_AUTHR 
AT_BLE_ATTR_WRITABLE_REQ_AUTHN_NO_AUTHR 
AT_BLE_ATTR_WRITABLE_NO_AUTHN_REQ_AUTHR 
AT_BLE_ATTR_WRITABLE_REQ_AUTHN_REQ_AUTHR 

Security authentication level.

Enumerator
AT_BLE_NO_SEC 

no security

AT_BLE_MODE1_L2_NOAUTH_PAIR_ENC 

Gap Mode 1 Level 2, Unauthenticated pairing with encryption, Man in the middle protection not checked, a LTK shall be exchanged.

AT_BLE_MODE1_L3_AUTH_PAIR_ENC 

Gap Mode 1 Level 3, Authenticated pairing with encryption, Man in the middle protection shall be set to 1, a LTK shall be exchanged.

AT_BLE_MODE2_L1_NOAUTH_DATA_SGN 

Gap Mode 2 Level 1, Unauthenticated pairing with data signing, Man in the middle protection not checked , a CSRK shall be exchanged.

AT_BLE_MODE2_L2_AUTH_DATA_SGN 

Gap Mode 2 Level 2, Authentication pairing with data signing, Man in the middle protection shall be set to 1, a CSRK shall be exchanged.

AT_BLE_MODE1_L2_AUTH_PAIR_ENC 

Gap Mode 1 Level 2, Authenticated pairing with encryption, Man in the middle protection shall be set to 1, a LTK shall be exchanged.

Authorization Types.

Enumerator
AT_BLE_AUTH_NO_MITM_NO_BOND 

No Man In The Middle protection(MITM) , No Bonding.

AT_BLE_AUTH_NO_MITM_BOND 

No MITM , Bonding.

AT_BLE_AUTH_MITM_NO_BOND 

MITM , No Bonding.

AT_BLE_AUTH_MITM_BOND 

MITM and Bonding.

Authorization setting.

Enumerator
GAP_AUTHZ_NOT_SET 

Authorization not set, application informed when authorization requested.

GAP_AUTHZ_ACCEPT 

Authorization request automatically accepted.

GAP_AUTHZ_REJECT 

Authorization request automatically rejected.

Presentation Formats.

Enumerator
AT_BLE_PRES_FORMAT_BOOLEAN 
AT_BLE_PRES_FORMAT_2BIT 
AT_BLE_PRES_FORMAT_NIBBLE 
AT_BLE_PRES_FORMAT_UINT8 
AT_BLE_PRES_FORMAT_UINT12 
AT_BLE_PRES_FORMAT_UINT16 
AT_BLE_PRES_FORMAT_UINT24 
AT_BLE_PRES_FORMAT_UINT32 
AT_BLE_PRES_FORMAT_UINT48 
AT_BLE_PRES_FORMAT_UINT64 
AT_BLE_PRES_FORMAT_UINT128 
AT_BLE_PRES_FORMAT_SINT8 
AT_BLE_PRES_FORMAT_SINT12 
AT_BLE_PRES_FORMAT_SINT16 
AT_BLE_PRES_FORMAT_SINT24 
AT_BLE_PRES_FORMAT_SINT32 
AT_BLE_PRES_FORMAT_SINT48 
AT_BLE_PRES_FORMAT_SINT64 
AT_BLE_PRES_FORMAT_SINT128 
AT_BLE_PRES_FORMAT_FLOAT32 
AT_BLE_PRES_FORMAT_FLOAT64 
AT_BLE_PRES_FORMAT_SFLOAT 
AT_BLE_PRES_FORMAT_FLOAT 
AT_BLE_PRES_FORMAT_DUINT16 
AT_BLE_PRES_FORMAT_UTF8S 
AT_BLE_PRES_FORMAT_UTF16S 
AT_BLE_PRES_FORMAT_STRUCT 

Characteristic properties (Each enum value is a single bit; multiple properties can be indicated simultaneously.)

Enumerator
AT_BLE_CHAR_BROADCST 
AT_BLE_CHAR_READ 
AT_BLE_CHAR_WRITE_WITHOUT_RESPONSE 
AT_BLE_CHAR_WRITE 
AT_BLE_CHAR_NOTIFY 
AT_BLE_CHAR_INDICATE 
AT_BLE_CHAR_SIGNED_WRITE 
AT_BLE_CHAR_RELIABLE_WRITE 
AT_BLE_CHAR_WRITEABLE_AUX 

Disconnection reasons.

Enumerator
AT_BLE_TERMINATED_BY_USER 
AT_BLE_UNACCEPTABLE_INTERVAL 

Events delivered from BLE stack to the application layer.

Enumerator
AT_BLE_UNDEFINED_EVENT 

Undefined event received.

AT_BLE_SCAN_INFO 

Scan info needs to be delivered either adv data or scan response data.


Refer to at_ble_scan_info_t

AT_BLE_SCAN_REPORT 

Scan report received at the end of scan period if AT_BLE_SCAN_GEN_DISCOVERY or AT_BLE_SCAN_LIM_DISCOVERY are used.


Refer to at_ble_scan_report_t

AT_BLE_RAND_ADDR_CHANGED 

Used random address.


Refer to at_ble_rand_addr_changed_t

AT_BLE_CONNECTED 

Connected to a peer device.


Refer to at_ble_connected_t

AT_BLE_DISCONNECTED 

Peer device connection terminated.


Refer to at_ble_disconnected_t

AT_BLE_CONN_PARAM_UPDATE_DONE 

Connection parameters updated.

It is required to call at_ble_conn_update_reply function to send response back if needed.
Refer to at_ble_conn_param_update_done_t

AT_BLE_CONN_PARAM_UPDATE_REQUEST 

Peer device asks for connection parameters update.


Refer to at_ble_conn_param_update_request_t

AT_BLE_RX_POWER_VALUE 

Reported RX power value.


Refer to at_ble_rx_power_value_t

AT_BLE_PAIR_DONE 

Pairing procedure is completed.


Refer to at_ble_pair_done_t

AT_BLE_PAIR_REQUEST 

A central device asks for Pairing.


Refer to at_ble_pair_request_t

AT_BLE_SLAVE_SEC_REQUEST 

Slave security request.


Refer to at_ble_slave_sec_request_t

AT_BLE_PAIR_KEY_REQUEST 

A passkey or OOB data is requested as part of pairing procedure.


Refer to at_ble_pair_key_request_t

AT_BLE_ENCRYPTION_REQUEST 

Encryption is requested by a master device.


Refer to at_ble_encryption_request_t

AT_BLE_ENCRYPTION_STATUS_CHANGED 

Encryption status changed.


Refer to at_ble_encryption_status_changed_t

AT_BLE_RESOLV_RAND_ADDR_STATUS 

Resolve random address status.


Refer to at_ble_resolv_rand_addr_status_t

AT_BLE_PRIMARY_SERVICE_FOUND 

A primary service is found.


Refer to at_ble_primary_service_found_t

AT_BLE_INCLUDED_SERVICE_FOUND 

An included service is found.


Refer to at_ble_included_service_found_t

AT_BLE_CHARACTERISTIC_FOUND 

A Characteristic is found.


Refer to at_ble_characteristic_found_t

AT_BLE_DESCRIPTOR_FOUND 

A descriptor is found.


Refer to at_ble_descriptor_found_t

AT_BLE_DISCOVERY_COMPLETE 

A discover operation has completed.


Refer to at_ble_discovery_complete_t

AT_BLE_CHARACTERISTIC_READ_RESPONSE 

Characteristic read procedure is done.


Refer to at_ble_characteristic_read_response_t

AT_BLE_CHARACTERISTIC_READ_MULTIBLE_RESPONSE 

Characteristic multiple read procedure is done.


Refer to at_ble_characteristic_read_response_t

AT_BLE_CHARACTERISTIC_WRITE_RESPONSE 

Characteristic write procedure is done.


Refer to at_ble_characteristic_write_response_t

AT_BLE_NOTIFICATION_RECEIVED 

A Notification is received.


Refer to at_ble_notification_received_t

AT_BLE_INDICATION_RECEIVED 

An Indication is received.


Refer to at_ble_indication_received_t

AT_BLE_INDICATION_CONFIRMED 

The peer confirmed that it has received an Indication.


Refer to at_ble_indication_confirmed_t

AT_BLE_CHARACTERISTIC_CHANGED 

The peer has changed a characteristic value.


Refer to at_ble_characteristic_changed_t

AT_BLE_SERVICE_CHANGED_NOTIFICATION_CONFIRMED 

The peer has confirmed that it has received the service changed notification.


Refer to at_ble_service_changed_notification_confirmed_t

AT_BLE_WRITE_AUTHORIZE_REQUEST 

The peer asks for a write Authorization.


Refer to at_ble_write_authorize_request_t

AT_BLE_READ_AUTHORIZE_REQUEST 

The peer asks for a read Authorization.


Refer to at_ble_read_authorize_request_t

AT_BLE_L2CAP_RX 

An L2CAP packet received from a registered custom CID.


Refer to at_ble_l2cap_rx_t

AT_BLE_WIFIPROV_SCAN_MODE_CHANGE_IND 

WiFi Scan requested.


Refer to at_ble_wifiprov_scan_mode_change_ind_t

AT_BLE_WIFIPROV_COMPLETE_IND 

WiFi Provisioning complete.


Refer to at_ble_wifiprov_complete_ind

AT_BLE_CUSTOM_EVENT 

A user-defined event is delivered to the system.

AT_BLE_TX_POWER_VALUE 

Reported TX power value.


Refer to at_ble_tx_power_value_t

AT_BLE_TX_POWER_SET 

Indication for tx power set (success or fail).


Refer to at_ble_tx_power_set_t

AT_BLE_MAX_PA_GAIN_VALUE 

Reported maximum PA gain value.


Refer to at_ble_max_PA_gain_value_t

AT_BLE_MTU_CHANGED_CMD_COMPLETE 

MTU changed complete.

AT_BLE_CHARACTERISTIC_WRITE_CMD_CMP 

Characteristic write complete.

AT_BLE_NOTIFICATION_CONFIRMED 

Notification confirmed.

Advertising Filter Policy.

Enumerator
AT_BLE_ADV_FP_ANY 

Allow both scan and connection requests from anyone.

AT_BLE_ADV_FP_FILTER_SCANREQ 

Allow both scan request from White List devices only and connection request from anyone.

AT_BLE_ADV_FP_FILTER_CONNREQ 

Allow both scan request from anyone and connection request from White List devices only.

AT_BLE_ADV_FP_FILTER_BOTH 

Allow scan and connection requests from White List devices only.

GAP Role.

Enumerator
AT_BLE_GAP_NO_ROLE 

No role set yet.

AT_BLE_GAP_OBSERVER_SCA 

Observer role.

AT_BLE_GAP_BROADCASTER_ADV 

Broadcaster role.

AT_BLE_GAP_CENTRAL_MST 

Master/Central role.

AT_BLE_GAP_PERIPHERAL_SLV 

Peripheral/Slave role.

Discovery status.

Enumerator
AT_BLE_DISCOVERY_SUCCESS 

GATTC discover operation complete.

AT_BLE_DISCOVERY_FAILURE 

GATTC discover operation found no services.

IO capabilities of a device.

Enumerator
AT_BLE_IO_CAP_DISPLAY_ONLY 

Can only display.

AT_BLE_IO_CAP_DISPLAY_YES_NO 

Can Display and get a Yes/No input from user.

AT_BLE_IO_CAP_KB_ONLY 

Has only a keyboard.

AT_BLE_IO_CAP_NO_INPUT_NO_OUTPUT 

Has no input and no output.

AT_BLE_IO_CAP_KB_DISPLAY 

Has both a display and a keyboard.

Security keys distribution list.

Enumerator
AT_BLE_KEY_DIST_NONE 

No keys to distribute.

AT_BLE_KEY_DIST_ENC 

Distribute Encryption Key.

AT_BLE_KEY_DIST_ID 

Distribute ID Key.

AT_BLE_KEY_DIST_SIGN 

Distribute Signature Key.

AT_BLE_KEY_DIS_ALL 

Distribute All Keys.

Pairing Key Types.

Enumerator
AT_BLE_PAIR_PASSKEY 

A passkey is required at_ble_passkey_type_t for more details.

AT_BLE_PAIR_OOB 

Out of band key is required.

Enumeration for GAP Parameters.

Enumerator
AT_BLE_GAP_GEN_DISC_ADV_MIN 

Minimum time to remain advertising, when in Discoverable mode (mSec). Setting this parameter to 0 turns off the time-out (default).

AT_BLE_GAP_LIM_ADV_TIMEOUT 

Maximum time to remain advertising, when in Limited Discoverable mode. In seconds (default 180 seconds)

AT_BLE_GAP_GEN_DISC_SCAN 

Minimum time to perform scanning, when performing General Discovery proc (mSec)

AT_BLE_GAP_LIM_DISC_SCAN 

Minimum time to perform scanning, when performing Limited Discovery proc (mSec)

AT_BLE_GAP_CONN_EST_ADV_TIMEOUT 

Advertising time-out, when performing Connection Establishment proc (mSec)

AT_BLE_GAP_CONN_PARAM_TIMEOUT 

Link Layer connection parameter update notification timer, connection parameter update proc (mSec)

AT_BLE_GAP_LIM_DISC_ADV_INT_MIN 

Minimum advertising interval, when in limited discoverable mode (n * 0.625 mSec)

AT_BLE_GAP_LIM_DISC_ADV_INT_MAX 

Maximum advertising interval, when in limited discoverable mode (n * 0.625 mSec)

AT_BLE_GAP_GEN_DISC_ADV_INT_MIN 

Minimum advertising interval, when in General discoverable mode (n * 0.625 mSec)

AT_BLE_GAP_GEN_DISC_ADV_INT_MAX 

Maximum advertising interval, when in General discoverable mode (n * 0.625 mSec)

AT_BLE_GAP_CONN_ADV_INT_MIN 

Minimum advertising interval, when in Connectable mode (n * 0.625 mSec)

AT_BLE_GAP_CONN_ADV_INT_MAX 

Maximum advertising interval, when in Connectable mode (n * 0.625 mSec)

AT_BLE_GAP_CONN_SCAN_INT 

Scan interval used during Link Layer Initiating state, when in Connectable mode (n * 0.625 mSec)

AT_BLE_GAP_CONN_SCAN_WIND 

Scan window used during Link Layer Initiating state, when in Connectable mode (n * 0.625 mSec)

AT_BLE_GAP_CONN_HIGH_SCAN_INT 

Scan interval used during Link Layer Initiating state, when in Connectable mode, high duty scan cycle scan parameters (n * 0.625 mSec)

AT_BLE_GAP_CONN_HIGH_SCAN_WIND 

Scan window used during Link Layer Initiating state, when in Connectable mode, high duty scan cycle scan parameters (n * 0.625 mSec)

AT_BLE_GAP_GEN_DISC_SCAN_INT 

Scan interval used during Link Layer Scanning state, when in General Discovery proc (n * 0.625 mSec)

AT_BLE_GAP_GEN_DISC_SCAN_WIND 

Scan window used during Link Layer Scanning state, when in General Discovery proc (n * 0.625 mSec)

AT_BLE_GAP_LIM_DISC_SCAN_INT 

Scan interval used during Link Layer Scanning state, when in Limited Discovery proc (n * 0.625 mSec)

AT_BLE_GAP_LIM_DISC_SCAN_WIND 

Scan window used during Link Layer Scanning state, when in Limited Discovery proc (n * 0.625 mSec)

AT_BLE_GAP_CONN_EST_ADV 

Advertising interval, when using Connection Establishment proc (n * 0.625 mSec). Obsolete - Do not use.

AT_BLE_GAP_CONN_EST_INT_MIN 

Minimum Link Layer connection interval, when using Connection Establishment proc (n * 1.25 mSec)

AT_BLE_GAP_CONN_EST_INT_MAX 

Maximum Link Layer connection interval, when using Connection Establishment proc (n * 1.25 mSec)

AT_BLE_GAP_CONN_EST_SCAN_INT 

Scan interval used during Link Layer Initiating state, when using Connection Establishment proc (n * 0.625 mSec)

AT_BLE_GAP_CONN_EST_SCAN_WIND 

Scan window used during Link Layer Initiating state, when using Connection Establishment proc (n * 0.625 mSec)

AT_BLE_GAP_CONN_EST_SUPERV_TIMEOUT 

Link Layer connection supervision time-out, when using Connection Establishment proc (n * 10 mSec)

AT_BLE_GAP_CONN_EST_LATENCY 

Link Layer connection slave latency, when using Connection Establishment proc (in number of connection events)

AT_BLE_GAP_CONN_EST_MIN_CE_LEN 

Local informational parameter about min length of connection needed, when using Connection Establishment proc (n * 0.625 mSec)

AT_BLE_GAP_CONN_EST_MAX_CE_LEN 

Local informational parameter about max length of connection needed, when using Connection Establishment proc (n * 0.625 mSec)

AT_BLE_GAP_PRIVATE_ADDR_INT 

Minimum Time Interval between private (resolvable) address changes. In minutes (default 15 minutes)

AT_BLE_GAP_CONN_PAUSE_CENTRAL 

Central idle timer. In seconds (default 1 second)

AT_BLE_GAP_CONN_PAUSE_PERIPHERAL 

Minimum time upon connection establishment before the peripheral starts a connection update procedure. In seconds (default 5 seconds)

Passkey Types.

Enumerator
AT_BLE_PAIR_PASSKEY_ENTRY 

A passkey entry is required.

AT_BLE_PAIR_PASSKEY_DISPLAY 

A passkey needs to be generated and displayed as part of pairing procedure.

Connection type.

Enumerator
PRF_CON_DISCOVERY 

Discovery type connection.

PRF_CON_NORMAL 

Normal type connection.

Scan modes used at at_ble_scan_start.

Enumerator
AT_BLE_SCAN_GEN_DISCOVERY 

Send advertising report about device that advertise in limited or general mode ,the operation stops after 10 sec of activity.

AT_BLE_SCAN_LIM_DISCOVERY 

Send advertising report about device that advertise in limited mode ,the operation stops after 10 sec of activity.

AT_BLE_SCAN_OBSERVER_MODE 

Send any advertising report ,this operation can only be stopped by at_ble_scan_stop.

Scan types used at at_ble_scan_start.

Enumerator
AT_BLE_SCAN_PASSIVE 

Passive scan, without transmitting.

AT_BLE_SCAN_ACTIVE 

Active scan, using scan requests.

Enumeration for BLE Status.

Enumerator
AT_BLE_SUCCESS 

Success.

AT_BLE_FAILURE 

Failure.

AT_BLE_INVALID_PARAM 

Input Parameter invalid.

AT_BLE_PRIVACY_CFG_PB 

Problem with privacy configuration.

AT_BLE_COMMAND_DISALLOWED 

Request not allowed in current state.

AT_BLE_INVALID_STATE 

Operation disallowed in this state.

AT_BLE_INVALID_HANDLE 

Invalid attribute handle.

AT_BLE_INSUFF_RESOURCE 

Resources not sufficient to complete the request.

AT_BLE_INVALID_ATTRIBUTE_VAL_LEN 

Invalid length of the attribute value.

AT_BLE_TIMEOUT 

Time-out.

AT_BLE_FW_INCOMPAT 

Incompatible firmware version.

UUID Type.

Enumerator
AT_BLE_UUID_16 

16 Bit UUID

AT_BLE_UUID_32 

32 Bit UUID

AT_BLE_UUID_128 

128 Bit UUID

AT_BLE_UUID_INVALID 

Invalid UUID.