Просмотр исходного кода

Complete all sections of readme.

Cody Tolene 2 лет назад
Родитель
Сommit
e7db927fa8

BIN
.github/images/camera-suite.png


BIN
.github/images/esp32-cam-back.png


BIN
.github/images/esp32-cam-front.png


BIN
.github/images/esp32-cam-pinout-guide.png


BIN
.github/images/flipper-dev.png


+ 0 - 0
.github/images/app-preview-cam-01.png → .github/images/preview.png


BIN
.github/images/rotation-demo.gif


+ 68 - 8
README.md

@@ -1,5 +1,5 @@
 <div align="center">
 <div align="center">
-  <img align="center" src=".github/images/flipper-dev.png" />
+  <img align="center" src=".github/images/camera-suite.png" />
   <h2 align="center">Flipper Zero - Camera Suite</h2>
   <h2 align="center">Flipper Zero - Camera Suite</h2>
   <p align="center">
   <p align="center">
     Firmware and software to run an ESP32-CAM module on your Flipper Zero device.
     Firmware and software to run an ESP32-CAM module on your Flipper Zero device.
@@ -24,27 +24,63 @@
 - [Software Guide](#software-guide)
 - [Software Guide](#software-guide)
 - [Attributions](#attributions)
 - [Attributions](#attributions)
 
 
-## Previews <a name="previews"></a>
+## Preview <a name="previews"></a>
 
 
-This section is coming soon...
+<img align="center" src=".github/images/preview.png" />
+
+More previews coming soon!
 
 
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 
 
 ## Hardware Requirements <a name="hardware-requirements"></a>
 ## Hardware Requirements <a name="hardware-requirements"></a>
 
 
-Requires an ESP32-CAM module (I've personally used these: [Amazon link 1][amazon-esp32-cam-link-1] | [Amazon link 2][amazon-esp32-cam-link-2] ).
+Requires an ESP32-CAM module (I've personally used these: [Amazon Link 1][amazon-esp32-cam-link-1] | [Amazon Link 2][amazon-esp32-cam-link-2]).
+
+<img src=".github/images/esp32-cam-front.png" />
+<img src=".github/images/esp32-cam-back.png" />
 
 
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 
 
 ## Hardware Installation <a name="hardware-installation"></a>
 ## Hardware Installation <a name="hardware-installation"></a>
 
 
-This section is coming soon...
+Below is the pinout guide and digram for the ESP32-CAM module to the Flipper Zero. From the ESP32-CAM module to the Flipper Zero:
+
+```
+VCC to 3V3
+GND to GND (Be sure to use the right GND, see image below.)
+U0R to TX
+U0T to RX
+```
+
+On the ESP32-CAM module itself you'll also need to connect the `IO0` pin to `GND`. This will place the module into flash mode for installing the firmware later on (see [Firmware Installation](#firmware-installation)). You can do this by connecting a jumper wire, a button, or a switch to do this.
+
+<img align="center" src=".github/images/esp32-cam-pinout-guide.png" />
 
 
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 
 
 ## Firmware Installation <a name="firmware-installation"></a>
 ## Firmware Installation <a name="firmware-installation"></a>
 
 
-This section is coming soon...
+1. Download and install the Arduino IDE from [here][arduino-ide].
+2. Go to the [releases section][flipper-zero-camera-suite-releases] for this repo and download the `esp32_cam_uart_stream.zip` file.
+3. Extract contents of `esp32_cam_uart_stream.zip` to disk. Be sure to keep the `.ino` file nested in the folder with the same name.
+4. Open `~\esp32_cam_uart_stream\esp32_cam_uart_stream.ino` with your Arduino IDE.
+5. In the Arduino IDE, go to `File > Preferences`.
+6. In the `Settings` tab, add the following URL to the `Additional Boards Manager URLs` field:
+   ```
+   https://dl.espressif.com/dl/package_esp32_index.json
+   ```
+7. In the Arduino IDE, go to `Tools > Board > Boards Manager`.
+8. Search for `esp32` and install `esp32` by `Espressif Systems`.
+9. Plug in your Flipper Zero via USB. Make sure qFlipper or something else isn't connected to it already after doing so.
+10. On your Flipper Zero, open `GPIO > USB-UART Bridge`.
+11. In the Arduino IDE, go to `Tools > Board > esp32 > AI Thinker ESP32-CAM`.
+12. In the Arduino IDE, go to `Tools > Port` and select the port that your Flipper Zero is connected to.
+13. Plug in the ESP32-CAM module to your Flipper Zero while connecting the `IO0` pin to `GND`. See [Hardware Installation](#hardware-installation) for more information.
+14. Press the RST button on the back of the ESP32-CAM module to boot it into flash mode.
+15. In the Arduino IDE, go to `Sketch > Upload` to upload the firmware to your ESP32-CAM module. You will see upload progress in % and receive a message on completion if successful.
+16. Fin! Now you may use the [Software Installation](#software-installation) section to install the software on your Flipper Zero to take advantage of this hardwares firmware.
+
+Note the upload may fail a few times, this is normal, try again. If it still fails, try pressing the RST button on the back of the ESP32-CAM module again or checking your connections.
 
 
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 
 
@@ -72,7 +108,29 @@ This section is coming soon...
 
 
 ## Software Guide <a name="software-guide"></a>
 ## Software Guide <a name="software-guide"></a>
 
 
-This section is coming soon...
+### Flipper Zero button mappings:
+
+⨀ = Toggle between Floyd–Steinberg and Atkinson dithering.
+
+▲ = Contrast Up
+
+▼ = Contrast Down
+
+◀ = Toggle invert.
+
+▶ = Toggle dithering on/off.
+
+↩ = Go back.
+
+### Camera Suite settings:
+
+**Orientation** = Rotate the camera image 90 degrees clockwise starting at zero by default (0, 90, 180, 270). This is useful if you have your camera module mounted in a different orientation than the default.
+
+**Haptic FX** = Toggle haptic feedback on/off.
+
+**Sound FX** = Toggle sound effects on/off.
+
+**LED FX** = Toggle LED effects on/off.
 
 
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 <p align="right">[ <a href="#index">Back to top</a> ]</p>
 
 
@@ -92,7 +150,9 @@ Cody
 
 
 [amazon-esp32-cam-link-1]: https://amzn.to/3NCoQUq
 [amazon-esp32-cam-link-1]: https://amzn.to/3NCoQUq
 [amazon-esp32-cam-link-2]: https://amzn.to/46IuAF9
 [amazon-esp32-cam-link-2]: https://amzn.to/46IuAF9
+[arduino-ide]: https://www.arduino.cc/en/software
+[flipper-zero-camera-suite-releases]: https://github.com/CodyTolene/Flipper-Zero-Camera-Suite/releases
 [flipper-zero-fap-boilerplate]: https://github.com/leedave/flipper-zero-fap-boilerplate
 [flipper-zero-fap-boilerplate]: https://github.com/leedave/flipper-zero-fap-boilerplate
 [flipperzero-camera]: https://github.com/Z4urce/flipperzero-camera
 [flipperzero-camera]: https://github.com/Z4urce/flipperzero-camera
-[github-profile-z4urce]: https://github.com/Z4urce
 [github-profile-leedave]: https://github.com/leedave
 [github-profile-leedave]: https://github.com/leedave
+[github-profile-z4urce]: https://github.com/Z4urce