diff --git a/ReadMe.md b/ReadMe.md index 99133ec4d..82af4dfbb 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -24,155 +24,23 @@ Our Discord Community:

-# Update firmware +# What changed +* SubGhz regional TX restriction removed +* Rolling code protocols now has ability to save & send captured signals +* FAAC SLH (Spa) & BFT Mitto (secure with seed) manual creation +* Custom plugins and games included +* Custom SubGhz frequencies and new mf classic keys +* Other small fixes and changes -## [Get Latest Firmware from GitHub Releases](https://github.com/Eng1n33r/flipperzero-firmware/releases) +### Current modified and new SubGhz protocols list: +- CAME Atomo +- FAAC SLH (Spa) +- Keeloq(+ proper mf codes selection) +- Nice Flor S +- SecPlus v1 & v2 +- Star Line -
-
- -### **Update to the latest official firmware before proceeding** - -
-
- -## With offline update on flipper - -### **Replace (CURRENT VERSION) with version that you downloaded from releases** -- Unpack `flipper-z-f7-update-(CURRENT VERSION).tgz` (or `.zip`) into any free folder on your PC or smartphone -- You should find folder named `f7-update-(CURRENT VERSION)` that contains files like `update.fuf`, `resources.tar` and etc.. -- Remove microSD card from flipper and insert it into PC or smartphone (you can skip this step and upload all files using qFlipper) -- Create new folder `update` on the root of the microSD card and move folder that you previously extracted from archive - `f7-update-(CURRENT VERSION)` into `update` on microSD card -- So result should look like `update/f7-update-(CURRENT VERSION)/` with all files in this folder on microSD card, remember iOS default Files app doesnt show all files properly (3 instead of 6), so you need to use another app for unpacking or use PC or Android -- Verify that all files are present on your microSD card -- After all you need to insert microSD card back into flipper, navigate into filebrowser, open this file -`update/f7-update-(CURRENT VERSION)/update.fuf` -- Update will start, wait for all stages, and when flipper started after update, you can upload any custom [IR libs](https://github.com/logickworkshop/Flipper-IRDB), and other stuff using qFlipper or directly into microSD card - -
-
- -## With qFlipper - -### **Replace (CURRENT VERSION) with version that you downloaded from releases** -- Connect your device and select `Update from file` -then select **`flipper-z-f7-full-(CURRENT VERSION).dfu`** - -- And wait, if all flashed successfully - you can manually upload IR libs and other stuff to sd card - -- If you doing install for first time or migrating from official fw, unpack 2 folders from archive `sd-card-(CURRENT VERSION).zip` onto your microSD card - - -
-
- -## With USB DFU - -1. Download latest [Firmware](https://github.com/Eng1n33r/flipperzero-firmware/releases) - -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` - -### **Replace (CURRENT VERSION) with version that you downloaded from releases** -3. Run `dfu-util -D flipper-z-f7-full-(CURRENT VERSION).dfu -a 0` - -4. If you doing install for first time or migrating from official fw, unpack 2 folders from archive `sd-card-(CURRENT VERSION).zip` to your microSD card - -
-
- -# After install: -- ### If you installed using .dfu - unpack 2 folders from archive `sd-card-(CURRENT VERSION).zip` to your microSD card -
- -- ## [How To: Configure UniversalRF Remix App](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/UniRFRemix.md) - -
-
- -## Support us so we can buy equipment and develop new features -* ETH/BSC/ERC20-Tokens: `0xFebF1bBc8229418FF2408C07AF6Afa49152fEc6a` -* BTC: `bc1q0np836jk9jwr4dd7p6qv66d04vamtqkxrecck9` -* DOGE: `D6R6gYgBn5LwTNmPyvAQR6bZ9EtGgFCpvv` -* LTC: `ltc1q3ex4ejkl0xpx3znwrmth4lyuadr5qgv8tmq8z9` - - -# Where I can find IR, SubGhz, ... DBs, and other stuff? -## [Awesome Flipper Zero - Github](https://github.com/djsime1/awesome-flipperzero) - -
-
- -# How to Build by yourself: - -## Clone the Repository - -You should clone with -```shell -$ git clone --recursive https://github.com/Eng1n33r/flipperzero-firmware.git -``` - -## Build with Docker - -### Prerequisites - -1. Install [Docker Engine and Docker Compose](https://www.docker.com/get-started) -2. Prepare the container: - - ```sh - docker-compose up -d - ``` - -### Compile everything for development - -```sh -docker-compose exec dev ./fbt -``` - -### Compile everything for release + get updater package to update from microSD card - -```sh -docker-compose exec dev ./fbt --with-updater COMPACT=1 DEBUG=0 updater_package -``` - -Check `dist/` for build outputs. - -Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device. - -If compilation fails, make sure all submodules are all initialized. Either clone with `--recursive` or use `git submodule update --init --recursive`. - -# Build on 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 -``` - -Install Python packages required by assets build scripts: `pip3 install -r scripts/requirements.txt` - -### Compile everything for development - -```sh -./fbt -``` - -### Compile everything for release + get updater package to update from microSD card - -```sh -./fbt --with-updater COMPACT=1 DEBUG=0 updater_package -``` - -Check `dist/` for build outputs. - -Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device. - -# Apps included +### Apps included: - [Clock/Stopwatch (By CompaqDisc, Stopwatch & Sound Alert By RogueMaster)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/blob/unleashed/applications/clock_app/clock_app.c) - [UniversalRF Remix (By ESurge)(Original UniversalRF By jimilinuxguy)](https://github.com/ESurge/flipperzero-firmware-unirfremix) @@ -181,10 +49,34 @@ Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device. - [Arkanoid (By gotnull)](https://github.com/gotnull/flipperzero-firmware-wPlugins) - [Tic Tac Toe (By gotnull)](https://github.com/gotnull/flipperzero-firmware-wPlugins) + +## Support us so we can buy equipment and develop new features +* ETH/BSC/ERC20-Tokens: `0xFebF1bBc8229418FF2408C07AF6Afa49152fEc6a` +* BTC: `bc1q0np836jk9jwr4dd7p6qv66d04vamtqkxrecck9` +* DOGE: `D6R6gYgBn5LwTNmPyvAQR6bZ9EtGgFCpvv` +* LTC: `ltc1q3ex4ejkl0xpx3znwrmth4lyuadr5qgv8tmq8z9` + +# Instructions +## [- How to install firmware](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/HowToInstall.md) + +## [- How to build firmware](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/HowToInstall.md) + +## [- Configure UniversalRF Remix App](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/UniRFRemix.md) + +
+
+ +# Where I can find IR, SubGhz, ... DBs, and other stuff? +## [Awesome Flipper Zero - Github](https://github.com/djsime1/awesome-flipperzero) +## [UberGuidoZ Playground - Large collection of files - Github](https://github.com/UberGuidoZ/Flipper) + +
+
+ # Links * Unofficial Discord: [discord.gg/58D6E8BtTU](https://discord.gg/58D6E8BtTU) -* Docs by atmanos: [https://flipper.atmanos.com/docs](https://flipper.atmanos.com/docs/your-first-program/intro) +* Docs by atmanos / How to write your own app (outdated): [https://flipper.atmanos.com/docs](https://flipper.atmanos.com/docs/your-first-program/intro) * Official Docs: [http://docs.flipperzero.one](http://docs.flipperzero.one) * Official Forum: [forum.flipperzero.one](https://forum.flipperzero.one/) diff --git a/documentation/HowToBuild.md b/documentation/HowToBuild.md new file mode 100644 index 000000000..04eccf50d --- /dev/null +++ b/documentation/HowToBuild.md @@ -0,0 +1,67 @@ + +# How to Build by yourself: + +## Clone the Repository + +You should clone with +```shell +$ git clone --recursive https://github.com/Eng1n33r/flipperzero-firmware.git +``` + +## Build with Docker + +### Prerequisites + +1. Install [Docker Engine and Docker Compose](https://www.docker.com/get-started) +2. Prepare the container: + + ```sh + docker-compose up -d + ``` + +### Compile everything for development + +```sh +docker-compose exec dev ./fbt +``` + +### Compile everything for release + get updater package to update from microSD card + +```sh +docker-compose exec dev ./fbt --with-updater COMPACT=1 DEBUG=0 updater_package +``` + +Check `dist/` for build outputs. + +Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device. + +If compilation fails, make sure all submodules are all initialized. Either clone with `--recursive` or use `git submodule update --init --recursive`. + +# Build on 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 +``` + +Install Python packages required by assets build scripts: `pip3 install -r scripts/requirements.txt` + +### Compile everything for development + +```sh +./fbt +``` + +### Compile everything for release + get updater package to update from microSD card + +```sh +./fbt --with-updater COMPACT=1 DEBUG=0 updater_package +``` + +Check `dist/` for build outputs. + +Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device. diff --git a/documentation/HowToInstall.md b/documentation/HowToInstall.md new file mode 100644 index 000000000..151cf6c67 --- /dev/null +++ b/documentation/HowToInstall.md @@ -0,0 +1,65 @@ + +# Update firmware + +## [Get Latest Firmware from GitHub Releases](https://github.com/Eng1n33r/flipperzero-firmware/releases) + +
+
+ +### **Update to the latest official firmware before proceeding** + +
+
+ +## With offline update on flipper + +### **Replace (CURRENT VERSION) with version that you downloaded from releases** +- Unpack `flipper-z-f7-update-(CURRENT VERSION).tgz` (or `.zip`) into any free folder on your PC or smartphone +- You should find folder named `f7-update-(CURRENT VERSION)` that contains files like `update.fuf`, `resources.tar` and etc.. +- Remove microSD card from flipper and insert it into PC or smartphone (you can skip this step and upload all files using qFlipper) +- Create new folder `update` on the root of the microSD card and move folder that you previously extracted from archive - `f7-update-(CURRENT VERSION)` into `update` on microSD card +- So result should look like `update/f7-update-(CURRENT VERSION)/` with all files in this folder on microSD card, remember iOS default Files app doesnt show all files properly (3 instead of 6), so you need to use another app for unpacking or use PC or Android +- Verify that all files are present on your microSD card +- After all you need to insert microSD card back into flipper, navigate into filebrowser, open this file +`update/f7-update-(CURRENT VERSION)/update.fuf` +- Update will start, wait for all stages, and when flipper started after update, you can upload any custom [IR libs](https://github.com/logickworkshop/Flipper-IRDB), and other stuff using qFlipper or directly into microSD card + +
+
+ +## With qFlipper + +### **Replace (CURRENT VERSION) with version that you downloaded from releases** +- Connect your device and select `Update from file` +then select **`flipper-z-f7-full-(CURRENT VERSION).dfu`** + +- And wait, if all flashed successfully - you can manually upload IR libs and other stuff to sd card + +- If you doing install for first time or migrating from official fw, unpack files from archive `sd-card-(CURRENT VERSION).zip` onto your microSD card + + +
+
+ +## With USB DFU + +1. Download latest [Firmware](https://github.com/Eng1n33r/flipperzero-firmware/releases) + +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` + +### **Replace (CURRENT VERSION) with version that you downloaded from releases** +3. Run `dfu-util -D flipper-z-f7-full-(CURRENT VERSION).dfu -a 0` + +4. If you doing install for first time or migrating from official fw, unpack files from archive `sd-card-(CURRENT VERSION).zip` to your microSD card + +
+
+ +# After install: +- ### If you installed using .dfu - unpack files from archive `sd-card-(CURRENT VERSION).zip` to your microSD card +
+ +- ## [How To: Configure UniversalRF Remix App](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/UniRFRemix.md)