ymodem 1.5.1

Ymodem Python3 implementation

The YMODEM project is based on XMODEM implementation written by tehmaze. It is also compatible with XMODEM mode.

README: ENGLISH | 简体中文

• Installation
• Usage
  • CLI TOOL
    • Sending a batch of files
    • Receive a file
  • Source Code
  • API
    • Create MODEM Object
    • Send files
    • Receive files
• Debug
• Changelog
• License

Demo

Test the sending and receiving functions

Interact with SecureCRT

Interact with SecureCRT as sender

Interact with SecureCRT as Finder

Installation

pip install ymodem

Usage

CLI TOOL

# To get help
ymodem -h
# or
python -m ymodem -h

Sending a batch of files

ymodem send ./file.bin ./file2.bin -p COM4 -b 115200
# or
python -m ymodem send ./file.bin ./file2.bin -p COM4 -b 115200

Receive a file

ymodem recv ./ -p COM4 -b 115200
# or
python -m ymodem recv ./ -p COM4 -b 115200

Source Code

from ymodem.Socket import ModemSocket

# define read
def read(size, timeout = 3):
    # implementation

# define write
def write(data, timeout = 3):
    # implementation

# create socket
cli = ModemSocket(read, write)

# send multi files
cli.send([file_path1, file_path2, file_path3 ...])

# receive multi files
cli.recv(folder_path)

For more detailed usage, please refer to main.py.

API

Create MODEM Object

def __init__(self, 
             read: Callable[[int, Optional[float]], Any], 
             write: Callable[[Union[bytes, bytearray], Optional[float]], Any], 
             protocol_type: int = ProtocolType.YMODEM, 
             protocol_type_options: List[str] = [],
             packet_size: int = 1024,
             style_id: int = _psm.get_available_styles()[0]):

• protocol_type: Protocol type, see Protocol.py
• protocol_type_options: such as g representing the YMODEM-G in the YMODEM protocol.
• packet_size: The size of a single packet, 128/1024 bytes, may be adjusted depending on the protocol style
• style_id: Protocol style, different styles have different support for functional features

Send files

def send(self, 
         paths: List[str], 
         callback: Optional[Callable[[int, str, int, int], None]] = None
        ) -> bool:

• callback: callback function. see below.

  Parameter	Description
  task index	index of current task
  task (file) name	name of the file
  total packets	number of packets plan to send
  success packets	number of packets successfully sent

Receive files

def recv(self, 
         path: str, 
         callback: Optional[Callable[[int, str, int, int], None]] = None
        ) -> bool:

• path: folder path for storing the target file
• callback: callback function. Same as the callback of send().

ATTENTION

Depending on different communication environments, developers may need to manually adjust timeout parameters in _read_and_wait or _write_and_wait.

Debug

If you want to output debugging information, set the log level to DEBUG.

logging.basicConfig(level=logging.DEBUG, format='%(message)s')

Changelog

v1.5 (2024/02/03)

• Added cli tool to iteract with YMODEM via Serial bus

v1.5 (2023/05/20 11:00 +00:00)

• Rewritten send() and recv()
• Support YMODEM-G. The success rate of YMODEM-G based on pyserial depends on the user's OS, and after testing, the success rate is very low without any delay.

License

MIT License