AT32 HOGP开发指南

Terran

; N% w/ N. l+ v0 A  v7 Z3 AAT32 HOGP开发指南
4 c2 M" q7 g8 K& J- L
前言
人机接口设备(Human InteRFace Devices, HID)的主要目的是基于USB实现者论坛所维护的规格书，提供用户与计算器之间的接口。HID涵盖了显示器、键盘、网络摄影机和鼠标甚至到VR耳机、游戏手把和触控屏幕的各种装置。HID传统上通过USB接口连接到计算器，然而，HID设备也可以通过使用无线技术与计算器连接。通过使用HID规范，可以开发出符合通用标准的计算器外设，从而与大多数装置兼容。
/ h& `; J4 ~( z" ~2 l. E, \- ]3 y支持型号 列表：
AT32WB415
1 L2 r; z: q7 p* @( l2 ]& J1 a; h
/ ~! Y  X8 \9 o" b7 C* T1 HOGP概述
5 U" Q) n5 o" OHOGP(HID over GATT)是由Bluetooth SIG维护的蓝牙配置文件规范，通过低功耗蓝牙实现HID的配置文件并作为与计算器之间的接口，消除HID中对电线或物理连接的需求。

( D- R+ E+ \8 b% i% E  n! I1.1 HID 角色
在HID 中，以及在 HOGP 的延伸中，定义了两个角色，这些角色是 HID 主机和 HID 设备。 HID 设备
4 M) M4 r- J5 H/ Y; G一次只能主动连接到单个 HID 主机；然而一个 HID 主机可以连接到多个 HID 设备。有关主机和设备
, m* b( I7 j+ ~: P" b% A$ S* K' E" M4 R如何交互的细节，请参阅 HOGP 规范 中的第 3 章 HID 设备需求和第 4 章 HID 主机需求和行为。
- K$ g( J" v5 r$ t5 j
5 O. Y( Z; Y! ?. }: B/ k1.2 HID 主机
HID主机实现蓝牙 GAP 中的中心 ( 角色，接收输入讯息并使用提供的数据进行更进一步的处
理。例如，计算器会是 HID 主机，因为这是接收 HID 数据的设备。 HID 主机对 HID 功能的正确执行
有许多责任与需求，但在此开发指南中所提供的范例仅实现了 HID 设备，因此本文檔不涉及这些内
容。想要了解 HID 主机的职责和需求，请参阅 HOGP 规范中的第 2 章配置、第 4 章 HID 主机需求和
行为、第 5 章连线建立。

1.3 HID 设备
HID设备实现蓝牙 GAP 中的外设 ( 角色，负责将输入信息传输到中央计算器。例如，鼠标
或键盘会是 HID 设备，因为它们将输入数据发送到计算器设备。
0 z$ R/ G* Q$ h0 Q# d

2 例 蓝牙键盘实做
HOGP工程是一个在 AT32WB415 上实现 HOGP 规范的低功耗蓝牙工程，该工程使用 HOGP 规范 指
定的 蓝牙 外设角色，演示了 HOGP 的键盘。通过使用通知 ( 和 GATT 配置文件，该项目能
, ~4 t% I" F% N' H够通过低功耗蓝牙 HID 装置并与 HID 主机正确连接。 HOGP 工程中有几个复杂的部份，在本文档中
* s% _8 p( h8 t; p$ u' I* `进行了讨论，这些部份组合在一起以实现整体功能。
% q7 o# O+ O# f7 i" ?
2.1 报告映射讨论
HOGP工程依赖于报告映像，报告映射是 HOGP 用于实现低功耗蓝牙 HID 功能的结构。报告映像用
5 l9 ]8 |) b8 v* |于告诉主机许要从 HID 设备获得什么功能和什么样的数据，在原始的 HID USB 规范中，报告映射称
6 p/ c$ `$ d" D/ ?" a为报告描述符，报告映射和报告描述符是相同的，它们之间唯一的区别是报告映射用于 HOGP, 报告
; T& r3 R4 F9 N! u* ]描述符用于 HID USB 。
该工程使用的报告映像可以在
app_hid.c 文件中找到，并且包含在 gHIDReportDescriptor 变量中，此
: y" H; \5 z' N0 w工程中的报告映像包含键盘的输入信息。该结构分为多个部份，应用程序以及 HID 主机能够通过使用
报告 ID 字段找到所需的部份。可以轻松修改报告映像以包含不同的输入或修改已经存在的输入，
5 r: S' y' [& \, A. D" a/ bUSB 实现者论坛的设备工作组有一个报告描述符建构器工具，可以用于轻松创建报告映射。 图 3 显
示了报告映像结构的片段，所有字段都有标签，可以轻松修改。例如，如果需要不同数量的键盘按
4 u/ g$ u# _9 @, J: K7 a& \键，则可以轻松修改相关字段。
+ N/ W7 N& J- x' e
2.2 资源准备
1) 硬件环境:
对应产品型号的AT-START BOARD
. \) F2 s5 v( ~& ~1 k) _2) 软件环境
wb415_hogp_bt_demo\projects\ble_app_remote
; r: P) X. R) X( ^8 ]5 hwb415_hogp_mcu_demo\utilities\wb415_hogp_mcu_demo\mdk_v5

2.3 软件设计
* S) Y4 m0 A) M/ z. X4 Q1 j1) 配置流程
a) MCU端
3 A9 Z  H/ I' Q  I 配置USER KEY作为击键
 编写USART3通讯函数
 轮询USER KEY是否按下
 根据需求去配置USER KEY按下后发出的AT command
' G) G7 {# N& b0 r8 Zb) BT端
 将HOGP的Profile加入database
4 b% t* m' E) m' K' ^) }! g, M 编写应用层与GATT之间的界面
" w3 c* u8 @  x% n 在应用层中轮询AT command
- x& G, Z" k& ~1 n6 s, Q 透过HOGP将不同的key function发给host端
5 ~( g0 g' d7 T+ ?+ B; G- S$ J2) 代码介绍
 MCU端
 main函数代码描述

• int main(void)
• {
• gpio_init_type gpio_init_struct;
• #ifdef BT_FLASH_WR_TEST
• uint8_t data;
• #endif
• /* 配置系统时钟 */
• system_clock_config();
• /* 初始化开发板资源 */
• at32_board_init();
• /* 初始化USER Key */
• at32_button_init();
• ....
  ( c$ u* ?: }3 K) v. V% I" ?9 v

& M/ ?; B8 Q6 @, a/ A BT端
7 L+ W# P) d3 E4 S- O! h0 R原则上不需要去修改Profile层的内容，由APP层去设定HID装置的内容即可
 初始化HOGP装置变量

• void app_hid_init(void)
• {
• // Reset the environment
• memset(&app_hid_env, 0, sizeof(app_hid_env));
• app_hid_env.state = APP_HID_IDLE;
• app_hid_set_send_flag(true);
• }
  0 t9 D+ h  u: T1 p2 c

+ g  G& N! O/ Z. X; j1 h2 e* i5 y 将HOGP加入database
+ S3 B' \1 c/ T$ H; z/ u

• void app_hid_add_hids(void)
• {
• struct hogpd_db_cfg *db_cfg;
• // Prepare the HOGPD_CREATE_DB_REQ message
• struct gapm_profile_task_add_cmd *req = KE_MSG_ALLOC_DYN(GAPM_PROFILE_TASK_ADD_CMD,
• TASK_GAPM, TASK_APP,
• gapm_profile_task_add_cmd, sizeof(struct hogpd_db_cfg));
• // Fill message
• req->operation = GAPM_PROFILE_TASK_ADD;
• req->sec_lvl = 0;
• req->prf_task_id = TASK_ID_HOGPD;
• req->app_task = TASK_APP;
• req->start_hdl = 0;
• ....
  : v, L" O; c3 F: J1 m3 O4 E8 m. H' l* ~

# t; W8 s- z8 M( ~5 _在main函数之中的while loop不断轮询app_user_entry()来确认有无收到AT command，如果收到有收到AT command则执行该命令的内容。
2 o! t) H% O! s8 L9 c2 t/ A 解析AT command并执行对应的程序

• void app_user_entry(void)
• {
• uint8_t without_prefix_len;
• // GPIO_int_enable();
• if (ke_state_get(TASK_APP) == APPM_READY)
• {
• UART_PRINTF("start advertising\r\n");
• appm_start_advertising();
• }
• ....
  

2.4 实验效果
) d) y4 V7 w9 u0 j 按下AT-START板上的USER KEY发送www back按键，则浏览器页面返回上一页
7 ^4 _& J3 L0 w' R 按下AT-START板上的USER KEY发送volume up按键，则音量提高（需要修改AT command）
- E& M1 Z: R$ f9 c% v 按下AT-START板上的USER KEY发送volume down按键，则音量降低（需要修改AT command）

$ I* e: u- W4 A/ X5 ~6 n2.5 按键定义
本应用指南以多媒体按键为例，在代码中定义了多媒体按键值的数组，用户可以在app_key.c 中找到以下代码：
& z! X0 m/ X0 ?# D# d6 u
 多媒体按键值定义
/ |6 R( P! {3 K; ~6 j# `; D$ F

• const uint8_t media_key[47][2] =
• {
• {0x24, 0x02}, // WWW back 0
• {0x25, 0x02}, // WWW forward 1
• {0x26, 0x02}, // WWW Stop 2
• {0x27, 0x02}, // WWW Refresh 3
• ....
  

在app.c 中的 app_user_entry 函数，每当添加一个新的按键实例，必须透过 app_hid_send_report
0 E& ^7 V3 o7 l这个函数，将按键值及长度发送给主机端，主机才能根据按键值做出对应的行为； 举例来说，要发出
$ b- `9 V: q! u/ M; p6 \) F; h降低音量的按键功能，从上面的注释可以看到 volume down 对应到第九列，是整个数组的第 18 个
数，因此调用发送函数时写成 app_hid_send_report(&key_copy[18], 2) 2)，其他按键也是如此使用。

) C4 I, A6 h1 G9 e5 L+ v2.6 HOGP 相关 AT command
+ t, ^8 A5 ~% g$ R8 l0 p# ^  f本应用指南中，已经建立部分的AT command ，
5 D; f, p5 S: g1 Z  }; Z
% h  H8 ~5 S; t9 g& P" b用户自行添加 AT command 时，需要在 MCU 端及 BT 端同时增加对应的实例； MCU 端要在
at_cmd.h 中新增 AT command 的请求及期待的响应； BT 端要在 app.h 中新增要解析的 AT
command 字符串、 command 的枚举以及回复的枚举，数量上如果对不上的话则发出的按键功能可
能会不正常。
5 r1 `3 ~0 V( G: k% k

RGB_lamp

常见的物联网应用，小至家庭，大至整个城市系统网络，无线则是串起IoT系统中最重要的通讯方式。AT32都能够用得到！

CRAZY_argentina

终端装置进行联网时，会产生的大量隐私数据，要确保用户隐私和数据安全，MCU在数据储存中的受保护区管理(带有硬件的访问控制)和严格的编程流程规划，以及操作中管理访问权限的应用，非常重要。。。