mirrors/unleashed-firmware
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 04:34:43 +04:00
Code Issues Activity

Merge remote-tracking branch 'OFW/dev' into dev

Browse Source
This commit is contained in:
MX
2024-07-01 22:18:36 +03:00
parent 160d6c319c 14b37a68b2
commit 0812cd30b2
39 changed files with 2029 additions and 287 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
documentation/file_formats/TarHeatshrinkFormat.md Normal file
View File

@@ -0,0 +1,19 @@
# Heatshrink-compressed Tarball Format
Flipper supports the use of Heatshrink compression library for .tar archives. This allows for smaller file sizes and faster OTA updates.
Heatshrink specification does not define a container format for storing compression parameters. This document describes the format used by Flipper to store Heatshrink-compressed data streams.
## Header
Header begins with a magic value, followed by a version number and compression parameters - window size and lookahead size.
Magic value consists of 4 bytes: `0x48 0x53 0x44 0x53` (ASCII "HSDS", HeatShrink DataStream).
Version number is a single byte, currently set to `0x01`.
Window size is a single byte, representing the size of the sliding window used by the compressor. It corresponds to `-w` parameter in Heatshrink CLI.
Lookahead size is a single byte, representing the size of the lookahead buffer used by the compressor. It corresponds to `-l` parameter in Heatshrink CLI.
Total header size is 7 bytes. Header is followed by compressed data.