|
1 | 1 | <div align="center">
|
2 |
| - <img align="center" src=".github/images/flipper-dev.png" /> |
| 2 | + <img align="center" src=".github/images/camera-suite.png" /> |
3 | 3 | <h2 align="center">Flipper Zero - Camera Suite</h2>
|
4 | 4 | <p align="center">
|
5 | 5 | Firmware and software to run an ESP32-CAM module on your Flipper Zero device.
|
|
24 | 24 | - [Software Guide](#software-guide)
|
25 | 25 | - [Attributions](#attributions)
|
26 | 26 |
|
27 |
| -## Previews <a name="previews"></a> |
| 27 | +## Preview <a name="previews"></a> |
28 | 28 |
|
29 |
| -This section is coming soon... |
| 29 | +<img align="center" src=".github/images/preview.png" /> |
| 30 | + |
| 31 | +More previews coming soon! |
30 | 32 |
|
31 | 33 | <p align="right">[ <a href="#index">Back to top</a> ]</p>
|
32 | 34 |
|
33 | 35 | ## Hardware Requirements <a name="hardware-requirements"></a>
|
34 | 36 |
|
35 |
| -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] ). |
| 37 | +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]). |
| 38 | + |
| 39 | +<img src=".github/images/esp32-cam-front.png" /> |
| 40 | +<img src=".github/images/esp32-cam-back.png" /> |
36 | 41 |
|
37 | 42 | <p align="right">[ <a href="#index">Back to top</a> ]</p>
|
38 | 43 |
|
39 | 44 | ## Hardware Installation <a name="hardware-installation"></a>
|
40 | 45 |
|
41 |
| -This section is coming soon... |
| 46 | +Below is the pinout guide and diagram for the ESP32-CAM module to the Flipper Zero. From the ESP32-CAM module to the Flipper Zero: |
| 47 | + |
| 48 | +``` |
| 49 | +VCC to 3V3 |
| 50 | +GND to GND (Be sure to use the right GND, see image below.) |
| 51 | +U0R to TX |
| 52 | +U0T to RX |
| 53 | +``` |
| 54 | + |
| 55 | +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. |
| 56 | + |
| 57 | +<img align="center" src=".github/images/esp32-cam-pinout-guide.png" /> |
42 | 58 |
|
43 | 59 | <p align="right">[ <a href="#index">Back to top</a> ]</p>
|
44 | 60 |
|
45 | 61 | ## Firmware Installation <a name="firmware-installation"></a>
|
46 | 62 |
|
47 |
| -This section is coming soon... |
| 63 | +1. Download and install the Arduino IDE from [here][arduino-ide]. |
| 64 | +2. Go to the [releases section][flipper-zero-camera-suite-releases] for this repo and download the `esp32_cam_uart_stream.zip` file. |
| 65 | +3. Extract the contents of `esp32_cam_uart_stream.zip` to disk. Be sure to keep the `.ino` file nested in the folder with the same name. |
| 66 | +4. Open `~\esp32_cam_uart_stream\esp32_cam_uart_stream.ino` with your Arduino IDE. |
| 67 | +5. In the Arduino IDE, go to `File > Preferences`. |
| 68 | +6. In the `Settings` tab, add the following URL to the `Additional Boards Manager URLs` field: |
| 69 | + ``` |
| 70 | + https://dl.espressif.com/dl/package_esp32_index.json |
| 71 | + ``` |
| 72 | +7. In the Arduino IDE, go to `Tools > Board > Boards Manager`. |
| 73 | +8. Search for `esp32` and install `esp32` by `Espressif Systems`. |
| 74 | +9. Plug in your Flipper Zero via USB. Make sure qFlipper or something else isn't connected to it already after doing so. |
| 75 | +10. On your Flipper Zero, open `GPIO > USB-UART Bridge`. |
| 76 | +11. In the Arduino IDE, go to `Tools > Board > esp32 > AI Thinker ESP32-CAM`. |
| 77 | +12. In the Arduino IDE, go to `Tools > Port` and select the port that your Flipper Zero is connected to. |
| 78 | +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. |
| 79 | +14. Press the RST button on the back of the ESP32-CAM module to boot it into flash mode. |
| 80 | +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. |
| 81 | +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. |
| 82 | + |
| 83 | +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. |
48 | 84 |
|
49 | 85 | <p align="right">[ <a href="#index">Back to top</a> ]</p>
|
50 | 86 |
|
@@ -72,7 +108,29 @@ This section is coming soon...
|
72 | 108 |
|
73 | 109 | ## Software Guide <a name="software-guide"></a>
|
74 | 110 |
|
75 |
| -This section is coming soon... |
| 111 | +### Flipper Zero button mappings: |
| 112 | + |
| 113 | +⨀ = Toggle between Floyd–Steinberg and Atkinson dithering. |
| 114 | + |
| 115 | +▲ = Contrast Up |
| 116 | + |
| 117 | +▼ = Contrast Down |
| 118 | + |
| 119 | +◀ = Toggle invert. |
| 120 | + |
| 121 | +▶ = Toggle dithering on/off. |
| 122 | + |
| 123 | +↩ = Go back. |
| 124 | + |
| 125 | +### Camera Suite settings: |
| 126 | + |
| 127 | +**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. |
| 128 | + |
| 129 | +**Haptic FX** = Toggle haptic feedback on/off. |
| 130 | + |
| 131 | +**Sound FX** = Toggle sound effects on/off. |
| 132 | + |
| 133 | +**LED FX** = Toggle LED effects on/off. |
76 | 134 |
|
77 | 135 | <p align="right">[ <a href="#index">Back to top</a> ]</p>
|
78 | 136 |
|
|
92 | 150 |
|
93 | 151 | [amazon-esp32-cam-link-1]: https://amzn.to/3NCoQUq
|
94 | 152 | [amazon-esp32-cam-link-2]: https://amzn.to/46IuAF9
|
| 153 | +[arduino-ide]: https://www.arduino.cc/en/software |
| 154 | +[flipper-zero-camera-suite-releases]: https://github.com/CodyTolene/Flipper-Zero-Camera-Suite/releases |
95 | 155 | [flipper-zero-fap-boilerplate]: https://github.com/leedave/flipper-zero-fap-boilerplate
|
96 | 156 | [flipperzero-camera]: https://github.com/Z4urce/flipperzero-camera
|
97 |
| -[github-profile-z4urce]: https://github.com/Z4urce |
98 | 157 | [github-profile-leedave]: https://github.com/leedave
|
| 158 | +[github-profile-z4urce]: https://github.com/Z4urce |
0 commit comments