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.4.tar.gz (33.9 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.4-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.4.tar.gz
  • Upload date:
  • Size: 33.9 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.4.tar.gz
Algorithm Hash digest
SHA256 1b507a36959f2f52a352e9cb9ce68f60f9765b0f91362186bb7d7073fa9b9570
MD5 c3cd9f97658b7c2989d629592c23a9d1
BLAKE2b-256 8a76b4496ef339ce8cd5673c4ffd60eb3b9665b4143a5fd947c036272af97354

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 29.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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 89a961f0cf1779e75d3ea2840fb8ae1e1e8a69fd8dfc9d2b07588758ad092cf8
MD5 fad5ea6f70f8b36d5222d1fad2b12e85
BLAKE2b-256 b82febe6aeb982ddfc9e5cd8eccd701fdb28fe153b2a3ce14975e95cd2e7cdc2

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