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.5.tar.gz (35.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.5-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.5.tar.gz
  • Upload date:
  • Size: 35.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.5.tar.gz
Algorithm Hash digest
SHA256 eafd99c55091f482121d42bae70329ba62702498b55ddd8a50588dacc3a47a3c
MD5 73d59a18a6d9be6cb20c66baa3b0e19d
BLAKE2b-256 caadca99a129e0a4eeb5401d17394c2089e652ea39851dfdb2eb458f4da44ac7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ttypal_ai-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 30.1 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8fe6c81d30b2ccf1872562f5ca3f1e9a4e5d7412740900e169851cadbfa632c7
MD5 fba5255d6404bdf7c6b19a63d48537b6
BLAKE2b-256 b772f71759bac1c425d20e767e370b6f34f625d2e4525feeea671824b1f04fd7

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