|
|
@@ -7,6 +7,7 @@ Python desktop and CLI tool for parsing Firmament `mlog` binary files, exporting
|
|
|
- Parse binary `mlog` files into structured bus data.
|
|
|
- Export each bus group to an individual CSV file.
|
|
|
- Inspect and compare signals in a `PySide6 + PyQtGraph` desktop GUI.
|
|
|
+- View parsed parameter groups directly in the GUI.
|
|
|
- Build a platform-native single-file executable with `PyInstaller`.
|
|
|
|
|
|
## Project Layout
|
|
|
@@ -17,7 +18,7 @@ python_mlog_tool/
|
|
|
├── pyproject.toml
|
|
|
├── mlog_tool_qt.spec
|
|
|
├── scripts/
|
|
|
-│ └── build_qt_exe.sh
|
|
|
+│ ├── build_qt_exe.sh
|
|
|
│ └── build_qt_exe.ps1
|
|
|
├── examples/
|
|
|
│ └── example_usage.py
|
|
|
@@ -66,6 +67,15 @@ Install the packaging dependency:
|
|
|
uv pip install --python ./.venv/bin/python ".[bundle]"
|
|
|
```
|
|
|
|
|
|
+## Quick Start
|
|
|
+
|
|
|
+Parse a sample log and open the Qt GUI:
|
|
|
+
|
|
|
+```bash
|
|
|
+PYTHONPATH=src ./.venv/bin/python -m mlog_tool parse ../mlog16.bin
|
|
|
+PYTHONPATH=src ./.venv/bin/python -m mlog_tool.qt_gui
|
|
|
+```
|
|
|
+
|
|
|
## Run From Source
|
|
|
|
|
|
CLI:
|
|
|
@@ -101,9 +111,9 @@ Output:
|
|
|
|
|
|
```text
|
|
|
dist/mlog-tool-qt
|
|
|
-dist/mlog-tool-qt-v0.1.0-linux-x86_64
|
|
|
+dist/mlog-tool-qt-v<version>-linux-<arch>
|
|
|
dist/mlog-tool-qt.exe
|
|
|
-dist/mlog-tool-qt-v0.1.0-windows-x86_64.exe
|
|
|
+dist/mlog-tool-qt-v<version>-windows-<arch>.exe
|
|
|
```
|
|
|
|
|
|
Run it with:
|
|
|
@@ -126,6 +136,9 @@ The build script also creates a versioned copy that is convenient for release de
|
|
|
|
|
|
- The Qt GUI parses the selected log immediately after opening the file.
|
|
|
- The generated CSV files are organized one bus per file.
|
|
|
+- The left panel is split into `Parameters` and `Buses`.
|
|
|
+- Parameter details are viewed in the lower-right table and are not plottable.
|
|
|
+- Cursor mode supports left-click freeze and right-click release directly on the plot.
|
|
|
- `src/qt_gui_entry.py` exists only as a PyInstaller-friendly GUI entry point for the onefile build.
|
|
|
|
|
|
## Release Checklist
|
