flipperzero-firmware/scripts
hedger 9bf11d9fd2
[FL-2859,2838] fbt: improvements for FAPs (#1813)
* fbt: assets builder for apps WIP
* fbt: automatically building private fap assets
* docs: details on how to use image assets
* fbt: renamed fap_assets -> fap_icons
* fbt: support for fap_extbuild field
* docs: info on fap_extbuild
* fbt: added --proxy-env parame ter
* fbt: made firmware_cdb & updater_cdb targets always available
* fbt: renamed fap_icons -> fap_icon_assets
* fbt: deprecated firmware_* target names for faps; new alias is "fap_APPID"
* fbt: changed intermediate file locations for external apps
* fbt: support for fap_private_libs; docs: updates
* restored mbedtls as global lib
* scripts: lint.py: skip "lib" subfolder
* fbt: Sanity checks for building advanced faps as part of fw
* docs: info on fap_private_libs; fbt: optimized *.fam indexing
* fbt: cleanup; samples: added sample_icons app
* fbt: moved example app to applications/examples
* linter fix
* docs: readme fixes
* added applications/examples/application.fam stub
* docs: more info on private libs

Co-authored-by: あく <alleteam@gmail.com>
2022-10-06 22:55:57 +09:00
..
flipper fbt: reproducible manifest builds & improvements (#1801) 2022-09-29 20:00:22 +09:00
toolchain fbt: exclude user site-packages directory from sys.path (#1778) 2022-09-24 15:30:19 +04:00
amap_mariadb_insert.py Amap and PVS Studio reports in CI/CD (#1526) 2022-08-23 20:29:26 +09: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
flash.py [FL-2269] Core2 OTA (#1144) 2022-04-27 18:53:48 +03:00
fwsize.py fbt: support for LOADER_AUTOSTART; post-build size stats (#1594) 2022-08-13 08:17:11 +10:00
get_env.py Fix CI/CD in tags #1703 2022-09-05 22:40:54 +09:00
guruguru.py
lint.py [FL-2859,2838] fbt: improvements for FAPs (#1813) 2022-10-06 22:55:57 +09:00
meta.py
ob_custradio.data [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09:00
ob.data
ob.py [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
otp.py Scripts: add new region to otp generator (#1582) 2022-08-12 01:10:50 +09:00
ReadMe.md Remove obsolete info from docs (#1672) 2022-08-29 00:39:08 +09:00
requirements.txt Bump protobuf from 3.20.1 to 3.20.2 in /scripts (#1774) 2022-09-25 20:56:53 +09:00
runfap.py [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
sconsdist.py [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
selfupdate.py fbt fixes & improvements (#1490) 2022-08-02 22:46:43 +09:00
serial_cli.py fbt: exclude user site-packages directory from sys.path (#1778) 2022-09-24 15:30:19 +04:00
slideshow.py slideshow.py: add return code on error (#1636) 2022-08-23 01:24:08 +09:00
storage.py fbt fixes & improvements (#1490) 2022-08-02 22:46:43 +09:00
update.py [FL-2836] Fast flash programming mode (#1782) 2022-09-26 20:03:21 +09:00
version.py fbt: Respect SOURCE_DATE_EPOCH when setting build date (#1421) 2022-07-20 15:48:10 +03: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 loose 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.