From 987291396534e3e67baf69fd79d0e8c6bb10cf91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=90=D0=BD=D1=82=D0=BE=D0=BD=20=D0=A2=D1=80=D0=BE=D1=88?= =?UTF-8?q?=D0=B8=D0=BD?= Date: Tue, 27 Oct 2026 10:49:45 +0300 Subject: [PATCH] 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. --- README.md | 21 ++++++++++++++------- README_RUS.md | 24 +++++++++++++++--------- 2 files changed, 29 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f95c8da..d2edccd 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/README_RUS.md b/README_RUS.md index cb9216a..296814e 100644 --- a/README_RUS.md +++ b/README_RUS.md @@ -15,19 +15,25 @@ SIM/UICC из UDP-потока GSMTAP (или импортирует файлы ## Требования -- **Python 3.9+** -- **PyUSB** — `pip install pyusb` (нужен только для захвата с оборудования - SIMtrace2; захват GSMTAP/UDP и импорт PCAP работают без него) +**Обязательно** + +- **Python 3.9+** — для захвата GSMTAP, импорта PCAP и просмотра достаточно + стандартной библиотеки. + +**Только для захвата с оборудования Osmocom SIMtrace2** (`--capture direct` и +встроенная утилита `simtrace2-pysniff`): + +- **PyUSB** — `pip install pyusb` - **libusb** — системная библиотека, обычно уже есть в Linux; в Windows нужно заменить драйвер SIMtrace2 (см. [Доступ к USB-устройству](#доступ-к-usb-устройству)) -- **Оборудование SIMtrace2** с прошивкой в режиме *trace* (только для - прямого захвата; VID `1d50`, PID `60e3`, USB class `ff`, subclass `01`). - О сборке и прошивке trace-прошивки см. - [проект SIMtrace2](https://gitea.osmocom.org/sim-card/simtrace2). +- **Оборудование SIMtrace2** с прошивкой в режиме *trace* (VID `1d50`, PID + `60e3`, USB class `ff`, subclass `01`); сборка и прошивка trace-прошивки + описаны в + [проекте SIMtrace2](https://gitea.osmocom.org/sim-card/simtrace2). -Других зависимостей нет. Вывод PCAP, GSMTAP и hex dump использует только -стандартную библиотеку Python. +Для `--capture gsmtap` (источник GSMTAP может быть даже на другой машине), +`--capture disabled` и импорта PCAP анализатору ничего из этого не нужно. ## Быстрый старт