|
|
@@ -1,134 +1,25 @@
|
|
|
-# Flipper Zero Firmware
|
|
|
+# WiFi Marauder companion app for Flipper Zero
|
|
|
|
|
|
-[](http://flipperzero.one/discord)
|
|
|
+Requires a connected dev board running Marauder FW. [See install instructions from UberGuidoZ here.](https://github.com/UberGuidoZ/Flipper/tree/main/Wifi_DevBoard#marauder-install-information)
|
|
|
|
|
|
-
|
|
|
+## Get the app
|
|
|
|
|
|
-Welcome to [Flipper Zero](https://flipperzero.one/)'s Firmware repo!
|
|
|
-Our goal is to create nice and clean code with good documentation, to make it a pleasure for everyone to work with.
|
|
|
+The app is now released as a FAP for use with official firmware. Alternative firmwares manage their own releases and may come with the app preinstalled.
|
|
|
|
|
|
-# Clone the Repository
|
|
|
+From a local clone of this repo, you can also build the app yourself using the command: `./fbt fap_ESP32_WiFi_Marauder`
|
|
|
|
|
|
-You should clone with
|
|
|
-```shell
|
|
|
-$ git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git
|
|
|
-```
|
|
|
+This will build using the included API, so make sure it matches your firmware!
|
|
|
|
|
|
-# Read the Docs
|
|
|
+## Support
|
|
|
|
|
|
-Check out details on [how to build firmware](documentation/fbt.md), [write applications](documentation/AppsOnSDCard.md), [un-brick your device](documentation/KeyCombo.md) and more in `documentation` folder.
|
|
|
+For app feedback, bugs, and feature requests, please [create an issue here](https://github.com/0xchocolate/flipperzero-firmware-with-wifi-marauder-companion/issues).
|
|
|
|
|
|
-# Update firmware
|
|
|
+You can find me (0xchocolate) on discord as @cococode#6011.
|
|
|
|
|
|
-[Get Latest Firmware from Update Server](https://update.flipperzero.one/)
|
|
|
+If you'd like to donate to the app development effort:
|
|
|
+**ETH**: `0xf32A1F0CD6122C97d8953183E53cB889cc087C9b`
|
|
|
+**BTC**: `bc1qtw7s25cwdkuaups22yna8sttfxn0usm2f35wc3`
|
|
|
|
|
|
-Flipper Zero's firmware consists of two components:
|
|
|
+Find more info about Marauder and support its developer (justcallmekoko aka WillStunForFood) here: https://github.com/justcallmekoko/ESP32Marauder
|
|
|
|
|
|
-- Core2 firmware set - proprietary components by ST: FUS + radio stack. FUS is flashed at factory, and you should never update it.
|
|
|
-- Core1 Firmware - HAL + OS + Drivers + Applications.
|
|
|
-
|
|
|
-They both must be flashed in the order described.
|
|
|
-
|
|
|
-## With offline update package
|
|
|
-
|
|
|
-With Flipper attached over USB:
|
|
|
-
|
|
|
-`./fbt flash_usb`
|
|
|
-
|
|
|
-Just building the package:
|
|
|
-
|
|
|
-`./fbt updater_package`
|
|
|
-
|
|
|
-To update, copy the resulting directory to Flipper's SD card and navigate to `update.fuf` file in Archive app.
|
|
|
-
|
|
|
-## With STLink
|
|
|
-
|
|
|
-### Core1 Firmware
|
|
|
-
|
|
|
-Prerequisites:
|
|
|
-
|
|
|
-- Linux / macOS
|
|
|
-- Terminal
|
|
|
-- [arm-gcc-none-eabi](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
|
|
|
-- openocd
|
|
|
-
|
|
|
-One-liner: `./fbt firmware_flash`
|
|
|
-
|
|
|
-## With USB DFU
|
|
|
-
|
|
|
-1. Download latest [Firmware](https://update.flipperzero.one)
|
|
|
-
|
|
|
-2. Reboot Flipper to Bootloader
|
|
|
- - Press and hold `← Left` + `↩ Back` for reset
|
|
|
- - Release `↩ Back` and keep holding `← Left` until blue LED lights up
|
|
|
- - Release `← Left`
|
|
|
-
|
|
|
-3. Run `dfu-util -D full.dfu -a 0`
|
|
|
-
|
|
|
-# Build on Linux/macOS
|
|
|
-
|
|
|
-Check out `documentation/fbt.md` for details on building and flashing firmware.
|
|
|
-
|
|
|
-## macOS Prerequisites
|
|
|
-
|
|
|
-Make sure you have [brew](https://brew.sh) and install all the dependencies:
|
|
|
-```sh
|
|
|
-brew bundle --verbose
|
|
|
-```
|
|
|
-
|
|
|
-## Linux Prerequisites
|
|
|
-
|
|
|
-The FBT tool handles everything, only `git` is required.
|
|
|
-
|
|
|
-### Optional dependencies
|
|
|
-
|
|
|
-- openocd (debugging/flashing over SWD)
|
|
|
-- heatshrink (compiling image assets)
|
|
|
-- clang-format (code formatting)
|
|
|
-- dfu-util (flashing over USB DFU)
|
|
|
-- protobuf (compiling proto sources)
|
|
|
-
|
|
|
-For example, to install them on Debian, use:
|
|
|
-```sh
|
|
|
-apt update
|
|
|
-apt install openocd clang-format-13 dfu-util protobuf-compiler
|
|
|
-```
|
|
|
-
|
|
|
-heatshrink has to be compiled [from sources](https://github.com/atomicobject/heatshrink).
|
|
|
-
|
|
|
-## Compile everything
|
|
|
-
|
|
|
-```sh
|
|
|
-./fbt
|
|
|
-```
|
|
|
-
|
|
|
-Check `dist/` for build outputs.
|
|
|
-
|
|
|
-Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
|
|
|
-
|
|
|
-## Flash everything
|
|
|
-
|
|
|
-Connect your device via ST-Link and run:
|
|
|
-```sh
|
|
|
-./fbt firmware_flash
|
|
|
-```
|
|
|
-
|
|
|
-# Links
|
|
|
-
|
|
|
-* Discord: [flipp.dev/discord](https://flipp.dev/discord)
|
|
|
-* Website: [flipperzero.one](https://flipperzero.one)
|
|
|
-* Kickstarter page: [kickstarter.com](https://www.kickstarter.com/projects/flipper-devices/flipper-zero-tamagochi-for-hackers)
|
|
|
-* Forum: [forum.flipperzero.one](https://forum.flipperzero.one/)
|
|
|
-
|
|
|
-# Project structure
|
|
|
-
|
|
|
-- `applications` - Applications and services used in firmware
|
|
|
-- `assets` - Assets used by applications and services
|
|
|
-- `furi` - Furi Core: os level primitives and helpers
|
|
|
-- `debug` - Debug tool: GDB-plugins, SVD-file and etc
|
|
|
-- `documentation` - Documentation generation system configs and input files
|
|
|
-- `firmware` - Firmware source code
|
|
|
-- `lib` - Our and 3rd party libraries, drivers, etc.
|
|
|
-- `scripts` - Supplementary scripts and python libraries home
|
|
|
-
|
|
|
-Also pay attention to `ReadMe.md` files inside those directories.
|
|
|
+If you found the app preinstalled in a firmware release, consider supporting the maintainers!
|
0xchocolate