skywalkerf34 / unziplib Goto Github PK

Copyright (c) 2021 BitBank Software, Inc.
Written by Larry Bank
[email protected]

An 'embedded-friendly' (aka Arduino) library to extract and decompress files from ZIP archives

I wanted to be able to unzip files on MCUs for various projects and I couldn't find any libraries that would do the job. The thing that prevents most Linux open source projects from running on embedded boards is their use of the file system and heap management. There is support for malloc/free on Arduino, but it's better to control how memory is used more directly (e.g. TCM vs FLASH vs DDR).

I designed the unzip library to not rely on malloc/free, but instead to have a fixed class/structure which could be managed by the user. I also removed the dependency on the file system and instead offer a set of callback hooks to allow zip files to be read from memory, SDCard or any media. These two features give it maximum flexibility to run on low end systems.

• Runs on any MCU with at least 41K of free RAM
  
• No external dependencies (including malloc/free, file system calls)
  
• unzip API implemented in C and C++
  
• ZIP files can come from RAM, FLASH, SDCard or any media by using callbacks
  
• Decompress files by reading any sized chunk at a time (full sized buffer not needed)
  
• Compiles on any target CPU
  

Detailed information about the API is in the Wiki
See the examples folder for easy starting points