Skip to content

Commit 7dd0fb6

Browse files
cifertechcifertech
authored
Update README.md
1 parent 38772b4 commit 7dd0fb6

File tree

1 file changed

+29
-62
lines changed

1 file changed

+29
-62
lines changed

‎README.md‎

Lines changed: 29 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
</div>
2626
<br/>
2727

28-
## 📖 Explore the Full Documentation
28+
## 📖 Explore the nRFBox Wiki
2929

30-
Ready to dive deeper into nRFBOX's details? Discover the full story, in-depth tutorials, and all the exciting features in our comprehensive [documentation](https://cifertech.net/nrfbox-your-all-in-one-gadget-for-ble-and-2-4ghz-networks/). Click the link and explore further!
30+
Complete project story, in-depth tutorials, and all the features in [Wiki](https://github.com/cifertech/nRFBox/wiki)! From Wi-Fi deauthentication attacks to Sub-GHz signal replay, the Wiki covers everything you need to get started. [Click here to explore now!](https://github.com/cifertech/nRFBox/wiki)
3131

3232
<div>&nbsp;</div>
3333

@@ -82,9 +82,12 @@ Ready to dive deeper into nRFBOX's details? Discover the full story, in-depth tu
8282
</tbody>
8383
</table>
8484

85-
- When using **multiple NRF24** modules, the power demands can exceed the capabilities of the onboard power supply or regulator. Running three NRF modules simultaneously may cause instability, leading to intermittent failures or causing the nRFBox to stop functioning altogether.
86-
- **Range Limitations**: The jammer is most effective at short range. Beyond a certain distance, the signal weakens, making it harder to consistently disrupt communication.
87-
- **Device Variability**: Different devices react to jamming signals in varying ways. Some may be more resistant.
85+
> [!NOTE]
86+
> - When using **multiple NRF24** modules, the power demands can exceed the capabilities of the onboard power supply or regulator. Running three NRF modules simultaneously may cause instability, leading to intermittent failures or causing the nRFBox to stop functioning altogether.
87+
> - **Range Limitations**: The jammer is most effective at short range. Beyond a certain distance, the signal weakens, making it harder to consistently disrupt communication.
88+
> - **Device Variability**: Different devices react to jamming signals in varying ways. Some may be more resistant.
89+
90+
8891

8992
<div>&nbsp;</div>
9093

@@ -95,30 +98,26 @@ nRFBOX is a wireless toolkit designed to explore, analyze, and interact with var
9598

9699

97100
<div align="center">
98-
<img src="https://github.com/user-attachments/assets/7012353c-2d09-4956-9152-937cf6a7ce18" alt="screenshot" width="Auto" height="Auto" />
101+
<img src="https://github.com/user-attachments/assets/5238a610-ca81-490f-be8e-b77a84d46383" alt="screenshot" width="Auto" height="Auto" />
99102
</div>
100103

101-
<div>&nbsp;</div>
104+
105+
102106

103107
<!-- Features -->
104108
### 🎯 Features
105109

106-
**Software:**
107-
- **Scanner**: Scans the 2.4GHz frequency band to detect active channels and devices.
108-
- **Analyzer**: Analyzes the detected signals and provides detailed information about the activity.
109-
- **Jammer**: Jams wireless communication on selected channels to test network robustness.
110-
- **BLE Jammer**: Specifically targets Bluetooth Low Energy (BLE) devices to disrupt their communication.
111-
- **BLE Spoofer**: Spoofs BLE devices to simulate various BLE signals for testing and research.
112-
- **Sour Apple**: A specialized attack for testing security measures against specific wireless vulnerabilities.
113-
- **Proto Kill Mode**: Proto Kill has evolved into a powerful tool for disrupting various protocols.
114-
115-
- **WiFi Scanner**
116-
- **BLE Scanner**
110+
- **Scanner** - Scans the 2.4GHz frequency band to detect active channels and devices.
111+
- **Analyzer** - Analyzes the detected signals and provides detailed information about the activity.
112+
- **Jammer** - Jams wireless communication on selected channels to test network robustness.
113+
- **BLE Jammer** - Specifically targets Bluetooth Low Energy (BLE) devices to disrupt their communication.
114+
- **BLE Spoofer** - Spoofs BLE devices to simulate various BLE signals for testing and research.
115+
- **Sour Apple** - A specialized attack for testing security measures against specific wireless vulnerabilities.
116+
- **Proto Kill Mode** - Proto Kill has evolved into a powerful tool for disrupting various protocols.
117+
- **WiFi Scanner** - Scan for hidden and visible BLE devices
118+
- **BLE Scanner** - List nearby Wi-Fi networks with extended details
119+
- **Wi-Fi Deauthentication Attack** - Send deauthentication frames to disrupt client connections
117120

118-
**Hardware:**
119-
- ESP32 Wroom32U
120-
- NRF24 GTmini Modules
121-
- OLED 0.96" Display
122121

123122
<div>&nbsp;</div>
124123

@@ -128,54 +127,22 @@ nRFBOX is a wireless toolkit designed to explore, analyze, and interact with var
128127
<table>
129128
<tr>
130129
<td style="text-align: center;">
131-
<img src="https://github.com/user-attachments/assets/b121fe84-c789-409a-85f5-21f6d5854347" alt="nRFBOX V1" style="width: 600px; border: 1px solid #ccc; border-radius: 5px;">
130+
<img src="https://github.com/user-attachments/assets/b121fe84-c789-409a-85f5-21f6d5854347" alt="nRFBOX V1" style="width: 400px; border: 1px solid #ccc; border-radius: 5px;">
132131
<p style="font-style: italic; font-size: 14px; margin-top: 5px;">nRFBox-v1 based on Arduino</p>
133132
</td>
134133
<td style="text-align: center;">
135-
<img src="https://github.com/user-attachments/assets/a044ab5e-346c-415f-b1fb-f65aa04c520a" alt="nRFBOX V2" style="width: 600px; border: 1px solid #ccc; border-radius: 5px;">
134+
<img src="https://github.com/user-attachments/assets/a044ab5e-346c-415f-b1fb-f65aa04c520a" alt="nRFBOX V2" style="width: 400px; border: 1px solid #ccc; border-radius: 5px;">
136135
<p style="font-style: italic; font-size: 14px; margin-top: 5px;">nRFBox-v2 based on ESP32</p>
137136
</td>
137+
</td>
138+
<td style="text-align: center;">
139+
<img src="https://github.com/user-attachments/assets/ecdd4a05-19c5-4f32-8871-4912475123ec" alt="nRFBOX V3" style="width: 400px; border: 1px solid #ccc; border-radius: 5px;">
140+
<p style="font-style: italic; font-size: 14px; margin-top: 5px;">nRFBox-v3 based on ESP32</p>
141+
</td>
138142
</tr>
139143
</table>
140144

141145

142-
<div>&nbsp;</div>
143-
144-
## 🔗 Uploading the Firmware (.bin) to ESP32
145-
146-
If you prefer not to upload the code manually or encounter errors during compilation, you can directly upload the precompiled `.bin` file to the ESP32. Follow these steps:
147-
148-
### Step 1: Download the Required Tools
149-
1. **ESP32 Flash Download Tool**: Download the tool from Espressif's official site: [ESP32 Flash Download Tool](https://www.espressif.com/sites/default/files/tools/flash_download_tool_3.9.7_2.zip).
150-
2. **USB Drivers**: Make sure the drivers for the ESP32 are installed on your system. You can download the drivers from [CP210x USB to UART Bridge VCP Drivers](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers) if you're using the CP2102 chip.
151-
152-
### Step 2: Prepare the `.bin` File
153-
1. Download the [precompiled `.bin`](https://github.com/cifertech/nRFBox/tree/main/precompiled%20%20bin) file from the repository.
154-
155-
### Step 3: Upload the `.bin` File to ESP32
156-
1. Connect your ESP32 to your computer using a USB cable.
157-
2. Open the **ESP32 Flash Download Tool** and configure the following:
158-
- Select the appropriate **chip type** (ESP32) and click **OK**.
159-
- In the **Download Path Config** section, add the `.bin` file and set the start address to `0x10000`.
160-
- Select the correct **COM port** where your ESP32 is connected.
161-
- Choose the correct **Baud rate** (115200 is generally recommended).
162-
163-
3. Click on **Start** to begin uploading the `.bin` file to your ESP32.
164-
165-
### Step 4: Verify the Upload
166-
Once the upload is completed, the tool will confirm a successful flash. You can now restart your ESP32 and run the firmware.
167-
168-
&nbsp;
169-
### Arduino IDE 1.8 Settings:
170-
If you want to upload the sketch code to the ESP32, use the following settings in the Tools menu:
171-
- **Built using ESP32 Board Version 2.0.11**
172-
173-
<div style="display: flex; justify-content: center; align-items: center; gap: 10px;">
174-
<img src="https://github.com/user-attachments/assets/2e43dc05-9ef7-4743-85f2-a8fc38e7b785" alt="Photo 1" style="width: 34%; border: 1px solid #ccc; border-radius: 5px;">
175-
<img src="https://github.com/user-attachments/assets/9fc87b96-7442-44f8-9457-22d1b481eda1" alt="Photo 2" style="width: 53%; border: 1px solid #ccc; border-radius: 5px;">
176-
</div>
177-
178-
179146
<div>&nbsp;</div>
180147

181148
<!-- License -->
@@ -199,7 +166,7 @@ Project Link: [https://github.com/cifertech/nRFBOX](https://github.com/cifertech
199166
<!-- Acknowledgments -->
200167
## :gem: Acknowledgements
201168

202-
**The libraries and projects listed below are used in this software:**
169+
**The libraries and projects listed below are used in the nRFBox Project:**
203170
- [Poor Man’s 2.4 GHz Scanner](https://forum.arduino.cc/t/poor-mans-2-4-ghz-scanner/54846)
204171
- [arduino_oled_menu](https://github.com/upiir/arduino_oled_menu)
205172
- [nRF24L01-WiFi-Jammer](https://github.com/hugorezende/nRF24L01-WiFi-Jammer)

0 commit comments

Comments
 (0)