StamPLC

StamPLC 是 StamPLC 内置 PLC I/O 的板级辅助类。

支持的产品：

创建一个 StamPLC 对象后，可以通过该对象访问继电器输出、数字输入和内置 RGB LED。

通道编号从 1 开始：

relay[1] 到 relay[4] 控制 4 路继电器输出。
input[1] 到 input[8] 读取 8 路数字输入。
led.red、led.green 和 led.blue 控制内置 RGB LED。

MicroPython 示例

继电器控制

在 UiFlow2 中打开 stamplc_relay_control_example.m5f2 项目。

此示例使用按键 A 切换继电器输出 1，并点亮内置蓝色 LED。

UiFlow2 代码块：

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from stamplc import StamPLC


title0 = None
label_tip = None
label_state = None
stamplc_0 = None


def btna_was_clicked_event(state):
    global title0, label_tip, label_state, stamplc_0
    stamplc_0.relay[1].toggle()
    if stamplc_0.relay[1].value():
        label_state.setText(str("Realy1: ON"))
        label_state.setCursor(x=55, y=53)
        label_state.setColor(0x009900, 0x000000)
    else:
        label_state.setText(str("Realy1: OFF"))
        label_state.setCursor(x=50, y=53)
        label_state.setColor(0xFFFFFF, 0x000000)


def setup():
    global title0, label_tip, label_state, stamplc_0

    M5.begin()
    Widgets.fillScreen(0x000000)
    title0 = Widgets.Title("Relay Control", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.Montserrat24)
    label_tip = Widgets.Label(
        "BtnA control relay1", 33, 103, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_state = Widgets.Label(
        "Realy1: OFF", 50, 53, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat24
    )

    BtnA.setCallback(type=BtnA.CB_TYPE.WAS_CLICKED, cb=btna_was_clicked_event)

    stamplc_0 = StamPLC()
    stamplc_0.led.blue.on()


def loop():
    global title0, label_tip, label_state, stamplc_0
    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")

数字输入控制

在 UiFlow2 中打开 stamplc_input_example.m5f2 项目。

此示例读取数字输入 1-3，并使用这些输入控制继电器输出 1-3。

UiFlow2 代码块：

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
import time
from stamplc import StamPLC


title0 = None
label_relay1_state = None
label_relay2_state = None
label_relay3_state = None
stamplc_0 = None


last_time = None
state1 = None
laste_state1 = None
state2 = None
last_state2 = None
state3 = None
last_state3 = None


def setup():
    global \
        title0, \
        label_relay1_state, \
        label_relay2_state, \
        label_relay3_state, \
        stamplc_0, \
        last_time, \
        state1, \
        laste_state1, \
        state2, \
        last_state2, \
        state3, \
        last_state3

    M5.begin()
    Widgets.fillScreen(0x000000)
    title0 = Widgets.Title(
        "Input control relay", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.Montserrat24
    )
    label_relay1_state = Widgets.Label(
        "Relay1: OFF", 10, 35, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_relay2_state = Widgets.Label(
        "Relay2: OFF", 10, 65, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_relay3_state = Widgets.Label(
        "Relay3: OFF", 10, 95, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )

    stamplc_0 = StamPLC()
    stamplc_0.led.red.value(1)


def loop():
    global \
        title0, \
        label_relay1_state, \
        label_relay2_state, \
        label_relay3_state, \
        stamplc_0, \
        last_time, \
        state1, \
        laste_state1, \
        state2, \
        last_state2, \
        state3, \
        last_state3
    M5.update()
    if (time.ticks_diff((time.ticks_ms()), last_time)) >= 200:
        last_time = time.ticks_ms()
        state1 = stamplc_0.input[1].value()
        if state1 != laste_state1:
            laste_state1 = state1
            if state1:
                stamplc_0.relay[1].value(1)
                label_relay1_state.setText(str("Relay1: ON"))
                label_relay1_state.setColor(0x009900, 0x000000)
            else:
                stamplc_0.relay[1].value(0)
                label_relay1_state.setText(str("Relay1: OFF"))
                label_relay1_state.setColor(0xFFFFFF, 0x000000)
        state2 = stamplc_0.input[2].value()
        if state2 != last_state2:
            last_state2 = state2
            if state2:
                stamplc_0.relay[2].value(1)
                label_relay2_state.setText(str("Relay2: ON"))
                label_relay2_state.setColor(0x009900, 0x000000)
            else:
                stamplc_0.relay[2].value(0)
                label_relay2_state.setText(str("Relay2: OFF"))
                label_relay2_state.setColor(0xFFFFFF, 0x000000)
        state3 = stamplc_0.input[3].value()
        if state3 != last_state3:
            last_state3 = last_state3
            if state3:
                stamplc_0.relay[3].value(1)
                label_relay3_state.setText(str("Relay3: ON"))
                label_relay3_state.setColor(0x009900, 0x000000)
            else:
                stamplc_0.relay[3].value(0)
                label_relay3_state.setText(str("Relay3: OFF"))
                label_relay3_state.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")

API

StamPLC

class StamPLC

创建 StamPLC 板级辅助对象。

UiFlow2 代码块：

MicroPython 代码块：

from stamplc import StamPLC

plc = StamPLC()

relay

继电器输出组。继电器通道编号为 1 到 4。创建 StamPLC() 时，继电器会初始化为 False/关闭。

relay[channel].on()

打开一路继电器输出。

参数:: channel (int) – 继电器通道，范围 1-4。

UiFlow2 代码块：

MicroPython 代码块：

plc.relay[1].on()

relay[channel].off()

关闭一路继电器输出。

参数:: channel (int) – 继电器通道，范围 1-4。

UiFlow2 代码块：

MicroPython 代码块：

plc.relay[1].off()

relay[channel].toggle()

切换一路继电器输出状态。

参数:: channel (int) – 继电器通道，范围 1-4。

UiFlow2 代码块：

MicroPython 代码块：

plc.relay[1].toggle()

relay[channel].value(state=None)

获取或设置一路继电器输出。

参数:

channel (int) – 继电器通道，范围 1-4。
state (bool) – 可选输出状态。True 打开继电器，False 关闭继电器。

返回:

省略 state 时返回继电器状态。

返回类型:

bool or None

UiFlow2 代码块：

MicroPython 代码块：

plc.relay[1].value(True)
state = plc.relay[1].value()

input

数字输入组。创建 StamPLC() 时，所有数字输入通道都会初始化为输入。输入通道编号为 1 到 8。

input[channel].value()

读取一路输入通道。

参数:: channel (int) – 输入通道，范围 1-8。
返回:: 所选输入值，0 或 1。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

input_1 = plc.input[1].value()

input[channel].irq(handler, trigger)

为一路输入通道设置中断处理函数。回调函数接收输入引脚对象，可使用 pin.channel 获取通道编号。

参数:

channel (int) – 输入通道，范围 1-8。
handler (function) – 中断回调函数。
trigger (int) – plc.input.IRQ_FALLING 或 plc.input.IRQ_RISING。

UiFlow2 代码块：

MicroPython 代码块：

def input_1_falling_event(pin):
    print("input", pin.channel, "falling")

plc.input[1].irq(input_1_falling_event, plc.input.IRQ_FALLING)

led

内置 RGB LED 控制器。LED 由 PI4IOE5V6408 驱动：红色映射到 P6，绿色映射到 P5，蓝色映射到 P4。

led.red、led.green 和 led.blue 提供相同的方法。

led.red.on()

打开红色 LED。

UiFlow2 代码块：

MicroPython 代码块：

plc.led.red.on()

led.red.off()

关闭红色 LED。

UiFlow2 代码块：

MicroPython 代码块：

plc.led.red.off()

led.red.toggle()

切换红色 LED 状态。

UiFlow2 代码块：

MicroPython 代码块：

plc.led.red.toggle()

led.red.value(state=None)

获取或设置红色 LED 状态。

参数:: state (bool) – 可选 LED 状态。True 打开 LED，False 关闭 LED。
返回:: 省略 state 时返回 LED 状态。
返回类型:: bool or None

UiFlow2 代码块：

MicroPython 代码块：

plc.led.red.value(True)
state = plc.led.red.value()

MicroPython 代码块：

plc.led.green.on()
plc.led.blue.off()
plc.led.blue.toggle()