BLE_API v2.1.3

BLE Command Event Definition
BLE Common » BLE Command Definition

## BleCmdEvent
Define the different events that could be received by the BleEventCallBack. Note The event parameter shall be ignored if the event status is not equal to BLESTACK_STATUS_SUCCESS.
typedef uint8_t | BleCmdEvent
#define | BLECMD_EVENT_NULL 0x00
#define | BLECMD_EVENT_ADV_COMPLETE 0x01
#define | BLECMD_EVENT_SCAN_REPORT 0x02
#define | BLECMD_EVENT_CONN_COMPLETE 0x03
#define | BLECMD_EVENT_CONN_CANCEL_COMPLETE 0x04
#define | BLECMD_EVENT_CONN_PARAMETER_UPDATE_RSP 0x05
#define | BLECMD_EVENT_CONN_UPDATE_COMPLETE 0x06
#define | BLECMD_EVENT_DISCONN_COMPLETE 0x07
#define | BLECMD_EVENT_PHY_UPDATE_COMPLETE 0x08
#define | BLECMD_EVENT_PHY_READ_COMPLETE 0x09
#define | BLECMD_EVENT_READ_RSSI_COMPLETE 0x0A
#define | BLECMD_EVENT_STK_GEN_METHOD 0x0B
#define | BLECMD_EVENT_PASSKEY_CONFIRM 0x0C
#define | BLECMD_EVENT_AUTH_STATUS 0x0D
#define | BLECMD_EVENT_SCAN_COMPLETE 0x0E
#define | BLECMD_EVENT_CREATE_CONNECTION 0x0F
#define | BLECMD_EVENT_EXCHANGE_MTU_SIZE 0x10
#define | BLECMD_EVENT_DATA_LENGTH_UPDATE 0x11
#define | BLECMD_EVENT_ATT_DATABASE_PARSING_FINISHED 0x12

## Detailed Description

BLE Command event definition.

## Macro Definition Documentation

## ◆ BLECMD_EVENT_ADV_COMPLETE

#define BLECMD_EVENT_ADV_COMPLETE 0x01

Event indicates the advertisement is enabled or disabled.

Note
  The parameter field indicates the advertisement information though the BLE_Event_AdvCompleteParam

## ◆ BLECMD_EVENT_ATT_DATABASE_PARSING_FINISHED

#define BLECMD_EVENT_ATT_DATABASE_PARSING_FINISHED 0x12

Event indicates the host attribute database has been parsed.

Note
  The parameter field indicates the updated data length though the BLE_Event_AttDbParsedParam

## ◆ BLECMD_EVENT_AUTH_STATUS

#define BLECMD_EVENT_AUTH_STATUS 0x0D

Event indicates the authentication status can be retrieved.

Note
  The parameter field indicates the authentication status though the BLE_Event_AuthStatusParam

## ◆ BLECMD_EVENT_CONN_CANCEL_COMPLETE

#define BLECMD_EVENT_CONN_CANCEL_COMPLETE 0x04

Event indicates the BLE connection has been canceled.

Note
  The parameter field is always NULL

## ◆ BLECMD_EVENT_CONN_COMPLETE

#define BLECMD_EVENT_CONN_COMPLETE 0x03

Event indicates the BLE connection is established.

Note
  The parameter field indicates the connection information though the BLE_Event_ConnParam

## ◆ BLECMD_EVENT_CONN_PARAMETER_UPDATE_RSP

#define BLECMD_EVENT_CONN_PARAMETER_UPDATE_RSP 0x05

Event indicates the connection parameter update response can be retrieved.

Note
  The parameter field indicates the connection information though the BLE Connection Update Status Definition

Attention
  The event can be ignored, just wait for BLECMD_EVENT_CONN_UPDATE_COMPLETE event

## ◆ BLECMD_EVENT_CONN_UPDATE_COMPLETE

#define BLECMD_EVENT_CONN_UPDATE_COMPLETE 0x06

Event indicates the BLE connection has been updated.

Note
  The parameter field indicates the connection information though the BLE_Event_ConnUpdateParam

## ◆ BLECMD_EVENT_CREATE_CONNECTION

#define BLECMD_EVENT_CREATE_CONNECTION 0x0F

Event indicates the connection is creating.

Note
  The parameter field indicates the connection information though the BLE_Event_CreateConnParam

## ◆ BLECMD_EVENT_DATA_LENGTH_UPDATE

#define BLECMD_EVENT_DATA_LENGTH_UPDATE 0x11

Event indicates the updated data length can be retrieved.

Note
  The parameter field indicates the updated data length though the BLE_Event_DataLengthParam

## ◆ BLECMD_EVENT_DISCONN_COMPLETE

#define BLECMD_EVENT_DISCONN_COMPLETE 0x07

Event indicates the BLE connection has been disconnected.

Note
  The parameter field indicates the connection information though the BLE_Event_DisconnParam

## ◆ BLECMD_EVENT_EXCHANGE_MTU_SIZE

#define BLECMD_EVENT_EXCHANGE_MTU_SIZE 0x10

Event indicates the MTU size can be retrieved.

Note
  The parameter field indicates the MTU size though the BLE_Event_MtuParam

## ◆ BLECMD_EVENT_NULL

#define BLECMD_EVENT_NULL 0x00

Null event.

## ◆ BLECMD_EVENT_PASSKEY_CONFIRM

#define BLECMD_EVENT_PASSKEY_CONFIRM 0x0C

Event indicates the passkey entry can be retrieved.

Note
  The parameter field indicates the passkey entry information though the BLE_Event_PassKeyConfirmParam

## ◆ BLECMD_EVENT_PHY_READ_COMPLETE

#define BLECMD_EVENT_PHY_READ_COMPLETE 0x09

Event indicates the current Link Layer PHY can be retrieved.

Note
  The parameter field indicates the Link Layer PHY information though the BLE_Event_PhyParam

## ◆ BLECMD_EVENT_PHY_UPDATE_COMPLETE

#define BLECMD_EVENT_PHY_UPDATE_COMPLETE 0x08

Event indicates that the Link Layer PHY update procedure is complete.

Note
  The parameter field indicates the Link Layer PHY information though the BLE_Event_PhyUpdateParam

## ◆ BLECMD_EVENT_READ_RSSI_COMPLETE

#define BLECMD_EVENT_READ_RSSI_COMPLETE 0x0A

Event indicates the RSSI value can be retrieved.

Note
  The parameter field indicates the RSSI value though the BLE_Event_RssiParam

## ◆ BLECMD_EVENT_SCAN_COMPLETE

#define BLECMD_EVENT_SCAN_COMPLETE 0x0E

Event indicates the scan is enabled or disabled.

Note
  The parameter field is always NULL

## ◆ BLECMD_EVENT_SCAN_REPORT

#define BLECMD_EVENT_SCAN_REPORT 0x02

Event indicates that receives the advertisement packets.

Note
  The parameter field indicates the received data though the BLE_Event_ScanReportParam

## ◆ BLECMD_EVENT_STK_GEN_METHOD

#define BLECMD_EVENT_STK_GEN_METHOD 0x0B

Event indicates the security STK generator method can be retrieved.

Note
  The parameter field indicates the security STK generator information though the BLE_Event_StkGenMethodParam