cst328_async_driver

CST328 I2C capacitive touch driver for MicroPython

1.0.0 yangcong-bit Updated At: 2026-11-10
Install Package
Local Install
mpremote mip install https://upypi.net/pkgs/cst328_async_driver/1.0.0
Remote Install
mip.install("https://upypi.net/pkgs/cst328_async_driver/1.0.0")
Version Selection
README

CST328 I2C capacitive touch driver for MicroPython — MicroPython 异步驱动

实验性异步版本:尚未完成实物验收。

同步来源:同步版本。维护者说明同步版本已验证;本次未逐包复测同步来源,适用硬件和固件范围以原有记录为准。

异步版本:本包 Python 源码及示例已通过 MicroPython 1.23 / 1.29 编译检查;软件回归只覆盖选定路径,不代表本包全部 API、实际器件及并发行为已验证。

仓库验证说明 · 两轮软件检查 · 受限清单 · 安装与初始化迁移

目录

简介

cst328_async_driver 是当前仓库中独立发布的 MicroPython 异步包。设备/功能名称和 API 均来自包内运行时文件;它不是对同步 API 的无依据重命名。源包:input/cst328_driver。

主要功能

  • 可解析的公开类:CST328, CST328Async, SyncAdapterMixin。
  • 可解析的公开调用入口:32 个(详见 API 矩阵)。
  • 异步等级:event_bridge;依据:IRQ/事件通知由协程消费;总线访问仍可能同步。

硬件要求

项目 从代码取得的事实
通信/IO I2C, Pin(
示例 GPIO 示例未声明固定 GPIO 编号
供电、地址与电平 仅按模块实物标签、数据手册及代码常量配置;。

软件环境

项目 值
运行时 MicroPython + uasyncio
包版本 1.0.0
作者 FreakStudio
依赖 无声明的第三方依赖

文件结构

├── code/_gs_cst328_cst328.py
├── code/cst328_async.py
├── code/main.py
├── examples/main_sync.py
├── LICENSE
└── package.json

文件说明

  • code/:实际发布的运行时 Python 模块;以 package.json.urls 为安装映射依据。
  • code/main.py(若存在):异步演示入口,不是默认发布运行时映射。
  • examples/(若存在):同步保真基线或额外示例,不应当作安装后的运行时模块。
  • package.json、LICENSE:发布元数据和许可证的唯一事实来源。

快速开始

  1. 按 package.json.urls 将运行时文件复制到设备;不要把 examples/ 当作运行时依赖。
  2. 按上文硬件/运行环境配置总线、GPIO、网络或凭证。
  3. 使用包内真实 code/main.py 的 import 与构造方式运行。以下是当前文件逐字读取的异步入口;部署时请保留 try/finally 并调用对象实际提供的 deinit() 或 aclose()。
try:
    import uasyncio as asyncio
except ImportError:
    import asyncio

async def main():
    # Python env   : MicroPython v1.23.0
    # -*- coding: utf-8 -*-
    # @Time    : 2026/07/23
    # @Author  : FreakStudio
    # @File    : main.py
    # @Description : Test CST328 touch driver
    # @License : MIT

    try:
        from micropython import const
    except ImportError:

        def const(value):
            return value


    from machine import I2C, Pin
    from _gs_cst328_cst328 import CST328

    # ======================================== 导入相关模块 =========================================
    # ======================================== 全局变量 ============================================
    # 引脚定义(请替换为实际引脚号)
    SCL_PIN = 22
    SDA_PIN = 21
    I2C_FREQ = 400000
    RST_PIN = 19
    IRQ_PIN = 18

    # 触摸屏逻辑尺寸
    TOUCH_WIDTH = 320
    TOUCH_HEIGHT = 240

    # CST328 I2C 地址
    CST328_I2C_ADDR = const(0x1A)

    # CST328 无标准芯片 ID 寄存器,通过读取触摸数据寄存器验证设备响应
    _CST328_VERIFY_REG = const(0xD000)
    _CST328_VERIFY_LEN = const(2)

    # 打印间隔控制
    last_print_time = time.ticks_ms()
    print_interval = 50  # ms

    # ======================================== 功能函数 ============================================
    # ======================================== 自定义类 ============================================
    # ======================================== 初始化配置 ==========================================
    await asyncio.sleep(3)

    print("FreakStudio: CST328 touch driver test")

    # 初始化 I2C 总线
    i2c = I2C(0, scl=Pin(SCL_PIN), sda=Pin(SDA_PIN), freq=I2C_FREQ)

    # I2C 设备扫描
    devices = i2c.scan()
    print("I2C devices found: %s" % str(devices))

    if not devices:
        raise RuntimeError("No I2C device found on I2C bus")

    # 检查 CST328 是否在预期地址
    if CST328_I2C_ADDR not in devices:
        raise RuntimeError("CST328 not found at expected address 0x%02X" % CST328_I2C_ADDR)

    # CST328 无标准芯片 ID 寄存器,通过 I2C 读响应验证设备存在
    try:
        i2c.writeto(CST328_I2C_ADDR, bytes(((_CST328_VERIFY_REG >> 8) & 0xFF, _CST328_VERIFY_REG & 0xFF)), False)
        i2c.readfrom(CST328_I2C_ADDR, _CST328_VERIFY_LEN)
        print("CST328 device verified at address 0x%02X" % CST328_I2C_ADDR)
    except OSError:
        raise RuntimeError("CST328 not responding at address 0x%02X" % CST328_I2C_ADDR)

    # 初始化引脚
    rst_pin = Pin(RST_PIN, Pin.OUT)
    irq_pin = Pin(IRQ_PIN, Pin.IN)

    # 实例化触摸驱动
    touch = CST328(i2c, address=CST328_I2C_ADDR, rst_pin=rst_pin, irq_pin=irq_pin, width=TOUCH_WIDTH, height=TOUCH_HEIGHT)

    # 清除上电初始触摸状态(CST328 上电后可能触发一次虚假触摸事件)
    await asyncio.sleep_ms(50)
    _ = touch.read_point()
    print("Touch driver initialized, polling started")

    # ========================================  主程序  ===========================================
    try:
        while True:
            # 读取触摸点坐标
            point = touch.read_point()
            if point is not None:
                print("Touch: x=%d, y=%d" % (point["x"], point["y"]))
            await asyncio.sleep_ms(10)

    except KeyboardInterrupt:
        print("Program interrupted by user")
    except OSError as e:
        print("Hardware communication error: %s" % str(e))
    except Exception as e:
        print("Unknown error: %s" % str(e))
    finally:
        print("Cleaning up resources...")
        touch.deinit()
        del touch
        print("Program exited")

if __name__ == '__main__':
    asyncio.run(main())

异步设计与使用

源状态:sync_source。本包归属当前异步仓库;原始实现的作者和许可证以源包元数据及 LICENSE 为准。协程入口应以 asyncio.run(main()) 启动。若类提供 start()/stop()、deinit() 或 aclose(),必须按其实际签名管理后台任务和资源,且在 finally 中清理。

API Async Matrix

API Level Async strategy Residual blocking Timeout/cancellation
CST328.deinit event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328.get_size event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328.read_point event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328.reset event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328.set_debug event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328.set_size event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328.touched event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328Async.deinit_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328Async.get_size_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328Async.read_point_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328Async.reset_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328Async.set_debug_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328Async.set_size_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
CST328Async.touched_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
SyncAdapterMixin.aclose event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
aclose event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
const event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
deinit event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
deinit_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
get_size event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
get_size_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
main event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
read_point event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
read_point_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
reset event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
reset_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_debug event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_debug_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_size event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_size_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
touched event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
touched_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。

Source Demo to Async Demo Mapping

Source sync step Source API/protocol action Async implementation Preserved output/error meaning Residual blocking
源包示例 code/main.py code/main.py 或本文快速开始 保留实际构造与调用;异常语义以运行时代码为准 存在

超时、取消、并发与残余阻塞

任何 await 不会自动使底层 I2C/SPI/UART/Pin 操作变为非阻塞。取消时应停止后台任务并在 finally 释放资源;没有实现超时参数的 API 不应被假定具有超时。协议命令、帧界限、ACK、静默间隔及错误含义只以当前实现和源示例可证明的内容为准。

Hardware Acceptance

Level Evidence Not covered
Link 未实测:仅完成静态代码与文档取证。 总线/网络连接、设备身份响应。
Basic function 未实测。 一次真实业务 API 成功及结果正确性。
Complete business flow 未实测。 端到端设备、对端、供电、时序和异常恢复。

注意事项

类别 说明
并发 同一硬件实例应由调用方串行化;UART 额外遵守其并发契约。
阻塞 不把短同步总线访问或严格时序脉冲描述为真正可中断。
验收 文档生成不等于硬件验证;接入真实设备后分别记录三层验收证据。

版本记录

版本号 日期 作者 修改说明
1.0.0 2026-09-17 FreakStudio 基于当前异步代码、来源包和许可证重新取证 README。

联系方式

请通过本仓库的 issue 或维护者渠道联系;包内元数据作者为:FreakStudio。

许可协议

许可证声明:MIT。以下为本包 LICENSE 的逐字内容:

MIT License

Copyright (c) 2023 L-ING

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
File List
Name Size Type
LICENSE 1.0KB File
README.md 17.4KB Doc
code/_gs_cst328_cst328.py 17.8KB Python
code/cst328_async.py 4.6KB Python
code/main.py 1.9KB Main
examples/main_sync.py 3.2KB Python
package.json 562B Conf