Compression Library for Use with Arduino Flash (PROGMEM)

Arduino UNO

<_e_1q6o ><a href="https://github.com/siara-cc/Shox96">Shox96 </a><span >is a technique used for compressing and decompressing short strings. This library allows storing of compressed text strings in Arduino Program Memory and provides API to retrieve each string individually using index.</span></_e_1q6o><p >Shox96 can achieve upto 60% compression depending on the composition of text. This can be especially useful in constrained environments like Arduino Uno where only 32kb of Flash memory is available.</p><_e_1q6o ><span >To find out how Shox96 works, read </span><a href="https://github.com/siara-cc/Shox96/blob/master/Shox96_Article_0_2_0.pdf?raw=true">this article.</a></_e_1q6o><h3 >Applications</h3><_e_1q6o ><li >Displaying descriptive error or warning messages</li></_e_1q6o><_e_1q6o ><li >Storing text file content (such as html)</li></_e_1q6o><_e_1q6o ><li >Transferring compressed content over low speed networks</li></_e_1q6o><h3 >Usage</h3><p >First, the strings that need to compressed should to be listed in a file (usually with.txt extension).</p><_e_1q6o ><span >Download </span><a href="https://github.com/siara-cc/Shox96">Shox96 </a><span >and compile it using instructions provided in the repository. Then create compressed PROGMEM header using following command:&lt;_e_1q6o&gt;:</span><code >./shox96 g &lt;text_file&gt; &lt;output_header_name&gt;</code></_e_1q6o><p >or</p><_e_1q6o ><code >./shox96 G &lt;text_file&gt; &lt;output_header_name&gt;</code></_e_1q6o><p >The command with capital G provides more compression taking into account repeating texts across the file.</p><_e_1q6o ><span >For example, if we use the file </span><code >proverbs.txt</code><span > given in the repository and the run command </span><code >./shox96 g proverbs.txt proverbs</code><span >, a file by name </span><code >proverbs.h</code><span > will be generated.  This file can be copied alongside any </span><code >.ino</code><span > file and included. Then the </span><code >shox96_0_2_pgm_decompress()</code><span > API from </span><code >shox96_progmem_0_2.h</code><span > in this library can be called to uncompress the strings.</span></_e_1q6o><p >Please try the examples provided along with this library to see how it works.</p><h3 >Compatibility</h3><p >This library can be used with Arduino Duemilanove, Uno upwards. It is useful only if saving by compressing text content is over 3000 bytes since the decompressor takes as much space.</p><h3 >Limitations</h3><_e_1q6o ><li >Only text data (ASCII 32 to 126, 13, 10, 9) can be compressed using Shox96</li></_e_1q6o><_e_1q6o ><_e_1q6o ><span >The capital G parameter requires more memory allocated for decompression. Please see </span><code >Html</code><span > example</span></_e_1q6o></_e_1q6o><_e_1q6o ><li >It is useful only if saving by compressing text content is over 3000 bytes since the decompressor takes as much space.</li></_e_1q6o><h3 >Examples and screenshots</h3><h3 >Html</h3><_e_1q6o ><span >This example demonstrates de-compression of Html content. Source of Html content is </span><a href="https://github.com/modularcode/modular-admin-html">https://github.com/modularcode/modular-admin-html,</a><span > which is released under MIT License.</span></_e_1q6o><p >Original html size: 65540 bytes</p><p >Compressed size: 22973 bytes</p><p >Savings: 64.95%</p><figure><img src=https://projects.arduinocontent.cc/c834ec3d-998c-446c-b64b-8e99dc728d45.png /><figcaption> </figcaption></figure><h3 >Error Messages</h3><_e_1q6o ><span >This example demonstrates de-compression of Error messages. Source: </span><code >include/errno.h</code><span > of GCC.</span></_e_1q6o><p >Original size: 2122 bytes</p><p >Compressed size: 1212 bytes</p><p >Savings: 42.88%</p><p >The savings do not justify compression as the decompressor itself takes around 3500 bytes.  This example has been given to show the use case.</p><figure><img src=https://projects.arduinocontent.cc/0a4acb4d-4418-43f3-9caf-8a26bd8ed726.png /><figcaption> </figcaption></figure><h3 >Proverbs</h3><_e_1q6o ><span >This example demonstrates de-compression of compressed proverbs. Source: </span><a href="https://en.wikipedia.org/wiki/List_of_proverbial_phrases">https://en.wikipedia.org/wiki/List_of_proverbial_phrases.</a></_e_1q6o><p > Original size : 25244 bytes</p><p > Compressed size: 14556 bytes </p><p > Savings: 42.34%</p><figure><img src=https://projects.arduinocontent.cc/d7e0945f-4b37-465c-89c4-8c3ec2e24f02.png /><figcaption> </figcaption></figure><_e_1q6o ></_e_1q6o>

Compression Library for Use with Arduino Flash (PROGMEM)

Achieve up to 60% saving on program memory space using Shox96 Guaranteed Text Compression Library for Arduino Uno and upwards.