Merge remote-tracking branch 'origin/master'

Author: Stefan Kremser

README.md

@@ -1,9 +1,16 @@
 # ArduinoPcap
 Create and send .pcap files using ESP8266/ESP32 and Arduino.
 
-[**Support me and my projects on Patreon!**  
-<img width="450" alt="Support me on Patreon" src="https://c5.patreon.com/external/logo/downloads_wordmark_navy.png">](https://www.patreon.com/spacehuhn)  
+[![Sniffing WiFi with ESP32 & ESP8266 in Wireshark](https://img.youtube.com/vi/3Ac6X6ZBQ0g/0.jpg)](https://www.youtube.com/watch?v=3Ac6X6ZBQ0g)  
 
+**Support me and my projects on [Patreon!](https://www.patreon.com/spacehuhn)**  
+[<img width="200" alt="Support me on Patreon" src="https://c5.patreon.com/external/logo/downloads_wordmark_navy.png">](https://www.patreon.com/spacehuhn)  
+
+## Please Note
+
+This is a proof of concept! The included examples are only for ESP8266 and ESP32, but the library can be used for other Arduinos as well. The packet output in the examples is unfiltered and maybe malformed, **errors can occur!**  
+
+Also a big thanks to [xdavidhu](http://github.com/xdavidhu) for writing the python script to connect to Wireshark!  
 
 ## Installation
 
@@ -15,11 +22,11 @@ For more information please read [Installing Additional Arduino Libraries](https
 **If you don't use an ESP32, you will need the [SdFat](https://github.com/greiman/SdFat) library.**
 
 Following Arduino libraries are required for the included examples:
-- [Arduino Time Library](https://github.com/PaulStoffregen/Time)  
-- [ESP8266](https://github.com/esp8266/Arduino)  
-- [ESP32](https://github.com/espressif/arduino-esp32)  
+- [Arduino Time Library](https://github.com/PaulStoffregen/Time) (for all examples)  
+- [ESP8266](https://github.com/esp8266/Arduino) (for the `esp8266_*` examples)  
+- [ESP32](https://github.com/espressif/arduino-esp32) (for the `esp32_*` examples)  
 
-For the Serialshark script:
+For the Serialshark script (the script located in `extras`):
   - [python3](https://www.python.org/downloads/)
   - [pyserial](https://github.com/pyserial/pyserial)  
   - [Wireshark](https://www.wireshark.org/#download)
@@ -43,7 +50,7 @@ You might want to adjust the settings in the sketch (settings may be different d
 ```
 
 Also note that when you use the ESP8266 most packets will be malformed or cut off at the end.  
-I don't know why the promiscuous mode returns this mostly false data, but it's still good enough to get some MAC adresses and SSIDs. I used it successfully in various projects to [detect deauthentication packets](https://github.com/spacehuhn/DeauthDetector), [scan for client devices](https://github.com/spacehuhn/esp8266_deauther) and build a low cost WiFi [packet monitor](https://github.com/spacehuhn/PacketMonitor).  
+I don't know why the promiscuous mode returns this mostly false data, but it's still good enough to get some MAC addresses and SSIDs. I used it successfully in various projects to [detect deauthentication packets](https://github.com/spacehuhn/DeauthDetector), [scan for client devices](https://github.com/spacehuhn/esp8266_deauther) and build a low cost WiFi [packet monitor](https://github.com/spacehuhn/PacketMonitor).  
 But if you want something more reliable then have a look at the ESP32, its promiscuous mode is working way better.  
 
 ### Live capture using Wireshark
@@ -53,11 +60,11 @@ For that be sure to have everything installed - see [Dependencies](#dependencies
 
 Flash your device and be sure it is connected.  
 Then start the `SerialShark.py` (it's in the `extras` folder) with `python3 SerialShark.py`.  
-It will ask you about about the serial port (you have to find that out), the baudrate (be sure it's the same as in your sketch) and where to save the pcap file (wherever you want).  
+It will ask you about about the serial port (you have to find that out), the baud rate (be sure it's the same as in your sketch) and where to save the pcap file (wherever you want).  
 
 ### Saving onto a SD-Card
 
-For that you will need a SD-Card (obviously). You can connect it direcly to the ESP8266/ESP32, but I recomment buying a SD-Card module/shield. Wire up the SPI connection (MOSI,MISO,SCL,CS,GND,VCC) to your module and basically you are ready to go!  
+For that you will need a SD-Card (obviously). You can connect it directly to the ESP8266/ESP32, but I recommend buying a SD-Card module/shield. Wire up the SPI connection (MOSI,MISO,SCL,CS,GND,VCC) to your module and basically you are ready to go!  
 [If you don't know which pins to connect to which, just search for a pinout picture of your module]  
 
 The included examples will save a new .pcap file every 30s. If you open the serial monitor in Arduino (baudrate is 115200), you will get some more information.