DualKey

支持以下产品：

UiFlow2 应用示例

按钮 LED 控制

在 UiFlow2 上打开 dualkey_button_led_example.m5f2 项目。

该示例演示了使用按钮回调函数来切换 RGB LED 灯。当点击左侧按钮（BtnA）时，它会切换左侧 RGB LED（LED 0）。当点击右侧按钮（BtnB）时，它会切换右侧 RGB LED（LED 1）。

UiFlow2 代码块：

示例输出：

无

电源检测

在 UiFlow2 上打开 dualkey_power_detection_example.m5f2 项目。

该示例演示了电池电压监测和开关位置检测。它读取开关位置（左/中/右）并显示相应的 RGB LED 颜色，同时定期读取并显示电池电压（单位为毫伏）。

UiFlow2 代码块：

示例输出：

无

USB 鼠标

在 UiFlow2 上打开 dualkey_usb_mouse_example.m5f2 项目。

该示例演示了通过按钮触发点击的 USB HID 鼠标功能。当点击左侧按钮（BtnA）时，它会发送左键点击并点亮左侧 RGB LED。当点击右侧按钮（BtnB）时，它会发送右键点击并点亮右侧 RGB LED。LED 会在 300ms 后自动熄灭。

UiFlow2 代码块：

示例输出：

无

MicroPython 应用示例

按钮 LED 控制

该示例演示了使用按钮回调函数来切换 RGB LED 灯。当点击左侧按钮（BtnA）时，它会切换左侧 RGB LED（LED 0）。当点击右侧按钮（BtnB）时，它会切换右侧 RGB LED（LED 1）。

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from hardware import RGB


rgb = None
led1_state = None
led2_state = None


def btnb_was_clicked_event(state):
    global rgb, led1_state, led2_state
    print("clicke left")
    led1_state = not led1_state
    if led1_state:
        rgb.set_color(0, 0x009900)
    else:
        rgb.set_color(0, 0x000000)


def btna_was_clicked_event(state):
    global rgb, led1_state, led2_state
    print("click right")
    led2_state = not led2_state
    if led2_state:
        rgb.set_color(1, 0x009900)
    else:
        rgb.set_color(1, 0x000000)


def setup():
    global rgb, led1_state, led2_state

    M5.begin()
    BtnA.setCallback(type=BtnA.CB_TYPE.WAS_CLICKED, cb=btna_was_clicked_event)
    BtnB.setCallback(type=BtnB.CB_TYPE.WAS_CLICKED, cb=btnb_was_clicked_event)

    rgb = RGB()
    rgb.set_color(0, 0x33CCFF)
    rgb.set_color(1, 0x33CCFF)


def loop():
    global rgb, led1_state, led2_state
    M5.update()


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

示例输出：

无

电源检测

该示例演示了电池电压监测和开关位置检测。它读取开关位置（左/中/右）并显示相应的 RGB LED 颜色，同时定期读取并显示电池电压（单位为毫伏）。

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from hardware import RGB
from hardware import dualkey
import time


rgb = None
sw_status = None
battery_voltage = None


def setup():
    global rgb, sw_status, battery_voltage
    M5.begin()
    rgb = RGB()
    rgb.set_color(0, 0x000000)
    rgb.set_color(1, 0x000000)


def loop():
    global rgb, sw_status, battery_voltage
    M5.update()
    sw_status = dualkey.get_switch_position()
    if sw_status == 0:
        print("Left")
        rgb.set_color(0, 0x009900)
        rgb.set_color(1, 0x000000)
    elif sw_status == 1:
        print("Middle")
        rgb.set_color(0, 0x000000)
        rgb.set_color(1, 0x000000)
    elif sw_status == 2:
        rgb.set_color(0, 0x000000)
        rgb.set_color(1, 0x009900)
        print("Right")
    battery_voltage = dualkey.get_battery_voltage()
    print((str((str("Battery voltage: ") + str(battery_voltage))) + str("mV")))
    time.sleep_ms(500)


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 鼠标

该示例演示了通过按钮触发点击的 USB HID 鼠标功能。当点击左侧按钮（BtnA）时，它会发送左键点击并点亮左侧 RGB LED。当点击右侧按钮（BtnB）时，它会发送右键点击并点亮右侧 RGB LED。LED 会在 300ms 后自动熄灭。

备注

当 USB 鼠标初始化时，USB-CDC REPL 可能会断开连接。运行此示例后，您可能需要重新连接到设备。

MicroPython 代码块：

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT
import os, sys, io
import M5
from M5 import *
from hardware import RGB
from usb.device.mouse import Mouse
import time


rgb = None
mouse = None
click_left = None
click_right = None
last_time = None


def btnb_was_clicked_event(state):
    global rgb, mouse, click_left, click_right, last_time
    print("click left")
    click_left = True


def btna_was_clicked_event(state):
    global rgb, mouse, click_left, click_right, last_time
    print("click right")
    click_right = True


def setup():
    global rgb, mouse, click_left, click_right, last_time

    M5.begin()
    BtnA.setCallback(type=BtnA.CB_TYPE.WAS_CLICKED, cb=btna_was_clicked_event)
    BtnB.setCallback(type=BtnB.CB_TYPE.WAS_CLICKED, cb=btnb_was_clicked_event)

    rgb = RGB()
    rgb.set_color(0, 0x3333FF)
    rgb.set_color(1, 0x3333FF)
    mouse = Mouse()


def loop():
    global rgb, mouse, click_left, click_right, last_time
    M5.update()
    if click_left:
        click_left = False
        if mouse.is_open():
            mouse.click_left(True)
            rgb.set_color(0, 0x009900)
            rgb.set_color(1, 0x000000)
            last_time = time.ticks_ms()
    if click_right:
        click_right = False
        if mouse.is_open():
            mouse.click_right(True)
            rgb.set_color(0, 0x000000)
            rgb.set_color(1, 0x009900)
    if (time.ticks_diff((time.ticks_ms()), last_time)) >= 300:
        rgb.set_color(0, 0x000000)
        rgb.set_color(1, 0x000000)


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

示例输出：

无

API应用

class DualKey

class hardware.dualkey.DualKey

DualKey 模块 - 电压和开关检测（单例）。

DualKey 类是一个单例，提供了监控电池电压、VBUS 电压、充电状态和开关位置的方法。

MicroPython 代码块：

from hardware import dualkey

get_battery_voltage()

获取电池电压。

返回:

电池电压值，单位为毫伏 (mV)。

返回类型:

int

UiFlow2 代码块：

MicroPython 代码块：

voltage = dualkey.get_battery_voltage()
print(f"Battery voltage: {voltage} mV")

get_vbus_voltage()

获取 VBUS（USB 电源）电压。

返回:

VBUS 电压值，单位为毫伏 (mV)。

返回类型:

int

UiFlow2 代码块：

MicroPython 代码块：

vbus_voltage = dualkey.get_vbus_voltage()
print(f"VBUS voltage: {vbus_voltage} mV")

is_charging()

检测设备是否正在充电。

返回:

如果正在充电返回 True，如果未在充电返回 False。

返回类型:

bool

UiFlow2 代码块：

MicroPython 代码块：

if dualkey.is_charging():
    print("Device is charging")
else:
    print("Device is not charging")

get_switch_position()

获取开关位置。

返回:

开关位置值：- 0: 左侧 - 1: 中间 - 2: 右侧

返回类型:

int

UiFlow2 代码块：

MicroPython 代码块：

position = dualkey.get_switch_position()
if position == 0:
    print("Switch position: left")
elif position == 1:
    print("Switch position: middle")
elif position == 2:
    print("Switch position: right")