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.2.tar.gz (33.4 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.2-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.2.tar.gz
  • Upload date:
  • Size: 33.4 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.2.tar.gz
Algorithm Hash digest
SHA256 1772aa6b1213f06e8eea692809844dcbce410e47491fa1d644f735a754360238
MD5 b4fe647c34f658fc263cd5259cb47e7b
BLAKE2b-256 a9b460cd9bf843b6ae879bbf972ec56a98df87d6367fa1779109750fd5846ad5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 29.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 59fcd49074be9ac5d5e3c09737ccc35804b3aa24f74ec530eadbcfaaa1fceb19
MD5 ff3ea31bb3999a1917a30e6c7ec33bf9
BLAKE2b-256 ccbdf900b43b9b03487e94e6172c40599ad7f2ed62b75bffe7cb9b6818e14bbe

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