README: mark the SIMtrace2 USB prerequisites as conditional

The prerequisites read as if PyUSB, libusb and SIMtrace2 hardware were needed
generally.  They are only for `--capture direct` (and the bundled
`simtrace2-pysniff` utility): the analyser starts and captures GSMTAP with
just Python 3.9+ - verified in a fresh venv without PyUSB, where the server
served the PWA and a GSMTAP ATR+APDU landed in the session (2 messages).

Both READMEs split the list into "Required" (Python 3.9+) and "Only for
capturing from Osmocom SIMtrace2 hardware", and state that GSMTAP capture
(the source may even run on another machine), --capture disabled and PCAP
imports need none of it.  No code change; 557 Python + 80 Node tests.
This commit is contained in:
catarrh committed 2026-10-27 10:49:45 +03:00
1 parent a863f66860
commit 9872913965
2 files changed
+29 -16

No files matched your search

+14 -7
View File
@@ -15,17 +15,24 @@ GSMTAP into this analyser.
## Prerequisites
- **Python 3.9+**
- **PyUSB** — `pip install pyusb` (needed only for capture from SIMtrace2
hardware; GSMTAP/UDP capture and PCAP import work without it)
**Required**
- **Python 3.9+** — GSMTAP capture, PCAP import and browsing use only the
standard library.
**Only for capturing from Osmocom SIMtrace2 hardware** (`--capture direct`, and
the bundled `simtrace2-pysniff` capture utility):
- **PyUSB** — `pip install pyusb`
- **libusb** — system library, present by default on Linux; on Windows the
SIMtrace2 driver must be swapped (see [USB Device Access](#usb-device-access))
- **SIMtrace2 hardware** running firmware in *trace* mode (only for direct
capture; VID `1d50`, PID `60e3`, USB class `ff`, subclass `01`). For
building and flashing trace firmware, see the
- **SIMtrace2 hardware** running firmware in *trace* mode (VID `1d50`, PID
`60e3`, USB class `ff`, subclass `01`); building and flashing trace firmware
is described in the
[upstream SIMtrace2 project](https://gitea.osmocom.org/sim-card/simtrace2).
No other dependencies. PCAP, GSMTAP, and hex dump output use only Python stdlib.
The analyser needs none of this for `--capture gsmtap` (the GSMTAP source may
even run on another machine), `--capture disabled`, or PCAP imports.
## Quick start