Merge pull request #3 from carvilsi/updating-firmware-1.0

Updating firmware 1.0

Author: carvilsi

.gitignore

@@ -1 +1,2 @@
 .*.swp
+tags

README.md

@@ -28,3 +28,48 @@ Clone this repo at `applications_user/` folder under `flipperzero-firmware`
 |      RX           | TXD GPIO_17 |
 |      3V3          |     3V3     |
 
+## Collected Data
+
+WiFi_MaP, by now, saves the collected data on a kind of **CSV** formated file, like:
+
+```
+##### 20-9-2024_17:47:47 #####
+f8a4985c;1.96;3;18
+394d4b0b;17.78;3;18
+bab9b9a6;34.81;3;18
+2e41b0ed;34.81;4;18
+f81b53a0;42.17;3;18
+287de1e8;68.13;5;18
+f1d1f410;68.13;4;18
+6cb4288c;74.99;4;18
+7b2695be;74.99;4;18
+163976e1;82.54;4;18
+198bb499;90.85;4;18
+ff52db41;90.85;3;18
+72a684f0;100.00;4;18
+163976e1;100.00;4;18
+f8a4985c;1.78;3;21
+```
+Every time that WiFi_MaP starts adds the date to the file surronded by hash signs, then starts to add the collected AP
+data separated by ';'. The maximun AP that scans is 20.
+The data is:
+
+| AP name hashed | distance to AP (meters) | AP auth mode (1) | seconds since the scan started | 
+|----------------|-------------------------|------------------|--------------------------------|
+|    f8a4985c    |          1.96           |         3        |               18               |
+
+
+**(1)** -> Table of ESP32 AP WIFI Auth Mode [wifi_auth_mode_t](https://github.com/pycom/esp-idf-2.0/blob/092aa8176ffa0ab386fb6d33e50e1a267bef9d1c/components/esp32/include/esp_wifi_types.h#L58)
+
+| Open | WEP | WPA_PSK | WPA2_PSK | WPA_WPA2_PSK |
+|------|-----|---------|----------|--------------|
+|  0   |  1  |    2    |    3     |      2       |
+
+---
+
+**Note:** main branch works with latest version of FlipperZero firmware, **1.0.1** (in the moment of writting this).
+If you want to have this app running with a firmware version < 1.* check the *legacy-previous-API-1* at the repo.
+
+---
+
+<3 & Hack the Planet!