Add options to include tracks and netlist data

Issue #113

Author: qu1ck

InteractiveHtmlBom/core/config.py

@@ -63,6 +63,8 @@ class Config:
     component_blacklist = []
     blacklist_virtual = True
     blacklist_empty_val = False
+    include_tracks = False
+    include_nets = False
 
     # Extra fields section
     netlist_file = None
@@ -113,6 +115,8 @@ def __init__(self):
                 'blacklist_virtual', self.blacklist_virtual)
         self.blacklist_empty_val = f.ReadBool(
                 'blacklist_empty_val', self.blacklist_empty_val)
+        self.include_tracks = f.ReadBool('include_tracks', self.include_tracks)
+        self.include_nets = f.ReadBool('include_nets', self.include_nets)
 
         f.SetPath('/extra_fields')
         self.extra_fields = self._split(f.Read(
@@ -159,6 +163,8 @@ def save(self):
                 ','.join(self.component_blacklist))
         f.WriteBool('blacklist_virtual', self.blacklist_virtual)
         f.WriteBool('blacklist_empty_val', self.blacklist_empty_val)
+        f.WriteBool('include_tracks', self.include_tracks)
+        f.WriteBool('include_nets', self.include_nets)
 
         f.SetPath('/extra_fields')
         f.Write('extra_fields', ','.join(self.extra_fields))
@@ -196,6 +202,8 @@ def set_from_dialog(self, dlg):
             dlg.general.blacklistVirtualCheckbox.IsChecked()
         self.blacklist_empty_val = \
             dlg.general.blacklistEmptyValCheckbox.IsChecked()
+        self.include_tracks = dlg.general.includeTracksCheckbox.IsChecked()
+        self.include_nets = dlg.general.includeNetsCheckbox.IsChecked()
 
         # Extra fields
         self.netlist_file = dlg.extra.netlistFilePicker.Path
@@ -241,6 +249,8 @@ def transfer_to_dialog(self, dlg):
         dlg.general.blacklistBox.SetItems(self.component_blacklist)
         dlg.general.blacklistVirtualCheckbox.Value = self.blacklist_virtual
         dlg.general.blacklistEmptyValCheckbox.Value = self.blacklist_empty_val
+        dlg.general.includeTracksCheckbox.Value = self.include_tracks
+        dlg.general.includeNetsCheckbox.Value = self.include_nets
 
         # Extra fields
         dlg.extra.netlistFilePicker.SetInitialDirectory(
@@ -308,6 +318,11 @@ def add_options(self, parser, file_name_format_hint):
                                  'relative to pcb file directory.')
         parser.add_argument('--name-format', default=self.bom_name_format,
                             help=file_name_format_hint.replace('%', '%%'))
+        parser.add_argument('--include-tracks', action='store_true',
+                            help='Include track/zone information in output. '
+                                 'F.Cu and B.Cu layers only.')
+        parser.add_argument('--include-nets', action='store_true',
+                            help='Include netlist information in output.')
         parser.add_argument('--sort-order',
                             help='Default sort order for components. '
                                  'Must contain "~" once.',
@@ -370,6 +385,8 @@ def set_from_args(self, args):
         self.component_blacklist = self._split(args.blacklist)
         self.blacklist_virtual = not args.no_blacklist_virtual
         self.blacklist_empty_val = args.blacklist_empty_val
+        self.include_tracks = args.include_tracks
+        self.include_nets = args.include_nets
 
         # Extra
         self.netlist_file = args.netlist_file

InteractiveHtmlBom/dialog/dialog_base.py

@@ -234,6 +234,17 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
 
         bSizer32.Add( sbSizer6, 0, wx.ALL|wx.EXPAND, 5 )
 
+        sbSizer9 = wx.StaticBoxSizer( wx.StaticBox( self, wx.ID_ANY, u"Additional pcb data" ), wx.HORIZONTAL )
+        
+        self.includeTracksCheckbox = wx.CheckBox( sbSizer9.GetStaticBox(), wx.ID_ANY, u"Include tracks/zones", wx.DefaultPosition, wx.DefaultSize, 0 )
+        sbSizer9.Add( self.includeTracksCheckbox, 1, wx.ALL, 5 )
+        
+        self.includeNetsCheckbox = wx.CheckBox( sbSizer9.GetStaticBox(), wx.ID_ANY, u"Include nets", wx.DefaultPosition, wx.DefaultSize, 0 )
+        sbSizer9.Add( self.includeNetsCheckbox, 1, wx.ALL, 5 )
+        
+        
+        bSizer32.Add( sbSizer9, 0, wx.ALL|wx.EXPAND, 5 )
+        
         sortingSizer = wx.StaticBoxSizer( wx.StaticBox( self, wx.ID_ANY, u"Component sort order" ), wx.VERTICAL )
 
         bSizer4 = wx.BoxSizer( wx.HORIZONTAL )

InteractiveHtmlBom/ecad/__init__.py

@@ -1,21 +1,21 @@
 import os
 
 
-def get_parser_by_extension(file_name, logger):
+def get_parser_by_extension(file_name, config, logger):
     ext = os.path.splitext(file_name)[1]
     if ext == '.kicad_pcb':
-        return get_kicad_parser(file_name, logger)
+        return get_kicad_parser(file_name, config, logger)
     elif ext == '.json':
-        return get_easyeda_parser(file_name, logger)
+        return get_easyeda_parser(file_name, config, logger)
     else:
         return None
 
 
-def get_kicad_parser(file_name, logger, board=None):
+def get_kicad_parser(file_name, config, logger, board=None):
     from .kicad import PcbnewParser
-    return PcbnewParser(file_name, logger, board)
+    return PcbnewParser(file_name, config, logger, board)
 
 
-def get_easyeda_parser(file_name, logger):
+def get_easyeda_parser(file_name, config, logger):
     from .easyeda import EasyEdaParser
-    return EasyEdaParser(file_name, logger)
+    return EasyEdaParser(file_name, config, logger)

InteractiveHtmlBom/ecad/common.py

@@ -5,12 +5,14 @@
 
 class EcadParser(object):
 
-    def __init__(self, file_name, logger):
+    def __init__(self, file_name, config, logger):
         """
         :param file_name: path to file that should be parsed.
+        :param config: Config instance
         :param logger: logging object.
         """
         self.file_name = file_name
+        self.config = config
         self.logger = logger
         self.extra_data_func = lambda f, b: ([], {})
 

InteractiveHtmlBom/ecad/kicad.py

@@ -12,8 +12,8 @@
 
 class PcbnewParser(EcadParser):
 
-    def __init__(self, file_name, logger, board=None):
-        super(PcbnewParser, self).__init__(file_name, logger)
+    def __init__(self, file_name, config, logger, board=None):
+        super(PcbnewParser, self).__init__(file_name, config, logger)
         self.board = board
         if self.board is None:
             self.board = pcbnew.LoadBoard(self.file_name)  # type: pcbnew.BOARD
@@ -273,6 +273,8 @@ def parse_pad(self, pad):
             pad_dict["type"] = "smd"
         if hasattr(pad, "GetOffset"):
             pad_dict["offset"] = self.normalize(pad.GetOffset())
+        if self.config.include_nets:
+            pad_dict["net"] = pad.GetNetname()
 
         return pad_dict
 
@@ -354,12 +356,14 @@ def parse_tracks(self, tracks):
                         result[l].append(track_dict)
             else:
                 if track.GetLayer() in [pcbnew.F_Cu, pcbnew.B_Cu]:
-                    result[track.GetLayer()].append({
+                    track_dict = {
                         "start": self.normalize(track.GetStart()),
                         "end": self.normalize(track.GetEnd()),
                         "width": track.GetWidth() * 1e-6,
-                        "net": track.GetNetname(),
-                    })
+                    }
+                    if self.config.include_nets:
+                        track_dict["net"] = track.GetNetname()
+                    result[track.GetLayer()].append(track_dict)
 
         return {
             'F': result.get(pcbnew.F_Cu),
@@ -368,20 +372,30 @@ def parse_tracks(self, tracks):
 
     def parse_zones(self, zones):
         result = {pcbnew.F_Cu: [], pcbnew.B_Cu: []}
-        for zone in zones:
+        for zone in zones: # type: (pcbnew.ZONE_CONTAINER)
             if not zone.IsFilled() or zone.GetIsKeepout():
                 continue
             if zone.GetLayer() in [pcbnew.F_Cu, pcbnew.B_Cu]:
-                result[zone.GetLayer()].append({
+                zone_dict = {
                     "polygons": self.parse_poly_set(zone.GetFilledPolysList()),
-                    "net": zone.GetNetname(),
-                })
+                }
+                if self.config.include_nets:
+                    zone_dict["net"] = zone.GetNetname()
+                result[zone.GetLayer()].append(zone_dict)
 
         return {
             'F': result.get(pcbnew.F_Cu),
             'B': result.get(pcbnew.B_Cu)
         }
 
+    @staticmethod
+    def parse_netlist(net_info):
+        # type: (pcbnew.NETINFO_LIST) -> list
+        nets = net_info.NetsByName().asdict().keys()
+        nets = [str(s) for s in nets]
+        nets.sort()
+        return nets
+
     @staticmethod
     def module_to_component(module):
         # type: (pcbnew.MODULE) -> Component
@@ -452,8 +466,11 @@ def parse(self):
             "bom": {},
             "font_data": self.font_parser.get_parsed_font()
         }
-        pcbdata["tracks"] = self.parse_tracks(self.board.GetTracks())
-        pcbdata["zones"] = self.parse_zones(self.board.Zones())
+        if self.config.include_tracks:
+            pcbdata["tracks"] = self.parse_tracks(self.board.GetTracks())
+            pcbdata["zones"] = self.parse_zones(self.board.Zones())
+        if self.config.include_nets:
+            pcbdata["nets"] = self.parse_netlist(self.board.GetNetInfo())
         components = [self.module_to_component(m) for m in pcb_modules]
 
         return pcbdata, components
@@ -485,5 +502,5 @@ def Run(self):
             logger.error('Please save the board file before generating BOM.')
             return
 
-        parser = PcbnewParser(pcb_file_name, logger, board)
+        parser = PcbnewParser(pcb_file_name, config, logger, board)
         ibom.run_with_dialog(parser, config, logger)

InteractiveHtmlBom/generate_interactive_bom.py

@@ -44,7 +44,7 @@ def to_utf(s):
         exit(1)
     print("Loading %s" % args.file)
     logger = ibom.Logger(cli=True)
-    parser = get_parser_by_extension(os.path.abspath(args.file), logger)
+    parser = get_parser_by_extension(os.path.abspath(args.file), config, logger)
     if args.show_dialog:
         ibom.run_with_dialog(parser, config, logger)
     else:

InteractiveHtmlBom/web/ibom.html

@@ -71,14 +71,16 @@
             <input id="valuesCheckbox" type="checkbox" checked onchange="valuesVisible(this.checked)">
             Values
           </label>
-          <label class="menu-label" style="width: calc(50% - 18px)">
-            <input id="tracksCheckbox" type="checkbox" checked onchange="tracksVisible(this.checked)">
-            Tracks
-          </label><!-- This comment eats space! All of it!
-          --><label class="menu-label" style="width: calc(50% - 17px); border-left: 0;">
-            <input id="zonesCheckbox" type="checkbox" checked onchange="zonesVisible(this.checked)">
-            Zones
-          </label>
+          <div id="tracksAndZonesCheckboxes">
+            <label class="menu-label" style="width: calc(50% - 18px)">
+              <input id="tracksCheckbox" type="checkbox" checked onchange="tracksVisible(this.checked)">
+              Tracks
+            </label><!-- This comment eats space! All of it!
+            --><label class="menu-label" style="width: calc(50% - 17px); border-left: 0;">
+              <input id="zonesCheckbox" type="checkbox" checked onchange="zonesVisible(this.checked)">
+              Zones
+            </label>
+          </div>
           <label class="menu-label">
             <input id="dnpOutlineCheckbox" type="checkbox" checked onchange="dnpOutline(this.checked)">
             DNP components outlined

InteractiveHtmlBom/web/ibom.js

@@ -865,13 +865,19 @@ function initDefaults() {
   document.getElementById("valuesCheckbox").checked = b;
   valuesVisible(b);
 
-  b = getStorageBooleanOrDefault("tracksVisible", true);
-  document.getElementById("tracksCheckbox").checked = b;
-  tracksVisible(b);
-
-  b = getStorageBooleanOrDefault("zonesVisible", true);
-  document.getElementById("zonesCheckbox").checked = b;
-  zonesVisible(b);
+  if ("tracks" in pcbdata) {
+    b = getStorageBooleanOrDefault("tracksVisible", true);
+    document.getElementById("tracksCheckbox").checked = b;
+    tracksVisible(b);
+  
+    b = getStorageBooleanOrDefault("zonesVisible", true);
+    document.getElementById("zonesCheckbox").checked = b;
+    zonesVisible(b);
+  } else {
+    document.getElementById("tracksAndZonesCheckboxes").style.display = "none";
+    tracksVisible(false);
+    zonesVisible(false);
+  }
 
   b = getStorageBooleanOrDefault("dnpOutline", false);
   document.getElementById("dnpOutlineCheckbox").checked = b;