Atomic QRCode Base

这个库是 Atomic QRCode Base 的驱动，该模块使用 UART 通信。

支持以下产品：

UiFlow2 应用示例：

按键模式二维码识别

在 UiFlow2 上打开 atoms3_qrcode_key_mode_example.m5f2 项目。

在按键模式下，模块在按下按键时开始解码，并在释放按键时停止解码

UiFlow2 代码块：

示例输出：

无

主机模式二维码识别

在 UiFlow2 上打开 atoms3_qrcode_host_mode_example.m5f2 项目。

在主机模式下，按下一次按键开始解码，再次按下停止解码。

UiFlow2 代码块：

示例输出：

无

自动模式二维码识别

在 UiFlow2 上打开 atoms3_qrcode_auto_mode_example.m5f2 项目。

在自动模式下，模块上电开始扫码解码，不可停止。

UiFlow2 代码块：

示例输出：

无

脉冲模式二维码识别

在 UiFlow2 上打开 atoms3_qrcode_pulse_mode_example.m5f2 项目。

在脉冲模式下，设置触发引脚超过 20ms 的低电平触发解码一次。

UiFlow2 代码块：

示例输出：

无

移动感应模式二维码识别

在 UiFlow2 上打开 atoms3_qrcode_motion_sensing_mode_example.m5f2 项目。

在感应模式下，模块基于视觉识别信息检测到场景变化时，会自动触发解码。

UiFlow2 代码块：

示例输出：

无

MicroPython 应用示例：

按键模式二维码识别

在按键模式下，模块在按下按键时开始解码，并在释放按键时停止解码

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from base import AtomicQRCodeBase


title0 = None
label_data = None
label_status = None
base_qrcode = None
is_scanning = None
status = None
data = None


def setup():
    global title0, label_data, label_status, base_qrcode, is_scanning, status, data
    M5.begin()
    title0 = Widgets.Title("QRCode", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18)
    label_data = Widgets.Label("data", 5, 60, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu18)
    label_status = Widgets.Label(
        "stop scan", 5, 25, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu18
    )
    base_qrcode = AtomicQRCodeBase(2, 5, 6, 7, 8)
    base_qrcode.set_trigger_mode(base_qrcode.TRIGGER_MODE_KEY)
    is_scanning = False
    status = is_scanning


def loop():
    global title0, label_data, label_status, base_qrcode, is_scanning, status, data
    M5.update()
    if BtnA.isPressed():
        base_qrcode.set_trig(0)
        is_scanning = True
    else:
        base_qrcode.set_trig(1)
        is_scanning = False
    if status != is_scanning:
        status = is_scanning
        if status:
            label_status.setColor(0x00FF00, 0x000000)
            label_status.setText(str("scanning"))
        else:
            label_status.setColor(0xFFFFFF, 0x000000)
            label_status.setText(str("stop scan"))
    data = base_qrcode.read()
    if data:
        label_data.setText(str(data.decode()))
        print(data.decode())


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

示例输出：

无

主机模式二维码识别

在主机模式下，按下一次按键开始解码，再次按下停止解码。

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from base import AtomicQRCodeBase


title0 = None
label_data = None
label_status = None
base_qrcode = None
is_scanning = None
data = None


def btna_was_clicked_event(state):
    global title0, label_data, label_status, base_qrcode, is_scanning, data
    if is_scanning:
        base_qrcode.stop_decode()
        label_status.setText(str("stop scan"))
        label_status.setColor(0xFFFFFF, 0x000000)
    else:
        base_qrcode.start_decode()
        label_status.setText(str("scanning"))
        label_status.setColor(0x00FF00, 0x000000)
    is_scanning = not is_scanning


def setup():
    global title0, label_data, label_status, base_qrcode, is_scanning, data
    M5.begin()
    title0 = Widgets.Title("QRCode", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18)
    label_data = Widgets.Label("data", 5, 60, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu18)
    label_status = Widgets.Label(
        "stop scan", 5, 25, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu18
    )
    BtnA.setCallback(type=BtnA.CB_TYPE.WAS_CLICKED, cb=btna_was_clicked_event)
    base_qrcode = AtomicQRCodeBase(2, 5, 6, 7, 8)
    is_scanning = False
    base_qrcode.set_trigger_mode(base_qrcode.TRIGGER_MODE_HOST)
    base_qrcode.set_pos_light_mode(base_qrcode.POS_LIGHT_ON_DECODE)
    base_qrcode.set_fill_light_mode(base_qrcode.FILL_LIGHT_ON_DECODE)


def loop():
    global title0, label_data, label_status, base_qrcode, is_scanning, data
    M5.update()
    data = base_qrcode.read()
    if data:
        label_data.setText(str(data.decode()))
        print(data.decode())
        base_qrcode.start_decode()


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

示例输出：

无

自动模式二维码识别

在自动模式下，模块上电开始扫码解码，不可停止。

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from base import AtomicQRCodeBase


title0 = None
label_data = None
label_status = None
base_qrcode = None
data = None


def setup():
    global title0, label_data, label_status, base_qrcode, data
    M5.begin()
    title0 = Widgets.Title("QRCode", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18)
    label_data = Widgets.Label("data", 5, 60, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu18)
    label_status = Widgets.Label(
        "scanning", 5, 25, 1.0, 0x00FF00, 0x000000, Widgets.FONTS.DejaVu18
    )
    base_qrcode = AtomicQRCodeBase(2, 5, 6, 7, 8)
    base_qrcode.set_trigger_mode(base_qrcode.TRIGGER_MODE_AUTO)


def loop():
    global title0, label_data, label_status, base_qrcode, data
    M5.update()
    data = base_qrcode.read()
    if data:
        print(data.decode())
        label_data.setText(str(data.decode()))


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

示例输出：

无

脉冲模式二维码识别

在脉冲模式下，设置触发引脚超过 20ms 的低电平触发解码一次。

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from base import AtomicQRCodeBase
import time


title0 = None
label_data = None
label_status = None
base_qrcode = None
data = None


def btna_was_clicked_event(state):
    global title0, label_data, label_status, base_qrcode, data
    base_qrcode.set_trig(0)
    time.sleep_ms(20)
    base_qrcode.set_trig(1)
    label_status.setText(str("scanning"))
    label_status.setColor(0x00FF00, 0x000000)


def setup():
    global title0, label_data, label_status, base_qrcode, data
    M5.begin()
    title0 = Widgets.Title("QRCode", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18)
    label_data = Widgets.Label("data", 5, 60, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu18)
    label_status = Widgets.Label(
        "stop scan", 5, 25, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu18
    )
    BtnA.setCallback(type=BtnA.CB_TYPE.WAS_CLICKED, cb=btna_was_clicked_event)
    base_qrcode = AtomicQRCodeBase(2, 5, 6, 7, 8)
    base_qrcode.set_trigger_mode(base_qrcode.TRIGGER_MODE_PULSE)


def loop():
    global title0, label_data, label_status, base_qrcode, data
    M5.update()
    data = base_qrcode.read()
    if data:
        label_data.setText(str(data.decode()))
        label_status.setText(str("stop scan"))
        label_status.setColor(0xFFFFFF, 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")

示例输出：

无

移动感应模式二维码识别

在感应模式下，模块基于视觉识别信息检测到场景变化时，会自动触发解码。

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from base import AtomicQRCodeBase


title0 = None
label_data = None
label_status = None
base_qrcode = None
data = None


def setup():
    global title0, label_data, label_status, base_qrcode, data
    M5.begin()
    title0 = Widgets.Title("QRCode", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18)
    label_data = Widgets.Label("data", 5, 60, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu18)
    label_status = Widgets.Label(
        "detecting", 5, 25, 1.0, 0x00FF00, 0x000000, Widgets.FONTS.DejaVu18
    )
    base_qrcode = AtomicQRCodeBase(2, 5, 6, 7, 8)
    base_qrcode.set_trigger_mode(base_qrcode.TRIGGER_MODE_MOTION_SENSING)


def loop():
    global title0, label_data, label_status, base_qrcode, data
    M5.update()
    data = base_qrcode.read()
    if data:
        label_data.setText(str(data.decode()))


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应用

AtomicQRCodeBase

class base.qrcode.AtomicQRCodeBase(id=1, tx=5, rx=6, trig=7, done=8)

基类：object

创建一个 AtomicQRCodeBase 对象。

参数:

• id (int) – UART 端口号。

• tx (int) – UART 发送引脚。

• rx (int) – UART 接收引脚。

• trig (int) – 触发引脚。

• done (int) – 接收完成引脚。

UiFlow2 代码块：

MicroPython 代码块：

from base import AtomicQRCodeBase

base_qrcode = AtomicQRCodeBase(id = 1, tx = 6, rx = 5, trig = 7, done = 8)

set_trig(value)

设置触发引脚电平。

参数:

value (int) – 0 - 低电平, 1 - 高电平。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_trig(value)

start_decode()

开始解码。

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.start_decode()

返回类型:

None

stop_decode()

停止解码。

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.stop_decode()

返回类型:

None

read()

读取解码数据。

返回:

二维码数据。

返回类型:

None | bytes

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.read()

set_trigger_mode(mode)

Set trigger mode.

参数:

mode (int) – 触发解码模式，可选项: - TRIGGER_MODE_KEY: 按键模式, 触发引脚低电平触发解码，高电平停止解码，解码成功后停止解码。- TRIGGER_MODE_HOST: 主机模式, 命令控制解码，解码成功或者超时停止解码- TRIGGER_MODE_AUTO: 自动模式, 上电自动开始解码。- TRIGGER_MODE_PULSE: 脉冲模式, 触发引脚 20ms 以上低电平触发一次解码。- TRIGGER_MODE_MOTION_SENSING: 移动感应模式，使用图像识别感应，当检测到场景发生变化时，触发解码。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_trigger_mode(mode)

set_decode_continuous(delay_100ms)

设置解码持续时间。

参数:

delay_100ms (int) – 解码持续时间(单位: 100ms)，范围：0~99，对应 0~9900 ms(0表示无限时)。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_decode_continuous(delay_100ms)

set_decode_interval(interval_100ms)

设置解码间隔时间

参数:

interval_100ms (int) – 解码间隔时间(单位:100ms)，范围：0~99，对应 0~9900 ms。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_decode_interval(interval_100ms)

set_same_code_interval(interval_100ms)

设置同码间隔。

参数:

interval_100ms (int) – 同码间隔(单位:100ms), 范围: 0~99, 对应 0~9900ms 。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_same_code_interval(interval_100ms)

set_fill_light_mode(mode)

设置补光灯模式。

参数:

mode (int) – 补光灯模式，可选项: - FILL_LIGHT_OFF: 常灭。- FILL_LIGHT_ON: 常亮。 - FILL_LIGHT_ON_DECODE: 解码时亮。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_fill_light_mode(mode)

set_pos_light_mode(mode)

设置定位灯模式。

参数:

mode (int) – 定位灯模式，可选项: - POS_LIGHT_OFF: 常灭。 - POS_LIGHT_ON: 常亮。 - POS_LIGHT_ON_DECODE: 解码时亮。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_pos_light_mode(mode)

set_startup_tone(enable)

设置启动提示音。

参数:

enable (bool) – True - 开启启动提示音, False - 关闭启动提示音。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_startup_tone(enable)

set_decode_success_tone(enable)

设置解码成功提示音。

参数:

enable (bool) – True - 打开解码成功提示音，False - 关闭解码成功提示音。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_decode_success_tone(enable)

set_config_tone(enable)

设置配置参数提示音。

参数:

enable (bool) – True - 打开配置参数提示音，False - 关闭配置参数提示音。

返回类型:

None

UiFlow2 代码块：

MicroPython 代码块：

base_qrcode.set_config_tone(enable)