heatshrink-integration
SolidUse when integrating or debugging heatshrink embedded compression — encoder/decoder sink/poll/finish loops, window/lookahead sz2, HSER/HSDR codes, or static vs dynamic alloc
AI & Automation 22 stars
2 forks Updated 1 weeks ago MIT
Install
Quality Score: 79/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# heatshrink Integration
## Overview
Use this skill to integrate heatshrink (`github.com/atomicobject/heatshrink`) by fixing memory budget, `window_sz2`/`lookahead_sz2` sizes, the sink/poll/finish streaming loop, and decompression safety. Compression bugs usually come from mismatched encoder/decoder settings, an unfinished poll loop, or output buffers that are too small.
## When To Use
Use this skill when:
- The user wants heatshrink compression/decompression on an MCU.
- The task involves compressed logs, resources, firmware chunks, OTA payloads, or serial transfer compression.
- Decompression fails, output is truncated, memory is too high, or compressed data is incompatible.
- The project uses `heatshrink_encoder.h`, `heatshrink_decoder.h`, `heatshrink_config.h`, or the `heatshrink` command-line tool.
Do not use this skill for general archive formats like gzip/zip unless heatshrink is specifically involved.
## First Questions
Ask for:
- Use case: logs, UI assets, firmware chunks, telemetry, or storage.
- Encoder/decoder settings: `window_sz2` (4-15) and `lookahead_sz2` (3 to `window_sz2 - 1`). The CLI's compiled default is `-w 11 -l 4`; its help text recommends `-w 8 -l 4` for embedded systems.
- Allocation model: `HEATSHRINK_DYNAMIC_ALLOC` (heap via `HEATSHRINK_MALLOC`/`HEATSHRINK_FREE`) or static (`HEATSHRINK_STATIC_WINDOW_BITS`, `HEATSHRINK_STATIC_LOOKAHEAD_BITS`, `HEATSHRINK_STATIC_INPUT_BUFFER_SIZE`).
- Streaming or one-shot mode, and input/output chunk sizes ...
Details
- Author
- easyzoom
- Repository
- easyzoom/aix-skills
- Created
- 3 months ago
- Last Updated
- 1 weeks ago
- Language
- Python
- License
- MIT
Similar Skills
Semantically similar based on skill content — not just same category
AI & Automation Solid
miniz-integration
Use when integrating, configuring, or debugging miniz compression, DEFLATE, zlib streams, gzip-compatible data, ZIP archives, or embedded decompression buffers
22 Updated 1 weeks ago
easyzoom AI & Automation Solid
nr-micro-shell-integration
Use when integrating, porting, configuring, or debugging nr_micro_shell command consoles, UART shell input, command tables, or tiny embedded CLI behavior
22 Updated 1 weeks ago
easyzoom AI & Automation Solid
letter-shell-integration
Use when integrating, porting, configuring, or debugging letter-shell command shells, UART shell transport, command registration, RTOS shell tasks, or embedded debug consoles
22 Updated 1 weeks ago
easyzoom