Skip to content

AGENTS.md

Latest commit

 

History

History
46 lines (35 loc) · 1.36 KB

AGENTS.md

File metadata and controls

46 lines (35 loc) · 1.36 KB

zserial

本仓库提供命令行串口工具 zserial。

当任务涉及串口枚举、向硬件发送数据、接收串口响应、读取串口日志时，优先使用 zserial，不要临时手写串口脚本，除非用户明确要求。

常用命令

zserial list
zserial list --json
zserial send -p COM3 -b 115200 "AT+RST"
zserial send -p COM3 -b 115200 --hex "FF 01 A3"
zserial recv -p COM3 -b 115200 --timeout 2
zserial recv -p COM3 -b 115200 --until "OK"
zserial recv -p COM3 -b 115200 --idle-timeout 0.5
zserial recv -p COM3 -b 115200 --max-bytes 1024
zserial sendrecv -p COM3 -b 115200 "AT+VERSION"
zserial sendrecv -p COM3 -b 115200 "AT+RST" --until "OK" --idle-timeout 0.5
zserial log -p COM3 -b 115200 --duration 10
zserial log -p COM3 -b 115200 --lines 100
zserial log -p COM3 -b 115200 --bytes 4096

使用约定

  • 需要结构化输出时优先加 --json
  • 文本数据默认直接发送；二进制数据使用 --hex
  • recv / sendrecv 支持 --idle-timeout、--until、--until-hex、--max-bytes
  • log 支持 --duration、--bytes、--lines、--output
  • 超时退出码是 5 (TIMEOUT)
  • HEX 输入错误退出码是 6 (HEX_ERROR)

配置文件

{"port": "COM3", "baudrate": 115200}

使用：

zserial sendrecv --config serial.json "AT+RST"

详细参数和平台集成方式见 README.md。