Add support for native variants from kicad 10

Fixes #540

Author: qu1ck

InteractiveHtmlBom/core/config.py

@@ -81,6 +81,9 @@ class Config:
     board_variant_blacklist = []
     dnp_field = ''
 
+    # this is cli only field
+    kicad_variant = ''
+
     @staticmethod
     def _split(s):
         """Splits string by ',' and drops empty strings from resulting array"""
@@ -323,14 +326,21 @@ def safe_set_checked_strings(clb, strings):
                                  self.board_variant_blacklist)
         dlg.fields.dnpFieldBox.Value = self.dnp_field
 
+        if self.kicad_variant != '':
+            dlg.fields.variantLabel.Show()
+        dlg.fields.variantLabel.SetLabel(f'Current variant: {self.kicad_variant}')
+
         dlg.finish_init()
 
     @classmethod
     def add_options(cls, parser, version):
         # type: (argparse.ArgumentParser, str) -> None
         parser.add_argument('--show-dialog', action='store_true',
-                            help='Shows config dialog. All other flags '
-                                 'will be ignored.')
+                            help='Shows config dialog. All flags except '
+                                 '--kicad-variant will be ignored.')
+        parser.add_argument('--kicad-variant', default='',
+                            help='KiCad board variant, empty is default '
+                                 'variant. (Only for KiCad v10+)')
         parser.add_argument('--version', action='version', version=version)
         # Html
         parser.add_argument('--dark-mode', help='Default to dark mode.',
@@ -443,6 +453,8 @@ def set_from_args(self, args):
         # type: (argparse.Namespace) -> None
         import math
 
+        self.kicad_variant = args.kicad_variant
+
         # Html
         self.dark_mode = args.dark_mode
         self.show_pads = not args.hide_pads

InteractiveHtmlBom/dialog/dialog_base.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###########################################################################
-## Python code generated with wxFormBuilder (version 3.10.1-0-g8feb16b3)
+## Python code generated with wxFormBuilder (version 4.2.1-0-g80c4cb6)
 ## http://www.wxformbuilder.org/
 ##
 ## PLEASE DO *NOT* EDIT THIS FILE!
@@ -413,6 +413,13 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
         self.extraDataFilePicker = wx.FilePickerCtrl( sbSizer7.GetStaticBox(), wx.ID_ANY, wx.EmptyString, u"Select a file", u"Netlist and xml files (*.net; *.xml)|*.net;*.xml", wx.DefaultPosition, wx.DefaultSize, wx.FLP_DEFAULT_STYLE|wx.FLP_FILE_MUST_EXIST|wx.FLP_OPEN|wx.FLP_SMALL|wx.FLP_USE_TEXTCTRL|wx.BORDER_SIMPLE )
         sbSizer7.Add( self.extraDataFilePicker, 0, wx.EXPAND|wx.BOTTOM|wx.RIGHT|wx.LEFT, 5 )
 
+        self.variantLabel = wx.StaticText( sbSizer7.GetStaticBox(), wx.ID_ANY, u"Current variant:", wx.DefaultPosition, wx.DefaultSize, 0 )
+        self.variantLabel.Wrap( -1 )
+
+        self.variantLabel.Hide()
+
+        sbSizer7.Add( self.variantLabel, 0, wx.ALL, 5 )
+
 
         bSizer42.Add( sbSizer7, 0, wx.ALL|wx.EXPAND, 5 )
 

InteractiveHtmlBom/dialog/settings_dialog.py

@@ -334,8 +334,11 @@ def OnExtraDataFileChanged(self, event):
             self.extra_field_data = self.extra_data_func(
                 extra_data_file, self.normalizeCaseCheckbox.Value)
         except Exception as e:
+            import traceback
             pop_error(
-                "Failed to parse file %s\n\n%s" % (extra_data_file, e))
+                "Failed to parse file %s\n\n%s" % (
+                    extra_data_file,
+                    str(e) + '\n' + traceback.format_exc()))
             self.extraDataFilePicker.Path = ''
 
         if self.extra_field_data is not None:

InteractiveHtmlBom/ecad/kicad.py

@@ -30,6 +30,10 @@ def __init__(self, file_name, config, logger, board=None):
         self.board = board
         if self.board is None:
             self.board = pcbnew.LoadBoard(self.file_name)  # type: pcbnew.BOARD
+            if not self.board:
+                raise Exception('Failed to load board file')
+            if hasattr(self.board, "SetCurrentVariant"):
+                self.board.SetCurrentVariant(config.kicad_variant)
         if hasattr(self.board, 'GetModules'):
             # type: list[pcbnew.MODULE]
             self.footprints = list(self.board.GetModules())
@@ -48,8 +52,7 @@ def get_extra_field_data(self, file_name):
 
         return ExtraFieldData(data[0], data[1])
 
-    @staticmethod
-    def get_footprint_fields(f):
+    def get_footprint_fields(self, f):
         # type: (pcbnew.FOOTPRINT) -> dict
         props = {}
         if hasattr(f, "GetProperties"):
@@ -62,6 +65,15 @@ def get_footprint_fields(f):
         if hasattr(f, "IsDNP"):
             if f.IsDNP():
                 props["kicad_dnp"] = "DNP"
+        if hasattr(f, 'GetVariant'):
+            variant = f.GetVariant(self.config.kicad_variant)
+            if variant:
+                var_fields = variant.GetFields()
+                for k in var_fields.keys():
+                    props[str(k)] = str(f.GetFieldShownText(str(k)))
+                if variant.GetDNP():
+                    props["kicad_dnp"] = "DNP"
+
         return props
 
     def parse_extra_data_from_pcb(self):
@@ -742,8 +754,7 @@ def parse_netlist(net_info):
         nets = sorted([str(s) for s in nets])
         return nets
 
-    @staticmethod
-    def footprint_to_component(footprint, extra_fields):
+    def footprint_to_component(self, footprint, extra_fields):
         try:
             footprint_name = str(footprint.GetFPID().GetFootprintName())
         except AttributeError:
@@ -753,6 +764,10 @@ def footprint_to_component(footprint, extra_fields):
         if hasattr(pcbnew, 'FP_EXCLUDE_FROM_BOM'):
             if footprint.GetAttributes() & pcbnew.FP_EXCLUDE_FROM_BOM:
                 attr = 'Virtual'
+            if hasattr(footprint, 'GetExcludedFromBOMForVariant'):
+                if footprint.GetExcludedFromBOMForVariant(
+                        self.config.kicad_variant):
+                    attr = 'Virtual'
         elif hasattr(pcbnew, 'MOD_VIRTUAL'):
             if footprint.GetAttributes() == pcbnew.MOD_VIRTUAL:
                 attr = 'Virtual'
@@ -912,14 +927,17 @@ def Run(self):
         from ..errors import ParsingException
 
         logger = ibom.Logger()
-        board = pcbnew.GetBoard()
+        board = pcbnew.GetBoard()  # type: pcbnew.BOARD
         pcb_file_name = board.GetFileName()
 
         if not pcb_file_name:
             logger.error('Please save the board file before generating BOM.')
             return
 
         config = Config(version, os.path.dirname(pcb_file_name))
+        if hasattr(board, 'GetCurrentVariant'):
+            config.kicad_variant = board.GetCurrentVariant()
+
         parser = PcbnewParser(pcb_file_name, config, logger, board)
 
         try:

InteractiveHtmlBom/generate_interactive_bom.py

@@ -66,6 +66,7 @@ def main():
     print("Loading %s" % args.file)
 
     config = Config(version, os.path.dirname(os.path.abspath(args.file)))
+    config.kicad_variant = args.kicad_variant
 
     parser = get_parser_by_extension(
         os.path.abspath(args.file), config, logger)