Now liveThe Skillselion MCP - thousands of ranked skills, loaded into your agent mid-task. No install.Get it →
zhinkgit avatar

Serial

  • 533 installs
  • 534 repo stars
  • Updated June 29, 2026
  • zhinkgit/embeddedskills

serial is an agent skill that scans, monitors, sends, and logs embedded UART/USB serial sessions from your coding agent.

About

serial is a Claude Code skill from the embeddedskills family for practical UART and USB-serial work on solo hardware projects. It helps you discover COM ports, watch firmware boot logs in real time, push test commands or Hex frames, and persist traces for later diffing with your agent. Configuration lives at the workspace level in `.embeddedskills/config.json`, covering baud rate, parity, encoding, timeouts, and log paths, while CLI flags win when you need a one-off session. The workflow assumes Python 3 with pyserial installed and socat when you need multiplexing across streams. It is aimed at indie builders flashing MCUs, debugging AT modules, or validating sensor streams—not at production fleet monitoring. Pair it with your board docs and flashing scripts so the agent can reproduce the same serial steps you would run manually in a terminal.

  • Scans system serial ports when `port` is unset and picks the device automatically when only one is found
  • Live text monitor with regex filters, timestamps, and binary Hex view
  • Send plain text or Hex payloads including AT-command style debugging
  • Export session logs as text, CSV, or JSON under configurable `log_dir`
  • Resolves port and baud via CLI overrides, then `.embeddedskills/config.json`, then state file defaults

Serial by the numbers

  • 533 all-time installs (skills.sh)
  • +25 installs in the week ending Jul 28, 2026 (Skillselion tracking)
  • Ranked #79 of 596 Debugging skills by installs in the Skillselion catalog
  • Security screen: LOW risk (skills.sh audit)
  • Data as of Aug 5, 2026 (Skillselion catalog sync)
npx skills add https://github.com/zhinkgit/embeddedskills --skill serial

Add your badge

Show developers this skill is listed on Skillselion. Paste this into your README.

Listed on Skillselion
Installs533
repo stars534
Security audit3 / 3 scanners passed
Last updatedJune 29, 2026
Repositoryzhinkgit/embeddedskills

What it does

Scan, monitor, send, and log UART/USB serial traffic while bringing up embedded firmware without leaving the agent.

Who is it for?

Best when you're flashing ESP32, STM32, or modem modules and want the agent to run repeatable serial bring-up in-repo.

Skip if: Skip if you need remote production serial gateways, protocol certification, or debugging without local USB access and drivers installed.

When should I use this skill?

User needs to scan ports, watch serial output, send text or Hex data, or save serial logs for embedded hardware debug.

What you get

After a session you have filtered live output, sent test traffic, and saved structured serial logs tied to your workspace config.

  • Real-time serial capture with optional regex filtering
  • Transmitted test payloads (text or Hex)
  • Session logs under `.embeddedskills/logs/serial`

By the numbers

  • Logs export in text, csv, and json formats
  • Parameter stack: CLI, project config, state file, then defaults

Files

SKILL.mdMarkdownGitHub ↗

Serial — 嵌入式串口调试工具

统一封装端口发现、实时监控、数据发送、日志记录和 Hex 查看能力。

配置

环境级配置 (skill/config.json)

serial skill 的环境级配置目前为空对象 {},因为串口参数属于工程级配置,统一在工作区的 .embeddedskills/config.json 中管理。

工程级配置 (.embeddedskills/config.json)

工作区下的 .embeddedskills/config.json 存放工程级串口配置:

{
  "serial": {
    "port": "",
    "baudrate": 115200,
    "bytesize": 8,
    "parity": "none",
    "stopbits": 1,
    "encoding": "utf-8",
    "timeout_sec": 1.0,
    "log_dir": ".embeddedskills/logs/serial"
  }
}
字段说明默认值
port串口号,如 COM3""
baudrate波特率115200
bytesize数据位8
parity校验位:none/even/odd/mark/spacenone
stopbits停止位:1/1.5/21
encoding文本编码utf-8
timeout_sec读写超时(秒)1.0
log_dir日志输出目录.embeddedskills/logs/serial

参数解析优先级

1. CLI 参数 (--port, --baudrate 等) - 最高优先级 2. 工程级配置 (.embeddedskills/config.json 中的 serial 部分) 3. 状态文件 (.embeddedskills/state.json 中的历史记录) 4. 默认值 - 最低优先级

自动扫描行为

当未指定 port 时,脚本会自动扫描系统串口:

  • 若只找到一个串口,自动使用该端口并写入工程配置
  • 若找到多个串口,返回候选列表让用户选择(通过 --port 指定)
  • 若未找到串口,提示错误

子命令

子命令用途风险
scan扫描可用串口
monitor实时查看文本输出
send发送文本或 Hex 数据
hex实时查看二进制流
log保存串口日志到文件

执行流程

1. 检查 pyserial 是否可用,未安装时提示 pip install pyserial 2. 按优先级解析参数:CLI > 工程级配置 > 状态文件 > 默认值 3. 无子命令时默认执行 scan 4. monitor / send / hex / log 使用解析后的连接参数 5. 若未指定 port,自动扫描系统串口:

  • 唯一候选:自动使用并写入工程配置
  • 多候选:返回列表让用户选择

6. 成功执行后,将确认的参数写回工程配置 7. 运行对应脚本并输出结构化结果 8. 失败时优先反馈端口占用、驱动、波特率和编码问题

脚本调用

所有脚本位于 skill 目录的 scripts/ 下,通过 python 直接调用。 脚本会按优先级从 CLI 参数、工程级配置、状态文件中读取参数。

# 扫描串口
python scripts/serial_scan.py [--filter <关键词>] [--json]

# 实时监控
python scripts/serial_monitor.py [--port <串口>] [--baudrate <波特率>] [--timestamp] [--filter <regex>] [--timeout <秒>] [--json]

# 发送数据
python scripts/serial_send.py [--port <串口>] [--baudrate <波特率>] <data> [--hex] [--crlf] [--repeat <次>] [--wait-response] [--json]

# Hex 查看
python scripts/serial_hex.py [--port <串口>] [--baudrate <波特率>] [--width <列>] [--timeout <秒>] [--json]

# 日志记录
python scripts/serial_log.py [--port <串口>] [--baudrate <波特率>] [--output <文件>] [--duration <秒>] [--format text|csv|json] [--json]

输出格式

单次命令返回标准 JSON:

{
  "status": "ok",
  "action": "scan",
  "summary": "发现 2 个串口",
  "details": { ... }
}

持续命令(monitor --json、hex --json)输出 JSON Lines,结束摘要写入 stderr。

错误输出:

{
  "status": "error",
  "action": "monitor",
  "error": { "code": "port_busy", "message": "串口被其他程序占用" }
}

串口多路复用 (Mux)

当需要同时使用 minicom(或其他串口工具)和 skill 脚本访问同一个串口设备时,可以通过 mux 后台服务实现多路复用。

依赖

  • socatapt install socat / pacman -S socat

架构

                   ┌──────────────────┐
                   │   Real Hardware   │
                   │   /dev/ttyUSB0    │
                   └────────┬─────────┘
                            │
                   ┌────────▼─────────┐
                   │ Python mux server │
                   │ TCP-LISTEN:20001  │  单串口读者 + 广播
                   └────────┬─────────┘
                            │
            ┌───────────────┼───────────────┐
            │               │               │
   ┌────────▼──────┐ ┌─────▼──────┐ ┌──────▼────────┐
   │  socat PTY    │ │ skill      │ │ skill         │
   │ /tmp/serial_  │ │ monitor    │ │ send/log/hex  │
   │ mux_vserial   │ │ socket://  │ │ socket://     │
   └───────┬───────┘ └────────────┘ └───────────────┘
           │
   ┌───────▼───────┐
   │   minicom     │
   │  (用户侧)      │
   └───────────────┘
  • Layer 1: Python mux 进程独占打开真实串口,暴露 TCP server,并把串口 RX 广播给所有客户端
  • Layer 2: socat 作为 TCP 客户端创建虚拟 PTY /tmp/serial_mux_vserial,供 minicom 使用
  • Skill 脚本: 自动检测 mux 状态,仅当本次串口配置与 mux 匹配时通过 socket:// 连接 TCP 端口
  • 数据流: 串口 RX → 广播到所有 TCP 客户端;任一客户端 TX → 转发到真实串口

Mux 管理命令

# 启动多路复用
python scripts/serial_mux.py start --port /dev/ttyUSB0 [--baudrate 115200]

# 查询状态
python scripts/serial_mux.py status

# 停止多路复用
python scripts/serial_mux.py stop

启动后,skill 脚本(monitor/hex/log/send)自动通过多路复用连接,无需额外参数。若命令显式指定了不同串口或串口参数,则不会复用当前 mux。

使用流程

1. python scripts/serial_mux.py start --port /dev/ttyUSB0 2. minicom -D /tmp/serial_mux_vserial(用户侧交互) 3. python scripts/serial_monitor.py(模型侧监控,自动走 mux) 4. 两个终端同时看到串口数据 5. python scripts/serial_mux.py stop 停止复用(终止 socat 进程并清理 /tmp/serial_mux_vserial 符号链接)

写入冲突警告

多客户端同时写入会导致串口数据错乱。 监控/hex/log 脚本在通过 mux 连接时输出警告到 stderr。send 脚本输出更强的冲突警告。如需直连真实串口(跳过 mux),使用 --direct 参数。

Mux 状态持久化

mux 进程 PID 保存到 .embeddedskills/state.jsonserial_mux 段。脚本退出后下次调用 status 会检测进程是否仍存活,自动清理僵尸 PID。start 成功后会把已确认的串口配置写回 .embeddedskills/config.json,方便后续无参命令复用。stop 命令会终止 mux 与 socat PTY 进程,并删除残留的 /tmp/serial_mux_vserial 符号链接。

核心规则

  • 不自动猜测波特率;发现多个候选串口时不自动选择端口
  • 参数解析优先级:CLI > 工程级配置 > 状态文件 > 默认值
  • 未指定 port 时自动扫描,唯一候选自动写入配置,多候选需用户选择
  • 成功执行后,确认的参数自动写回 .embeddedskills/config.json
  • 未明确说明用途时不主动发送任何串口数据
  • --json 输出的持续流使用 JSON Lines,摘要写 stderr 不污染数据流
  • 正则过滤失败不应导致监控退出
  • Mux 运行中发送数据前提示用户避免同时写入

参考

  • references/common_devices.json:常见 USB 转串口芯片 VID/PID 映射

Related skills

How it compares

Use instead of ad-hoc `screen`/`minicom` copy-paste when you want config-driven scans, logging, and agent-guided steps.

FAQ

Who is serial for?

embedded and IoT developers using Claude Code who need structured serial port scan, monitor, send, and log workflows on their machine.

When should I use serial?

During Build integrations when a board is on USB, you need boot logs, AT tests, or Hex traces; less often in Operate when reproducing a field issue locally with the same `.embeddedskills` config.

Is serial safe to install?

It runs local Python and serial I/O on your hardware; review the Security Audits panel on this page before granting shell and filesystem access in your agent.

Debuggingintegrations

This week in AI coding

Five minutes, every Monday - the tools, releases and tactics for developers.

unsubscribe anytime.