FlipperHTTP - v1.4.1 (Restructure)

- Directory restructure - Raspberry Pi 2 W Support
jblanked · Nov 21, 2024 · d856e0d · d856e0d
1 parent 9cc3299
commit d856e0d
Show file tree

Hide file tree

Showing 25 changed files with 139 additions and 132 deletions.
diff --git a/Flipper Zero/README.md b/Flipper Zero/README.md
diff --git a/flipper_http.c → Flipper Zero/flipper_http.c b/flipper_http.c → Flipper Zero/flipper_http.c
@@ -1,3 +1,7 @@
+// Description: Flipper HTTP API (For use with Flipper Zero and the FlipperHTTP flash: https://github.com/jblanked/FlipperHTTP)
+// License: MIT
+// Author: JBlanked
+// File: flipper_http.c
 #include <flipper_http.h> // change this to where flipper_http.h is located
 FlipperHTTP fhttp;
 char rx_line_buffer[RX_LINE_BUFFER_SIZE];

diff --git a/flipper_http.h → Flipper Zero/flipper_http.h b/flipper_http.h → Flipper Zero/flipper_http.h
@@ -1,4 +1,7 @@
-// flipper_http.h
+// Description: Flipper HTTP API (For use with Flipper Zero and the FlipperHTTP flash: https://github.com/jblanked/FlipperHTTP)
+// License: MIT
+// Author: JBlanked
+// File: flipper_http.h
 #ifndef FLIPPER_HTTP_H
 #define FLIPPER_HTTP_H
 

diff --git a/flipper_http.js → Flipper Zero/flipper_http.js b/flipper_http.js → Flipper Zero/flipper_http.js
diff --git a/flipper_http.py → Flipper Zero/flipper_http.py b/flipper_http.py → Flipper Zero/flipper_http.py
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 jblanked
+Copyright (c) 2024 JBlanked
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
diff --git a/...Raspberry Pi Pico W/C++/FlipperHTTPPico.h → Raspberry Pi Pico W/C++/FlipperHTTPPico.h b/...Raspberry Pi Pico W/C++/FlipperHTTPPico.h → Raspberry Pi Pico W/C++/FlipperHTTPPico.h
diff --git a/Raspberry Pi Pico W/C++/README.md b/Raspberry Pi Pico W/C++/README.md
@@ -0,0 +1,8 @@
+## Raspberry Pi Pico W Installation (C++)
+
+1. Download the `flipper_http_pico_c++.uf2` file.
+2. Press and hold the `BOOT` button on your Pico W for 2 seconds.
+3. While holding the `BOOT` button, connect the Pico W to your computer using a USB cable.
+4. Drag and drop the downloaded file onto the device. It will automatically reboot and begin running the FlipperHTTP firmware.
+
+Here's a video tutorial: https://www.youtube.com/watch?v=rdzKDCjbZ4k
diff --git a/...berry Pi Pico W/C++/flipper-http-pico.ino → ...berry Pi Pico W/C++/flipper-http-pico.ino b/...berry Pi Pico W/C++/flipper-http-pico.ino → ...berry Pi Pico W/C++/flipper-http-pico.ino
diff --git a/flipper_http_pico_c++.uf2 → ...y Pi Pico W/C++/flipper_http_pico_c++.uf2 b/flipper_http_pico_c++.uf2 → ...y Pi Pico W/C++/flipper_http_pico_c++.uf2
diff --git a/...Raspberry Pi Pico W/MicroPython/EasySD.py → Raspberry Pi Pico W/MicroPython/EasySD.py b/...Raspberry Pi Pico W/MicroPython/EasySD.py → Raspberry Pi Pico W/MicroPython/EasySD.py
diff --git a/... Pi Pico W/MicroPython/FlipperHTTPPico.py → ... Pi Pico W/MicroPython/FlipperHTTPPico.py b/... Pi Pico W/MicroPython/FlipperHTTPPico.py → ... Pi Pico W/MicroPython/FlipperHTTPPico.py
diff --git a/Raspberry Pi Pico W/MicroPython/README.md b/Raspberry Pi Pico W/MicroPython/README.md
@@ -0,0 +1,20 @@
+## Raspberry Pi Pico W Installation (MicroPython)
+
+1. Download the `main.py`, `urequests_2.py`, `EasySD.py`, and `FlipperHTTPPico.py` files.
+2. Press and hold the `BOOT` button on your Pico W for 2 seconds.
+3. While holding the `BOOT` button, connect the Pico W to your computer using a USB cable.
+4. The Pico W should appear as a storage device on your computer.
+5. Download Thonny from [https://thonny.org](https://thonny.org).
+6. Install MicroPython:
+   - Go to `Run -> Configure interpreter`.
+   - Select `MicroPython (Raspberry Pi Pico)` in the `Which kind of interpreter...` field.
+   - Click `Install or update MicroPython`. The target volume and MicroPython family should appear. If not, ensure your Pico W is connected.
+   - Choose `Raspberry Pi - Pico W / Pico WH` in the `Variant` field.
+   - Click `Install`. When the installation is complete, your Pico W will automatically reboot and start running MicroPython.
+7. Click `OK` to close the dialog and return to the main window.
+8. Add the Files:
+    - Click `Load`, then `This computer`, and select the `FlipperHTTPPico.py` file you downloaded earlier.
+    - Go to the `File` menu, select `Save copy`, then choose `Raspberry Pi Pico`. Name the file `FlipperHTTPPico.py` and click `OK`.
+    - Repeat the steps above for `main.py`, `EasySD.py`, and `urequests_2.py`, saving it to the Raspberry Pi Pico with the name `main.py`, `EasySD.py`, and `urequests_2.py`.
+
+You're all set! When you reboot your Pico W, it will run the FlipperHTTP Flash. Here's a video tutorial: https://www.youtube.com/watch?v=rdzKDCjbZ4k
diff --git a/src/Raspberry Pi Pico W/MicroPython/main.py → Raspberry Pi Pico W/MicroPython/main.py b/src/Raspberry Pi Pico W/MicroPython/main.py → Raspberry Pi Pico W/MicroPython/main.py
diff --git a/...erry Pi Pico W/MicroPython/urequests_2.py → ...erry Pi Pico W/MicroPython/urequests_2.py b/...erry Pi Pico W/MicroPython/urequests_2.py → ...erry Pi Pico W/MicroPython/urequests_2.py
diff --git a/src/Raspberry Pi Zero 2 W/FlipperHTTPPi2W.py → Raspberry Pi Zero 2 W/FlipperHTTPPi2W.py b/src/Raspberry Pi Zero 2 W/FlipperHTTPPi2W.py → Raspberry Pi Zero 2 W/FlipperHTTPPi2W.py
diff --git a/Raspberry Pi Zero 2 W/README.md b/Raspberry Pi Zero 2 W/README.md
@@ -0,0 +1,2 @@
+## Raspberry Pi 2 W Installation (Python)
+
diff --git a/src/Raspberry Pi Zero 2 W/main.py → Raspberry Pi Zero 2 W/main.py b/src/Raspberry Pi Zero 2 W/main.py → Raspberry Pi Zero 2 W/main.py
diff --git a/src/WiFi Developer Board/FlipperHTTP.h → WiFi Developer Board (ESP32S2)/FlipperHTTP.h b/src/WiFi Developer Board/FlipperHTTP.h → WiFi Developer Board (ESP32S2)/FlipperHTTP.h
diff --git a/WiFi Developer Board (ESP32S2)/README.md b/WiFi Developer Board (ESP32S2)/README.md
@@ -0,0 +1,22 @@
+## WiFi Devboard Installation
+1. Install the ESP Flasher app on your Flipper Zero from the Apps catalog: https://lab.flipper.net/apps/esp_flasher
+2. Download the `flipper_http_bootloader.bin`, `flipper_http_firmware_a.bin`, and `flipper_http_partitions.bin` files.
+3. Disconnect your WiFi Developer Board and connect your Flipper Zero to your computer.
+4. Open up qFlipper.
+5. Click on the `File manager`.
+6. Navigate to `SD Card/apps_data/esp_flasher/`. If the folder doesn’t exist, create it yourself or run the ESP Flasher app once.
+7. Drag all three bin files you downloaded earlier into the directory.
+8. Disconnect your Flipper from your computer then turn off your Flipper.
+9. Connect your WiFi Developer Board into the Flipper then turn on your Flipper.
+10. Open the ESP Flasher app on your Flipper, it should be located in the `Apps->GPIO` folder from the main menu. 
+11. In the ESP Flasher app, select the following options:
+    - `Reset Board`: wait a few seconds, then go back.
+    - `Enter Bootloader`: wait until the 'waiting for download' message appears, then go back.
+    - `Flash ESP`: if you do not see this option at the top of the main menu, then click `Manual Flash`.
+13. Click on `Bootloader (0x1000)` and select the `flipper_http_bootloader.bin` that you downloaded earlier.
+14. Click on `Part Table (0x8000)` and select the `flipper_http_partitions.bin` that you downloaded earlier.
+15. Click on `FirmwareA (0x10000)` and select the `flipper_http_firmware_a.bin` that you downloaded earlier.
+16. Click on `FLASH - slow` to flash the firmware to your Developer Board. Wait until the process is complete. If successful, the LED of the Developer Board will flash GREEN three times.
+17. Lastly, on the Developer Board, press the RESET button once.
+
+You are all set. Here's a video tutorial: https://www.youtube.com/watch?v=AZfbrLKJMpM
diff --git a/src/WiFi Developer Board/flipper-http.ino → ...eveloper Board (ESP32S2)/flipper-http.ino b/src/WiFi Developer Board/flipper-http.ino → ...eveloper Board (ESP32S2)/flipper-http.ino
diff --git a/flipper_http_bootloader.bin → ...ard (ESP32S2)/flipper_http_bootloader.bin b/flipper_http_bootloader.bin → ...ard (ESP32S2)/flipper_http_bootloader.bin
diff --git a/flipper_http_firmware_a.bin → ...ard (ESP32S2)/flipper_http_firmware_a.bin b/flipper_http_firmware_a.bin → ...ard (ESP32S2)/flipper_http_firmware_a.bin
diff --git a/flipper_http_partitions.bin → ...ard (ESP32S2)/flipper_http_partitions.bin b/flipper_http_partitions.bin → ...ard (ESP32S2)/flipper_http_partitions.bin