templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added support for iBoM 2.4.1

This commit is contained in:
Salvador E. Tropea 2021-12-27 14:13:12 -03:00
parent 67b807610e
commit a72aac4e54
4 changed files with 49 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1169,7 +1169,12 @@ Next time you need this list just use an alias, like this:
- `dnp_field`: [string=''] Name of the extra field that indicates do not populate status.
Components with this field not empty will be blacklisted.
IBoM option, avoid using in conjunction with KiBot variants/filters.
- `extra_data_file`: [string=''] Path to netlist or xml file. You can use '%F.xml' to avoid specifying the project name.
Leave it blank for most uses, data will be extracted from the PCB.
- `extra_fields`: [string=''] Comma separated list of extra fields to pull from netlist or xml file.
Using 'X,Y' is a shortcut for `show_fields` and `group_fields` with values 'Value,Footprint,X,Y'.
- `group_fields`: [string=''] Comma separated list of fields that components will be grouped by.
Value and Footprint are used when nothing is specified.
- `hide_pads`: [boolean=false] Hide footprint pads by default.
- `hide_silkscreen`: [boolean=false] Hide silkscreen by default.
- `highlight_pin1`: [boolean=false] Highlight pin1 by default.
@ -1186,14 +1191,16 @@ Next time you need this list just use an alias, like this:
%T : bom generation time.
Extension .html will be added automatically.
Note that this name is used only when output is ''.
- `netlist_file`: [string=''] Path to netlist or xml file. You can use '%F.xml' to avoid specifying the project name.
Leave it blank for most uses, data will be extracted from the PCB.
- *netlist_file*: Alias for extra_data_file.
- `no_blacklist_virtual`: [boolean=false] Do not blacklist virtual components.
IBoM option, avoid using in conjunction with KiBot variants/filters.
- `no_compression`: [boolean=false] Disable compression of pcb data.
- `no_redraw_on_drag`: [boolean=false] Do not redraw pcb on drag by default.
- `normalize_field_case`: [boolean=false] Normalize extra field name case. E.g. 'MPN' and 'mpn' will be considered the same field.
- `output`: [string='%f-%i%v.%x'] Filename for the output, use '' to use the IBoM filename (%i=ibom, %x=html). Affected by global options.
- `show_fabrication`: [boolean=false] Show fabrication layer by default.
- `show_fields`: [string=''] Comma separated list of fields to show in the BOM.
Value and Footprint are displayed when nothing is specified.
- `sort_order`: [string='C,R,L,D,U,Y,X,F,SW,A,~,HS,CNN,J,P,NT,MH'] Default sort order for components. Must contain '~' once.
- `variant`: [string=''] Board variant to apply.
Avoid using it in conjunction with with IBoM native filtering options.

18
docs/samples/generic_plot.kibot.yaml
View File

@ -585,8 +585,15 @@ outputs:
# Components with this field not empty will be blacklisted.
# IBoM option, avoid using in conjunction with KiBot variants/filters
dnp_field: ''
# [string=''] Comma separated list of extra fields to pull from netlist or xml file
# [string=''] Path to netlist or xml file. You can use '%F.xml' to avoid specifying the project name.
# Leave it blank for most uses, data will be extracted from the PCB
extra_data_file: ''
# [string=''] Comma separated list of extra fields to pull from netlist or xml file.
# Using 'X,Y' is a shortcut for `show_fields` and `group_fields` with values 'Value,Footprint,X,Y'
extra_fields: ''
# [string=''] Comma separated list of fields that components will be grouped by.
# Value and Footprint are used when nothing is specified
group_fields: ''
# [boolean=false] Hide footprint pads by default
hide_pads: false
# [boolean=false] Hide silkscreen by default
@ -610,12 +617,12 @@ outputs:
# Extension .html will be added automatically.
# Note that this name is used only when output is ''
name_format: 'ibom'
# [string=''] Path to netlist or xml file. You can use '%F.xml' to avoid specifying the project name.
# Leave it blank for most uses, data will be extracted from the PCB
netlist_file: ''
# `netlist_file` is an alias for `extra_data_file`
# [boolean=false] Do not blacklist virtual components.
# IBoM option, avoid using in conjunction with KiBot variants/filters
no_blacklist_virtual: false
# [boolean=false] Disable compression of pcb data
no_compression: false
# [boolean=false] Do not redraw pcb on drag by default
no_redraw_on_drag: false
# [boolean=false] Normalize extra field name case. E.g. 'MPN' and 'mpn' will be considered the same field
@ -624,6 +631,9 @@ outputs:
output: '%f-%i%v.%x'
# [boolean=false] Show fabrication layer by default
show_fabrication: false
# [string=''] Comma separated list of fields to show in the BOM.
# Value and Footprint are displayed when nothing is specified
show_fields: ''
# [string='C,R,L,D,U,Y,X,F,SW,A,~,HS,CNN,J,P,NT,MH'] Default sort order for components. Must contain '~' once
sort_order: 'C,R,L,D,U,Y,X,F,SW,A,~,HS,CNN,J,P,NT,MH'
# [string=''] Board variant to apply.

39
kibot/out_ibom.py
View File

@ -41,6 +41,8 @@ class IBoMOptions(VariantOptions):
""" [bom-only,left-right,top-bottom] Default BOM view """
self.layer_view = 'FB'
""" [F,FB,B] Default layer view """
self.no_compression = False
""" Disable compression of pcb data """
self.name_format = 'ibom'
""" Output file name format supports substitutions:
%f : original pcb file name without extension.
@ -58,11 +60,20 @@ class IBoMOptions(VariantOptions):
""" 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.netlist_file = ''
self.netlist_file = None
""" {extra_data_file} """
self.extra_data_file = ''
""" Path to netlist or xml file. You can use '%F.xml' to avoid specifying the project name.
Leave it blank for most uses, data will be extracted from the PCB """
self.extra_fields = ''
""" Comma separated list of extra fields to pull from netlist or xml file """
""" Comma separated list of extra fields to pull from netlist or xml file.
Using 'X,Y' is a shortcut for `show_fields` and `group_fields` with values 'Value,Footprint,X,Y' """
self.show_fields = ''
""" Comma separated list of fields to show in the BOM.
Value and Footprint are displayed when nothing is specified """
self.group_fields = ''
""" Comma separated list of fields that components will be grouped by.
Value and Footprint are used when nothing is specified """
self.normalize_field_case = False
""" Normalize extra field name case. E.g. 'MPN' and 'mpn' will be considered the same field """
self.blacklist = ''
@ -103,12 +114,12 @@ class IBoMOptions(VariantOptions):
def config(self, parent):
super().config(parent)
self._netlist_file_guess = False
if not self.netlist_file and self.need_extra_fields():
self.netlist_file = '%F.xml'
self._netlist_file_guess = True
if self.netlist_file:
self.netlist_file = self.expand_filename('', self.netlist_file, 'ibom', 'xml')
self._extra_data_file_guess = False
if not self.extra_data_file and self.need_extra_fields():
self.extra_data_file = '%F.xml'
self._extra_data_file_guess = True
if self.extra_data_file:
self.extra_data_file = self.expand_filename('', self.extra_data_file, 'ibom', 'xml')
def get_targets(self, out_dir):
if self.output:
@ -119,8 +130,8 @@ class IBoMOptions(VariantOptions):
def get_dependencies(self):
files = [GS.pcb_file]
if self.netlist_file and os.path.isfile(self.netlist_file):
files.append(self.netlist_file)
if self.extra_data_file and os.path.isfile(self.extra_data_file):
files.append(self.extra_data_file)
return files
def run(self, name):
@ -141,14 +152,14 @@ class IBoMOptions(VariantOptions):
output_dir = name
cmd = [tool, GS.pcb_file, '--dest-dir', output_dir, '--no-browser', ]
# Check if the user wants extra_fields but there is no data about them (#68)
if self.need_extra_fields() and not os.path.isfile(self.netlist_file):
if self.need_extra_fields() and not os.path.isfile(self.extra_data_file):
logger.warning(W_NONETLIST+'iBoM needs information about user defined fields and no netlist provided')
if self._netlist_file_guess:
if self._extra_data_file_guess:
logger.warning(W_NONETLIST+'Create a BoM in XML format or use the `update_xml` preflight')
# If the name of the netlist is just a guess remove it from the options
self.netlist_file = ''
self.extra_data_file = ''
else:
logger.warning(W_NONETLIST+"The file name used in `netlist_file` doesn't exist")
logger.warning(W_NONETLIST+"The file name used in `extra_data_file` doesn't exist")
# Apply variants/filters
to_remove = ','.join(self.get_not_fitted_refs())
if self.blacklist and to_remove:

2
tests/test_plot/test_ibom.py
View File

@ -97,7 +97,7 @@ def test_ibom_all_ops(test_dir):
r'"checkboxes": "Sourced,Placed,Bogus"',
r'"bom_view": "top-bottom"',
r'"layer_view": "B"',
r'"extra_fields": \["EF"\]'])
r'"fields": \["Value", "Footprint", "EF"\]'])
ctx.clean_up()