Documented computed component flags.

fitted, in_bom (new) and fixed

kibot/kicad/v5_sch.py

@@ -591,6 +591,19 @@ class SchematicAltRef():
 
 
 class SchematicComponent(object):
+    """ Class for a component in the schematic.
+        Here are special members currently computed elsehere:
+        - fitted: equivalent to 'Exclude from board' but inverted
+                  - Solded: only if True
+                  - BoM normal: only if True
+                  - BoM DNF: only if False
+        - in_bom: equivalent to 'Exclude from BoM' but inverted
+                  - Solded: doesn't affected
+                  - BoM normal: only if True
+                  - BoM DNF: only if True (and fitted is False)
+        - fixed: means you can't change it by a replacement without authorization
+                 Is just a flag and doesn't affect much.
+        """
     ref_re = re.compile(r'([^\d]+)([\?\d]+)')
 
     def __init__(self):

kibot/out_ibom.py

@@ -52,28 +52,27 @@ class IBoMOptions(BaseOptions):
             """ Include netlist information in output. """
             self.sort_order = 'C,R,L,D,U,Y,X,F,SW,A,~,HS,CNN,J,P,NT,MH'
             """ Default sort order for components. Must contain '~' once """
-            # self.blacklist = ''
-            # """ List of comma separated blacklisted components or prefixes with *. E.g. 'X1,MH*' """
+            self.blacklist = ''
+            """ List of comma separated blacklisted components or prefixes with *. E.g. 'X1,MH*' """
             self.no_blacklist_virtual = False
             """ Do not blacklist virtual components """
-            # self.blacklist_empty_val = False
-            # """ Blacklist components with empty value """
+            self.blacklist_empty_val = False
+            """ Blacklist components with empty value """
             self.netlist_file = ''
             """ Path to netlist or xml file """
             self.extra_fields = ''
-            """ Comma separated list of extra fields to pull from netlist or xml file.
-                These are extra columns in the BoM """
+            """ Comma separated list of extra fields to pull from netlist or xml file """
             self.normalize_field_case = False
             """ Normalize extra field name case. E.g. 'MPN' and 'mpn' will be considered the same field """
-            # self.variant_field = ''
-            # """ Name of the extra field that stores board variant for component """
-            # self.variants_whitelist = ''
-            # """ List of board variants to include in the BOM """
-            # self.variants_blacklist = ''
-            # """ List of board variants to exclude from the BOM """
-            # self.dnp_field = ''
-            # """ Name of the extra field that indicates do not populate status. Components with this field not empty will be
-            #     blacklisted """
+            self.variant_field = ''
+            """ Name of the extra field that stores board variant for component """
+            self.variants_whitelist = ''
+            """ List of board variants to include in the BOM """
+            self.variants_blacklist = ''
+            """ List of board variants to exclude from the BOM """
+            self.dnp_field = ''
+            """ Name of the extra field that indicates do not populate status. Components with this field not empty will be
+                blacklisted """
         super().__init__()
 
     def run(self, output_dir, board):