From 63063bd030ae0e9cd196068bdf884d4225577fb1 Mon Sep 17 00:00:00 2001 From: Philippe Teuwen Date: Fri, 2 Oct 2026 15:05:19 +0200 Subject: [PATCH] tune docs for default port 18888 --- client/pm5_ble_bridge.py | 4 ++-- doc/commands.json | 4 ++-- doc/md/PM5_Start_Here/PM5-BWM-USAGE.md | 26 +++++++++++++++++--------- doc/termux_notes.md | 18 +++++++++--------- 4 files changed, 30 insertions(+), 22 deletions(-) diff --git a/client/pm5_ble_bridge.py b/client/pm5_ble_bridge.py index c110c2355..38b648034 100644 --- a/client/pm5_ble_bridge.py +++ b/client/pm5_ble_bridge.py @@ -17,8 +17,8 @@ # WSL2 without admin, NAT networking: Windows can only make OUTBOUND # connections, but by default localhostForwarding lets Windows reach a WSL # listener at 127.0.0.1:PORT. So: -# WSL: python3 pm5_ble_bridge.py --relay --listen 7777 --pty /tmp/pm5-ble -# Windows: py pm5_ble_bridge.py -n Proxmark5 --connect 127.0.0.1:7777 +# WSL: python3 pm5_ble_bridge.py --relay --listen 18888 --pty /tmp/pm5-ble +# Windows: py pm5_ble_bridge.py -n Proxmark5 --connect 127.0.0.1:18888 # WSL: ./pm3 /tmp/pm5-ble # If localhostForwarding is off, point --connect at WSL's own IP # (WSL: `hostname -I`) instead of 127.0.0.1. diff --git a/doc/commands.json b/doc/commands.json index 7aadd9acc..f56b72dc6 100644 --- a/doc/commands.json +++ b/doc/commands.json @@ -11222,7 +11222,7 @@ "notes": [ "hw bwm wifi status -> show connection state + IP", "hw bwm wifi stop -> tear down WiFi, back to BLE-only", - "hw bwm wifi --ssid Home --pwd secret -> bring up, port 7777", + "hw bwm wifi --ssid Home --pwd secret -> bring up, port 18888", "hw bwm wifi --ssid Home --pwd secret --port 9000" ], "offline": false, @@ -11230,7 +11230,7 @@ "-h, --help This help", "--ssid WiFi SSID to join", "--pwd WiFi password (omit for open network)", - "--port TCP server listen port (default 7777)", + "--port TCP server listen port (default 18888)", "--hostname DHCP hostname (default Proxmark5)" ], "usage": "hw bwm wifi [-h] [--ssid ] [--pwd ] [--port ] [--hostname ]" diff --git a/doc/md/PM5_Start_Here/PM5-BWM-USAGE.md b/doc/md/PM5_Start_Here/PM5-BWM-USAGE.md index 752353d94..ddc9a028e 100644 --- a/doc/md/PM5_Start_Here/PM5-BWM-USAGE.md +++ b/doc/md/PM5_Start_Here/PM5-BWM-USAGE.md @@ -228,8 +228,8 @@ python3 pm5_ble_bridge.py --pty # default link /tmp/pm5-ble **b) TCP listener** — bridge listens, client connects in: ``` -python3 pm5_ble_bridge.py --tcp 7777 # or HOST:PORT -./pm3 -p tcp:127.0.0.1:7777 +python3 pm5_ble_bridge.py --tcp 18888 # or HOST:PORT +./pm3 -p tcp:127.0.0.1:18888 ``` **c) Outbound TCP** (`--connect`) — bridge dials **out** to a listener. Pairs with @@ -237,13 +237,13 @@ the client's `--wait` mode ([2.3](#23-client-listen-mode--pm3----wait)) and cros the WSL2 NAT boundary: ``` -python3 pm5_ble_bridge.py --connect 127.0.0.1:7777 +python3 pm5_ble_bridge.py --connect 127.0.0.1:18888 ``` **d) Relay only** (no BLE) — TCP listener ↔ PTY, for chaining: ``` -python3 pm5_ble_bridge.py --relay --listen 7777 --pty +python3 pm5_ble_bridge.py --relay --listen 18888 --pty ``` > [!NOTE] @@ -258,10 +258,10 @@ bridge at it with `--connect`. This removes the relay/PTY hop. ``` # window 1 — client listens (blocks until something connects) -./pm3 -p tcp:127.0.0.1:7777 --wait +./pm3 -p tcp:127.0.0.1:18888 --wait # window 2 — bridge dials in (on the machine with the radio) -python3 pm5_ble_bridge.py --connect 127.0.0.1:7777 +python3 pm5_ble_bridge.py --connect 127.0.0.1:18888 ``` > [!NOTE] @@ -283,14 +283,18 @@ limited to 10 minutes per session (the limit resets after quitting the app). | Setting | Value | | ---------------- | ----------------------------------------------------------------- | -| Device A | Start TCP server (default port `54321`) | +| Device A | Start TCP server, use client default port:`18888` | | Device B | Connect to BLE device → `Proxmark5` | | Characteristic | the last one: service `0000ae86-…`, characteristic `0000ae88-…`, for RX+TX | -3. In Termux, connect over the local port: +1. In Termux, connect over the local port: ``` -./client/proxmark3 tcp:localhost:54321 +./client/proxmark3 tcp:localhost:18888 +``` +Or, as we're using the default port, just +``` +./client/proxmark3 tcp:localhost ``` No pairing is needed (the BWM has no BLE security). The same app also does classic @@ -346,6 +350,10 @@ strings: ``` ./pm3 -p tcp:192.168.1.77:18888 ``` +Or, as we're using the default port, just +``` +./pm3 -p tcp:192.168.1.77 +``` > [!NOTE] > Connecting **by hostname** works only if your router registers DHCP client names diff --git a/doc/termux_notes.md b/doc/termux_notes.md index 1c3851320..a2bad3886 100644 --- a/doc/termux_notes.md +++ b/doc/termux_notes.md @@ -150,11 +150,11 @@ Install [this free TCPUART app](https://play.google.com/store/apps/details?id=co The app lets you choose the baudrate. Default value (115 200 baud) is fine. Plug the PM3 in and click connect. -Set the toggle in server mode and choose a random port not used by system (e.g. 4321) and start the server. +Set the toggle in server mode and choose a random port not used by system (client default port is 18888) and start the server. Alternatively, use the [paid version of the BT/USB/TCP Bridge app](https://play.google.com/store/apps/details?id=masar.bluetoothbridge.pro) which includes USB bridge as well. -In this app, select TCP server as 'Device A' and choose an unused port (e.g. 4321). +In this app, select TCP server as 'Device A' and choose an unused port (client default port is 18888). Choose your registered PM3 device as 'Device B' -> 'Connect to USB device'. Ensure 'Retransmission' is set to 'both ways'. It is possible to record the config as autostart, cf 'Settings' -> 'Autostart setting'. @@ -167,7 +167,7 @@ You can download the apk on this website without installing F-Droid. The app lets you choose the baudrate. Default value (115 200 baud) is fine. Plug the PM3 in and click `Connect`. -Choose a random port not used by system (e.g. 4321) and click `Start Server`. +Choose a random port not used by system (client default port is 18888) and click `Start Server`. Note: This app uses foreground service to keep the connection alive, so you can safely put it in the background without suspending the transmission. However, you will see a dummy notification in the status bar which is required for foreground service. @@ -180,7 +180,7 @@ Note: This app uses foreground service to keep the connection alive, so you can Install [this free app](https://play.google.com/store/apps/details?id=masar.bb) or [the paid version](https://play.google.com/store/apps/details?id=masar.bluetoothbridge.pro) (which includes usb bridge) You need to pair the proxmark3 in the Android settings. -In the app, select TCP server as 'Device A' and choose an unused port (e.g. 4321). +In the app, select TCP server as 'Device A' and choose an unused port (client default port is 18888). Choose your registered PM3 device as 'Device B' -> 'Connect to classic Bluetooth device'. Ensure 'Retransmission' is set to 'both ways'. It is possible to record the config as autostart, cf 'Settings' -> 'Autostart setting'. @@ -191,10 +191,10 @@ It is possible to record the config as autostart, cf 'Settings' -> 'Autostart se The Proxmark5 Battery Wireless Module (BWM) uses BLE, not classic Bluetooth. The [paid version of the BT/USB/TCP Bridge app](https://play.google.com/store/apps/details?id=masar.bluetoothbridge.pro) handles it (the free version works with 10 minute time limit, can be reset by restarting the app): -In the app, select TCP server as 'Device A' (default port 54321). +In the app, select TCP server as 'Device A', port 18888 to use the client default port. Choose 'Device B' -> 'Connect to BLE device' -> `Proxmark5`. When asked for the characteristic, choose: service UUID starting with `0000ae86`, characteristic starting with `0000ae88`, for RX+TX. -No pairing is needed. Then connect from Termux as in [TCP connection](#tcp-connection) using port 54321. +No pairing is needed. Then connect from Termux as in [TCP connection](#tcp-connection) using port 18888. See [PM5-BWM-USAGE.md](md/PM5_Start_Here/PM5-BWM-USAGE.md) for the BWM firmware build flag and the WiFi alternative, which needs no bridge app at all. @@ -252,10 +252,10 @@ proxmark3 udp:localhost:12345 ^[Top](#top) 1. Phone and pm3 are connected, blue led is on and *not* blinking -2. BTUART Tool TCP Server at Port 4321 +2. BTUART Tool TCP Server at Port 18888 3. Using proxmark3 in termux shows the following error message: ``` -$ proxmark3 tcp:localhost:4321 +$ proxmark3 tcp:localhost:18888 [=] Session log /data/data/com.termux/files/home/.suroot /.proxmark3/log_20210519.txt @@ -263,7 +263,7 @@ $ proxmark3 tcp:localhost:4321 [+] loaded from JSON file /data/data/com.termux/files/ho me/.suroot/.proxmark3/preferences.json -Using UART port tcp:localhost:4321 +Using UART port tcp:localhost:18888 [!!] ERROR: cannot communicate with the Proxmark3 ```