Improve HPM API with kwargs

Author: patrislav1

bin2hpm/cli.py

@@ -108,18 +108,21 @@ def main():
     print(f'FW version {v_maj}.{v_min:02d} / 0x{args.auxillary:08x}\n')
 
     # Build HPM upgrade image header
-    result = hpm.upg_image_hdr({
-        'device_id': args.device,
-        'manufacturer_id': args.manufacturer,
-        'product_id': args.product,
-        'components': components,
-        'version_major': v_maj,
-        'version_minor': v_min,
-        'version_aux': v_aux
-    })
+    result = hpm.upg_image_hdr(
+        device_id=args.device,
+        manufacturer_id=args.manufacturer,
+        product_id=args.product,
+        components=components,
+        version_major=v_maj,
+        version_minor=v_min,
+        version_aux=v_aux,
+    )
 
     # Append HPM upgrade action (HPM prepare action)
-    result += hpm.upg_action_hdr(components, hpm.UpgradeActionType.Prepare)
+    result += hpm.upg_action_hdr(
+        action_type=hpm.UpgradeActionType.Prepare,
+        components=components
+    )
 
     # Read input file
     with open(args.infile, 'rb') as f:
@@ -144,12 +147,12 @@ def main():
 
     # Append HPM upgrade action image
     result += hpm.upg_action_img(
-        components,
-        v_maj,
-        v_min,
-        v_aux,
-        args.description or os.path.basename(args.infile)[:20],
-        img_data
+        img_data,
+        components=components,
+        version_major=v_maj,
+        version_minor=v_min,
+        version_aux=v_aux,
+        desc_str=args.description or os.path.basename(args.infile)[:20]
     )
 
     # Append MD5 hash

bin2hpm/hpm.py

@@ -71,6 +71,8 @@ def encode_generic(table, values):
             else:
                 if name == 'version_minor':
                     val = to_bcd(val)
+                elif isinstance(val, Enum):
+                    val = val.value
                 result += int.to_bytes(val, length=size, byteorder='little')
 
         except OverflowError:
@@ -81,27 +83,25 @@ def encode_generic(table, values):
             sys.exit(-1)
     return result
 
-def upg_image_hdr(values):
-    result = encode_generic(UPG_IMG_HEADER, values)
+def upg_image_hdr(**kwargs):
+    result = encode_generic(UPG_IMG_HEADER, kwargs)
     result += zero_cksum(result)
     return result
 
-def upg_action_hdr(components, action_type):
-    result = encode_generic(UPG_ACTION_HEADER, {
-        'action_type': action_type.value,
-        'components': components
-    })
+def upg_action_hdr(**kwargs):
+    result = encode_generic(UPG_ACTION_HEADER, kwargs)
     result += zero_cksum(result)
     return result
 
-def upg_action_img(components, v_maj, v_min, v_aux, description, img_data):
-    result = upg_action_hdr(components, UpgradeActionType.Upload)
+def upg_action_img(img_data,**kwargs):
+
+    result = upg_action_hdr(**{
+        'action_type': UpgradeActionType.Upload,
+        **kwargs
+    })
     result += encode_generic(UPG_ACTION_IMG_INFO, {
-        'version_major': v_maj,
-        'version_minor': v_min,
-        'version_aux': v_aux,
-        'desc_str': description,
-        'img_length': len(img_data)
+        'img_length': len(img_data),
+        **kwargs
     })
     result += img_data
     return result