# 腾讯小微蓝牙设备协议

# 概要

蓝牙设备（如蓝牙耳机、蓝牙音箱）可以通过蓝牙与“腾讯小微APP”或“QQ音乐App”建立连接，接入小微语音助手的服务。
接入小微语音助手后，设备即可具有语音对话能力，可以通过说话来使用音乐点播、故事播放、新闻收听、天气和百科查询等服务。

一些接入基本情况如下：

• 支持蓝牙协议版本4.2及以上。
• iOS系统支持10.0及以上，连接方式支持IAP，BLE。
• Android系统支持6.0及以上，连接方式支持SPP。
• 录音采样参数：16000采样率，单声道，16bit采样位深。
• 音频编码方式支持Opus，SBC，mSBC。
• 支持OTA升级（可选）。

# 发现与连接

# IAP

仅iOS支持。

protocol string: com.tencent.xiaowei

# SPP

仅Android支持。

UUID: 85dbf2f9-73e3-43f5-a129-971b91c72f1e

# BLE

仅iOS支持。

设备通过Advertising Data和Scan Response来向App传递设备的信息。
优先通过Advertising Data来传递，如数据包大小超过限制，可放到Scan Response中。
广播数据中应包含：

Service UUID：0709

MANUFACTURER SPECIFIC DATA：

建立BLE连接后，设备向App发送数据的通道为 dfd4416e-e40c-47f7-8248-eb8be3dc47f9。
设备接收来自App的数据的通道为 9884d812-61fe-4a24-94d3-b2c11a851fac。
设备需要在与App建立连接后停止广播。

# 连接流程

1. App通过BLE，SPP，IAP等方式查找可用设备。
2. 发现设备后，App发送103命令给设备来获取product_id，mac地址以及特征值。
   如果App已经通过BLE的广播包获取到了相应信息，App会跳过该步骤。
3. App检查特征值，判断是否可以自动连接。
4. 如不能自动连接，App弹窗询问用户是否连接设备。用户确认后继续流程。
5. App发送105命令，给设备分配特征值，设备设备回复配置参数。
6. App发送106命令，给设备发送phone id，设备根据校验方式回复校验信息。
7. 连接完成，App播放已连接的提示。
8. 连接完成后，App会定时发送心跳（112_heartBeat）给设备。如心跳失败，App将断开与耳机的连接。

过程如下图所示

# 录音流程

# 长按

1. 用户按下按键时，设备发送101命令，收到回复后开始录音。
2. 设备持续通过255命令发送编码后的音频数据。如多次没有收到App的回复时，设备要停止录音并主动发送102命令尝试告知App停止录音。
3. 用户松开按键时，设备发送108命令，在收到回复后需要继续录音和发送音频数据。
4. 设备收到App发来的102命令时，结束录音。

过程如下图所示

# 短按

1. 用户触发录音，设备发送101命令，收到回复后开始录音。
2. 设备持续通过255命令发送编码后的音频数据。如多次没有收到App的回复时，设备要停止录音并主动发送102命令尝试告知App停止录音。
3. 设备收到App发来的102时，结束录音。

过程如下图所示

# 对话控制

在iOS平台上，如果有第三方的App正在播放音乐，此时小微App需要通过设备来发送AVRCP指令来控制第三方App的音乐播放。

以长按为例，过程如下图所示

# 采样和编码

# 采样

录音采样参数：16000采样率，单声道，16bit采样位深。

# Opus

iOS和Android均支持。

采用固定码率，压缩后的每一帧大小为40个字节。

支持16倍和8倍的压缩，对应的frame_duration分别为20ms, 10ms。

# SBC

iOS和Android均支持。

SBC参数：

sbc->frequency = SBC_FREQ_16000;
sbc->blocks = SBC_BLK_16;
sbc->subbands = SBC_SB_8;
sbc->mode = SBC_MODE_MONO;
sbc->allocation = SBC_AM_LOUDNESS;
sbc->bitpool = 12; // 256 bytes input 32 bytes output
sbc->endian = SBC_LE;

mSBC参数：

​sbc->frequency = SBC_FREQ_16000;
​sbc->blocks = MSBC_BLOCKS;
​sbc->subbands = SBC_SB_8;
​sbc->mode = SBC_MODE_MONO;
​sbc->allocation = SBC_AM_LOUDNESS;
​sbc->bitpool = 26; // 240 bytes input 57 bytes output
​sbc->endian = SBC_LE;

# 指令协议

App及设备均可主动发送request指令。
App或设备收到request指令后，回复相应的response指令。
如超过0.5秒没有收到相应的response，耳机会重新发送command，最多重试2次
命令处理成功时，response指令的code为0，其他错误码参考Response Code。
数据序列化时采用小端字节序。

# 包结构

request：

response：

其中payload数据由各指令自己定义。

# 指令列表

# 101_wakeUp

用户触发录音，发送该命令给App，并开始录音。

request payload: NULL

response payload: NULL

# 102_silence

App检测到静音时，发送该命令给设备，设备结束录音。

或设备在录音时多次没有收到App回复时，发送此命令结束录音。

request payload: NULL

respone payload: NULL

# 103_getInfo

建立连接过程中，由App发送给设备，设备返回product_id以及MAC地址。

request payload：NULL

response payload：

# 105_getConfig

建立连接过程中，由App发送给设备，设备返回参数配置信息。

request payload:

response payload:

extra config中包含一到多个配置项。目前支持的配置项有：

• 功能键设备：默认（降噪）/小微助手
• 设备sku信息，用于与厂商在硬件管理平台配置的信息关联。
• 设备自定义名称
• 设备序列号
• 更多详细信息参考代码xw_headphone_extra_config_item

# 106_getSig

建立连接过程中，由App发送phoneId给设备，设备返回校验信息。

request payload:

response payload:

校验未启用时，sig返回长度不为0的任意值。

# 107_stopPlay

由设备发送给App，App收到命令后会停止正在播放对话结果，或者暂停正在播放的内容资源（音乐、故事、新闻等）。

request payload: NULL

respone payload: NULL

# 108_requestStopRceord

长按录音流程中，用户松开按键时，设备需要发送此命令。

request payload: NULL

respone payload: NULL

# 109_setKeyFunction

设置按键功能，如设备不支持，可不实现。

request payload:

response payload: NULL

# 110_clearFValue

清空设备的特征值。

request payload:

response payload: NULL

# 111_playControl

播放控制及对话结束通知指令，App通过该指令告诉设备，TTS播放结束，以及需要发送的AVRCP指令（pause、resume）。
在Android上，TTS播放完成后会发送该命令告知设备TTS播放结束。
在iOS上，开始录音时，如有第三方App在播放音乐，App会发送该命令告知设备发送AVRCP Pause指令 。对话结束时，发送此命令告知设备TTS播放完成以及是否需要发送AVRCP Resume指令。

request payload:

response payload: NULL

# 112_heartBeat

App和设备均可主动发送该指令，用于探测连接是否正常。
App会定期发送心跳给设备，用于维持App在后台时不被系统挂起，并保持连接可用。

request payload: NULL

response payload: NULL

# 115_customSkill

1.6.0及以上版本支持。

用户query了耳机的自定义技能时，App通过该命令将技能的意图和槽位信息转发给耳机。

request payload:

每一个slot info包含了槽位名称和槽位值

response payload:

NULL（如果处理成功）
出错则参考错误码处理回包。

# 255_voiceData

设备发送语音数据给App。

request payload:

response payload: NULL

# 其他

# extra_config

extra config用于在105命令中返回更多的配置信息。

extra config的数据由0-N个config_item拼接而成。
每个config_item的第一个byte为config_key。
根据config_key的不同，config_item接下来数据格式如下：

config_key < 200时, config_item长度为2

config_key >= 200时，config_item长度为2+N，N为对应数据的长度

相关代码请参考:
xw_headphone_extra_config_key
xw_headphone_extra_config_item_list_pack
xw_headphone_extra_config_item_list_unpack

# 打开App

厂商自有App中可以跳转到小微App。

当跳转到小微App时，小微App已连接设备，会打开设备的设置页面。

当手机上没有安装小微App时，需要打开下载页面，提示用户下载安装。

# 判断是否安装

iOS： 通过url shceme xiaoweiapp://，使用系统接口-[UIApplication canOpenURL:]来判断是否安装。

Android：通过url shceme xiaoweiapp://，使用系统接口判断是否安装。

示例代码：

public boolean checkXwappInstalled() {
​    Intent action = new Intent(Intent.ACTION_VIEW);
​    action.setData(Uri.parse("xiaoweiapp://"));
​    List list = getPackageManager().queryIntentActivities(action, 
        PackageManager.GET_RESOLVED_FILTER);
​    return list != null && list.size() > 0;
}

# 下载页面

iOS：https://apps.apple.com/cn/app/tencent-xiaowei/id1454208784?mt=8

Android：https://a.app.qq.com/o/simple.jsp?pkgname=com.tencent.xw

# 跳转链接

iOS & Android：xiaoweiapp://headphone/settings

# 附录

# App对小微协议版本支持情况

# Response Code

# 代码下载

协议参考代码下载