功能支持

ble_host組件主要支持如下功能：

• Generic Access Profile(GAP)角色支持

• Peripheral&Central

• Observer&Broadcaster

• Generic Attribute Profile(GATT)連接支持

• GATT client

• GATT server

• Security Manager(SM)支持

• Legacy Pairing

• 多安全等級(jí)設(shè)定Security Level 1, 2, 3, 4

• 安全連接Security Connection

• LE Privacy（RPA地址生成）

• HCI接口支持

• 標(biāo)準(zhǔn)HCI接口，支持host-only，host通過HCI硬件接口（以UART為主）和controller對(duì)接

• 虛擬HCI接口，支持host+controller，適合SoC的硬件平臺(tái)

版權(quán)說明

目錄結(jié)構(gòu)

|-- ble_profiles             #BLE服務(wù)
|-- bt_crypto                #BLE安全
|-- bt_defconfig             #BLE配置項(xiàng)
|-- bt_host                  #BLE Host核心代碼
|-- bt_preconfig             #BLE預(yù)配置項(xiàng)
|-- bt_shell                 #BLE控制臺(tái)命令
|-- include                  #頭文件
|-- package.yaml             #makefile
|-- README.md                #README文檔
|-- SConscript
|-- script

依賴組件

• osal_aos

API列表

API詳情

ble_stack_init

BLE模塊初始化。函數(shù)原型

int ble_stack_init(init_param_t *param)

輸入?yún)?shù)

返回參數(shù)0：成功， 其他值：失敗。

ble_stack_event_register

注冊(cè)BLE協(xié)議棧事件回調(diào)函數(shù)。注意：入?yún)⒉荒苁且粋€(gè)局部變量。函數(shù)原型

int ble_stack_event_register(ble_event_cb_t *callback)

輸入?yún)?shù)

返回參數(shù)0：成功， 其他值：失敗。

ble_stack_adv_start

打開BLE廣播功能。函數(shù)原型

int ble_stack_adv_start(adv_param_t *param)

輸入?yún)?shù)

返回參數(shù)0：成功， 其他值：失敗。

ble_stack_adv_stop

關(guān)閉BLE廣播功能。函數(shù)原型

int ble_stack_adv_stop()

輸入?yún)?shù)

返回參數(shù)0：成功， 其他值：失敗。

ble_stack_scan_start

打開BLE掃描功能。函數(shù)原型

int ble_stack_scan_start(const scan_param_t *param)

輸入?yún)?shù)

返回參數(shù)0：成功， 其他值：失敗。

ble_stack_scan_stop

關(guān)閉BLE掃描功能。異步事件，掃描結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GAP_DEV_FIND函數(shù)原型

int ble_stack_scan_stop()

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_mtu_get

獲取一個(gè)連接的當(dāng)前MTU大小函數(shù)原型

int ble_stack_gatt_mtu_get(int16_t conn_handle)

輸入?yún)?shù)

返回值23-65535: MTU大小

ble_stack_gatt_registe_service

注冊(cè)一個(gè)GATT服務(wù)函數(shù)原型

int ble_stack_gatt_registe_service(gatt_service *s, gatt_attr_t attrs[], uint16_t attr_num)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_notificate

GATT服務(wù)某個(gè)屬性值上報(bào)，此上報(bào)方式無需GATT Client回復(fù)函數(shù)原型

int ble_stack_gatt_notificate(int16_t conn_handle, uint16_t char_handle, const uint8_t *data, uint16_t len)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_indicate

GATT服務(wù)某個(gè)屬性值上報(bào)，此上報(bào)方式GATT Client回復(fù)confirm。函數(shù)原型

int ble_stack_gatt_indicate(int16_t conn_handle, int16_t char_handle, const uint8_t *data, uint16_t len)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_mtu_exchange

GATT Client功能，確保配置項(xiàng)CONFIG_BT_GATT_CLIENT配置。GATT協(xié)商MTU大小，協(xié)商大小由配置項(xiàng)CONFIG_BT_L2CAP_RX_MTU與CONFIG_BT_L2CAP_TX_MTU的最小值以及對(duì)端設(shè)備的回復(fù)決定。異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GATT_MTU_EXCHANGE函數(shù)原型

int ble_stack_gatt_mtu_exchange(int16_t conn_handle)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_discovery

GATT Client功能，確保配置項(xiàng)CONFIG_BT_GATT_CLIENT配置。GATT服務(wù)或者屬性項(xiàng)發(fā)現(xiàn)。異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件根據(jù)入?yún)⒉煌煌?/p>

函數(shù)原型

int ble_stack_gatt_discovery(int16_t conn_handle,
                             gatt_discovery_type_en type,
                             uuid_t *uuid,
                             uint16_t start_handle,
                             uint16_t end_handle)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_read

GATT Client功能，確保配置項(xiàng)CONFIG_BT_GATT_CLIENT配置。GATT讀取某個(gè)屬性項(xiàng)的屬性值異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GATT_CHAR_READ_CB函數(shù)原型

int ble_stack_gatt_read(int16_t conn_handle, uint16_t attr_handle, uint16_t offset)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_read_multiple

GATT Client功能，確保配置項(xiàng)CONFIG_BT_GATT_CLIENT配置。GATT讀取多個(gè)屬性項(xiàng)的屬性值異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GATT_CHAR_READ_CB函數(shù)原型

int ble_stack_gatt_read_multiple(int16_t conn_handle, uint16_t attr_count, uint16_t attr_handle[])

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_write

GATT Client功能，確保配置項(xiàng)CONFIG_BT_GATT_CLIENT配置。GATT寫入某個(gè)屬性項(xiàng)的屬性值異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GATT_CHAR_WRITE_CB函數(shù)原型

int ble_stack_gatt_write(int16_t conn_handle, uint16_t attr_handle, uint8_t *data, uint16_t len, uint16_t offset, gatt_write_en type)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_gatt_read_multiple

GATT Client功能，確保配置項(xiàng)CONFIG_BT_GATT_CLIENT配置。此函數(shù)用于GATT讀取多個(gè)屬性項(xiàng)的屬性值。異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GATT_CHAR_READ_CB函數(shù)原型

int ble_stack_gatt_read_multiple(int16_t conn_handle, uint16_t attr_count, uint16_t attr_handle[])

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_connect

BLE連接功能，確保配置項(xiàng)CONFIG_BT_CONN配置。此函數(shù)用于BLE連接某個(gè)設(shè)備。異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GATT_CONN_CHANGE函數(shù)原型

int ble_stack_connect(dev_addr_t *peer_addr, conn_param_t *param, uint8_t auto_connect)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_disconnect

BLE連接功能，確保配置項(xiàng)CONFIG_BT_CONN配置。此函數(shù)用于BLE斷開某個(gè)設(shè)備的連接。異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GATT_CONN_CHANGE函數(shù)原型

int ble_stack_disconnect(int16_t conn_handle)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_connect_param_update

BLE連接功能，確保配置項(xiàng)CONFIG_BT_CONN配置。此函數(shù)用于BLE修改某個(gè)連接的連接參數(shù)。異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GAP_CONN_PARAM_UPDATE函數(shù)原型

int ble_stack_connect_param_update(int16_t conn_handle, conn_param_t *param)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_security

BLE連接功能，確保配置項(xiàng)CONFIG_BT_CONN配置。此函數(shù)用于BLE修改某個(gè)連接的安全參數(shù)。異步事件，執(zhí)行結(jié)果在注冊(cè)的事件回調(diào)函數(shù)中返回，返回事件EVENT_GAP_CONN_SECURITY_CHANGE函數(shù)原型

int ble_stack_security(int16_t conn_handle, security_en level)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_iocapability_set

BLE SMP配對(duì)功能，確保配置項(xiàng)CONFIG_BT_SMP配置。此函數(shù)用于設(shè)置BLE設(shè)備的IO能力，這個(gè)設(shè)置會(huì)在BLE SMP配對(duì)被使用。函數(shù)原型

int ble_stack_iocapability_set(uint8_t io_cap)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_smp_cancel

BLE SMP配對(duì)功能，確保配置項(xiàng)CONFIG_BT_SMP配置。此函數(shù)用于取消當(dāng)前BLE的SMP配對(duì)請(qǐng)求。函數(shù)原型

int ble_stack_smp_cancel(int16_t conn_handle)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_smp_passkey_entry

BLE SMP配對(duì)功能，確保配置項(xiàng)CONFIG_BT_SMP配置。此函數(shù)用于SMP Passkey模式下輸入當(dāng)前passkey，當(dāng)接收到EVENT_SMP_PASSKEY_ENTER后調(diào)用。函數(shù)原型

int ble_stack_smp_passkey_entry(int16_t conn_handle, uint32_t passkey)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_smp_passkey_confirm

BLE SMP配對(duì)功能，確保配置項(xiàng)CONFIG_BT_SMP配置。此函數(shù)用于SMP Passkey模式下確認(rèn)當(dāng)前的passkey是否正確，當(dāng)接收到EVENT_SMP_PASSKEY_CONFIRM后調(diào)用。函數(shù)原型

int ble_stack_smp_passkey_confirm(int16_t conn_handle)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

ble_stack_dev_unpair

BLE SMP配對(duì)功能，確保配置項(xiàng)CONFIG_BT_SMP配置。此函數(shù)用于解除某臺(tái)已SMP配對(duì)的設(shè)備的配對(duì)，如果連接存在則斷開連接。函數(shù)原型

int ble_stack_dev_unpair(dev_addr_t *peer_addr)

輸入?yún)?shù)

返回值0：成功， 其他值：失敗。

步驟1 創(chuàng)建或打開工程

打開已有工程

如果用于測(cè)試的案例工程已存在，可參考《AliOS Things集成開發(fā)環(huán)境使用說明之打開工程》打開已有工程。

創(chuàng)建新的工程

組件的示例代碼可以通過編譯鏈接到AliOS Things的任意案例（solution）來運(yùn)行，這里選擇helloworld_demo案例。helloworld_demo案例相關(guān)的源代碼下載可參考《AliOS Things集成開發(fā)環(huán)境使用說明之創(chuàng)建工程》。

步驟2 添加組件

案例下載完成后，需要在helloworld_demo組件的package.yaml中添加對(duì)組件的依賴：

depends:
  - ble_host: master

步驟3 下載組件

在已安裝了的開發(fā)環(huán)境工具欄中，選擇Terminal -> New Terminal啟動(dòng)終端，并且默認(rèn)工作路徑為當(dāng)前工程的workspace，此時(shí)在終端命令行中輸入：

aos install ble_host

上述命令執(zhí)行成功后，組件源碼則被下載到了./components/ble_host路徑中。

步驟4 添加示例

修改solutions/helloworld_demo/helloworld_demo.c，如下：

頭文件修改

#include <aos/ble.h>
#include <atomic.h>
#include <bluetooth/bluetooth.h>
#include <bluetooth/gatt.h>
#include <bluetooth/uuid.h>

代碼修改

#define EXAMPLE_BLE_DEV_NAME        "HaaS BLE"
#define DEVICE_ADDR                 {0xE8,0x3B,0xE3,0x88,0xB4,0xC8}

int application_start(int argc, char *argv[])
{
    int count = 0;
    int ret;
    dev_addr_t addr = {DEV_ADDR_LE_RANDOM, DEVICE_ADDR};
    init_param_t init = {
        .dev_name = EXAMPLE_BLE_DEV_NAME,
        .dev_addr = &addr,   //&addr,
        .conn_num_max = 1,
    };

    printf("nano entry here!\r\n");

#if 1
    /* bt stack init */
    ret = ble_stack_init(&init);
    if (ret) {
        printf("error: ble_stack_init!, ret = %x\r\n", ret);
        return -1;
    }
#endif

    while(1) {
        printf("hello world! count %d \r\n", count++);
        aos_msleep(1000);
    };
}

步驟5 編譯固件

在示例代碼已經(jīng)添加至組件的配置文件，并且helloworld_demo已添加了對(duì)該組件的依賴后，就可以編譯helloworld_demo案例來生成固件了，具體編譯方法可參考《AliOS Things集成開發(fā)環(huán)境使用說明之編譯固件》。

步驟6 燒錄固件

helloworld_demo案例的固件生成后，可參考《AliOS Things集成開發(fā)環(huán)境使用說明之燒錄固件》來燒錄固件。

步驟7 打開串口

固件燒錄完成后，可以通過串口查看示例的運(yùn)行結(jié)果，打開串口的具體方法可參考《AliOS Things集成開發(fā)環(huán)境使用說明之查看日志》。

當(dāng)串口終端打開成功后，可在串口中輸入help來查看已添加的測(cè)試命令。

步驟8 測(cè)試示例

打開串口工具，在串口工具中輸入ble，可看到ble的cli命令集。

BLE廣播與連接測(cè)試

在串口工具中輸入ble adv start 020106，可以在串口日志中看到如下打印

adv_type:0;adv_interval_min:160 (*0.625)ms;adv_interval_max:240 (*0.625)ms
Advertising started

此時(shí)在手機(jī)端打開NRF Connect工具并搜索廣播包，可以看到設(shè)備。

點(diǎn)擊連接，可以看到Generic Access(GAP)和Generic Attribute(GATT)2個(gè)服務(wù)，點(diǎn)擊GAP服務(wù)的Device Name的讀取按鍵（下圖紅色圈中的箭頭），可以讀取到數(shù)值“HaaS BLE”