mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2025-12-12 12:42:30 +04:00
update docs
This commit is contained in:
@@ -83,6 +83,8 @@ See changelog in releases for latest updates!
|
|||||||
|
|
||||||
## [- BadUSB: how to add new keyboard layouts](https://github.com/dummy-decoy/flipperzero_badusb_kl)
|
## [- BadUSB: how to add new keyboard layouts](https://github.com/dummy-decoy/flipperzero_badusb_kl)
|
||||||
|
|
||||||
|
## [- How to change Flipper name](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/CustomFlipperName.md)
|
||||||
|
|
||||||
### **Plugins**
|
### **Plugins**
|
||||||
|
|
||||||
## [- Configure UniversalRF Remix App](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/UniRFRemix.md)
|
## [- Configure UniversalRF Remix App](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/UniRFRemix.md)
|
||||||
|
|||||||
34
documentation/CustomFlipperName.md
Normal file
34
documentation/CustomFlipperName.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# How to change Flipper name:
|
||||||
|
|
||||||
|
## Instruction
|
||||||
|
1. Read [How to build](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/HowToBuild.md) and [How to install](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/HowToInstall.md) to know how to build and install firmware
|
||||||
|
2. Follow how to build instructions to prepare all things before continuing
|
||||||
|
3. Run release build to verify all is ok - `./fbt COMPACT=1 DEBUG=0 updater_package`
|
||||||
|
4. Clear build files - `./fbt COMPACT=1 DEBUG=0 updater_package -c`
|
||||||
|
5. Run command with extra enviroment var before `./fbt` that variable should contain your custom name in alphanumeric characters - max length 8 chars
|
||||||
|
`CUSTOM_FLIPPER_NAME=Name ./fbt COMPACT=1 DEBUG=0 updater_package` - where `Name` write your custom name
|
||||||
|
6. Copy `dist/f7-C/f7-update-local` folder to microSD `update/myfw/` and run `update` file on flipper from file manager app (Archive)
|
||||||
|
7. Flash from microSD card only, .dfu update from qFlipper will not work properly since name and serial number will be changed
|
||||||
|
8. Done, you will have custom name, serial number and bluetooth mac address
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
### I'm using Windows and name changing / building firmware doesn't work
|
||||||
|
- Use PowerShell or VSCode terminal(powershell by default)
|
||||||
|
- Clear build files - `.\fbt.cmd COMPACT=1 DEBUG=0 updater_package -c`
|
||||||
|
- Enter this in same terminal `$Env:CUSTOM_FLIPPER_NAME="Name"`
|
||||||
|
- Run release build - `.\fbt.cmd COMPACT=1 DEBUG=0 updater_package`
|
||||||
|
- Flash as described before (see 6.)
|
||||||
|
- If something still not work - Run powershell or VSCode as Admin
|
||||||
|
### Name stays same for every new build
|
||||||
|
- Clear build files - `./fbt COMPACT=1 DEBUG=0 updater_package -c`
|
||||||
|
- Try again
|
||||||
|
### I want to return my original name and serial number
|
||||||
|
- Flash stock FW or any CFW using microSD card offline update method
|
||||||
|
|
||||||
|
Or
|
||||||
|
- Clear build files - `./fbt COMPACT=1 DEBUG=0 updater_package -c`
|
||||||
|
- Run release build - `./fbt COMPACT=1 DEBUG=0 updater_package`
|
||||||
|
- Copy `dist/f7-C/f7-update-local` folder to microSD `update/myfw/` and run `update` file on flipper from file manager app (Archive)
|
||||||
|
- Flash from microSD card only, .dfu update from qFlipper will not work properly since name and serial number will be changed
|
||||||
@@ -1,6 +1,15 @@
|
|||||||
|
|
||||||
# How to Build by yourself:
|
# How to Build by yourself:
|
||||||
|
|
||||||
|
## Install required software
|
||||||
|
|
||||||
|
- Git - [Download](https://git-scm.com/downloads) for Windows, on Linux/Mac install via package manager (`brew`, `apt`, ...)
|
||||||
|
|
||||||
|
For development:
|
||||||
|
- Git
|
||||||
|
- Python3
|
||||||
|
- VSCode
|
||||||
|
|
||||||
## Clone the Repository
|
## Clone the Repository
|
||||||
|
|
||||||
You should clone with
|
You should clone with
|
||||||
@@ -8,6 +17,47 @@ You should clone with
|
|||||||
$ git clone --recursive https://github.com/Eng1n33r/flipperzero-firmware.git
|
$ git clone --recursive https://github.com/Eng1n33r/flipperzero-firmware.git
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# Build on Linux/macOS
|
||||||
|
|
||||||
|
Check out `documentation/fbt.md` for details on building and flashing firmware.
|
||||||
|
|
||||||
|
### Compile everything for development
|
||||||
|
|
||||||
|
```sh
|
||||||
|
./fbt
|
||||||
|
```
|
||||||
|
|
||||||
|
### Compile everything for release + get updater package to update from microSD card
|
||||||
|
|
||||||
|
```sh
|
||||||
|
./fbt COMPACT=1 DEBUG=0 updater_package
|
||||||
|
```
|
||||||
|
|
||||||
|
Check `dist/` for build outputs.
|
||||||
|
|
||||||
|
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
|
||||||
|
|
||||||
|
|
||||||
|
# Build on Windows
|
||||||
|
|
||||||
|
Check out `documentation/fbt.md` for details on building and flashing firmware.
|
||||||
|
|
||||||
|
### Compile everything for development
|
||||||
|
|
||||||
|
```sh
|
||||||
|
.\fbt.cmd
|
||||||
|
```
|
||||||
|
|
||||||
|
### Compile everything for release + get updater package to update from microSD card
|
||||||
|
|
||||||
|
```sh
|
||||||
|
.\fbt.cmd COMPACT=1 DEBUG=0 updater_package
|
||||||
|
```
|
||||||
|
|
||||||
|
Check `dist/` for build outputs.
|
||||||
|
|
||||||
|
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
|
||||||
|
|
||||||
## Build with Docker
|
## Build with Docker
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
@@ -28,7 +78,7 @@ docker-compose exec dev ./fbt
|
|||||||
### Compile everything for release + get updater package to update from microSD card
|
### Compile everything for release + get updater package to update from microSD card
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker-compose exec dev ./fbt --with-updater COMPACT=1 DEBUG=0 updater_package
|
docker-compose exec dev ./fbt COMPACT=1 DEBUG=0 updater_package
|
||||||
```
|
```
|
||||||
|
|
||||||
Check `dist/` for build outputs.
|
Check `dist/` for build outputs.
|
||||||
@@ -36,44 +86,3 @@ Check `dist/` for build outputs.
|
|||||||
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
|
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`.
|
If compilation fails, make sure all submodules are all initialized. Either clone with `--recursive` or use `git submodule update --init --recursive`.
|
||||||
|
|
||||||
# Build on Linux/macOS
|
|
||||||
|
|
||||||
Check out `documentation/fbt.md` for details on building and flashing firmware.
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
|
|
||||||
# Build on Windows
|
|
||||||
|
|
||||||
Check out `documentation/fbt.md` for details on building and flashing firmware.
|
|
||||||
|
|
||||||
### Compile everything for development
|
|
||||||
|
|
||||||
```sh
|
|
||||||
.\fbt.cmd
|
|
||||||
```
|
|
||||||
|
|
||||||
### Compile everything for release + get updater package to update from microSD card
|
|
||||||
|
|
||||||
```sh
|
|
||||||
.\fbt.cmd --with-updater COMPACT=1 DEBUG=0 updater_package
|
|
||||||
```
|
|
||||||
|
|
||||||
Check `dist/` for build outputs.
|
|
||||||
|
|
||||||
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user