Skip to content

Commit 4348818

Browse files
authored
Update README.md
1 parent 4b467bb commit 4348818

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ ESP-32 Wi-Fi Scanner
2121

2222
[Usage](https://github.com/CyberTechNex/ESP32-WIFI-Scanner/tree/main?tab=readme-ov-file#-usage)
2323

24-
[Contact](https://github.com/CyberTechNex/ESP32-WIFI-Scanner/edit/main/README.md#-contact)
24+
[Contact](#contact)
2525

2626
-------------
2727
-------------
2828

29-
🔎 About the Project
29+
# 🔎 About the Project
3030
-------------
3131
This project implements a Wi-Fi scanner using an ESP32 microcontroller. It allows users to scan for nearby Wi-Fi networks, display information such as SSID, MAC address, security type, RSSI, distance, and channel on an OLED display. Additionally, it features a functionality for rescanning networks at regular intervals.
3232

33-
📷 Pictures
33+
# 📷 Pictures
3434
-------------
3535

3636
![Device picture 1](images/oled_1.jpeg)
@@ -39,15 +39,15 @@ This project implements a Wi-Fi scanner using an ESP32 microcontroller. It allow
3939

4040

4141

42-
📝 Features
42+
# 📝 Features
4343
-------------
4444
* Estimates distance in metres between AP and ESP 32 with the help of RSSI value.
4545
* Displays each Wi-Fi info on a separate page.
4646
* Page can be changed with the help of a button.
4747
* Displays a page number on the bottom right and number updates with each page ,it resets when it returns to first Wi-Fi info.
4848
* Has a functionality to rescan and locate any changes in the Wi-Fi networks nearby.
4949

50-
🧰 Getting Started
50+
# 🧰 Getting Started
5151
-------------
5252
I used an ESP32 for the microcontroller and an OLED screen to display the Wi-Fi networks. Push buttons were also used to navigate across the different Wi-Fi access points scanned.
5353

@@ -61,7 +61,7 @@ Parts Needed:
6161
* Push Button
6262

6363

64-
🔌 Schematics
64+
# 🔌 Schematics
6565
-------------
6666
The table indicating the connections and the schematics for assembly are shown below.
6767

@@ -94,7 +94,7 @@ Breadboard Schematic:
9494

9595
![Breadboard circuit](images/breadboard_circuit.jpg)
9696

97-
⚡ PCB (Not tested):
97+
# ⚡ PCB (Not tested):
9898
-------------
9999
I made a prototype of a PCB for this circuit will be sharing the files once i verify it has no problems.
100100

@@ -113,7 +113,7 @@ Will upload the schematic files soon...
113113
-------------
114114
-------------
115115

116-
⚙️ Flashing Code:
116+
# ⚙️ Flashing Code:
117117
-------------
118118
To flash this code the Arduino IDE software will be needed which can be downloaded from the official arduino website at : https://www.arduino.cc/en/software.
119119

@@ -164,14 +164,14 @@ This process should successfully take place without any errors.
164164
(In case of any issues or bugs open an issue on github describing what the issue or bug is OR contact me via social media or mail.)
165165

166166

167-
👀 Usage:
167+
# 👀 Usage:
168168
-------------
169169

170170
After uploading the code, An intro screen appears with the name and credits (also an ASCII art of a cat),which switches to the Wi-Fi information page where the wifi info of all the wifis are available. Each wifi network has its own page. The button connected to the pin D23 of the ESP32 can be used to navigate the different pages of WIFI networks. To initiate a rescan of the networks the button connected to the pin D15 has to be pressed , a loading screen with a countdown for 5 seconds (along a ASCII art of a cat) will appear. Soon after the timer reaches zero the main wifi information page appears again but with updated WIFI information.
171171

172172

173173

174-
🤝 Contact
174+
🤝 ## Contact
175175
-------------
176176

177177
CyberTechNex (A1D3N) -

0 commit comments

Comments
 (0)