From fc79d8b8aeb7fa0d51dbb550c1d5be14bf091d0d Mon Sep 17 00:00:00 2001
From: Alexander Entinger <cto@lxrobotics.com>
Date: Tue, 7 Jul 2020 09:34:16 +0200
Subject: [PATCH 1/7] Adding lzss encoder by Haruhiko Okumura available in the
 public domain

---
 extras/tools/lzss.c | 180 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 180 insertions(+)
 create mode 100644 extras/tools/lzss.c

diff --git a/extras/tools/lzss.c b/extras/tools/lzss.c
new file mode 100644
index 000000000..58391f535
--- /dev/null
+++ b/extras/tools/lzss.c
@@ -0,0 +1,180 @@
+/* LZSS encoder-decoder (Haruhiko Okumura; public domain) */
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#define EI 11  /* typically 10..13 */
+#define EJ  4  /* typically 4..5 */
+#define P   1  /* If match length <= P then output one character */
+#define N (1 << EI)  /* buffer size */
+#define F ((1 << EJ) + 1)  /* lookahead buffer size */
+
+int bit_buffer = 0, bit_mask = 128;
+unsigned long codecount = 0, textcount = 0;
+unsigned char buffer[N * 2];
+FILE *infile, *outfile;
+
+void error(void)
+{
+    printf("Output error\n");  exit(1);
+}
+
+void putbit1(void)
+{
+    bit_buffer |= bit_mask;
+    if ((bit_mask >>= 1) == 0) {
+        if (fputc(bit_buffer, outfile) == EOF) error();
+        bit_buffer = 0;  bit_mask = 128;  codecount++;
+    }
+}
+
+void putbit0(void)
+{
+    if ((bit_mask >>= 1) == 0) {
+        if (fputc(bit_buffer, outfile) == EOF) error();
+        bit_buffer = 0;  bit_mask = 128;  codecount++;
+    }
+}
+
+void flush_bit_buffer(void)
+{
+    if (bit_mask != 128) {
+        if (fputc(bit_buffer, outfile) == EOF) error();
+        codecount++;
+    }
+}
+
+void output1(int c)
+{
+    int mask;
+    
+    putbit1();
+    mask = 256;
+    while (mask >>= 1) {
+        if (c & mask) putbit1();
+        else putbit0();
+    }
+}
+
+void output2(int x, int y)
+{
+    int mask;
+    
+    putbit0();
+    mask = N;
+    while (mask >>= 1) {
+        if (x & mask) putbit1();
+        else putbit0();
+    }
+    mask = (1 << EJ);
+    while (mask >>= 1) {
+        if (y & mask) putbit1();
+        else putbit0();
+    }
+}
+
+void encode(void)
+{
+    int i, j, f1, x, y, r, s, bufferend, c;
+    
+    for (i = 0; i < N - F; i++) buffer[i] = ' ';
+    for (i = N - F; i < N * 2; i++) {
+        if ((c = fgetc(infile)) == EOF) break;
+        buffer[i] = c;  textcount++;
+    }
+    bufferend = i;  r = N - F;  s = 0;
+    while (r < bufferend) {
+        f1 = (F <= bufferend - r) ? F : bufferend - r;
+        x = 0;  y = 1;  c = buffer[r];
+        for (i = r - 1; i >= s; i--)
+            if (buffer[i] == c) {
+                for (j = 1; j < f1; j++)
+                    if (buffer[i + j] != buffer[r + j]) break;
+                if (j > y) {
+                    x = i;  y = j;
+                }
+            }
+        if (y <= P) {  y = 1;  output1(c);  }
+        else output2(x & (N - 1), y - 2);
+        r += y;  s += y;
+        if (r >= N * 2 - F) {
+            for (i = 0; i < N; i++) buffer[i] = buffer[i + N];
+            bufferend -= N;  r -= N;  s -= N;
+            while (bufferend < N * 2) {
+                if ((c = fgetc(infile)) == EOF) break;
+                buffer[bufferend++] = c;  textcount++;
+            }
+        }
+    }
+    flush_bit_buffer();
+    printf("text:  %ld bytes\n", textcount);
+    printf("code:  %ld bytes (%ld%%)\n",
+        codecount, (codecount * 100) / textcount);
+}
+
+int getbit(int n) /* get n bits */
+{
+    int i, x;
+    static int buf, mask = 0;
+    
+    x = 0;
+    for (i = 0; i < n; i++) {
+        if (mask == 0) {
+            if ((buf = fgetc(infile)) == EOF) return EOF;
+            mask = 128;
+        }
+        x <<= 1;
+        if (buf & mask) x++;
+        mask >>= 1;
+    }
+    return x;
+}
+
+void decode(void)
+{
+    int i, j, k, r, c;
+    
+    for (i = 0; i < N - F; i++) buffer[i] = ' ';
+    r = N - F;
+    while ((c = getbit(1)) != EOF) {
+        if (c) {
+            if ((c = getbit(8)) == EOF) break;
+            fputc(c, outfile);
+            buffer[r++] = c;  r &= (N - 1);
+        } else {
+            if ((i = getbit(EI)) == EOF) break;
+            if ((j = getbit(EJ)) == EOF) break;
+            for (k = 0; k <= j + 1; k++) {
+                c = buffer[(i + k) & (N - 1)];
+                fputc(c, outfile);
+                buffer[r++] = c;  r &= (N - 1);
+            }
+        }
+    }
+}
+
+int main(int argc, char *argv[])
+{
+    int enc;
+    char *s;
+    
+    if (argc != 4) {
+        printf("Usage: lzss e/d infile outfile\n\te = encode\td = decode\n");
+        return 1;
+    }
+    s = argv[1];
+    if (s[1] == 0 && (*s == 'd' || *s == 'D' || *s == 'e' || *s == 'E'))
+        enc = (*s == 'e' || *s == 'E');
+    else {
+        printf("? %s\n", s);  return 1;
+    }
+    if ((infile  = fopen(argv[2], "rb")) == NULL) {
+        printf("? %s\n", argv[2]);  return 1;
+    }
+    if ((outfile = fopen(argv[3], "wb")) == NULL) {
+        printf("? %s\n", argv[3]);  return 1;
+    }
+    if (enc) encode();  else decode();
+    fclose(infile);  fclose(outfile);
+    return 0;
+}

From 236f7445c3ee8862011884d67d1ea4d6f943bfc4 Mon Sep 17 00:00:00 2001
From: Alexander Entinger <cto@lxrobotics.com>
Date: Thu, 9 Jul 2020 14:30:54 +0200
Subject: [PATCH 2/7] Ignoring the file extensions commonly stored in this
 folder, that is .bin, .ota and .json

---
 extras/tools/.gitignore | 4 ++++
 1 file changed, 4 insertions(+)
 create mode 100644 extras/tools/.gitignore

diff --git a/extras/tools/.gitignore b/extras/tools/.gitignore
new file mode 100644
index 000000000..c2f9380db
--- /dev/null
+++ b/extras/tools/.gitignore
@@ -0,0 +1,4 @@
+*.bin
+*.ota
+*.json
+

From ddf15410bd7f053d0940bb8032ddc8a030dce094 Mon Sep 17 00:00:00 2001
From: Alexander Entinger <cto@lxrobotics.com>
Date: Thu, 9 Jul 2020 14:35:52 +0200
Subject: [PATCH 3/7] Extend README with better instructions for how to perform
 OTA via cloud server

---
 extras/tools/README.md | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/extras/tools/README.md b/extras/tools/README.md
index 475fe41f3..795522e26 100644
--- a/extras/tools/README.md
+++ b/extras/tools/README.md
@@ -1,5 +1,18 @@
-`bin2ota.py`
-============
+Firmware Over-The-Air Tools
+===========================
+
+## How-to-OTA
+
+Arduino IDE: `Sketch` -> `Export compiled Binary`
+```bash
+cp sketch.bin ~/Arduino/libraries/ArduinoIoTCloud/extras/tools/
+cd ~/Arduino/libraries/ArduinoIoTCloud/extras/tools
+./bin2ota.py sketch.bin sketch.ota
+./bin2json.py sketch.ota sketch.json
+./ota-upload.sh CLIENT_ID CLIENT_SECRET DEVICE_ID sketch.json
+```
+
+## `bin2ota.py`
 This tool can be used to extend (actually prefix) a binary generated with e.g. the Arduino IDE with the required length and crc values required to perform an OTA (Over-The-Air) update of the firmware.
 
 ### How-To-Use
@@ -25,8 +38,7 @@ This tool can be used to extend (actually prefix) a binary generated with e.g. t
 0000030   0000 0000 7485 0000 0000 0000 0000 0000
 ```
 
-`bin2json.py`
-=============
+## `bin2json.py`
 This tool converts the binary file into base64 encoded JSON which is necessary for feeding it to the server.
 
 ### How-To-Use
@@ -34,8 +46,7 @@ This tool converts the binary file into base64 encoded JSON which is necessary f
 ./bin2json.py sketch.ota sketch.json
 ```
 
-`ota-upload.sh`
-==============
+## `ota-upload.sh`
 This tool allows to upload a OTA binary to a device via a Arduino cloud server.
 
 ### How-To-Use

From d1abdfef34450cd075c4b0c19f2fc9fb18d462e2 Mon Sep 17 00:00:00 2001
From: Alexander Entinger <cto@lxrobotics.com>
Date: Mon, 13 Jul 2020 13:47:47 +0200
Subject: [PATCH 4/7] Converting lzss.c from to linux line endings via dos2unix
 and replacing main with functions for encoding/decoding to be called from a
 python script

---
 extras/tools/lzss.c | 366 ++++++++++++++++++++++----------------------
 1 file changed, 186 insertions(+), 180 deletions(-)

diff --git a/extras/tools/lzss.c b/extras/tools/lzss.c
index 58391f535..ac28cb01f 100644
--- a/extras/tools/lzss.c
+++ b/extras/tools/lzss.c
@@ -1,180 +1,186 @@
-/* LZSS encoder-decoder (Haruhiko Okumura; public domain) */
-
-#include <stdio.h>
-#include <stdlib.h>
-
-#define EI 11  /* typically 10..13 */
-#define EJ  4  /* typically 4..5 */
-#define P   1  /* If match length <= P then output one character */
-#define N (1 << EI)  /* buffer size */
-#define F ((1 << EJ) + 1)  /* lookahead buffer size */
-
-int bit_buffer = 0, bit_mask = 128;
-unsigned long codecount = 0, textcount = 0;
-unsigned char buffer[N * 2];
-FILE *infile, *outfile;
-
-void error(void)
-{
-    printf("Output error\n");  exit(1);
-}
-
-void putbit1(void)
-{
-    bit_buffer |= bit_mask;
-    if ((bit_mask >>= 1) == 0) {
-        if (fputc(bit_buffer, outfile) == EOF) error();
-        bit_buffer = 0;  bit_mask = 128;  codecount++;
-    }
-}
-
-void putbit0(void)
-{
-    if ((bit_mask >>= 1) == 0) {
-        if (fputc(bit_buffer, outfile) == EOF) error();
-        bit_buffer = 0;  bit_mask = 128;  codecount++;
-    }
-}
-
-void flush_bit_buffer(void)
-{
-    if (bit_mask != 128) {
-        if (fputc(bit_buffer, outfile) == EOF) error();
-        codecount++;
-    }
-}
-
-void output1(int c)
-{
-    int mask;
-    
-    putbit1();
-    mask = 256;
-    while (mask >>= 1) {
-        if (c & mask) putbit1();
-        else putbit0();
-    }
-}
-
-void output2(int x, int y)
-{
-    int mask;
-    
-    putbit0();
-    mask = N;
-    while (mask >>= 1) {
-        if (x & mask) putbit1();
-        else putbit0();
-    }
-    mask = (1 << EJ);
-    while (mask >>= 1) {
-        if (y & mask) putbit1();
-        else putbit0();
-    }
-}
-
-void encode(void)
-{
-    int i, j, f1, x, y, r, s, bufferend, c;
-    
-    for (i = 0; i < N - F; i++) buffer[i] = ' ';
-    for (i = N - F; i < N * 2; i++) {
-        if ((c = fgetc(infile)) == EOF) break;
-        buffer[i] = c;  textcount++;
-    }
-    bufferend = i;  r = N - F;  s = 0;
-    while (r < bufferend) {
-        f1 = (F <= bufferend - r) ? F : bufferend - r;
-        x = 0;  y = 1;  c = buffer[r];
-        for (i = r - 1; i >= s; i--)
-            if (buffer[i] == c) {
-                for (j = 1; j < f1; j++)
-                    if (buffer[i + j] != buffer[r + j]) break;
-                if (j > y) {
-                    x = i;  y = j;
-                }
-            }
-        if (y <= P) {  y = 1;  output1(c);  }
-        else output2(x & (N - 1), y - 2);
-        r += y;  s += y;
-        if (r >= N * 2 - F) {
-            for (i = 0; i < N; i++) buffer[i] = buffer[i + N];
-            bufferend -= N;  r -= N;  s -= N;
-            while (bufferend < N * 2) {
-                if ((c = fgetc(infile)) == EOF) break;
-                buffer[bufferend++] = c;  textcount++;
-            }
-        }
-    }
-    flush_bit_buffer();
-    printf("text:  %ld bytes\n", textcount);
-    printf("code:  %ld bytes (%ld%%)\n",
-        codecount, (codecount * 100) / textcount);
-}
-
-int getbit(int n) /* get n bits */
-{
-    int i, x;
-    static int buf, mask = 0;
-    
-    x = 0;
-    for (i = 0; i < n; i++) {
-        if (mask == 0) {
-            if ((buf = fgetc(infile)) == EOF) return EOF;
-            mask = 128;
-        }
-        x <<= 1;
-        if (buf & mask) x++;
-        mask >>= 1;
-    }
-    return x;
-}
-
-void decode(void)
-{
-    int i, j, k, r, c;
-    
-    for (i = 0; i < N - F; i++) buffer[i] = ' ';
-    r = N - F;
-    while ((c = getbit(1)) != EOF) {
-        if (c) {
-            if ((c = getbit(8)) == EOF) break;
-            fputc(c, outfile);
-            buffer[r++] = c;  r &= (N - 1);
-        } else {
-            if ((i = getbit(EI)) == EOF) break;
-            if ((j = getbit(EJ)) == EOF) break;
-            for (k = 0; k <= j + 1; k++) {
-                c = buffer[(i + k) & (N - 1)];
-                fputc(c, outfile);
-                buffer[r++] = c;  r &= (N - 1);
-            }
-        }
-    }
-}
-
-int main(int argc, char *argv[])
-{
-    int enc;
-    char *s;
-    
-    if (argc != 4) {
-        printf("Usage: lzss e/d infile outfile\n\te = encode\td = decode\n");
-        return 1;
-    }
-    s = argv[1];
-    if (s[1] == 0 && (*s == 'd' || *s == 'D' || *s == 'e' || *s == 'E'))
-        enc = (*s == 'e' || *s == 'E');
-    else {
-        printf("? %s\n", s);  return 1;
-    }
-    if ((infile  = fopen(argv[2], "rb")) == NULL) {
-        printf("? %s\n", argv[2]);  return 1;
-    }
-    if ((outfile = fopen(argv[3], "wb")) == NULL) {
-        printf("? %s\n", argv[3]);  return 1;
-    }
-    if (enc) encode();  else decode();
-    fclose(infile);  fclose(outfile);
-    return 0;
-}
+/* LZSS encoder-decoder (Haruhiko Okumura; public domain) */
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#define EI 11  /* typically 10..13 */
+#define EJ  4  /* typically 4..5 */
+#define P   1  /* If match length <= P then output one character */
+#define N (1 << EI)  /* buffer size */
+#define F ((1 << EJ) + 1)  /* lookahead buffer size */
+
+int bit_buffer = 0, bit_mask = 128;
+unsigned long codecount = 0, textcount = 0;
+unsigned char buffer[N * 2];
+FILE *infile, *outfile;
+
+void error(void)
+{
+    printf("Output error\n");  exit(1);
+}
+
+void putbit1(void)
+{
+    bit_buffer |= bit_mask;
+    if ((bit_mask >>= 1) == 0) {
+        if (fputc(bit_buffer, outfile) == EOF) error();
+        bit_buffer = 0;  bit_mask = 128;  codecount++;
+    }
+}
+
+void putbit0(void)
+{
+    if ((bit_mask >>= 1) == 0) {
+        if (fputc(bit_buffer, outfile) == EOF) error();
+        bit_buffer = 0;  bit_mask = 128;  codecount++;
+    }
+}
+
+void flush_bit_buffer(void)
+{
+    if (bit_mask != 128) {
+        if (fputc(bit_buffer, outfile) == EOF) error();
+        codecount++;
+    }
+}
+
+void output1(int c)
+{
+    int mask;
+    
+    putbit1();
+    mask = 256;
+    while (mask >>= 1) {
+        if (c & mask) putbit1();
+        else putbit0();
+    }
+}
+
+void output2(int x, int y)
+{
+    int mask;
+    
+    putbit0();
+    mask = N;
+    while (mask >>= 1) {
+        if (x & mask) putbit1();
+        else putbit0();
+    }
+    mask = (1 << EJ);
+    while (mask >>= 1) {
+        if (y & mask) putbit1();
+        else putbit0();
+    }
+}
+
+void encode(void)
+{
+    int i, j, f1, x, y, r, s, bufferend, c;
+    
+    for (i = 0; i < N - F; i++) buffer[i] = ' ';
+    for (i = N - F; i < N * 2; i++) {
+        if ((c = fgetc(infile)) == EOF) break;
+        buffer[i] = c;  textcount++;
+    }
+    bufferend = i;  r = N - F;  s = 0;
+    while (r < bufferend) {
+        f1 = (F <= bufferend - r) ? F : bufferend - r;
+        x = 0;  y = 1;  c = buffer[r];
+        for (i = r - 1; i >= s; i--)
+            if (buffer[i] == c) {
+                for (j = 1; j < f1; j++)
+                    if (buffer[i + j] != buffer[r + j]) break;
+                if (j > y) {
+                    x = i;  y = j;
+                }
+            }
+        if (y <= P) {  y = 1;  output1(c);  }
+        else output2(x & (N - 1), y - 2);
+        r += y;  s += y;
+        if (r >= N * 2 - F) {
+            for (i = 0; i < N; i++) buffer[i] = buffer[i + N];
+            bufferend -= N;  r -= N;  s -= N;
+            while (bufferend < N * 2) {
+                if ((c = fgetc(infile)) == EOF) break;
+                buffer[bufferend++] = c;  textcount++;
+            }
+        }
+    }
+    flush_bit_buffer();
+    printf("text:  %ld bytes\n", textcount);
+    printf("code:  %ld bytes (%ld%%)\n",
+        codecount, (codecount * 100) / textcount);
+}
+
+int getbit(int n) /* get n bits */
+{
+    int i, x;
+    static int buf, mask = 0;
+    
+    x = 0;
+    for (i = 0; i < n; i++) {
+        if (mask == 0) {
+            if ((buf = fgetc(infile)) == EOF) return EOF;
+            mask = 128;
+        }
+        x <<= 1;
+        if (buf & mask) x++;
+        mask >>= 1;
+    }
+    return x;
+}
+
+void decode(void)
+{
+    int i, j, k, r, c;
+    
+    for (i = 0; i < N - F; i++) buffer[i] = ' ';
+    r = N - F;
+    while ((c = getbit(1)) != EOF) {
+        if (c) {
+            if ((c = getbit(8)) == EOF) break;
+            fputc(c, outfile);
+            buffer[r++] = c;  r &= (N - 1);
+        } else {
+            if ((i = getbit(EI)) == EOF) break;
+            if ((j = getbit(EJ)) == EOF) break;
+            for (k = 0; k <= j + 1; k++) {
+                c = buffer[(i + k) & (N - 1)];
+                fputc(c, outfile);
+                buffer[r++] = c;  r &= (N - 1);
+            }
+        }
+    }
+}
+
+int encode_file(char const * in, char const * out)
+{
+    infile = fopen(in, "rb");
+    if (infile == NULL) return 0;
+
+    outfile = fopen(out, "wb");
+    if (outfile == NULL) return 0;
+
+    encode();
+
+    fclose(infile);
+    fclose(outfile);
+
+    return 0;
+}
+
+int decode_file(char const * in, char const * out)
+{
+    infile = fopen(in, "rb");
+    if (infile == NULL) return 0;
+
+    outfile = fopen(out, "wb");
+    if (outfile == NULL) return 0;
+
+    decode();
+
+    fclose(infile);
+    fclose(outfile);
+
+    return 0;
+}

From b35fcf1d429f23127b7322f414042649da1973d4 Mon Sep 17 00:00:00 2001
From: Alexander Entinger <cto@lxrobotics.com>
Date: Mon, 13 Jul 2020 13:48:21 +0200
Subject: [PATCH 5/7] Adding shared object built from lzss.c via cc -fPIC
 -shared -o lzss.so lzss.c

---
 extras/tools/lzss.so | Bin 0 -> 12984 bytes
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100755 extras/tools/lzss.so

diff --git a/extras/tools/lzss.so b/extras/tools/lzss.so
new file mode 100755
index 0000000000000000000000000000000000000000..dadd5d8942e477381d7edd035244f69ecefcbeab
GIT binary patch
literal 12984
zcmeHNe{@vUoxd|lBtS^Q?<i7U)NG@rvw$Lj6bU~b3>73&(o!pqlgxyqO)_zQ(0~Sm
zqm?maO{I3z<5^43s%2Muj#iHcZ7o4sf?e8%ZP#+z)DsWr&TO(0&PJWpl-bYs-us=r
zd6V>P|Jt+XaOb@F-tXsrzu)`4Ki|9WeIGQpY;-ytf>VyTO%V6ubcIyuf@7c48IUSb
zA*SH}TCqUN=8YF+<#x_j5K|!x2~ZtZ;X1cavY>{{Fg@c`c=c>WS&v}Si)+2O)??bM
zo5D0-tLK8!by}C(=?z+rDalf*elP5!{NlNi&7xri3#P1hC-lhA|7|MPg4=a{ll4ov
z?iZ%IIkIhYU?T_DraNlHlg{7w-*SD+8+Wzc{-dJ5AN<;VPmP?SDrVv;z(r=J;5y<g
zC>ICvD@)#=b@ucxgaJsF7lIbyB6%7DYW_T2CAhA}bq%g-aeW5YB3uTp>u^!}kKbM_
zY+une=e4d&h3D?ud2Q^C{mFYmACLaz{1XoxZRx#s+p}|?{L`f~x$De-8{S>;bbBMN
zUo~|9^4GXL({6A3@tb=-oqgK_r!JP(6&?QgdkcPgcTc<drAJe5J$Fw?)sX#9z8KlC
zI1Fso1b99=ZX*2MN#y@H3I6OPILuGzk8_fGdnU0{F^Qe+z`4JXO(z<oSz?B`K$F3e
zUPFGSm@iHnhD3Ru(!84`ri!*{5>EduhM&cde@4r5!9^)wAXezktAQM)H*k@CqtrkS
zNl)ksZKr&xAz}V20zL~ftwQ_xf-dla&csYRVi*!(Kle)<_O%^e*JaZFyevO|4tcV_
zkR~!xr6S@CDB(LbUa#@zHNIhn0-_rK2aP{Niw5b4{1@V7P_omf<-e@)-)a13+J0QG
z*N-%Qh!ztPx3>#<vh$d>PwR?O7#H>DIo%K3-bXYpN)6<MU_6dI*?Eo@EYi0X5nl%-
zJN-60!sFT99BA=`!roxm;}M?5md3E~)Po4m<{eu-K7Y`^yD=2@2X|~;-xO%^@9@?(
z`BmA(C7!xAFB$MQHSY6^+QzV_*&F(Xs0;Y~b%97rScLs;VU=rasc(d_KqM@wKNt)I
zMQbD+68<*0fgIGAih5+~G`B?5H$_4X9<o~-sjv43NgV=9HC-nBEmW7N-|Z)@U}H<T
zULX$*K`x+3Nx(@|ULR=nw}|?>ra;KA%T+;BV{M%)6mZ=tJbs@y>_u1AhC-^R0JZqU
zrY)P-t@kW*Epshb-R#7Es(!Sy(vUla<FEcLkaJmCj9k+=m8`4=Mv3o>Jl-98z6|R7
zALCUT@3D<H^G6pM(jMKLv}wt|Xu+*p$1w}8G^M!cwcxb>b2@Fot@~5I1=mwls+_an
zbU)%WXu<WZR~E%BxL$e^AF<%ptt@H5^&^dxFVX!&b<(|qlVQR2(v?N!7M$*}oR(N{
z{iq|0DlGVCSQxa*g7aFZVz&k7J&*8e3vPYR+G)Y9&l&exaJpA>YOvsXYnDZ=7M$+u
zoZ2in&n+tJu;2?=81$e8FSX#^790~go!rske0OJF&0IscAL$J{Q~mDf&+|`;)bb#p
zR9P7RMT@GCBff$35`!tEvab{GAiiJnwZzj<C3+=)7x6Sii5Dfmop|cf#1YAVk$CFL
zM7QME5l>y1=#cy>;%QnWS|z`Xc<O@0y^_C)cxp<bTJqNsPg5>YCHZTJr>T}$BKcXw
z)2d7ulAlIAP2EJX<ekLR-6A0*|H&Ni^yrlsxeTCeJNWu;@G`l(R$l^8<L=5!fVx*E
z-Ldz=SEDQcFk5xyj9sb0dRNh+ho$_klhljjJoH~8y{_f|EX~|_8T#%Mmvh{)5%-Ds
z8n@$=`|Ra#2@Iaq1`EjGWcE5%?}Z%^`CE5%^$(!{&)`piyL0s_;PKUHLEMeMQ+aoS
zcaS?B<k)|mgvkv`d{?3#5~K+4cA~4}^U(6+G{*5^<YY-_-b$G7EQVvrS;&Z~Zz5X;
zEJoM`iJeWx2>m@6iT+xmkMu^q3iK^7ZfW46gx#^XV}0=js34k5Me^cj|C~xe>|asX
zM=nA*uS+r=is_LC(0A1i6g@^<thjsEN$sB(K&Q|y>;NNOxLu;!g^i>mU1*Z9a-jzm
zD;MriE^I?#+J$M7(JsuD2H1ru#93W<XC}F@nuNn^;N#oiRefW!MAcWGuJ4^O+2rF=
zjIF*z+_=@~un}t?j-P~RpE*W1jiGs+=J56A7}o8S`18Pr^5VI$dA5Bl+CC;C?{>eX
z`b4S5BJucpS{s9#q1~*sPl2ShQA;rzKyq=e#Z+=nTjj=US<+_?Ktl}8ad*!Bq!@i*
z4!C<x<vNY1Ip8?ZKJWq7^ZxUYx`@os?dX{ckaBmToqh4CFd8$H(e`92T-j+RV<%wc
z6}ED)zzOjuwYVDkM~RCSYvU;_*8MLGIl576%pC1AhpCo6bA((<yo?U(G)F&Y4!=GV
zd^9<;Xxp1HbF9z2K;?aAoaQ-dTqkQBcJ~y$n(HijwHGd-o1<|@%p4fn1A$U0fQD&-
zm1Z(>SD!gZ`a{b)YX&-z?}uQr2<}0uz}Z<d%;0$q<~l1*L<*x2MM<SO_P{CWIkNHn
z1+oPfP!KcY(dGe&3{;vU?GHuU<BkVsYhS60`r?N_!MM-I5Oq~w?ldoyrO;-%p#FdY
zzz!2t<A3Bp`|t<op`yS0C)r#zQ01_kM-Q)XcXQfZFkb+JGItO9o%@#t?>7gUM@jxb
z^ROZ#M25CuY_2AKHI%oZZatI{=MV;S6ayBk8SSh|#?Hd}JB8FUYDnLtJk->XzCv8A
z_(1!p9L}TY`bu-O=+Ihh5AjVfi;B9nM(h;!sW)(oIffRA_-p?yOZUmrVt1_HePYn*
z#z=I{p{I30Swd)D<!zBtOWd*3ugkKJKXS`0>kC%fp|tH?usuG{X(7@YMCvn>M1~qw
z`?0^=0_%lrr7wOnG-G)V>dw4R0n-LE<rwza)KFDl-n&3Lpnujs);V_o4E8<zm-b^#
z=SIyjM`s@O4>q&B*FmFZ5_2J0X%0W|c&9lwzPvHnr5m*H4$PpT!vt0fZx{=2m>1qC
zEr|rVjAbUmJC0-UL_C#D4_DE{qd?Gv>tO|37HU(Q)%}pk8pnAgMB{kCKS~oX@idf=
z(@i)2ytFwSZ68h*J^YUZ=MwxK3Df=r_;Db5eGc6%*T{&YU(R4O<MjfvJ-!Ix)8hnL
zeERo~C-CVZsW<LZ)Eq&djYWGME6tJp-&41<8I~45atU*5XiE1`Za0?T_$XrvwWINo
z5jS;0*YXFkz-ga)3AL)p@>!}%-dz?-&*%{fgNs&)As@6xptVJ7-JjNaYdUKkryQpK
zxRxt^_#-)s&*&o5_XCAIF^)VAMAnj?0Cr!03m3@OymYPir)#}0t5){)h}QZI)hL(4
z!nD@xEG<|3QRSJTi%{Q(A4>1vpQaiH<UA1Vt9;g^r^{{fz-XxBCY?rC8Ae%?&#2uS
z_J^j)ld2Ul%28NWcH=Y=tQFs^6^;ctm921f1}-1W9|8@-l~+LTL4(hLwt>b$OEA#%
zj_E1Ta?nelZqUV8mJOg!fF1<hhnvq)(CN5;o(8>__8ZUwEYy5F)y{z}N{)Tog`=(5
zv7lf|emBZ*07mDQ{?Syb7`!Mf-dI@j#iHro%<m9uuBp7~<{RYki}W|(ItG7f&2cJ0
z=5Ab%!GC!USzB2AE$8|f^dL-j+i)F3*%45|WzMHiyDIMioR79fGs^d;%c<+XfpYm?
zB&~mEy8Il<e}HoNUWUu}$YNQ466HTdd3}a`Z(6?uZFZth<@*)Z&pGcT0rH>TJN**d
z_O~<i52f{YqP+4`JX=!VrS+>FtltK_6=U;4hW-!J`aLKgo1~mnuB0nHaHR*X^uU!K
zxY7gv7d^o5hxvUl-R3CKJ7!7+ilo2$&@&As{%*wY0{Oi&zw6^?2!3}txX_S#bkC*4
z<sV*71&ANf_3^vQq|Wd=%NO-a)@dY+v{}pZyV?>3%kP>pYZ#JfHPNBv`8f%P0h#z+
zY*IVK_)(o<KdZGqznkRx@E9ijKd9yLI3{^5E=DxJPM70xPL|{3_WvsJcXPYb&*=eq
zRnt?NzOCu|ntr6|ReHeYY5F&s-m2+FO~0&Zy{3CK{g$TR)wD;Ca|ayTw0`|6qr9dT
z-;g543fFSilF#29k=)Y#ODkMUZn;sR_BPo09K5`uXKZ`Q!FLv(r`EC@%sQT*nRu??
zd7O#o37!v`_*H`EQ6@e`@O;d~^99e_Og#HLEtThpX`)+?L#F(6aYXlLCSH(^@5scn
zzZ+9|jwlrW$qUS)kb?*Tj*GCskS`WT=2{Vz&%u{S-cPKhIrwtP`$#4}8*v_n6_WWJ
zoQn86mbEa4q7?MJ$;9Ugo==(he9=3hJnsVI(ll*y#ii6ZqH?s4I<cE_ybPBYYJ9}j
z|D_t|eVOG~AmhMyTK0$PqqGs1V}kx^22S;M@J3F;NPBTPCg|rL;1l`(eJMX*4C;QM
zmnD?wWgYo*!G@Dx6WRH(lrI)Lc;f}nX(IVv6gu#o-##wCl6dyGzb%br&$ooOb5#2&
z#qjr`#IxtabTq(VAq)L1aQc33|8DQnxIIo`74V7T6xK_5i(#Fmb0&R<7o~<o`2MpC
zcrp6H9%tc`b_#?&UZ7Rt+Ngy*tmW<T4u>>uk1u#a;@Rt+&b8DJ_IQUQ61P;Sv#$W3
zC{E#L8t*p@Daq}n{dZQj8S%$S@Xff<lYOI9+2Od74<N6R3~PS|PH`*tcoQevS*o<y
zpQ*qnigTF@och5YC$doE_V||@G;WU{SuF7k7bRl?r*@q-ls~-g)@VESxRPp(+v7XF
zGKu|0;L37l-BIAzWkQnszO*yJ{iQA#4uuhK;i^NB1P6Y2!p$B8PPF(#2#)XtJiD6$
zwcaL=FB}MlJl;qfUZpj+Hu=MTpKHafD=Q`zlEEe(Z!qZHi>QilaIdHjdYk<oU!=Kt
zFH|g?j84fAZQ2(K!6k|?aV@L3d4)hs2xSno;n}!-?N-xc-m!t=T0Fi`z|-Ju@lo)~
zhOgeScI)Q#KoKM7G2L3!y<t0`9b4D4(xxrj)~(&**|u@xm&_fW9c$NZF=6U2gvIF4
z6BTBn!bs8qFcjBPRb`DC;kXwaUy>1(BI8lA#ATd|dT%MaEgd4G!dx=t$K!0qV{c?o
zOs1HOuE~V#K|vJkqGNTeK`<)tW*JA-z&SJ)0Xh^>lW8z3W=F^4P?%4qr0iXuUl<BY
z$WcaMkxfg6EeTg>Z*$mN3mOh8+Q7M%K-llv-4b!tMjD%ZpKtUD$u)RG4Z`Ky+X78R
z!$DQD#~%ze23j&056Xi6CNC-ITx(NUxMb}vWL>)hV5#GUOU6*Sf&m#j<nlM@iQM3W
z5$2Stn$b#w^Qghw+*pU|17WfZ=O_lrg%Bj+!m?_{Qkh`={<RRD=jiByWiJyy7c-^z
z%htsE6Jsu9@On7F`uzONv{wuAd5HI0)~`T@9*tO^pR<{|wIbDvEj@j%<R`N#U?jr&
z{5;N-&yf(3iELPt8w{Q4Sf8KUnbLC?CH9}?nAV_-&WOzO^F338l#%TID-_=kbQ$aO
zIe=-kc9`qu{^RzyX#I8CAfFeQc3AZB6qMC}ZNNx`&*2>Z$<+QBXCMENO`p#nOp9$D
zPG9sXG2M^6wSGRQFy;12CHyhZ^ii8WKYug5g%9-F0N2a*x@`LV-h-)4U5+E`5<RT-
zdHnc%#B_~SSj$?Wr)>Isj$&$G<M#en&*$UwpU+!NkJ<X4`;C2g85ugG@ciO)8ONR5
z<(X%C9J)moeLlYpE(D0ga*7-08UGg)(A?wt`JBgb{k__MZa3@kI6eej5@CHl4<20v
z5NW3(>3`N|`a6_Z_0#7@L#gznHC2Z7nEnZ{RiDo>J%*CE9m}%%<2=O37W>cVzGt+4
z12<He6B^bWK4>FH^)E>yD#Q9W+HjJkWTiZJRf+oVHx#Yb@3rVX-(p<cZr*=reX#FJ
fL;V}&iau*I&h@hFOk^g~|HVy8;t~sLYS;fCYcB>}

literal 0
HcmV?d00001


From cd3f1dc759c352d12db3fd78cbb2453d75eeb693 Mon Sep 17 00:00:00 2001
From: Alexander Entinger <cto@lxrobotics.com>
Date: Mon, 13 Jul 2020 13:48:56 +0200
Subject: [PATCH 6/7] Adding python script lzss.py which allows to
 encode/decode binary files via LZSS

---
 extras/tools/lzss.py | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100755 extras/tools/lzss.py

diff --git a/extras/tools/lzss.py b/extras/tools/lzss.py
new file mode 100755
index 000000000..e134ad807
--- /dev/null
+++ b/extras/tools/lzss.py
@@ -0,0 +1,28 @@
+#!/usr/bin/python3
+
+import sys
+import ctypes
+
+LZSS_SO_FILE = "./lzss.so"
+
+if len(sys.argv) != 4:
+    print ("Usage: lzss.py --[encode|decode] sketch.bin sketch.lzss")
+    sys.exit()
+
+lzss_functions = ctypes.CDLL(LZSS_SO_FILE)
+
+mode   = sys.argv[1]
+ifile  = sys.argv[2]
+ofile  = sys.argv[3]
+
+b_ifile = ifile.encode('utf-8')
+b_ofile = ofile.encode('utf-8')
+
+if mode == "--encode":
+    lzss_functions.encode_file.argtypes = [ctypes.c_char_p, ctypes.c_char_p]
+    lzss_functions.encode_file(b_ifile, b_ofile)
+elif mode == "--decode":
+    lzss_functions.decode_file.argtypes = [ctypes.c_char_p, ctypes.c_char_p]
+    lzss_functions.decode_file(b_ifile, b_ofile)
+else:
+    print ("Error, invalid mode parameter, use --encode or --decode")

From a7ee5007efbdf49992a4c51d8af1d12c57505de5 Mon Sep 17 00:00:00 2001
From: Alexander Entinger <cto@lxrobotics.com>
Date: Mon, 13 Jul 2020 13:51:39 +0200
Subject: [PATCH 7/7] Adding lzss.py to README and improvind documentation

---
 extras/tools/README.md | 13 +++++++++++++
 extras/tools/lzss.py   |  2 +-
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/extras/tools/README.md b/extras/tools/README.md
index 795522e26..ac0a5d2e5 100644
--- a/extras/tools/README.md
+++ b/extras/tools/README.md
@@ -38,6 +38,19 @@ This tool can be used to extend (actually prefix) a binary generated with e.g. t
 0000030   0000 0000 7485 0000 0000 0000 0000 0000
 ```
 
+## `lzss.py`
+This tool allows to compress a binary file using the LZSS algorithm.
+
+### How-To-Use
+* Encoding (Compressing)
+```bash
+./lzss.py --encode sketch.bin sketch.lzss
+```
+* Decoding (Extracting)
+```bash
+./lzss.py --decode sketch.lzss sketch.bin
+```
+
 ## `bin2json.py`
 This tool converts the binary file into base64 encoded JSON which is necessary for feeding it to the server.
 
diff --git a/extras/tools/lzss.py b/extras/tools/lzss.py
index e134ad807..b37aa4f96 100755
--- a/extras/tools/lzss.py
+++ b/extras/tools/lzss.py
@@ -6,7 +6,7 @@
 LZSS_SO_FILE = "./lzss.so"
 
 if len(sys.argv) != 4:
-    print ("Usage: lzss.py --[encode|decode] sketch.bin sketch.lzss")
+    print ("Usage: lzss.py --[encode|decode] infile outfile")
     sys.exit()
 
 lzss_functions = ctypes.CDLL(LZSS_SO_FILE)