USBH_MIDI 技术文档

1. 安装指南

USBH_MIDI 是 Arduino USB Host Shield 2.0 库的一个子库，用于支持 USB-MIDI 设备。以下是安装步骤：

1. 下载并安装 USB Host Shield 2.0 库。
2. 在 Arduino IDE 中，通过 管理库 选项安装 USB Host Shield 2.0 库。
3. USBH_MIDI 已经包含在 USB Host Shield 2.0 库中，因此不需要单独安装。

2. 项目的使用说明

USBH_MIDI 库提供了一系列的 API，用于接收和发送 MIDI 消息。以下是几个示例：

• 单个设备示例：File->Examples->USBH_MIDI->USB_MIDI_converter
• 单个设备带 SysEx 支持示例：File->Examples->USBH_MIDI->USB_MIDI_converter_wSysEx
• 多个设备（带 USB 集线器）示例：File->Examples->USBH_MIDI->USB_MIDI_converter_multi
• 双向转换示例：File->Examples->USBH_MIDI->bidirectional_converter
• 查看 USB-MIDI 设备描述符：File->Examples->USBH_MIDI->USB_MIDI_desc

通过这些示例，你可以了解如何使用 USBH_MIDI 库来接收和发送 MIDI 消息。

3. 项目API使用文档

以下是 USBH_MIDI 库的主要 API 及其功能：

• uint8_t RecvData(uint8_t *outBuf)：接收 MIDI 消息（3 字节）。返回值是 MIDI 消息长度（0-3）。
• uint8_t RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr)：接收原始 USB-MIDI 事件包（每个 4 字节，最多 64 字节）。dataptr 必须分配 64 字节缓冲区。返回值是 0：成功，非 0：错误（MAX3421E HRSLT），bytes_rcvd 是接收的 USB 包长度。
• uint8_t RecvRawData(uint8_t *outBuf)：接收 MIDI 事件包（4 字节）。返回值是 MIDI 消息长度（0-3）。
• uint8_t SendData(uint8_t *dataptr, uint8_t nCable=0)：发送 MIDI 消息。可以设置 CableNumber（默认为 0）。返回值是 0：成功，非 0：错误（MAX3421E HRSLT）。
• uint8_t SendRawData(uint16_t bytes_send, uint8_t *dataptr)：发送原始数据。你可以发送任何数据到 MIDI（无需符合 USB-MIDI 事件包）。
• uint8_t SendSysEx(uint8_t *dataptr, uint8_t datasize, uint8_t nCable=0)：发送 SysEx MIDI 消息。可以设置 CableNumber（默认为 0）。
• void attachOnInit(void (*funcOnInit)(void))：在控制器成功初始化时调用用户函数。
• void attachOnRelease(void (*funcOnRelease)(void))：在设备移除时调用用户函数。
• uint16_t idVendor()：获取供应商 ID。
• uint16_t idProduct()：获取产品 ID。
• uint8_t GetAddress()：获取 USB 设备地址。

4. 项目安装方式

USBH_MIDI 是 USB Host Shield 2.0 库的一部分，因此安装方式与 USB Host Shield 2.0 库相同。请参考以下步骤：

1. 下载并安装 USB Host Shield 2.0 库。
2. 在 Arduino IDE 中，通过 管理库 选项安装 USB Host Shield 2.0 库。
3. 使用 USB Host Shield 2.0 库中的功能时，确保正确连接 USB Host Shield 到 Arduino 板。

以上是 USBH_MIDI 库的安装和使用说明，希望对您有所帮助。