Update README

wh201906 · Jan 20, 2024 · 36f2416 · 36f2416
1 parent 3373354
commit 36f2416
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 12 deletions.
diff --git a/PM3_USB2TCP/README.md b/PM3_USB2TCP/README.md
@@ -1,14 +1,20 @@
 # PM3 USB to TCP Bridge
 
-Connect to PM3 hardware with TCP, using ESP32-S3 as a USB to TCP bridge.  
-This modding only contains the firmware of ESP32-S3, and it should work on most of the ESP32-S3 dev boards.  
+Connect to PM3 hardware with TCP, using ESP32-S3/S2 as a USB to TCP bridge.  
+This modding only contains the firmware of ESP32-S3, and it should work on most of the ESP32-S3 and ESP32-S2 dev boards.  
 
 # Tips:
 1. To use this modding, you need a Proxmark3 client newer than commit [9c947eddcdbc66e76be6b33be9af4ce75e730b92](https://github.com/RfidResearchGroup/proxmark3/commit/9c947eddcdbc66e76be6b33be9af4ce75e730b92)
 2. You need ESP-IDF to compile this project
-3. The ESP32-S3 will work as a soft-AP. The SSID and the password are defined in [PM3_Modding/PM3_USB2TCP/firmware/main/wifi.h](./firmware/main/wifi.h)
-4. The default IP address of ESP32-S3 is `192.168.4.1`(soft-AP mode). The server port is defined in [PM3_Modding/PM3_USB2TCP/firmware/main/tcp-server.h](./firmware/main/tcp-server.h)
-5. ESP32-S2 also has the USB-Host peripheral, so it should also works.
+3. The ESP32-S3 can work as a soft-AP. The SSID and the password are defined in [PM3_Modding/PM3_USB2TCP/firmware/main/wifi/wifi.h](./firmware/main/wifi/wifi.h)
+4. To connect to an existing AP like wireless router or mobile hotspot, you should follow these steps:  
+    + Set the correct SSID and password in [PM3_Modding/PM3_USB2TCP/firmware/main/wifi/wifi.h](./firmware/main/wifi/wifi.h)
+    + Comment out `wifi_init_softap();` in [PM3_Modding/PM3_USB2TCP/firmware/main/app_main.c](./firmware/main/app_main.c)
+    + Uncomment `wifi_init_sta();` in [PM3_Modding/PM3_USB2TCP/firmware/main/app_main.c](./firmware/main/app_main.c)
+    + To get the IP address allocated by the DHCP server, you can check the output on UART0(GPIO43 for Tx, GPIO44 for Rx) or the management page of the router
+    + (Optional) If it's not convenient to get the allocated IP address, you can set the static IP address in [PM3_Modding/PM3_USB2TCP/firmware/main/wifi/wifi.h](./firmware/main/wifi/wifi.h)
+5. The default IP address of ESP32-S3 is `192.168.4.1`(soft-AP mode). The server port is defined in [PM3_Modding/PM3_USB2TCP/firmware/main/tcp-server.h](./firmware/main/tcp-server.h)
+6. ESP32-S2 also has the USB-Host peripheral, so it also works. Remember to set the correct target chip in ESP-IDF.
 
 # Hardware Connection
 

diff --git a/PM3_USB2UDP/README.md b/PM3_USB2UDP/README.md
@@ -1,14 +1,20 @@
 # PM3 USB to UDP Bridge
 
-Connect to PM3 hardware with UDP, using ESP32-S3 as a USB to UDP bridge.  
-This modding only contains the firmware of ESP32-S3, and it should work on most of the ESP32-S3 dev boards.  
+Connect to PM3 hardware with UDP, using ESP32-S3/S2 as a USB to UDP bridge.  
+This modding only contains the firmware of ESP32-S3, and it should work on most of the ESP32-S3 and ESP32-S2 dev boards.  
 
 # Tips:
 1. To use this modding, you need a Proxmark3 client newer than commit [0c0967bcc56773e0b014fd4d89d5f893052928d3](https://github.com/RfidResearchGroup/proxmark3/commit/0c0967bcc56773e0b014fd4d89d5f893052928d3)
 2. You need ESP-IDF to compile this project
-3. The ESP32-S3 will work as a soft-AP. The SSID and the password are defined in [PM3_Modding/PM3_USB2UDP/firmware/main/wifi.h](./firmware/main/wifi.h)
-4. The default IP address of ESP32-S3 is `192.168.4.1`(soft-AP mode). The server port is defined in [PM3_Modding/PM3_USB2UDP/firmware/main/udp-server.h](./firmware/main/udp-server.h)
-5. ESP32-S2 also has the USB-Host peripheral, so it should also works.
+3. The ESP32-S3 can work as a soft-AP. The SSID and the password are defined in [PM3_Modding/PM3_USB2UDP/firmware/main/wifi/wifi.h](./firmware/main/wifi/wifi.h)
+4. To connect to an existing AP like wireless router or mobile hotspot, you should follow these steps:  
+    + Set the correct SSID and password in [PM3_Modding/PM3_USB2UDP/firmware/main/wifi/wifi.h](./firmware/main/wifi/wifi.h)
+    + Comment out `wifi_init_softap();` in [PM3_Modding/PM3_USB2UDP/firmware/main/app_main.c](./firmware/main/app_main.c)
+    + Uncomment `wifi_init_sta();` in [PM3_Modding/PM3_USB2UDP/firmware/main/app_main.c](./firmware/main/app_main.c)
+    + To get the IP address allocated by the DHCP server, you can check the output on UART0(GPIO43 for Tx, GPIO44 for Rx) or the management page of the router
+    + (Optional) If it's not convenient to get the allocated IP address, you can set the static IP address in [PM3_Modding/PM3_USB2UDP/firmware/main/wifi/wifi.h](./firmware/main/wifi/wifi.h)
+5. The default IP address of ESP32-S3 is `192.168.4.1`(soft-AP mode). The server port is defined in [PM3_Modding/PM3_USB2UDP/firmware/main/tcp-server.h](./firmware/main/udp-server.h)
+6. ESP32-S2 also has the USB-Host peripheral, so it also works. Remember to set the correct target chip in ESP-IDF.
 
 # Hardware Connection
 

diff --git a/README.md b/README.md
@@ -14,8 +14,8 @@ Add the smartcard module to the PM3 Easy
 
 ## PM3_USB2TCP
 [README](/PM3_USB2TCP/README.md)  
-Connect to PM3 hardware with TCP, using ESP32-S3 as a USB to TCP bridge  
-No need to jumping any wires to the MCU directly. It works with most of the ESP32-S3 dev boards  
+Connect to PM3 hardware with TCP, using ESP32-S3/S2 as a USB to TCP bridge  
+No need to jumping any wires to the MCU directly. It works with most of the ESP32-S3/S2 dev boards  
 
 ## PM3_USB2UDP
 [README](/PM3_USB2UDP/README.md)