flipperzero-firmware/scripts
hedger a91d319839
[FL-3162] Moved ufbt to fbt codebase (#2520)
* scripts: moved ufbt code
* ufbt: fixed tool path
* ufbt: fixed linter/formatter target descriptions
* scripts: ufbt: cleanup
* fbt: moved fap launch target to tools; ufbt fixes
* fbt: fixed missing headers from SDK
* ufbt: removed debug output
* ufbt: moved project template to main codebase
* ufbt: fixed vscode_dist
* ufbt: path naming changes
* fbt: error message for older ufbt versions
* ufbt: docs fixes
* ufbt: fixed build dir location
* fbt: fixes for extapps objcopy
* fbt: extapps: removed extra debug output; fixed formatting
* ufbt: handle launch target for multiple known apps
* ufbt: dropping wrapper; linter fixes
* ufbt: fixed boostrap path
* ufbt: renamed entrypoint
* ufbt: updated vscode config
* ufbt: moved sconsign db location
* ufbt: fixed sconsign path
* fbt: SDK builders rework
* fbt: reworked sdk packaging
* ufbt: additional checks and state processing
* ufbt: fixed sdk state file location
* dist: not packaging pycache
* dump commit json content
* Github: more workflow debug prints
* Github: fix incorrect commit meta extraction in get_env.py
* ufbt, fbt: changed SConsEnvironmentError->StopError
* fbtenv: no longer needs SCRIPT_PATH pre-set
* ufbt: fixed sdk state check
* scripts: exception fixes for storage.py
* scripts: fbtenv: added FBT_TOOLCHAIN_PATH for on Windows for compat
* ufbt: app template: creating .gitkeep for images folder
* ufbt: app template: fixed .gitkeep creation
* docs: formatting fixes for AppManifests; added link to ufbt
* fbt: added link to PyPI for old ufbt versions
* sdk: fixed dir component paths

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2023-04-06 10:44:37 +08:00
..
fbt [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
fbt_tools [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
flipper [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
testing Splitting units and updater benches (#2165) 2022-12-28 23:16:06 +09:00
toolchain [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
ufbt [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
assets.py [FL-2859,2838] fbt: improvements for FAPs (#1813) 2022-10-06 22:55:57 +09:00
bin2dfu.py [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
distfap.py [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
flash.py [FL-2269] Core2 OTA (#1144) 2022-04-27 18:53:48 +03:00
fwsize.py fbt fixes pt4 (#1899) 2022-10-26 07:15:02 +09:00
get_env.py [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
guruguru.py [FL-2832] fbt: more fixes & improvements (#1854) 2022-10-13 01:12:05 +09:00
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 [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09:00
ob.data Scripts: update ob.data to match current radio stack (#927) 2021-12-24 14:19:46 +03:00
ob.py OpenOCD scripts (#2101) 2022-12-27 21:59:36 +09:00
otp.py [FL-3180] OTP programmer: return exit code based on error type (#2504) 2023-03-20 21:07:17 +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 [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
selfupdate.py [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
serial_cli.py [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
slideshow.py slideshow.py: add return code on error (#1636) 2022-08-23 01:24:08 +09:00
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 fbt: explicitly set dist suffix length, not depending on environment settings. See (#2497) 2023-03-16 22:46:18 +09:00

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.