This release is a pre-release and may not be stable for production use.
YModTerm
A modern serial terminal application with YMODEM, YMODEM-G, XMODEM, and ZMODEM protocol support.
Based on o-murphy/ymodem fork of alexwoo1900/ymodem library GUI inpired by CuteCom - graphical serial terminal
Features
- Multiple Protocol Support: YMODEM, YMODEM-G, XMODEM, and ZMODEM file transfer protocols
- Cross-Platform: Works on Windows, Linux, and macOS
- Modern GUI: Built with Qt (via qtpy) for a responsive interface
- Flexible Configuration: Customizable serial port settings (baudrate, parity, stop bits, etc.)
- Input History: Keep track of previously sent commands
- Multiple Output Modes: ASCII, Hex, and control character display
- File Logging: Optional logging to file with append mode
- Auto-Reconnect: Automatic port reconnection option
- Settings Persistence: All settings are saved between sessions
Installation
Prerequisites
- Python 3.10 or higher
- pip package manager
Install from source
git clone https://github.com/yourusername/ymodterm.git
cd ymodterm
pip install -r requirements.txt
Dependencies
qtpy- Qt abstraction layerPyQt5orPySide2orPyQt6orPySide6- Qt bindingspyserial- Serial port communicationymodem- YMODEM protocol implementation (based on alexwoo1900/ymodem)
Usage
Basic Usage
python ymodterm_gui.py
Command Line Arguments
python ymodterm_gui.py [options]
Options:
-h, --help Show help message and exit
-p PORT, --port PORT COM port
-b BAUDRATE, --baudrate BAUDRATE
Baudrate (default: 9600)
-pr {N,E,O,S,M}, --parity {N,E,O,S,M}
Parity: N(one), E(ven), O(dd), S(pace), M(ark)
-db {5,6,7,8}, --databits {5,6,7,8}
Data bits (default: 8)
-sb {1,2,1.5}, --stopbits {1,2,1.5}
Stop bits (default: 1)
-m {X,Y,YG,Z}, --modem {X,Y,YG,Z}
Modem protocol: X(Modem), Y(Modem), YG(Modem-G), Z(Modem)
-d, --debug Enable debug logging
-V, --version Show version and exit
Example
# Connect to COM3 at 115200 baud with YMODEM protocol
python ymodterm_gui.py -p COM3 -b 115200 -m Y
# Linux example with debug output
python ymodterm_gui.py -p /dev/ttyUSB0 -b 9600 -d
GUI Features
Connection Panel
- Device Selection: Dropdown list of available serial ports with auto-refresh
- Connect/Disconnect: Toggle connection button
- RTS/DTR Control: Hardware flow control signals
- Auto Reconnect: Automatic reconnection on port disconnect
- Settings Panel: Expandable panel for advanced serial configuration
Settings Panel
- Baudrate: Configurable from 1200 to 10000000 (editable combo box)
- Data Bits: 5, 6, 7, or 8 bits
- Flow Control: None, Hardware, or Software
- Parity: None, Even, Odd, Space, Mark
- Stop Bits: 1, 1.5, or 2
- Open Mode: Read Only, Write Only, or Read/Write
- Display Options: Control character display, timestamps
- Logfile: Configure output logging with append mode
Terminal Output
- Hex Output Mode: Display data in hexadecimal format
- Control Character Display: Show control characters as
<0x00>format - UTF-8 Support: Proper handling of multi-byte UTF-8 sequences
- Auto-scroll: Automatic scrolling to latest output
- Clear Function: Clear terminal output
- File Logging: Optional logging to file
Input Panel
- Command Input: Text field with Enter-to-send
- Line Ending Options: LF, CR, CR/LF, None, or Hex input
- Auto Return: Automatically send on text change
- File Transfer: Send files using selected modem protocol
- Protocol Selection: YMODEM, YMODEM-G, XMODEM, or ZMODEM
Input History
- Command History: List of previously sent commands
- Click to Resend: Click any history item to populate input field
- Context Menu: Remove individual items or clear all history
File Transfer
YModTerm supports multiple file transfer protocols:
- YMODEM: Reliable batch file transfer with CRC checking
- YMODEM-G: Streaming variant of YMODEM (faster, no error recovery)
- XMODEM: Classic single-file transfer protocol
- ZMODEM: Advanced protocol with crash recovery
Sending Files
- Ensure serial port is connected
- Select desired protocol from dropdown
- Click "Send File..." button
- Select file to transfer
- Monitor progress in dialog
- Cancel anytime if needed
Receiving Files
File reception feature is implemented in the modem manager but requires additional UI work for directory selection.
Technical Details
Architecture
- SerialManagerWidget: Handles serial port connection and configuration
- ModemTransferManager: Manages file transfers with queue-based data handling
- QSerialPortModemAdapter: Adapter between Qt serial port and ymodem library
- AppState: Centralized state management with persistent settings
- StatefullProp: Reactive property system for UI binding
Data Flow
Serial Port → QSerialPort → readyRead signal
↓
data_received signal
↓
┌───────────────────────┴────────────────────┐
↓ ↓
OutputViewWidget ModemTransferManager
(display to user) (transfer queue)
Control Character Handling
The application properly handles control characters in multiple ways:
- Visual display:
<0x00>,<0x0D>, etc. - Named representation:
^@,^A,\n,\t - Hex mode: All bytes as hex pairs
UTF-8 Support
Smart UTF-8 decoding with fallback:
- Attempts to decode valid UTF-8 sequences
- Falls back to hex representation for invalid bytes
- Preserves multi-byte character integrity
Configuration
Settings are automatically saved to:
- Windows:
%APPDATA%/o-murphy/ymodterm.ini - Linux/macOS:
~/.config/o-murphy/ymodterm.conf
Development
Project Structure
ymodterm/
├── ymodterm_gui.py # Main application file
├── requirements.txt # Python dependencies
├── README.md # This file
└── ymodem/ # YMODEM library
├── Protocol.py
└── Socket.py
Adding Features
The codebase uses Qt's signal/slot mechanism extensively. To add new features:
- Create a
StatefullPropfor state management - Bind UI widgets to properties using
.bind()method - Connect signals for reactive updates
- Add persistence in
AppState.save_settings()
Troubleshooting
Port Access Issues (Linux)
Add your user to the dialout group:
sudo usermod -a -G dialout $USER
# Log out and back in for changes to take effect
Permission Denied (macOS)
Grant Terminal.app full disk access in System Preferences → Security & Privacy.
Transfer Failures
- Ensure both devices use the same protocol
- Check baud rate matches on both ends
- Verify flow control settings
- Enable debug mode:
python ymodterm_gui.py -d
Qt Backend Issues
YModTerm uses qtpy for Qt abstraction. If you encounter import errors:
# Try different Qt backends
pip install PyQt5 # or
pip install PySide2 # or
pip install PyQt6 # or
pip install PySide6
Credits
- Based on alexwoo1900/ymodem library
- Built with Qt and Python
- Serial communication via pyserial
License
MIT License - see LICENSE file for details
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Metadata
Release files for ymodterm 0.1.0b3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ymodterm-0.1.0b3.tar.gz | 39.0 kB | Without provenance | Details for ymodterm-0.1.0b3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ymodterm-0.1.0b3-py3-none-any.whl | Python 3 | none | any | Details for ymodterm-0.1.0b3-py3-none-any.whl |
Total release size: 59.3 kB
Release files / ymodterm-0.1.0b3.tar.gz
| Download URL | ymodterm-0.1.0b3.tar.gz |
|---|---|
| Size | 39.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
356f80335031b6713a38777bd9bcecafbc64dc100f1b4c11ad18d602ad5b6d71
|
|
BLAKE2b-256 checksum How to use checksums |
f3133cddfe3734a6bc956eac8f20d084eda298a919a944b420711d0626dff818
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.22 {"installer":{"name":"uv","version":"0.9.22","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / ymodterm-0.1.0b3-py3-none-any.whl
| Download URL | ymodterm-0.1.0b3-py3-none-any.whl |
|---|---|
| Size | 20.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
824ce7a1de830bf80f81f516094005fdb1151bda1480bcf54dcd352fe1be31d5
|
|
BLAKE2b-256 checksum How to use checksums |
98139634afa8aa03b66ce4440ed56f4d311faab71010645c7737636c9b7d97f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.22 {"installer":{"name":"uv","version":"0.9.22","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for ymodterm 0.1.0b3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.