From 5a926ba21f47182057a38e3a62d44cec22e9d373 Mon Sep 17 00:00:00 2001
From: Robin Krens <robin@robinkrens.nl>
Date: Sat, 10 Feb 2024 13:43:38 +0100
Subject: [PATCH] setup.py: directory setup with pytest

---
 flasher.py          | 86 -----------------------------------------------------
 flasher/flasher.py  | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.py            | 24 +++++++++++++++
 tests/test_parse.py |  8 +++++
 4 files changed, 118 insertions(+), 86 deletions(-)
 delete mode 100644 flasher.py
 create mode 100644 flasher/flasher.py
 create mode 100644 setup.py
 create mode 100644 tests/test_parse.py

diff --git a/flasher.py b/flasher.py
deleted file mode 100644
index c388815..0000000
--- a/flasher.py
+++ /dev/null
@@ -1,86 +0,0 @@
-import struct
-
-INQ_CMD = 0x00
-ERA_CMD = 0x12
-WRI_CMD = 0x13
-REA_CMD = 0x15
-IDA_CMD = 0x30
-BAU_CMD = 0x34
-SIG_CMD = 0x3A
-ARE_CMD = 0x3B
-
-OK_READ_RES = 0x15
-OK_WRITE_RES = 0x13
-
-LOW_PULSE = 0x00
-GENERIC_CODE = 0x55
-BOOT_CODE = 0xC3
-
-TESTID = [
-    "0xF0", "0xF1", "0xF2", "0xF3",
-    "0xE4", "0xE5", "0xE6", "0xE7",
-    "0xD8", "0xD9", "0xDA", "0xDB",
-    "0xCC", "0xCD", "0xCE", "0xCF"
-]
-
-def calc_sum(cmd, data):
-    data_len = len(data)
-    lnh = data_len + 1 & 0xFF00
-    lnl = data_len + 1 & 0x00FF
-    res = lnh + lnl + cmd
-    for i in range(data_len):
-            if isinstance(data[i], str):
-                res += int(data[i], 16)
-            else:
-                res += ord(data[i])
-    res = ~(res - 1) & 0xFF # two's complement
-    return (lnh, lnl, res)
-
-
-# format of data packet is [SOD|LNH|LNL|COM|byte_data|SUM|ETX]
-def format_command(cmd, data):
-    SOD = 0x01
-    COM = cmd
-
-    if isinstance(data, str):
-        byte_data = bytes(data.encode('utf-8'))
-    else:
-        byte_data = bytes([int(x, 16) for x in data])
-    
-    LNH, LNL, SUM = calc_sum(int(cmd), data)
-    ETX = 0x03
-    fmt_header = '<BBBB'
-    fmt_footer = 'BB'
-    fmt = fmt_header + str(len(data)) + 's' + fmt_footer
-    pack = struct.pack(fmt, SOD, LNH, LNL, COM, byte_data, SUM, ETX)
-    print(fmt, pack, len(pack))
-    return fmt
-
-# format of data packet is [SOD|LNH|LNL|RES|DAT|SUM|ETX]
-def format_data(res, data):
-    SOD = 0x81
-    if (len(data) >= 1024):
-        raise Exception(f'Data packet too large, data length is {DATA_LEN} (>1024)')
-    LNH, LNL, SUM = calc_sum(int(res), data)
-    DAT = bytes([int(x, 16) for x in data])
-    RES = res
-    ETX = 0x03
-    fmt_header = '<BBBB'
-    fmt_footer = 'BB'
-    fmt = fmt_header + str(len(data)) + 's' + fmt_footer
-    pack = struct.pack(fmt, SOD, LNH, LNL, RES, DAT, SUM, ETX)
-    print(fmt, pack, len(pack))
-
-cmd = format_command(INQ_CMD, "")
-
-cmd = format_command(BAU_CMD, ['0x00','0x1E'])
-
-cmd = format_command(IDA_CMD, TESTID)
-
-format_data(0x13, ['0x00','0x01','0x02'])
-format_data(0x34, ['0x00'])
-format_data(0x00, ['0x00'])
-format_data(0x12, ['0x00'])
-
-
-
diff --git a/flasher/flasher.py b/flasher/flasher.py
new file mode 100644
index 0000000..c388815
--- /dev/null
+++ b/flasher/flasher.py
@@ -0,0 +1,86 @@
+import struct
+
+INQ_CMD = 0x00
+ERA_CMD = 0x12
+WRI_CMD = 0x13
+REA_CMD = 0x15
+IDA_CMD = 0x30
+BAU_CMD = 0x34
+SIG_CMD = 0x3A
+ARE_CMD = 0x3B
+
+OK_READ_RES = 0x15
+OK_WRITE_RES = 0x13
+
+LOW_PULSE = 0x00
+GENERIC_CODE = 0x55
+BOOT_CODE = 0xC3
+
+TESTID = [
+    "0xF0", "0xF1", "0xF2", "0xF3",
+    "0xE4", "0xE5", "0xE6", "0xE7",
+    "0xD8", "0xD9", "0xDA", "0xDB",
+    "0xCC", "0xCD", "0xCE", "0xCF"
+]
+
+def calc_sum(cmd, data):
+    data_len = len(data)
+    lnh = data_len + 1 & 0xFF00
+    lnl = data_len + 1 & 0x00FF
+    res = lnh + lnl + cmd
+    for i in range(data_len):
+            if isinstance(data[i], str):
+                res += int(data[i], 16)
+            else:
+                res += ord(data[i])
+    res = ~(res - 1) & 0xFF # two's complement
+    return (lnh, lnl, res)
+
+
+# format of data packet is [SOD|LNH|LNL|COM|byte_data|SUM|ETX]
+def format_command(cmd, data):
+    SOD = 0x01
+    COM = cmd
+
+    if isinstance(data, str):
+        byte_data = bytes(data.encode('utf-8'))
+    else:
+        byte_data = bytes([int(x, 16) for x in data])
+    
+    LNH, LNL, SUM = calc_sum(int(cmd), data)
+    ETX = 0x03
+    fmt_header = '<BBBB'
+    fmt_footer = 'BB'
+    fmt = fmt_header + str(len(data)) + 's' + fmt_footer
+    pack = struct.pack(fmt, SOD, LNH, LNL, COM, byte_data, SUM, ETX)
+    print(fmt, pack, len(pack))
+    return fmt
+
+# format of data packet is [SOD|LNH|LNL|RES|DAT|SUM|ETX]
+def format_data(res, data):
+    SOD = 0x81
+    if (len(data) >= 1024):
+        raise Exception(f'Data packet too large, data length is {DATA_LEN} (>1024)')
+    LNH, LNL, SUM = calc_sum(int(res), data)
+    DAT = bytes([int(x, 16) for x in data])
+    RES = res
+    ETX = 0x03
+    fmt_header = '<BBBB'
+    fmt_footer = 'BB'
+    fmt = fmt_header + str(len(data)) + 's' + fmt_footer
+    pack = struct.pack(fmt, SOD, LNH, LNL, RES, DAT, SUM, ETX)
+    print(fmt, pack, len(pack))
+
+cmd = format_command(INQ_CMD, "")
+
+cmd = format_command(BAU_CMD, ['0x00','0x1E'])
+
+cmd = format_command(IDA_CMD, TESTID)
+
+format_data(0x13, ['0x00','0x01','0x02'])
+format_data(0x34, ['0x00'])
+format_data(0x00, ['0x00'])
+format_data(0x12, ['0x00'])
+
+
+
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..2b2880f
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+import os
+from setuptools import setup
+
+# Utility function to read the README file.
+# Used for the long_description.  It's nice, because now 1) we have a top level
+# README file and 2) it's easier to type in the README file than to put a raw
+# string in below ...
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+setup(
+    name = "flasher",
+    version = "0.0.1",
+    author = "Robin Krens",
+    description = ("An example of how to set up pytest"),
+    license = "GNU",
+    keywords = "example pytest",
+    packages=['flasher', 'tests'],
+    #long_description=read('README.md'),
+    classifiers=[
+        "Development Status :: 1",
+    ],
+)
diff --git a/tests/test_parse.py b/tests/test_parse.py
new file mode 100644
index 0000000..d83e629
--- /dev/null
+++ b/tests/test_parse.py
@@ -0,0 +1,8 @@
+from flasher.flasher import calc_sum
+import pytest
+
+def test_calc_sum():
+    assert calc_sum(0x12, ['0x00']) == (0, 0x2, 0xEC)
+    assert calc_sum(0x34, ['0x00']) == (0, 0x2, 0xCA)
+    assert calc_sum(0x00, ['0x00']) == (0, 0x02, 0xFE)
+
-- 
2.7.4