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.4.8.tar.gz (37.2 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.4.8-py3-none-any.whl (30.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.8.tar.gz
  • Upload date:
  • Size: 37.2 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.4.8.tar.gz
Algorithm Hash digest
SHA256 abb06ecc149e91e4fee64b4aa6a5674290487becf338f433b6a05fba9e1f5f5c
MD5 390961fde2e5675e2e2d0feb5e55a0e3
BLAKE2b-256 ad14de74715c4f9b09a8f0b87782a3e2adc4630cac7cd47fb2757ab8ff56ca8f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.8-py3-none-any.whl
  • Upload date:
  • Size: 30.9 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.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 127b1aa910837bad43c70fa6e661479b90cf70f027f5f1e2ff483663c28d7279
MD5 15629ebee7d5c323a804fd48a804408d
BLAKE2b-256 a73b4ce3b828793353b380f14f9cdf99f3edb1cbb2a0442f3a165506400223da

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