miwear 0.0.24

Python Miwear tools for extracting and handling archives/logs

OpenMiwear

A Python toolkit for extracting, merging, auditing and analyzing MiWear device dumps — from the command line.

OpenMiwear is a set of small, focused command-line tools for the everyday chores of working with MiWear device artifacts — unpacking .tar.gz / .zip / .gz bundles, merging rotated logs, extracting assertions, auditing resource directories, analyzing runtime log patterns, and driving serial consoles.

Each tool does one thing, takes sensible defaults, and produces human- or machine-readable output (plain text, CSV, Markdown, or interactive HTML).

Features

• Zero runtime dependencies for the core tools — pure Python standard library.
• Batch extraction of .tar.gz, .zip and .gz archives in a single pass.
• Log workflow: pull logs over adb, merge rotated shards, extract assertions, filter by pattern.
• Resource audit: duplicate detection, unused-asset scan, two-directory diff — with Markdown + interactive HTML reports.
• Log analyzer for AppID / screen-transition patterns, exportable to CSV or interactive HTML.
• Optional serial console (miniterm, one-shot, periodic, batch-file) via pyserial.
• Works on Python 3.10+, Linux / macOS / Windows.

Installation

Published on PyPI as the miwear package:

# Core tools
pip install miwear

# Core + serial console helper
pip install 'miwear[serial]'

[!TIP] Every command accepts --help for the full option list and --version to print the installed version.

Quick start

# Extract and merge a device log bundle
miwear_log ~/Downloads/log.tar.gz

# Or pull straight from a connected Android device via adb
miwear_log --phone -f 123456_abc

# Audit a resources directory for duplicates and open an HTML report
miwear_check -d ./resources -e bin

Commands

Command	Purpose
miwear_log	Extract a MiWear log archive and merge its shards into a single log file
miwear_assert	Extract assertion blocks from a log
miwear_gz	Decompress and merge .gz log shards
miwear_tz	Batch-extract every .tar.gz archive in a directory
miwear_uz	Batch-extract every .zip archive in a directory
miwear_ez	Pull files out of a ZIP archive by precise filename-stem suffix
miwear_check	Resource audit — duplicates, unused assets, directory diff
miwear_loganalyzer	Parse AppID / screen log patterns into CSV or interactive HTML
miwear_serial	Serial console helper (requires pyserial)

Usage

miwear_log

Extract a log bundle and merge its shards into one file.

# Positional path (recommended)
miwear_log ~/Downloads/log.tar.gz

# Or with -f / --filename
miwear_log -f ~/Downloads/log.tar.gz

# Pull straight from an Android phone via adb
miwear_log --phone -f 123456_abc

miwear_assert

Extract assertion blocks from a merged log.

miwear_assert -i mi.log -o assert_log.txt

miwear_gz

Decompress and concatenate all .gz shards in a directory.

miwear_gz --path ./logs --log_file my.log --output_file merged.log

miwear_tz / miwear_uz

Batch-extract every archive in a directory.

miwear_tz --path ./logs     # *.tar.gz
miwear_uz --path ./logs     # *.zip

miwear_ez

Pull files out of a ZIP archive into an output directory, without performing a full extraction. Files are selected by one or more precise filename-stem suffixes: ap matches *ap.elf but not *app.elf. Pass several suffixes like ap cp ota to extract multiple at once, or all to extract everything. If no ZIP is given, the current directory is scanned and you pick one interactively.

# Auto-detect a ZIP, extract *ap.elf (default target is 'ap')
miwear_ez

# Extract every *.elf (legacy behavior), plus ota.zip
miwear_ez all

# A different stem suffix, e.g. *cp.elf
miwear_ez cp

# Multiple suffixes in one pass: *ap.elf, *cp.elf and *ota.elf
miwear_ez ap cp ota

# Explicit archive, multiple extensions, custom output directory
miwear_ez ap -z firmware.zip -e bin hex -o ./out

miwear_check

Four modes: dup (default), unused, both, and diff. All modes emit Markdown + interactive HTML reports with search / filter / sort.

Duplicate detection

miwear_check -d ./resources -e bin
miwear_check -d ./resources -e bin png
miwear_check -d ./resources -e bin -p theme_ config_
miwear_check -d ./resources -e bin --action delete

Unused resource scan

-d sets where resources live; -c sets where to look for references (defaults to -d).

miwear_check -m unused -d ./project -e bin
miwear_check -m unused -d ./project -c ./project/ota -e bin
miwear_check -m unused -d ./project -e bin --code-ext ".c,.h,.cpp,.java"

# Run duplicate + unused together
miwear_check -m both -d ./project -e bin

Two-directory diff

Matches files by base name (everything before the first dot) under the same relative path — so confirm.indexed_8.png and confirm.bin pair up automatically.

miwear_check -m diff --path1 ./design --path2 ./converted
miwear_check -m diff --path1 ./design --path2 ./converted -i .git,node_modules
miwear_check -m diff --path1 ./design --path2 ./converted --sort count

Report output

miwear_check -d ./resources -e bin -o my_report.md
miwear_check -d ./resources -e bin --no-output

[!NOTE] When the scan directory contains both view/ and view_XX/res* variants, miwear_check prompts you to pick one (default: the variant with the most files). Pass -i to skip the prompt.

miwear_loganalyzer

Parse MiWear runtime log patterns and export to CSV or HTML.

# Default: all analyzers → miwear.csv
miwear_loganalyzer -f 1.log

# Interactive HTML report (opens in browser)
miwear_loganalyzer -f 1.log --html --open-browser

# Run a single analyzer
miwear_loganalyzer -f 1.log -t appid
miwear_loganalyzer -f 1.log -t screen -o screens.csv

miwear_serial

[!IMPORTANT] Requires pyserial. Install with pip install 'miwear[serial]'.

Interactive session

miwear_serial -p /dev/ttyACM0 -b 921600
# Press Ctrl+] to exit

One-shot command

miwear_serial -p /dev/ttyUSB1 -b 115200 -c "ps"
miwear_serial -p /dev/ttyUSB1 -b 115200 -c "ps" -r   # parse response

Periodic / batch

# Repeat on a timer
miwear_serial -p /dev/ttyACM1 -i 1.0 -c "ps"
miwear_serial -p /dev/ttyACM1 -i 2.0 -c "ps" --count 5

# Batch commands from a file
miwear_serial -f commands.txt
miwear_serial -f commands.txt -i 2.0 --count 5

Record to a log file

miwear_serial -p /dev/ttyACM0 -b 921600 -s             # miwear.log (default)
miwear_serial -p /dev/ttyACM0 -b 921600 -s log.txt     # custom path

Requirements

• Python 3.10+
• pyserial — only for miwear_serial

Development

Clone the repo and run the full lint + test + integration suite that mirrors CI:

git clone https://github.com/Junbo-Zheng/OpenMiwear.git
cd OpenMiwear

pip install flake8 black mypy pytest
./build.sh

build.sh runs flake8, black --check, mypy, pytest, and then exercises each CLI against the fixtures in tests/data/. GitHub Actions mirrors this on every push and pull request via .github/workflows/ci.yml, with the test job running against a Python 3.10 / 3.11 / 3.12 / 3.13 matrix.

Releases are automated through .github/workflows/publish.yml: publishing a GitHub Release triggers a build and uploads the distribution to PyPI via OIDC trusted publishing — no API tokens involved.

[!NOTE] The repository on GitHub is Junbo-Zheng/OpenMiwear, but the PyPI distribution and Python import/command names use the shorter miwear identifier (e.g. import miwear, miwear_log …). This is intentional — keep the project name OpenMiwear when referring to the repo, and the package name miwear when invoking the tools.