Chain PIR

PIRChain 是链式总线上 PIR（被动红外）传感器设备的辅助类。它提供了读取红外感应值、配置触发延迟以及监控 PIR 触发事件的方法。

支持以下产品：

UiFlow2 应用示例

PIR 运动检测

在 UiFlow2 中打开 m5core_chain_pir_basic_example.m5f2 项目。

本示例演示如何使用 Chain PIR 传感器的触发回调来更新屏幕上的运动状态。它启用触发自动发送、配置触发保持时间，并在运动激活时统计检测持续时间。

UiFlow2 代码块：

示例输出：

None

MicroPython 应用示例

PIR 运动检测

本示例演示如何使用 Chain PIR 传感器的触发回调来更新屏幕上的运动状态。它启用触发自动发送、配置触发保持时间，并在运动激活时统计检测持续时间。

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from chain import PIRChain
from chain import ChainBus
import time


title0 = None
label_status = None
label_count = None
bus2 = None
chain_pir_0 = None
detected = None
count = None
last_time = None
trigger_hold_time = None


def chain_pir_0_motion_detected_event(args):
    global \
        title0, \
        label_status, \
        label_count, \
        bus2, \
        chain_pir_0, \
        detected, \
        count, \
        last_time, \
        trigger_hold_time
    print("detect motion")
    detected = True
    count = 0
    label_status.setText(str("Status: detected"))
    label_status.setColor(0x009900, 0x000000)
    label_count.setVisible(True)


def chain_pir_0_motion_ended_event(args):
    global \
        title0, \
        label_status, \
        label_count, \
        bus2, \
        chain_pir_0, \
        detected, \
        count, \
        last_time, \
        trigger_hold_time
    print("not detect")
    detected = False
    label_status.setText(str("Status: no detect"))
    label_status.setColor(0xCCCCCC, 0x000000)
    label_count.setVisible(False)


def setup():
    global \
        title0, \
        label_status, \
        label_count, \
        bus2, \
        chain_pir_0, \
        detected, \
        count, \
        last_time, \
        trigger_hold_time

    M5.begin()
    Widgets.setRotation(1)
    Widgets.fillScreen(0x000000)
    title0 = Widgets.Title("Chain PIR Example", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu24)
    label_status = Widgets.Label(
        "Status: --", 20, 70, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu24
    )
    label_count = Widgets.Label(
        "Count: --", 20, 165, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.DejaVu24
    )

    bus2 = ChainBus(2, tx=21, rx=22)
    chain_pir_0 = PIRChain(bus2, 1)
    chain_pir_0.set_trigger_callback(
        PIRChain.TRIGGER_MOTION_DETECTED, chain_pir_0_motion_detected_event
    )
    chain_pir_0.set_trigger_callback(PIRChain.TRIGGER_MOTION_ENDED, chain_pir_0_motion_ended_event)
    chain_pir_0.set_trigger(True)
    chain_pir_0.set_trigger_hold_time(5, save=False)
    trigger_hold_time = chain_pir_0.get_trigger_hold_time()
    print((str("trigger hold time: ") + str(trigger_hold_time)))
    detected = chain_pir_0.get_detect_status()
    if detected:
        label_status.setText(str("Status: detected"))
        label_status.setColor(0x009900, 0x000000)


def loop():
    global \
        title0, \
        label_status, \
        label_count, \
        bus2, \
        chain_pir_0, \
        detected, \
        count, \
        last_time, \
        trigger_hold_time
    M5.update()
    if detected:
        if (time.ticks_diff((time.ticks_ms()), last_time)) >= 1000:
            last_time = time.ticks_ms()
            count = (count if isinstance(count, (int, float)) else 0) + 1
            label_count.setText(str((str("Count: ") + str(count))))
    else:
        pass


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            bus2.deinit()
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

示例输出：

None

API 参考

PIRChain

class chain.pir.PIRChain(bus, device_id)

基类：KeyChain

用于通过链式总线与 PIR（被动红外）传感器设备交互的 PIR Chain 类。

参数:

bus (ChainBus) – Chain 总线实例。
device_id (int) – Chain 总线上 PIR 传感器的设备 ID。

UiFlow2 代码块：

MicroPython 代码块：

from chain import ChainBus
from chain import PIRChain

bus2 = ChainBus(2, tx=21, rx=22)
chain_pir_0 = PIRChain(bus2, 1)

其他按钮和一些通用方法，请参考 ChainKey 类。

get_detect_status()

获取运动检测状态。

返回:: 运动检测状态。True 表示检测到运动，False 表示运动结束。失败时返回 False。
返回类型:: bool

UiFlow2 代码块：

MicroPython 代码块：

status = chain_pir_0.get_detect_status()

set_trigger(enable)

启用或禁用 PIR 检测报告。

参数:: enable (bool) – True 启用 PIR 检测报告，False 禁用。
返回:: 操作成功返回 True，否则返回 False。
返回类型:: bool

UiFlow2 代码块：

MicroPython 代码块：

success = chain_pir_0.set_trigger(True)

get_trigger()

获取是否启用 PIR 检测报告。

返回:: 启用 PIR 检测报告返回 True，禁用返回 False。失败时返回 False。
返回类型:: bool

UiFlow2 代码块：

MicroPython 代码块：

enabled = chain_pir_0.get_trigger()

set_trigger_hold_time(seconds, save=False)

设置触发运动结束状态前的保持时间。

参数:

seconds (int) – 保持时间（秒）。范围：0-255。
save (bool) – 是否将设置保存到闪存。默认值：False。

返回:

操作成功返回 True，否则返回 False。

返回类型:

bool

UiFlow2 代码块：

MicroPython 代码块：

success = chain_pir_0.set_trigger_hold_time(5, False)

get_trigger_hold_time()

获取触发运动结束状态前的保持时间。

返回:: 保持时间（秒），失败时返回 None。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

hold_time = chain_pir_0.get_trigger_hold_time()

set_trigger_callback(trigger_type, callback)

设置 PIR 运动检测事件的回调。

参数:

trigger_type (int) – 要监听的触发类型。使用 PIRChain.TRIGGER_MOTION_DETECTED (1) 表示检测到运动，或 PIRChain.TRIGGER_MOTION_ENDED (0) 表示运动结束。
callback – 当 PIR 运动检测状态变化时将被调用的回调函数。

返回类型:

None

备注

在回调函数中不能调用链式相关方法。

UiFlow2 代码块：

MicroPython 代码块：

def motion_detected_callback(args):
    print("Motion detected")

def motion_ended_callback(args):
    print("Motion ended")

# Listen for motion detected only
chain_pir_0.set_trigger_callback(PIRChain.TRIGGER_MOTION_DETECTED, motion_detected_callback)

# Listen for motion ended only
chain_pir_0.set_trigger_callback(PIRChain.TRIGGER_MOTION_ENDED, motion_ended_callback)