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.3.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.3-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.3.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.3.tar.gz
Algorithm Hash digest
SHA256 785bcd9c953dadfdfeabe5f49c6bc755e1d3ae644d44f057be958d6eb3595761
MD5 a6ef9e31c06258ee8822ab9f608db08d
BLAKE2b-256 af69c188c1f279b74463e79ae7cf773a91dca650273a0bd3b2cd665281222cb3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9be00cbd278d56f3ded54a234fd18f766ddb9c52ba5faca2a60677b4f8ca7e1c
MD5 daa686245b1d5b7b2e602cbe26eed7d2
BLAKE2b-256 ab48ffaf3c32f4033fff5dff77370d6a09968c820ea8c19242d8f9375dd3ab4a

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