Key Unit

Unit Key is a single mechanical key input unit with built-in RGB LED. The key shaft adopts Blue switch with tactile bump and audible click features. Embedded with one programable RGB LED - SK6812, supports 256 level brightness. Two digital IOs are available for key status and LED control key status and lighting control. Suitable for multiple HMI applications.

Support the following products:

Micropython Example:

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

import os, sys, io
import M5
from M5 import *
from unit import KeyUnit


label0 = None
key_0 = None


def key_0_wasPressed_event(state):  # noqa: N802
    global label0, key_0
    key_0.set_color(0x6600CC)
    label0.setText(str("pressed"))


def key_0_wasReleased_event(state):  # noqa: N802
    global label0, key_0
    key_0.set_color(0x33CC00)
    label0.setText(str("released"))


def setup():
    global label0, key_0

    M5.begin()
    Widgets.fillScreen(0x222222)
    label0 = Widgets.Label("label0", 108, 100, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)

    key_0 = KeyUnit((8, 9))
    key_0.setCallback(type=key_0.CB_TYPE.WAS_PRESSED, cb=key_0_wasPressed_event)
    key_0.setCallback(type=key_0.CB_TYPE.WAS_RELEASED, cb=key_0_wasReleased_event)


def loop():
    global label0, key_0
    M5.update()
    key_0.tick(None)


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 Example:

cores3_key_example.m5f2

class KeyUnit

Constructors

class KeyUnit(port: tuple)

Initialize the KeyUnit.

参数:: port (tuple) – The port to which the KeyUnit is connected. port[0]: key pin, port[1]: LEDs pin.

UIFLOW2:

Methods

KeyUnit.get_key_state() → int

Get the state of the key.

返回:: 0: released, 1: pressed, 2: long pressed.

UIFLOW2:

KeyUnit.set_color(color: int) → None

Set the color of the LED.

参数:: color (int) – The color of the LED.

UIFLOW2:

KeyUnit.set_brightness(br: int) → None

Set the brightness of the LED.

参数:: br (int) – The brightness of the LED, range from 0 to 100.

UIFLOW2:

KeyUnit.isHolding()

Returns whether the Button object is in a long press state.

UIFLOW2:

KeyUnit.isPressed()

Returns whether the Button object is in a pressed state.

UIFLOW2:

KeyUnit.isReleased()

Returns whether the Button object is in a released state.

UIFLOW2:

KeyUnit.wasClicked()

Returns True when the Button object is briefly pressed and released.

UIFLOW2:

KeyUnit.wasDoubleClicked()

Returns True when the Button object is double-clicked after a certain amount of time.

UIFLOW2:

KeyUnit.wasHold()

Returns True when the Button object is held down for a certain amount of time.

UIFLOW2:

KeyUnit.wasPressed()

Returns True when the Button object is pressed.

UIFLOW2:

KeyUnit.wasReleased()

Returns True when the Button object is released.

UIFLOW2:

KeyUnit.wasSingleClicked()

Returns True when the Button object is single-clicked after a certain amount of time.

UIFLOW2:

Event Handling

KeyUnit.setCallback(type: Callback_Type, cb)

Sets the event callback function.

UIFLOW2:

Constants

KeyUnit.CB_TYPE: A CB_TYPE object.

class CB_TYPE

Constants

CB_TYPE.WAS_CLICKED: Single click event type.

CB_TYPE.WAS_DOUBLECLICKED: Double click event type.

CB_TYPE.WAS_HOLD: Long press event type.

CB_TYPE.WAS_PRESSED: Press event type

CB_TYPE.WAS_RELEASED: Release event type