USB Module

Module USB 是使用 SPI 接口实现扩展 USB 功能的模块，使用 MAX3421E 实现。

Support the following products:

Micropython Example

备注

使用下列案例前请检查模块拨码开关，确保案例使用相关引脚与模块拨码开关位置一致，具体配置请查看产品说明手册页面。SPI 配置已在内部实现，用户无需关心。

输入/输出引脚控制

模块通过排针引出 5 个 IN（输入）引脚和 5 个 OUT （输出引脚），本案例控制输出引脚高低电平切换，读取并打印输入引脚电平状态。

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT
import os, sys, io
import M5
from M5 import *
from module import USBModule
import time



module_usb_0 = None
last_time = None
i = None
last_set_time = None
value = None
state = None
toggle = None


def setup():
    global module_usb_0, last_time, last_set_time, value, state, toggle, i
    M5.begin()
    Widgets.fillScreen(0x222222)
    module_usb_0 = USBModule(pin_cs=1, pin_int=10)
    module_usb_0.write_gpout(0, 0)
    module_usb_0.write_gpout(1, 1)
    module_usb_0.write_gpout(2, 0)
    module_usb_0.write_gpout(3, 1)
    module_usb_0.write_gpout(4, 0)
    state = [0] * 5
    toggle = True


def loop():
    global module_usb_0, last_time, last_set_time, value, state, toggle, i
    M5.update()
    module_usb_0.poll_data()
    if (time.ticks_diff((time.ticks_ms()), last_time)) > 200:
        last_time = time.ticks_ms()
        for i in range(5):
            value = module_usb_0.read_gpin(i)
            state[int((i + 1) - 1)] = value
        print(state)
    if (time.ticks_diff((time.ticks_ms()), last_set_time)) > 1000:
        last_set_time = time.ticks_ms()
        if toggle:
            for i in range(5):
                module_usb_0.write_gpout(i, 1)
        else:
            for i in range(5):
                module_usb_0.write_gpout(i, 0)
        toggle = not toggle


if __name__ == '__main__':
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg
            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

鼠标

案例实现 USB 主机，获取鼠标输入

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT
import os, sys, io
import M5
from M5 import *
from module import USBModule



title0 = None
label_x = None
label_y = None
module_usb_0 = None
x = None
y = None
mouse_move = None
dx = None
dy = None


def setup():
    global title0, label_x, label_y, module_usb_0, x, y, mouse_move, dx, dy
    M5.begin()
    Widgets.fillScreen(0x222222)
    title0 = Widgets.Title("Module USB Example mouse", 3, 0xffffff, 0x0000FF, Widgets.FONTS.DejaVu18)
    label_x = Widgets.Label("x", 130, 90, 1.0, 0xffffff, 0x222222, Widgets.FONTS.DejaVu18)
    label_y = Widgets.Label("y", 180, 90, 1.0, 0xffffff, 0x222222, Widgets.FONTS.DejaVu18)
    module_usb_0 = USBModule(pin_cs=1, pin_int=10)
    x = 0
    y = 0


def loop():
    global title0, label_x, label_y, module_usb_0, x, y, mouse_move, dx, dy
    module_usb_0.poll_data()
    if module_usb_0.is_left_btn_pressed():
        print('click left')
    if module_usb_0.is_right_btn_pressed():
        print('click right')
    if module_usb_0.is_middle_btn_pressed():
        print('click middle')
    mouse_move = module_usb_0.read_mouse_move()
    dx = mouse_move[0]
    dy = mouse_move[1]
    if dx != 0 or dy != 0:
        print((str('move: ') + str(((str(dx) + str(((str(', ') + str(dy)))))))))
        x = min(max(x + dx, 0), 320)
        y = min(max(y + dy, 0), 240)
        label_x.setText(str(x))
        label_y.setText(str(y))


if __name__ == '__main__':
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg
            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

键盘

案例实现 USB 主机，获取键盘输入

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT
import os, sys, io
import M5
from M5 import *
from module import USBModule



module_usb_0 = None
modifier = None
indata = None


def setup():
    global module_usb_0, modifier, indata
    M5.begin()
    Widgets.fillScreen(0x222222)
    module_usb_0 = USBModule(pin_cs=1, pin_int=10)


def loop():
    global module_usb_0, modifier, indata
    M5.update()
    module_usb_0.poll_data()
    modifier = module_usb_0.read_kb_modifier()
    if modifier & 0x01:
        print('Left Control pressed')
    if modifier & 0x02:
        print('Left Shift pressed')
    if modifier & 0x04:
        print('Left Alt pressed')
    if modifier & 0x08:
        print('Left GUI pressed')
    if modifier & 0x10:
        print('Right Control pressed')
    if modifier & 0x20:
        print('Right Shift pressed')
    if modifier & 0x40:
        print('Right Alt pressed')
    if modifier & 0x80:
        print('Right GUI pressed')
    indata = module_usb_0.read_kb_input(True)
    if indata:
        print(indata)


if __name__ == '__main__':
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg
            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

UIFlow2.0 Example

输入/输出引脚控制

cores3_module_usb_gpio_example.m5f2

鼠标

cores3_module_usb_mouse_example.m5f2

键盘

cores3_module_usb_kb_example.m5f2

class USBModule

Constructors

class USBModule(pin_cs: int = 1, pin_int: int = 10)

参数:

• pin_cs (int) – (RST) 复位引脚

• pin_irq (int) – (INT) 中断引脚

UIFLOW2:

poll_data()

poll data

Note: It needs to be called in the main loop

UIFlow2.0

is_left_btn_pressed() → bool

查询鼠标左键是否按下

UIFlow2.0

is_right_btn_pressed() → bool

查询鼠标右键是否按下

UIFlow2.0

is_middle_btn_pressed() → bool

查询鼠标中键（滚轮）是否按下

UIFlow2.0

is_forward_btn_pressed() → bool

查询鼠标前进键是否按下

UIFlow2.0

is_back_btn_pressed() → bool

查询鼠标后退键是否按下

UIFlow2.0

read_mouse_move() → tuple[int, int]

读取鼠标光标移动

返回包含鼠标水平位移 x 和垂直位移 y 的元组 (x, y)；x 范围: -127~127，静止为0，负值为向左移动，正值为向右移动；y 范围: -127~127，静止为0，负值为向上移动，正值为向下移动。

Example:

move = usb_module.read_mouse_move()
x = move[0]
y = move[1]

UIFlow2.0

read_wheel_move() → int

读取鼠标滚轮移动

返回 -127~127，静止为0，正值为向前滚动，负值为向后滚动

UIFlow2.0

read_kb_input(convert: bool = True) → list

读取键盘输入

• convert 是否转为 HID Keycode 为对应的字符串。

返回一个包含键盘输入的列表(元素个数最大为6，即一次最多输入6个按键值)

Example:

res = usb_module.read_kb_input(convert=True)
# output ['a', 'b', 'Enter']

res = usb_module.read_kb_input(convert=False)
# output [0x04, 0x05, 0x28]

UIFlow2.0

read_kb_modifier() → int

读取键盘修饰键，即 “Ctrl”，“Shift”，“Alt”，“Win” 按键。

• 返回 键盘修饰键的状态，通常是通过位掩码来表示不同修饰键的状态。

  • 0x01: 左侧控制键（Left Control）

  • 0x02: 左侧 Shift 键（Left Shift）

  • 0x04: 左侧 Alt 键（Left Alt）

  • 0x08: 左侧 Windows 键（Left GUI）

  • 0x10: 右侧控制键（Right Control）

  • 0x20: 右侧 Shift 键（Right Shift）

  • 0x40: 右侧 Alt 键（Right Alt）

  • 0x80: 右侧 Windows 键（Right GUI）

Example:

modifier = module_usb.read_kb_modifier()
if modifier & 0x01:
    print("left ctrl key pressed")

UIFlow2.0

read_gpin(pin) → int

读取输入引脚电平

• pin 引脚号

• 返回 1 为高电平，0 为低电平

UIFlow2.0

write_gpout(pin, value)

设置输出引脚电平

• pin 引脚号

• 返回 1 为高电平，0 为低电平

UIFlow2.0