flipperzero-firmware/scripts
hedger 53435579b3
[FL-3097] fbt, faploader: minimal app module implementation (#2420)
* fbt, faploader: minimal app module implementation
* faploader, libs: moved API hashtable core to flipper_application
* example: compound api
* lib: flipper_application: naming fixes, doxygen comments
* fbt: changed `requires` manifest field behavior for app extensions
* examples: refactored plugin apps; faploader: changed new API naming; fbt: changed PLUGIN app type meaning
* loader: dropped support for debug apps & plugin menus
* moved applications/plugins -> applications/external
* Restored x bit on chiplist_convert.py
* git: fixed free-dap submodule path
* pvs: updated submodule paths
* examples: example_advanced_plugins.c: removed potential memory leak on errors
* examples: example_plugins: refined requires
* fbt: not deploying app modules for debug/sample apps; extra validation for .PLUGIN-type apps
* apps: removed cdefines for external apps
* fbt: moved ext app path definition
* fbt: reworked fap_dist handling; f18: synced api_symbols.csv
* fbt: removed resources_paths for extapps
* scripts: reworked storage
* scripts: reworked runfap.py & selfupdate.py to use new api
* wip: fal runner
* fbt: moved file packaging into separate module
* scripts: storage: fixes
* scripts: storage: minor fixes for new api
* fbt: changed internal artifact storage details for external apps
* scripts: storage: additional fixes and better error reporting; examples: using APP_DATA_PATH()
* fbt, scripts: reworked launch_app to deploy plugins; moved old runfap.py to distfap.py
* fbt: extra check for plugins descriptors
* fbt: additional checks in emitter
* fbt: better info message on SDK rebuild
* scripts: removed requirements.txt
* loader: removed remnants of plugins & debug menus
* post-review fixes
2023-03-14 23:29:28 +09:00
..
fbt [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
fbt_tools [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
flipper [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
testing Splitting units and updater benches (#2165) 2022-12-28 23:16:06 +09:00
toolchain [FL-2974] Up toolchain version to 21 (#2416) 2023-02-20 21:21:29 +09:00
assets.py [FL-2859,2838] fbt: improvements for FAPs (#1813) 2022-10-06 22:55:57 +09:00
bin2dfu.py
distfap.py [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
flash.py
fwsize.py
get_env.py Rollback new amap workflow (#2152) 2022-12-20 02:09:19 +09:00
guruguru.py
lint.py fbt: lint fixes (#2008) 2022-11-12 19:03:22 +09:00
merge_report_qa.py Migrating CI/CD to Linode S3 (#2380) 2023-02-09 19:42:41 +09:00
meta.py CI: Remove pycache from artifacts (#858) 2021-12-01 13:21:26 +03:00
ob_custradio.data
ob.data
ob.py OpenOCD scripts (#2101) 2022-12-27 21:59:36 +09:00
otp.py OpenOCD scripts (#2101) 2022-12-27 21:59:36 +09:00
power.py Splitting units and updater benches (#2165) 2022-12-28 23:16:06 +09:00
program.py Script that can find programmer and flash firmware via it. (#2193) 2023-02-06 23:56:36 +09:00
ReadMe.md Fixing various typos in readme files #2208 2022-12-28 23:30:20 +09:00
runfap.py [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
sconsdist.py
selfupdate.py [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
serial_cli.py
slideshow.py
storage.py [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
update.py Update update.py (#2426) 2023-02-25 22:41:49 +09:00
version.py

About

This folder contains supplementary scripts that automates routine actions. Flashing scripts are based on cli version of STM32CubeProgrammer. You will need to add STM32_Programmer_CLI to your path to use them.

Flashing empty MCU/Flipper

Always flash your device in the following sequence:

  • OTP (Only on empty MCU)
  • Core1 and Core2 firmware flashing
  • Option Bytes

Otp flashing

!!! Flashing incorrect OTP may permanently brick your device !!!

Normally OTP data generated and flashed at the factory. In case if MCU was replaced you'll need correct OTP data to be able to use companion applications. Use otp.py to generate and flash OTP data. You will need exact main board revision to generate OTP data. It can be found on main PCB. Also display type, region and etc...

!!! Flashing incorrect OTP may permanently brick your device !!!

Core1 and Core2 firmware flashing

Core2 goes first, then Core1. Never flash FUS or you will lose your job, girlfriend and keys in secure enclave.

Option Bytes

!!! Setting incorrect Option Bytes may brick your MCU !!!

Defaults are mostly OK, but there are couple things that we'd like to tune. Also, OB may be damaged, so we've made couple scripts to check and set option bytes.

!!! Setting incorrect Option Bytes may brick your MCU !!!

Checking option bytes:

ob.py check

Setting option bytes:

ob.py set

Assets delivery

Run in the root folder of the repo:

python scripts/storage.py -p <flipper_cli_port> send assets/resources /ext

Slideshow creation

Put fullscreen slideshow frames in .png format into assets/slideshow/my_show folder, named frame_xx.png, where xx is zero-padded frame number, starting with #0.

Then run

python scripts/slideshow.py -i assets/slideshow/my_show/ -o assets/slideshow/my_show/.slideshow

Upload generated .slideshow file to Flipper's internal storage and restart it.