cushy-serial

A lightweight serial library


Keywords
serial, cushy-serial
License
Apache-2.0
Install
pip install cushy-serial==1.1.1

Documentation

cushy-serial

一个轻量级的Python Serial框架

简介

cushy-serial是一个轻量级的Serial框架,初衷是希望使Serial编程变得更加简单、快捷,因此,相较于传统的pyserial,该框架可以更加快速地构建起一个serial程序。

主要特性

  • 兼容pyserial的所有特性
  • 自定义serial消息异步回调,无需花费精力在多线程上
  • 方便实现和管理多个serial连接
  • 可自定义消息协议,兼容性强

快速上手

pip install cushy-serial --upgrade 
  • 下面是一个简单的serial程序,当python客户端接收到来自串口的信息时会自动回调
from cushy_serial import CushySerial

serial = CushySerial("COM1", 9600)
serial.send("I am python client")


@serial.on_message()
def handle_serial_message(msg: bytes):
    str_msg = msg.decode("utf-8")
    print(f"[serial] rec msg: {str_msg}")

需要说明的是,CushySerial兼容了Serial中所有的功能,因此,你可以在CushySerial中使用Serial的所有功能。

  • 运行结果如下

待办

  • 提供bytes包解析功能,减少在包解析上所花费的工作
  • 提供相关持久化解决方案
  • 提供数据流监控,提高数据稳定性
  • 提供更加细力度的数据包调控,降低丢包率
  • 提供串口定时任务调度
  • 完善单元测试

贡献

如果你想为这个项目做贡献,你可以提交pr或issue。我很高兴看到更多的人参与并优化它。