unleashed-firmware/scripts
hedger fcbcb6b5a8
Updater: resource compression (#3716)
* toolbox: compress: moved decompressor implementation to separate func
* toolbox: compress: callback-based api; cli: storage unpack command
* toolbox: compress: separate r/w contexts for stream api
* targets: f18: sync API
* compress: naming fixes & cleanup
* toolbox: compress: using hs buffer size for stream buffers
* toolbox: tar: heatshrink stream mode
* toolbox: compress: docs & small cleanup
* toolbox: tar: header support for .hs; updater: now uses .hs for resources; .hs.tar: now rewindable
* toolbox: compress: fixed hs stream tail handling
* updater: reworked progress for resources cleanup; rebalanced stage weights
* updater: single-pass decompression; scripts: print resources compression ratio
* updater: fixed warnings
* toolbox: tar: doxygen
* docs: update
* docs: info or tarhs format; scripts: added standalone compression/decompression tool for heatshrink-formatted streams
* scripts: tarhs: fixed parameter handling
* cli: storage extract command; toolbox: tar: guess type based on extension
* unit_tests: added test for streamed raw hs decompressor `compress_decode_streamed`
* unit_tests: compress: added extraction test for .tar.hs
* rpc: autodetect compressed archives
* scripts: minor cleanup of common parts
* scripts: update: now using in-memory intermediate tar stream
* scripts: added hs.py wrapper for heatshrink-related ops (single object and directory-as-tar compression)
* scripts: naming fixes
* Toolbox: export compress_config_heatshrink_default as const symbol
* Toolbox: fix various types naming
* Toolbox: more of types naming fixes
* Toolbox: use size_t in compress io callbacks and structures
* UnitTests: update to match new compress API
* Toolbox: proper path_extract_extension usage

Co-authored-by: あく <alleteam@gmail.com>
2024-06-30 11:38:48 +01:00
..
debug Debug: backup openocd work area, fix crash after fresh debugger connect and continue (#3722) 2024-06-18 18:11:40 +03:00
fbt Icons: compression fixes & larger dimension support (#3564) 2024-05-20 18:23:47 +01:00
fbt_tools Code Cleanup: unused includes, useless checks, unused variables, etc... (#3696) 2024-06-11 03:04:29 +10:00
flipper Updater: resource compression (#3716) 2024-06-30 11:38:48 +01:00
testing [FL-3421] Unit bench: multiple attempts to find flipper (#2960) 2023-08-23 21:51:02 +09:00
toolchain Toolchain fixes (#3451) 2024-02-26 16:16:19 +04:00
ufbt fbt, vscode: tweaks for cdb generation for clangd (#3680) 2024-06-01 13:20:51 +01:00
assets.py Icons: compression fixes & larger dimension support (#3564) 2024-05-20 18:23:47 +01:00
bin2dfu.py [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
fastfap.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
flash.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
fwflash.py Fix spelling across some project files (#3128) 2023-10-10 04:01:17 +09:00
fwsize.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
get_env.py Fix spelling across some project files (#3128) 2023-10-10 04:01:17 +09:00
guruguru.py [FL-2832] fbt: more fixes & improvements (#1854) 2022-10-13 01:12:05 +09:00
hs.py Updater: resource compression (#3716) 2024-06-30 11:38:48 +01:00
infrared.py Various Fixes and Improvements (#3059) 2023-09-11 16:23:00 +10:00
lint.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
map_analyse_upload.py Add new map analyser (#3648) 2024-05-15 12:25:02 +01:00
merge_report_qa.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
ob_custradio.data [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09:00
ob.data New clock switch schema, fixes random core2 crashes (#3008) 2023-09-19 18:22:21 +04:00
ob.py Various Fixes and Improvements (#3059) 2023-09-11 16:23:00 +10:00
otp.py [FL-3408, FL-3429, FL-3430] Backlight notification fix (#2878) 2023-08-01 16:56:11 +09:00
power.py [FL-3421] Unit bench: multiple attempts to find flipper (#2960) 2023-08-23 21:51:02 +09:00
ReadMe.md [FL-3629] fbt: reworked assets & resources handling (#3160) 2023-10-31 00:17:30 +09:00
runfap.py [FL-3847, FL-3513] Thread Signals (#3730) 2024-06-21 21:44:36 +01:00
sconsdist.py Updater: resource compression (#3716) 2024-06-30 11:38:48 +01:00
selfupdate.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
send_firebase_notification.py Add notification sending (#3449) 2024-02-17 14:32:32 +07:00
serial_cli.py [FL-3346] fbt: added Flipper selection when multiple are connected over USB (#2723) 2023-06-08 13:47:27 +09:00
slideshow.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
storage.py Scripts: fix incorrect handling of storage stress test count option (#3321) 2023-12-28 19:15:07 +09:00
update.py Updater: resource compression (#3716) 2024-06-30 11:38:48 +01:00
version.py fbt: improvements (#3217) 2023-11-16 01:27:35 +09:00
wifi_board.py WiFi board: fixed update script on Windows (unfortunately also Mac and Linux) (#3485) 2024-03-01 15:58:15 +04: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

Build the firmware and run in the root folder of the repo:

python scripts/storage.py -p <flipper_cli_port> send build/latest/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.