haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/eeschema/plugins/python_scripts/bom_html_grouped_by_value.py

100 lines
2.9 KiB
Python
Raw Normal View History

1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
#
# Example python script to generate a BOM from a KiCad generic netlist
#
# Example: Sorted and Grouped HTML BOM
#
Cleanup BOM script descriptions - make descriptions consistent - fix inaccuracies - describe what scripts do more precisely
2021-03-07 16:33:59 +00:00
Fix minor issues. Fix some outdated and broken BOM python scripts. Add info in BOM python scripts. BOM dialog: remove a not very useful button, and merge its function with an other (not perfect, need more work) Add message box to show info added in BOM python scripts (See scripts/bom-in-python/README-bom.txt about this info)
2014-12-03 16:22:06 +00:00
"""
@package
Cleanup BOM script descriptions - make descriptions consistent - fix inaccuracies - describe what scripts do more precisely
2021-03-07 16:33:59 +00:00
Output: HTML
Grouped By: Value
Sorted By: Ref
Fields: Ref, Qnty, Value, Part, Datasheet, Description, Vendor
Bom scripts: Update comments in scripts (no code change)
2017-05-13 06:18:06 +00:00
Command line:
Eeschema bom scripts: move python scripts to eeschema/plugins/python_scripts and xsl scripts to subdir xsl_scripts. Python scripts are now installed (previously: were ignored by the make install command)
2017-05-13 14:52:56 +00:00
python "pathToFile/bom_html_grouped_by_value.py" "%I" "%O.html"
Fix minor issues. Fix some outdated and broken BOM python scripts. Add info in BOM python scripts. BOM dialog: remove a not very useful button, and merge its function with an other (not perfect, need more work) Add message box to show info added in BOM python scripts (See scripts/bom-in-python/README-bom.txt about this info)
2014-12-03 16:22:06 +00:00
"""
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
Clarify, extend, and rename ky*.py to kicad_netlist_reader.py. Significantly enhance the bom_csv_grouped_by_value.py BOM generator. IMO it at this moment, the best BOM production tool for KiCad.
2013-09-01 17:49:01 +00:00
from __future__ import print_function
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
# Import the KiCad python helper module and the csv formatter
Clarify, extend, and rename ky*.py to kicad_netlist_reader.py. Significantly enhance the bom_csv_grouped_by_value.py BOM generator. IMO it at this moment, the best BOM production tool for KiCad.
2013-09-01 17:49:01 +00:00
import kicad_netlist_reader
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
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>
"""
Eeschema: add dialog and utilities to create BOMs from generic netlist
2013-06-14 14:59:52 +00:00
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
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
Clarify, extend, and rename ky*.py to kicad_netlist_reader.py. Significantly enhance the bom_csv_grouped_by_value.py BOM generator. IMO it at this moment, the best BOM production tool for KiCad.
2013-09-01 17:49:01 +00:00
net = kicad_netlist_reader.netlist(sys.argv[1])
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
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:
f = open(sys.argv[2], 'w')
except IOError:
Fix minor issues. Fix some outdated and broken BOM python scripts. Add info in BOM python scripts. BOM dialog: remove a not very useful button, and merge its function with an other (not perfect, need more work) Add message box to show info added in BOM python scripts (See scripts/bom-in-python/README-bom.txt about this info)
2014-12-03 16:22:06 +00:00
e = "Can't open output file for writing: " + sys.argv[2]
Clarify, extend, and rename ky*.py to kicad_netlist_reader.py. Significantly enhance the bom_csv_grouped_by_value.py BOM generator. IMO it at this moment, the best BOM production tool for KiCad.
2013-09-01 17:49:01 +00:00
print(__file__, ":", e, file=sys.stderr)
Fix minor issues. Fix some outdated and broken BOM python scripts. Add info in BOM python scripts. BOM dialog: remove a not very useful button, and merge its function with an other (not perfect, need more work) Add message box to show info added in BOM python scripts (See scripts/bom-in-python/README-bom.txt about this info)
2014-12-03 16:22:06 +00:00
f = sys.stdout
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
BOM generators now report count of "interesting" components, rather than total components
2013-09-20 15:11:45 +00:00
components = net.getInterestingComponents()
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
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>" + \
BOM generators now report count of "interesting" components, rather than total components
2013-09-20 15:11:45 +00:00
str(len(components)))
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
Fix minor issues. Fix some outdated and broken BOM python scripts. Add info in BOM python scripts. BOM dialog: remove a not very useful button, and merge its function with an other (not perfect, need more work) Add message box to show info added in BOM python scripts (See scripts/bom-in-python/README-bom.txt about this info)
2014-12-03 16:22:06 +00:00
row = "<tr><th style='width:640px'>Ref</th>"
row += "<th>Qnty</th>"
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
row += "<th>Value</th>" + "<th>Part</th>" + "<th>Datasheet</th>"
row += "<th>Description</th>" + "<th>Vendor</th></tr>"
Eeschema: add dialog and utilities to create BOMs from generic netlist
2013-06-14 14:59:52 +00:00
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
html = html.replace('<!--TABLEROW-->', row + "<!--TABLEROW-->")
Eeschema: add dialog and utilities to create BOMs from generic netlist
2013-06-14 14:59:52 +00:00
# Get all of the components in groups of matching parts + values
Clarify, extend, and rename ky*.py to kicad_netlist_reader.py. Significantly enhance the bom_csv_grouped_by_value.py BOM generator. IMO it at this moment, the best BOM production tool for KiCad.
2013-09-01 17:49:01 +00:00
# (see kicad_netlist_reader.py)
grouped = net.groupComponents(components)
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
# Output all of the component information
for group in grouped:
refs = ""
Eeschema: add dialog and utilities to create BOMs from generic netlist
2013-06-14 14:59:52 +00:00
# Add the reference of every component in the group and keep a reference
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
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:
Clarify, extend, and rename ky*.py to kicad_netlist_reader.py. Significantly enhance the bom_csv_grouped_by_value.py BOM generator. IMO it at this moment, the best BOM production tool for KiCad.
2013-09-01 17:49:01 +00:00
if len(refs) > 0:
refs += ", "
refs += component.getRef()
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
c = component
Eeschema: add dialog and utilities to create BOMs from generic netlist
2013-06-14 14:59:52 +00:00
row = "<tr><td>" + refs +"</td><td>" + str(len(group))
Fix minor issues. Fix some outdated and broken BOM python scripts. Add info in BOM python scripts. BOM dialog: remove a not very useful button, and merge its function with an other (not perfect, need more work) Add message box to show info added in BOM python scripts (See scripts/bom-in-python/README-bom.txt about this info)
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()
row += "</td><td>" + c.getField("Vendor")+ "</td></tr>"
Eeschema: add dialog and utilities to create BOMs from generic netlist
2013-06-14 14:59:52 +00:00
1) Add "rules" to base of tree for copying into BZR_HOME/rules. File "rules" has instructional text as comments near top. 2) Convert all text files in repo to LF line ending form. Any checkout done with "rules" in play will convert the working tree to native line ending, while keeping repo as LF line ending.
2013-05-26 04:36:44 +00:00
html = html.replace('<!--TABLEROW-->', row + "<!--TABLEROW-->")
# Print the formatted html to the file
Clarify, extend, and rename ky*.py to kicad_netlist_reader.py. Significantly enhance the bom_csv_grouped_by_value.py BOM generator. IMO it at this moment, the best BOM production tool for KiCad.
2013-09-01 17:49:01 +00:00
print(html, file=f)