#
# Example python script to generate a BOM from a KiCad generic netlist
#
# Example: Sorted and Grouped HTML BOM
#
"""
@package
Output: HTML
Grouped By: Value
Sorted By: Ref
Fields: Ref, Qnty, Value, Part, Datasheet, Description, Vendor
Command line:
python "pathToFile/bom_html_grouped_by_value.py" "%I" "%O.html"
"""
from __future__ import print_function
# Import the KiCad python helper module and the csv formatter
import kicad_netlist_reader
import sys
# Start with a basic html template
html = """
"""
# Generate an instance of a generic netlist, and load the netlist tree from
# the command line option. If the file doesn't exist, execution will stop
net = kicad_netlist_reader.netlist(sys.argv[1])
# Open a file to write to, if the file cannot be opened output to stdout
# instead
try:
f = open(sys.argv[2], 'w')
except IOError:
e = "Can't open output file for writing: " + sys.argv[2]
print(__file__, ":", e, file=sys.stderr)
f = sys.stdout
components = net.getInterestingComponents()
# Output a set of rows for a header providing general information
html = html.replace('', net.getSource())
html = html.replace('', net.getDate())
html = html.replace('', net.getTool())
html = html.replace('', "Component Count:" + \
str(len(components)))
row = "Ref | "
row += "Qnty | "
row += "Value | " + "Part | " + "Datasheet | "
row += "Description | " + "Vendor |
"
html = html.replace('', row + "")
# Get all of the components in groups of matching parts + values
# (see kicad_netlist_reader.py)
grouped = net.groupComponents(components)
# Output all of the component information
for group in grouped:
refs = ""
# Add the reference of every component in the group and keep a reference
# to the component so that the other data can be filled in once per group
for component in group:
if len(refs) > 0:
refs += ", "
refs += component.getRef()
c = component
row = "" + refs +" | " + str(len(group))
row += " | " + c.getValue()
row += " | " + c.getLibName() + ":" + c.getPartName()
row += " | " + c.getDatasheet()
row += " | " + c.getDescription()
row += " | " + c.getField("Vendor")+ " |
"
html = html.replace('', row + "")
# Print the formatted html to the file
print(html, file=f)