2013-05-26 04:36:44 +00:00
|
|
|
#
|
|
|
|
|
# Example python script to generate a BOM from a KiCad generic netlist
|
2021-05-31 16:54:24 +00:00
|
|
|
# The KiCad generic xml netlist is expected to be encoded UTF-8
|
2013-05-26 04:36:44 +00:00
|
|
|
#
|
|
|
|
|
# Example: Sorted and Grouped HTML BOM
|
|
|
|
|
#
|
2021-03-07 16:33:59 +00:00
|
|
|
|
2014-12-03 16:22:06 +00:00
|
|
|
"""
|
|
|
|
|
@package
|
2021-03-07 16:33:59 +00:00
|
|
|
Output: HTML
|
2023-01-11 02:45:43 +00:00
|
|
|
Grouped By: Value, DNP
|
2021-03-07 16:33:59 +00:00
|
|
|
Sorted By: Ref
|
2023-01-11 02:45:43 +00:00
|
|
|
Fields: Ref, Qnty, Value, Part, Datasheet, Description, Vendor, DNP
|
2017-05-13 06:18:06 +00:00
|
|
|
|
|
|
|
|
Command line:
|
2017-05-13 14:52:56 +00:00
|
|
|
python "pathToFile/bom_html_grouped_by_value.py" "%I" "%O.html"
|
2014-12-03 16:22:06 +00:00
|
|
|
"""
|
2013-05-26 04:36:44 +00:00
|
|
|
|
2013-09-01 17:49:01 +00:00
|
|
|
from __future__ import print_function
|
|
|
|
|
|
2013-05-26 04:36:44 +00:00
|
|
|
# Import the KiCad python helper module and the csv formatter
|
2013-09-01 17:49:01 +00:00
|
|
|
import kicad_netlist_reader
|
2021-12-02 06:07:41 +00:00
|
|
|
import kicad_utils
|
2013-05-26 04:36:44 +00:00
|
|
|
import sys
|
|
|
|
|
|
|
|
|
|
# Start with a basic html template
|
|
|
|
|
html = """
|
|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<h1><!--SOURCE--></h1>
|
|
|
|
|
<p><!--DATE--></p>
|
|
|
|
|
<p><!--TOOL--></p>
|
|
|
|
|
<p><!--COMPCOUNT--></p>
|
|
|
|
|
<table>
|
|
|
|
|
<!--TABLEROW-->
|
|
|
|
|
</table>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
"""
|
2013-06-14 14:59:52 +00:00
|
|
|
|
2013-05-26 04:36:44 +00:00
|
|
|
# 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
|
2013-09-01 17:49:01 +00:00
|
|
|
net = kicad_netlist_reader.netlist(sys.argv[1])
|
2013-05-26 04:36:44 +00:00
|
|
|
|
|
|
|
|
# Open a file to write to, if the file cannot be opened output to stdout
|
|
|
|
|
# instead
|
|
|
|
|
try:
|
2021-12-02 06:07:41 +00:00
|
|
|
f = kicad_utils.open_file_write(sys.argv[2], 'wb')
|
2013-05-26 04:36:44 +00:00
|
|
|
except IOError:
|
2014-12-03 16:22:06 +00:00
|
|
|
e = "Can't open output file for writing: " + sys.argv[2]
|
2013-09-01 17:49:01 +00:00
|
|
|
print(__file__, ":", e, file=sys.stderr)
|
2014-12-03 16:22:06 +00:00
|
|
|
f = sys.stdout
|
2013-05-26 04:36:44 +00:00
|
|
|
|
2023-01-10 22:31:25 +00:00
|
|
|
components = net.getInterestingComponents( excludeBOM=True )
|
2013-09-20 15:11:45 +00:00
|
|
|
|
2013-05-26 04:36:44 +00:00
|
|
|
# Output a set of rows for a header providing general information
|
|
|
|
|
html = html.replace('<!--SOURCE-->', net.getSource())
|
|
|
|
|
html = html.replace('<!--DATE-->', net.getDate())
|
|
|
|
|
html = html.replace('<!--TOOL-->', net.getTool())
|
|
|
|
|
html = html.replace('<!--COMPCOUNT-->', "<b>Component Count:</b>" + \
|
2013-09-20 15:11:45 +00:00
|
|
|
str(len(components)))
|
2013-05-26 04:36:44 +00:00
|
|
|
|
2021-05-31 08:00:38 +00:00
|
|
|
row =""
|
|
|
|
|
row += "<tr><th>Ref</th>"
|
2014-12-03 16:22:06 +00:00
|
|
|
row += "<th>Qnty</th>"
|
2013-05-26 04:36:44 +00:00
|
|
|
row += "<th>Value</th>" + "<th>Part</th>" + "<th>Datasheet</th>"
|
2023-01-10 23:21:31 +00:00
|
|
|
row += "<th>Description</th>" + "<th>Vendor</th>" + "<th>DNP</th></tr>"
|
2013-06-14 14:59:52 +00:00
|
|
|
|
2013-05-26 04:36:44 +00:00
|
|
|
html = html.replace('<!--TABLEROW-->', row + "<!--TABLEROW-->")
|
|
|
|
|
|
2013-06-14 14:59:52 +00:00
|
|
|
# Get all of the components in groups of matching parts + values
|
2013-09-01 17:49:01 +00:00
|
|
|
# (see kicad_netlist_reader.py)
|
|
|
|
|
grouped = net.groupComponents(components)
|
2013-05-26 04:36:44 +00:00
|
|
|
|
|
|
|
|
# Output all of the component information
|
|
|
|
|
for group in grouped:
|
|
|
|
|
refs = ""
|
|
|
|
|
|
2013-06-14 14:59:52 +00:00
|
|
|
# Add the reference of every component in the group and keep a reference
|
2013-05-26 04:36:44 +00:00
|
|
|
# to the component so that the other data can be filled in once per group
|
|
|
|
|
for component in group:
|
2013-09-01 17:49:01 +00:00
|
|
|
if len(refs) > 0:
|
|
|
|
|
refs += ", "
|
|
|
|
|
refs += component.getRef()
|
2013-05-26 04:36:44 +00:00
|
|
|
c = component
|
|
|
|
|
|
2013-06-14 14:59:52 +00:00
|
|
|
row = "<tr><td>" + refs +"</td><td>" + str(len(group))
|
2014-12-03 16:22:06 +00:00
|
|
|
row += "</td><td>" + c.getValue()
|
|
|
|
|
row += "</td><td>" + c.getLibName() + ":" + c.getPartName()
|
|
|
|
|
row += "</td><td>" + c.getDatasheet()
|
|
|
|
|
row += "</td><td>" + c.getDescription()
|
2023-01-10 23:21:31 +00:00
|
|
|
row += "</td><td>" + c.getField("Vendor")
|
|
|
|
|
row += "</td><td>" + c.getDNPString() + "</td></tr>"
|
2021-05-31 08:00:38 +00:00
|
|
|
row += "\n"
|
2013-06-14 14:59:52 +00:00
|
|
|
|
2013-05-26 04:36:44 +00:00
|
|
|
html = html.replace('<!--TABLEROW-->', row + "<!--TABLEROW-->")
|
|
|
|
|
|
2021-05-31 16:54:24 +00:00
|
|
|
# Write the formatted html to the file
|
|
|
|
|
if sys.version_info[0] < 3:
|
|
|
|
|
f.write(html)
|
|
|
|
|
else:
|
|
|
|
|
f.write(html.encode('utf-8'))
|
|
|
|
|
f.close()
|
