update plugins

3rdparty/plugins/com_github_bennymeg_JLC-Plugin-for-KiCad/utils.py

@@ -0,0 +1,101 @@
+import pcbnew  # type: ignore
+import os
+import json
+from .config import optionsFileName
+import wx
+
+def get_version():
+    return float('.'.join(pcbnew.GetBuildVersion().split(".")[0:2]))  # e.g GetBuildVersion(): e.g. '7.99.0-3969-gc5ac2337e4'
+
+def is_v9(version = get_version()):
+    return version >= 8.99 and version < 9.99
+
+def is_v8(version = get_version()):
+    return version >= 7.99 and version < 8.99
+
+def is_v7(version = get_version()):
+    return version >= 6.99 and version < 7.99
+
+def is_v6(version = get_version()):
+    return version >= 5.99 and version < 6.99
+                 
+def footprint_has_field(footprint, field_name):
+    version = get_version()
+    
+    if is_v8(version) or is_v9(version):
+        return footprint.HasFieldByName(field_name)
+    else:
+        return footprint.HasProperty(field_name)
+
+def footprint_get_field(footprint, field_name):
+    version = get_version()
+    
+    if is_v8(version) or is_v9(version):
+        return footprint.GetFieldByName(field_name).GetText()
+    else:
+        return footprint.GetProperty(field_name)
+
+def get_user_options_file_path():
+    boardFilePath = pcbnew.GetBoard().GetFileName()
+    return os.path.join(os.path.dirname(boardFilePath), optionsFileName)
+
+def load_user_options(default_options):
+    try:
+        with open(get_user_options_file_path(), 'r') as f:
+            user_options = json.load(f)
+    except:
+        user_options = default_options
+
+    # merge the user options with the default options
+    options = default_options.copy()
+    options.update(user_options)
+    return options
+
+def save_user_options(options):
+    try:
+        with open(get_user_options_file_path(), 'w') as f:
+            json.dump(options, f)
+    except:
+        wx.MessageBox("Error saving user options", "Error", wx.OK | wx.ICON_ERROR)
+
+def get_plot_plan(board, active_only=True):
+    """Returns `(KiCad standard name, layer id, custom user name)` of all (active) layers of the given board."""
+    layers = []
+    i = pcbnew.PCBNEW_LAYER_ID_START - 1
+    while i < pcbnew.PCBNEW_LAYER_ID_START + pcbnew.PCB_LAYER_ID_COUNT - 1:
+        i += 1
+        if active_only and not board.IsLayerEnabled(i):
+            continue
+
+        layer_std_name = pcbnew.BOARD.GetStandardLayerName(i)
+        layer_name = pcbnew.BOARD.GetLayerName(board, i)
+
+        layers.append((layer_std_name, i, layer_name))
+    return layers
+
+def get_layer_names(board, active_only=True):
+    """Returns a list of (active) layer names of the current board"""
+    plotPlan = get_plot_plan(board, active_only)
+    return [layer_info[0] for layer_info in plotPlan]
+
+def print_cli_progress_bar(percent, prefix = '', suffix = '', decimals = 1, length = 100, fill = '█', printEnd = "\r"):
+    """
+    Call in a loop to create terminal progress bar string
+    @params:
+        percent     - Required  : current percentage (Int)
+        prefix      - Optional  : prefix string (Str)
+        suffix      - Optional  : suffix string (Str)
+        decimals    - Optional  : positive number of decimals in percent complete (Int)
+        length      - Optional  : character length of bar (Int)
+        fill        - Optional  : bar fill character (Str)
+        printEnd    - Optional  : end character (e.g. "\r", "\r\n") (Str)
+    """
+    if percent == -1:
+        percent = 0
+    filledLength = int(length * (percent / 100 ))
+    bar = fill * filledLength + '-' * (length - filledLength)
+    percent2dec = "%.2f" % percent
+    print(f'\r{prefix} |{bar}| {percent2dec}% {suffix}', end = printEnd)
+    # Print New Line on Complete
+    if percent == 100: 
+        print()