Chain Joystick

Chain Joystick 是一个可连接到 M5Chain 系列设备的摇杆模块，提供读取摇杆位置和按键状态的功能。

支持以下产品：

UiFlow2 应用示例

USB 鼠标

在 UiFlow2 中打开 chain_joystick_usb_mouse_example.m5f2 项目。

该示例演示如何将 Chain Joystick 作为 USB 鼠标使用。

UiFlow2 代码块：

示例输出：

None

MicroPython 示例

USB 鼠标

该示例演示如何将 Chain Joystick 作为 USB 鼠标使用。

MicroPython 代码块：

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from chain import JoystickChain
from chain import ChainBus
from usb.device.mouse import Mouse
import m5utils


bus2 = None
mouse = None
chain_joystick_0 = None


key_press = None
x = None
y = None


def chain_joystick_0_click_event(args):
    global bus2, mouse, chain_joystick_0, key_press, x, y
    key_press = True


def setup():
    global bus2, mouse, chain_joystick_0, key_press, x, y

    M5.begin()
    bus2 = ChainBus(2, tx=6, rx=5)
    chain_joystick_0 = JoystickChain(bus2, 1)
    chain_joystick_0.set_click_callback(chain_joystick_0_click_event)
    print(chain_joystick_0.get_firmware_version())
    mouse = Mouse()
    key_press = False


def loop():
    global bus2, mouse, chain_joystick_0, key_press, x, y
    M5.update()
    if mouse.is_open():
        x = int(m5utils.remap(chain_joystick_0.get_x(), -128, 127, -64, 64))
        y = int(m5utils.remap(chain_joystick_0.get_y(), -128, 127, 64, -64))
        mouse.move(x, y)
        if key_press:
            mouse.click_left(True)
            key_press = False


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")

示例输出：

None

API参考

JoystickChain

class chain.joystick.JoystickChain(bus, device_id)

基类：KeyChain

用于通过 Chain 总线与摇杆设备交互的 JoystickChain 类。

参数:

bus (ChainBus) – Chain 总线实例。
device_id (int) – Chain 总线上摇杆的设备 ID。

UiFlow2 代码块：

MicroPython 代码块：

from chain import ChainBus
from chain import JoystickChain

chainbus_0 = ChainBus(2, 32, 33, verbose=True)
joystick_0 = JoystickChain(chainbus_0, 1)

其它按键及通用方法请参考 ChainKey 类。

get_x()

获取摇杆的 X 位置。

返回:: X 位置 (-128 到 127)。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

x = joystick_0.get_x()

get_y()

获取摇杆的 Y 位置。

返回:: Y 位置 (-128 到 127)。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

y = joystick_0.get_y()

get_x_16bit()

获取摇杆的 X 位置（16 位分辨率）。

返回:: X 位置 (-4095 到 4095)。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

x = joystick_0.get_x_16bit()

get_y_16bit()

获取摇杆的 Y 位置（16 位分辨率）。

返回:: Y 位置 (-4095 到 4095)。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

y = joystick_0.get_y_16bit()

get_x_raw()

获取摇杆的原始 X ADC 值。

返回:: 原始 X ADC 值 (0-255)。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

x = joystick_0.get_x_raw()

get_y_raw()

获取摇杆的原始 Y ADC 值。

返回:: 原始 Y ADC 值 (0-255)。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

y = joystick_0.get_y_raw()

get_x_16bit_raw()

获取摇杆的原始 X ADC 值（16 位分辨率）。

返回:: 原始 X ADC 值 (0-65535)。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

x = joystick_0.get_x_16bit_raw()

get_y_16bit_raw()

获取摇杆的原始 Y ADC 值（16 位分辨率）。

返回:: 原始 Y ADC 值 (0-65535)。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

y = joystick_0.get_y_16bit_raw()

get_mapping_value()

获取摇杆的映射值。

返回:: 包含映射值的元组 (x_negative_min, x_negative_max, x_positive_min, x_positive_max, y_negative_min, y_negative_max, y_positive_min, y_positive_max)。
返回类型:: tuple

UiFlow2 代码块：

MicroPython 代码块：

mapping = joystick_0.get_mapping_value()

set_mapping_value(value, save=False)

设置摇杆的映射值。

参数:

value (tuple) – 包含映射值的元组 (x_negative_min, x_negative_max, x_positive_min, x_positive_max, y_negative_min, y_negative_max, y_positive_min, y_positive_max)。
save (bool) – 是否将映射值保存到非易失性存储。

返回:

设置成功返回 True，否则返回 False。

返回类型:

bool

UiFlow2 代码块：

MicroPython 代码块：

success = joystick_0.set_mapping_value((100, 200, 300, 400, 100, 200, 300, 400), True)