The YMODEM project is based on XMODEM implementation written by tehmaze. It is also compatible with XMODEM mode.
YMODEM for Python Demo
Test the sending and receiving functions
If you want to run the test sample, please do the following:
- use virtual serial port tool to generate COM1 and COM2 that can communicate
- run the FileReceiver.py and FileSender.py on the command line
The specific transmission process is shown in the following figure:
Interact with SecureCRT
Interact with SecureCRT as sender
Interact with SecureCRT as Finder
How to use YMODEM for Python
- Import MODEM module
from Modem import Modem- Define the reader and writer (or read() and write()), then create MODEM object
def sender_read(size, timeout=3): serial_io.timeout = timeout return serial_io.read(size) or Nonedef sender_write(data, timeout=3): serial_io.writeTimeout = timeout return serial_io.write(data)sender = Modem(sender_read, sender_write)- Send file
sender.send(stream, info=file_info)- Receive file
receiver.recv(stream, info=file_info)YMODEM for Python API
Create MODEM Object
def __init__(self, reader, writer, mode='ymodem1k', program="rzsz")- reader, reader(object) or read(function)
- writer, writer(object) or write(function)
- mode, support xmodem, xmodem1k, ymodem, ymodem1k(by default)
- program, YMODEM of different program have different features
Send file (stream)
def send(self, stream, retry=10, timeout=10, callback=None, info=None):- stream, data stream.
- retry, max retry count.
- timeout, timeout of reader or writer in second.
- callback, callback function. see below.
- info, file information dictionary. see below.
callback parameters:
| Parameter | Description |
|---|---|
| total packets | number of packets plan to send |
| success packets | number of packets successfully sent |
| failed packets | number of packets failed to send |
info properties:
| Field | Description |
|---|---|
| name | file name |
| length | file length |
| mtime | file modification date (GMT) |
| source | operation system the file original from |
Receive file (stream)
def recv(self, stream, crc_mode=1, retry=10, timeout=10, delay=1, callback=None, info=None)- stream, data stream.
- crc_mode, checksum or crc mode.
- retry, max retry count.
- timeout, timeout of reader or writer in second.
- delay, delay in second.
- callback, callback function. see below.
- info, file information dictionary. see below.
callback parameters:
| Parameter | Description |
|---|---|
| received length | received file bytes |
| remaining length | remaining file bytes |
info properties:
| Field | Description |
|---|---|
| save_path | folder path where the file are saved |
Changelog
v1.2 (2022/8/10 14:00 +00:00)
- Fixed receiver bug
