Skip to main content

Serial port debug tool for humans and AI agents

Project description

ttypal

Serial port debug tool designed for both humans and AI agents.

Features

  • Interactive terminal (like minicom, but better)
  • Auto-logging with timestamps and rotation
  • External command injection via Unix socket (for AI/scripts)
  • ZMODEM file transfer over serial
  • Record/replay serial sessions
  • Macro recording and playback (F1-F12 hotkeys)
  • Board config management
  • Claude Code skill for AI-driven serial debugging

Install

pip install ttypal-ai

Platform-specific setup:

  • Linux — 原生支持,需配置串口权限
  • macOS — 原生支持,即插即用(未测试)
  • Windows — 通过 WSL2 + usbipd-win 运行(未测试)

Quick Start

# Interactive mode
ttypal

# Headless daemon (for AI automation)
ttypal-daemon start -b myboard

# Send commands from another process
ttypal-send --wait "# " "uname -a"

# Read recent serial output
ttypal-tail -n 50

Macros

Bind command sequences to F1-F12 keys in your board config:

[macro]
F1 = ["echo hello", "sleep 0.5", "ls -la"]
F2 = ["reboot"]

Or record interactively: Ctrl-T r to start, Ctrl-T s to stop and save.

Claude Code Integration

Clone this repo and open it with Claude Code — the /ttypal skill loads automatically from .claude/skills/.

cd /path/to/ttypal-ai
claude
# Then use /ttypal skill or just ask AI to operate the serial port

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ttypal_ai-0.3.0.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ttypal_ai-0.3.0-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

Details for the file ttypal_ai-0.3.0.tar.gz.

File metadata

  • Download URL: ttypal_ai-0.3.0.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for ttypal_ai-0.3.0.tar.gz
Algorithm Hash digest
SHA256 58e69d71ad3e6571f6854aece48a5343c4058b66d0f4cba8c86195c5c3abc0b9
MD5 1f1bf2927fdc8fe802365380f5611ab7
BLAKE2b-256 4892970fe7616f6e2c6bdb56b96d0a35cfb4f5d023a7e592c71fcba7e26022da

See more details on using hashes here.

File details

Details for the file ttypal_ai-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: ttypal_ai-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 26.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for ttypal_ai-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d78a48e4ae9325d0797548487be15cb027a7561f24c43dcf3f8324e89227543
MD5 fad44a71aafd5251dab63f9bef31d425
BLAKE2b-256 6476902421a805f8e6486d3f064bc54e8bc4ddde2fab29571da7277f1fead889

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page