+
+///////////////////////////////////////////////////////////////////////////
+
+///////////////////////////////////////////////////////////////////////////////
+/// Class DIALOG_BOM_BASE
+///////////////////////////////////////////////////////////////////////////////
+class DIALOG_BOM_BASE : public DIALOG_SHIM
+{
+ DECLARE_EVENT_TABLE()
+ private:
+
+ // Private event handlers
+ void _wxFB_OnPluginSelected( wxCommandEvent& event ){ OnPluginSelected( event ); }
+ void _wxFB_OnCommandLineEdited( wxCommandEvent& event ){ OnCommandLineEdited( event ); }
+ void _wxFB_OnNameEdited( wxCommandEvent& event ){ OnNameEdited( event ); }
+ void _wxFB_OnRunPlugin( wxCommandEvent& event ){ OnRunPlugin( event ); }
+ void _wxFB_OnCancelClick( wxCommandEvent& event ){ OnCancelClick( event ); }
+ void _wxFB_OnHelp( wxCommandEvent& event ){ OnHelp( event ); }
+ void _wxFB_OnAddPlugin( wxCommandEvent& event ){ OnAddPlugin( event ); }
+ void _wxFB_OnChoosePlugin( wxCommandEvent& event ){ OnChoosePlugin( event ); }
+ void _wxFB_OnRemovePlugin( wxCommandEvent& event ){ OnRemovePlugin( event ); }
+ void _wxFB_OnEditPlugin( wxCommandEvent& event ){ OnEditPlugin( event ); }
+
+
+ protected:
+ enum
+ {
+ ID_CMDLINE = 1000,
+ IN_NAMELINE,
+ ID_CREATE_BOM,
+ ID_HELP,
+ ID_ADD_PLUGIN,
+ wxID_BROWSE_PLUGINS,
+ ID_REMOVEL_PLUGIN,
+ ID_FN
+ };
+
+ wxStaticText* m_staticTextPluginTitle;
+ wxListBox* m_lbPlugins;
+ wxStaticText* m_staticTextCmd;
+ wxTextCtrl* m_textCtrlCommand;
+ wxStaticText* m_staticTextName;
+ wxTextCtrl* m_textCtrlName;
+ wxButton* m_buttonNetlist;
+ wxButton* m_buttonCancel;
+ wxButton* m_buttonHelp;
+ wxStaticLine* m_staticline2;
+ wxButton* m_buttonAddPlugin;
+ wxButton* m_buttonBrowsePlugin;
+ wxButton* m_buttonDelPlugin;
+ wxButton* m_buttonEdit;
+ wxStaticText* m_staticTextDefaultFN;
+ wxTextCtrl* m_textCtrlDefaultFileName;
+
+ // Virtual event handlers, overide them in your derived class
+ virtual void OnPluginSelected( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnCommandLineEdited( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnNameEdited( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnRunPlugin( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnCancelClick( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnHelp( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnAddPlugin( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnChoosePlugin( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnRemovePlugin( wxCommandEvent& event ) { event.Skip(); }
+ virtual void OnEditPlugin( wxCommandEvent& event ) { event.Skip(); }
+
+
+ public:
+
+ DIALOG_BOM_BASE( wxWindow* parent, wxWindowID id = wxID_ANY, const wxString& title = _("Bill of Material"), const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxSize( 404,334 ), long style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER );
+ ~DIALOG_BOM_BASE();
+
+};
+
+#endif //__DIALOG_BOM_BASE_H__
diff --git a/eeschema/dialogs/dialog_bom_cfg.keywords b/eeschema/dialogs/dialog_bom_cfg.keywords
new file mode 100644
index 0000000000..8790280ce4
--- /dev/null
+++ b/eeschema/dialogs/dialog_bom_cfg.keywords
@@ -0,0 +1,4 @@
+plugins
+plugin
+cmd
+opts
diff --git a/eeschema/dialogs/dialog_bom_help.html b/eeschema/dialogs/dialog_bom_help.html
new file mode 100644
index 0000000000..4ba5c5bac1
--- /dev/null
+++ b/eeschema/dialogs/dialog_bom_help.html
@@ -0,0 +1,210 @@
+
+
+
+
+ kicad help
+
+
+
+
+
+
+
+1 - Full
+documentation:
+
+The
+Eeschema
+documentation, chapter 14
+describes this intermediate netlist and gives examples
See also
+https://answers.launchpad.net/kicad/+faq/2265
+
+2 - The
+intermediate Netlist File
+
+BOM files (and
+netlist files) can be created from an Intermediate netlist file
+created by Eeschema.
+
+This file uses XML
+syntax and is called the intermediate netlist. The intermediate
+netlist includes a large amount of data about your board and because
+of this, it can be used with post-processing to create a BOM or other
+reports.
+
+Depending on the
+output (BOM or netlist), different subsets of the complete
+Intermediate Netlist file will be used in the post-processing.
+
+3 - Conversion to
+a new format
+
+By applying a
+post-processing filter to the Intermediate netlist file you can
+generate foreign netlist files as well as BOM files. Because this
+conversion is a text to text transformation.
+
+this post-processing
+filter can be written using Python, XSLT, or any other tool capable
+of taking XML as input.
+
+XSLT
+itself is a XML language very suitable for XML transformations. There
+is a free program called xsltproc
+that
+you can download and install. The
+xsltproc
+program can be used to read the Intermediate XML netlist input file,
+apply a
+style-sheet to transform the input, and save the results in an output
+file. Use of xsltproc requires a style-sheet file using XSLT
+conventions. The full conversion process is handled
+by
+Eeschema, after it is configured once to run xsltproc in a specific
+way.
+
+4 -
+Initialization of the dialog window
+
+You should add a new
+pluging (a script) in plugin list by clicking on the Add Plugin
+button.
+
+4.1 - Plugin
+Configuration Parameters
+
+The Eeschema plug-in
+configuration dialog requires the following information:
+
+
+ The title: for
+ instance, the name of the netlist format.
+
+ The command line to
+ launch the converter (usually a script).
+
+
+Once you click on
+the generate button the following will happen:
+
+
+ Eeschema creates an
+ intermediate netlist file *.xml, for instance test.xml.
+
+ Eeschema runs the
+ script from the command line to create the final output file.
+
+
+4.2 - Generate
+netlist files with the command line
+
+Assuming we are
+using the program xsltproc.exe
+to
+apply the sheet style to the intermediate file, xsltproc.exe
+is
+executed with the following command.
+
+xsltproc.exe -o <
+output filename > < style-sheet filename > < input XML
+file to convert >
+
+On
+Windows the command line is the
+following.
f:/kicad/bin/xsltproc.exe
+-o “%O” f:/kicad/bin/plugins/myconverter.xsl “%I”
+
+On
+Linux the command becomes as
+following.
xsltproc
+-o “%O” /usr/local/kicad/bin/plugins/myconverter .xsl
+“%I”
+
+Where
+myconverter.xsl
+is
+the style-sheet that you are applying. Do not forget the double
+quotes
+around
+the file names, this allows them to have spaces after the
+substitution by Eeschema.
+
+The command line
+format accepts parameters for filenames:
+
+The supported
+formatting parameters are.
+
+
+ %B => base
+ filename and path of selected output file, minus path and extension.
+
+ %I => complete
+ filename and path of the temporary input file (the intermediate net
+ file).
+
+ %O => complete
+ filename and path of the user chosen output file.
+
+
+%I will be replaced
+by the actual intermediate file name
%O
+will be replaced by the actual output file name.
+
+4.3 - Command
+line format: example for xsltproc
+
+The
+command line format for xsltproc is the following:
< path of
+xsltproc > xsltproc
+< xsltproc parameters >
+
+On
+Windows:
f:/kicad/bin/xsltproc.exe -o “%O”
+f:/kicad/bin/plugins/netlist_form_pads-pcb.xsl “%I”
+
+On
+Linux:
xsltproc
+-o “%O”
+/usr/local/kicad/bin/plugins/netlist_form_pads-pcb.xsl “%I”
+
+The
+above examples assume
+xsltproc
+is installed on your PC under Windows and all files located in
+kicad/bin.
+
+4.4 - Command
+line format: example for
+python scripts
+
+The command line
+format for python is something like:
python
+<
+script file name > < input filename > <
+output filename >
+
+On
+Windows:
python.exe f:/kicad/python/my_python_script.py
+“%I” “%O”
+
+On Linux:
python
+/usr/local/kicad/python/my_python_script.py “%I”
+“%O”
+
+Assuming python is
+installed on your PC.
+
+
+
+
+
\ No newline at end of file
diff --git a/eeschema/invoke_sch_dialog.h b/eeschema/invoke_sch_dialog.h
index a8ccbff50a..a1f6ffcc95 100644
--- a/eeschema/invoke_sch_dialog.h
+++ b/eeschema/invoke_sch_dialog.h
@@ -37,8 +37,8 @@
// DIALOG_.cpp file.
-#ifndef INVOKE_A_DIALOG_H_
-#define INVOKE_A_DIALOG_H_
+#ifndef INVOKE_SCH_DIALOG_H_
+#define INVOKE_SCH_DIALOG_H_
class wxFrame;
@@ -61,6 +61,9 @@ wxDialog* InvokeDialogERC( SCH_EDIT_FRAME* aCaller );
/// DIALOG_PRINT_USING_PRINTER::ShowModal() returns.
int InvokeDialogPrintUsingPrinter( SCH_EDIT_FRAME* aCaller );
+/// Create and show DIALOG_BOM and return whatever
+/// DIALOG_BOM::ShowModal() returns.
+int InvokeDialogCreateBOM( SCH_EDIT_FRAME* aCaller );
-#endif // INVOKE_A_DIALOG_H_
+#endif // INVOKE_SCH_DIALOG_H_
diff --git a/eeschema/netlist.h b/eeschema/netlist.h
index 55189e5df4..2a3c439366 100644
--- a/eeschema/netlist.h
+++ b/eeschema/netlist.h
@@ -374,26 +374,6 @@ public:
sort( componentFlatList.begin(), componentFlatList.end(), sortByRefAndValue );
}
- /**
- * Function SortByValueAndRef
- * sorts the list of references by value.
- *
- * Components are sorted in the following order:
- *
- * - Value of component.
- * - Numeric value of reference designator.
- * - Unit number when component has multiple parts.
- * - Sheet number.
- * - X coordinate position.
- * - Y coordinate position.
- *
- *
- */
- void SortByValueAndRef()
- {
- sort( componentFlatList.begin(), componentFlatList.end(), sortByValueAndRef );
- }
-
/**
* Function SortByReferenceOnly
* sorts the list of references by reference.
@@ -410,25 +390,6 @@ public:
sort( componentFlatList.begin(), componentFlatList.end(), sortByReferenceOnly );
}
- /**
- * Function SortByValueOnly
- * sort the list of references by value.
- *
- * Components are grouped by type and are sorted in the following order:
- *
- * - Value of component.
- * - Numeric value of reference designator.
- * - Unit number when component has multiple parts.
- *
- *
- * groups are made by the first letter of reference
- * or the 2 first letters when existing
- */
- void SortByValueOnly()
- {
- sort( componentFlatList.begin(), componentFlatList.end(), sortByValueOnly );
- }
-
/**
* Function GetUnit
* searches the sorted list of components for a another component with the same
@@ -474,16 +435,12 @@ private:
static bool sortByRefAndValue( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
- static bool sortByValueAndRef( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
-
static bool sortByXPosition( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
static bool sortByYPosition( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
static bool sortByTimeStamp( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
- static bool sortByValueOnly( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
-
static bool sortByReferenceOnly( const SCH_REFERENCE& item1, const SCH_REFERENCE& item2 );
/**
diff --git a/eeschema/schframe.cpp b/eeschema/schframe.cpp
index 289f83e2ea..49fa8390e5 100644
--- a/eeschema/schframe.cpp
+++ b/eeschema/schframe.cpp
@@ -632,10 +632,7 @@ void SCH_EDIT_FRAME::OnCreateNetlist( wxCommandEvent& event )
void SCH_EDIT_FRAME::OnCreateBillOfMaterials( wxCommandEvent& )
{
- wxMessageDialog dlg( this,
- wxT( "https://answers.launchpad.net/kicad/+faq/2265" ),
- _( "BOM Howto" ) );
- dlg.ShowModal();
+ InvokeDialogCreateBOM( this );
}
diff --git a/scripts/bom-in-python/README-bom.txt b/scripts/bom-in-python/README-bom.txt
new file mode 100644
index 0000000000..e5be840892
--- /dev/null
+++ b/scripts/bom-in-python/README-bom.txt
@@ -0,0 +1,14 @@
+bom_?.py are some python scripts which read a generic xml netlist from eeschema,
+and create a bom.
+
+All examples use ky_generic_netlist_reader.py, which is a python utility to read
+and parse this generic xml netlist and create the corresponding data
+used to build the bom.
+
+You can modify them to build the bom you want.
+
+to use them, you should install python, and run:
+python bom_example?.py
+
+See Eeschema doc, chapter 14 for info about the generic xml netlist format,
+and how to run a script from Eeschema to create a customized netlist or BOM.
diff --git a/scripts/bom-in-python/ky/bom_example5.py b/scripts/bom-in-python/bom-generation.py
similarity index 89%
rename from scripts/bom-in-python/ky/bom_example5.py
rename to scripts/bom-in-python/bom-generation.py
index 7f6cd3be69..8746575348 100644
--- a/scripts/bom-in-python/ky/bom_example5.py
+++ b/scripts/bom-in-python/bom-generation.py
@@ -5,7 +5,7 @@
#
# Import the KiCad python helper module and the csv formatter
-import ky
+import ky_generic_netlist_reader
import sys
# Start with a basic html template
@@ -30,13 +30,13 @@ html = """
"""
def myEqu(self, other):
- """myEqu is a more advanced equivalence function for components which is
+ """myEqu is a more advanced equivalence function for components which is
used by component grouping. Normal operation is to group components based
on their Value, Library source, and Library part.
-
- In this example of a more advanced equivalency operator we also compare the
+
+ In this example of a more advanced equivalency operator we also compare the
custom fields Voltage, Tolerance and Manufacturer as well as the assigned
- footprint. If these fields are not used in some parts they will simply be
+ footprint. If these fields are not used in some parts they will simply be
ignored (they will match as both will be empty strings).
"""
@@ -54,18 +54,18 @@ def myEqu(self, other):
elif self.getField("Manufacturer") != other.getField("Manufacturer"):
result = False
elif self.getField("Voltage") != other.getField("Voltage"):
- result = False
-
+ result = False
+
return result
# Override the component equivalence operator - it is important to do this
# before loading the netlist, otherwise all components will have the original
# equivalency operator.
-ky.component.__equ__ = myEqu
-
+ky_generic_netlist_reader.component.__equ__ = myEqu
+
# Generate an instance of a generic netlist, and load the netlist tree from
# video.tmp. If the file doesn't exist, execution will stop
-net = ky.netlist(sys.argv[1])
+net = ky_generic_netlist_reader.netlist(sys.argv[1])
# Open a file to write too, if the file cannot be opened output to stdout
# instead
@@ -82,31 +82,33 @@ html = html.replace('', net.getTool())
html = html.replace('', "Component Count:" + \
str(len(net.components)))
-row = "| Ref | " + "Qnty | "
+row = "
|---|
| Ref | " + "Qnty | "
row += "Value | " + "Part | " + "Datasheet | "
row += "Description | " + "Vendor |
|---|
"
-
+
html = html.replace('', row + "")
-# Get all of the components in groups of matching parts + values (see ky.py)
+# Get all of the components in groups of matching parts + values
+# (see ky_generic_netlist_reader.py)
grouped = net.groupComponents()
# Output all of the component information
for group in grouped:
refs = ""
- # Add the reference of every component in the group and keep a reference
+ # 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:
refs += component.getRef() + ", "
c = component
- row = "| " + refs +" | " + str(len(group))
- row += " | " + c.getValue() + " | " + c.getLib() + "/"
- row += c.getPart() + " | " + c.getDatasheet() + " | "
- row += c.getDescription() + " | " + c.getField("Vendor")
+ row = "\n "
+ row += " |
| " + refs +" | " + str(len(group))
+ row += " | " + c.getValue() + " | " + c.getLib() + "/"
+ row += c.getPart() + " | " + c.getDatasheet() + " | "
+ row += c.getDescription() + " | " + c.getField("Vendor")
row += " |
"
-
+
html = html.replace('', row + "")
# Print the formatted html to output file
diff --git a/scripts/bom-in-python/ky/bom_example1.py b/scripts/bom-in-python/bom_csv_by_ref.py
similarity index 82%
rename from scripts/bom-in-python/ky/bom_example1.py
rename to scripts/bom-in-python/bom_csv_by_ref.py
index 354c6b5686..ccc874fd16 100644
--- a/scripts/bom-in-python/ky/bom_example1.py
+++ b/scripts/bom-in-python/bom_csv_by_ref.py
@@ -5,13 +5,13 @@
#
# Import the KiCad python helper module and the csv formatter
-import ky
+import ky_generic_netlist_reader
import csv
import sys
# 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 = ky.netlist(sys.argv[1])
+net = ky_generic_netlist_reader.netlist(sys.argv[1])
# Open a file to write to, if the file cannot be opened output to stdout
# instead
@@ -23,16 +23,16 @@ except IOError:
# Create a new csv writer object to use as the output formatter, although we
# are created a tab delimited list instead!
-out = csv.writer(f, delimiter='\t', quoting=csv.QUOTE_NONE)
+out = csv.writer(f, lineterminator='\n', delimiter='\t', quoting=csv.QUOTE_NONE)
# Output a field delimited header line
out.writerow(['Source:', net.getSource()])
out.writerow(['Date:', net.getDate()])
out.writerow(['Tool:', net.getTool()])
-out.writerow(['Component Count:', len(net.components)])
+out.writerow(['Component Count:', len(net.components)])
out.writerow(['Ref', 'Value', 'Part', 'Documentation', 'Description', 'Vendor'])
# Output all of the component information
for c in net.components:
- out.writerow([c.getRef(), c.getValue(), c.getLib() + "/" + c.getPart(),
+ out.writerow([c.getRef(), c.getValue(), c.getLib() + "/" + c.getPart(),
c.getDatasheet(), c.getDescription(), c.getField("Vendor")])
diff --git a/scripts/bom-in-python/ky/bom_example2.py b/scripts/bom-in-python/bom_csv_by_ref_v2.py
similarity index 81%
rename from scripts/bom-in-python/ky/bom_example2.py
rename to scripts/bom-in-python/bom_csv_by_ref_v2.py
index 58b1c05453..38e6f0c75f 100644
--- a/scripts/bom-in-python/ky/bom_example2.py
+++ b/scripts/bom-in-python/bom_csv_by_ref_v2.py
@@ -5,16 +5,16 @@
#
# Import the KiCad python helper module
-import ky
+import ky_generic_netlist_reader
import csv
import sys
-
+
# 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 = ky.netlist(sys.argv[1])
+net = ky_generic_netlist_reader.netlist(sys.argv[1])
# Open a file to write to, if the file cannot be opened output to stdout
-# instead
+# instead
try:
f = open(sys.argv[2], 'w')
except IOError:
@@ -22,13 +22,13 @@ except IOError:
f = stdout
# Create a new csv writer object to use as the output formatter
-out = csv.writer(f, delimiter=',', quotechar="\"", quoting=csv.QUOTE_ALL)
+out = csv.writer(f, lineterminator='\n', delimiter=',', quotechar="\"", quoting=csv.QUOTE_ALL)
# Output a field delimited header line
out.writerow(['Source:', net.getSource()])
out.writerow(['Date:', net.getDate()])
out.writerow(['Tool:', net.getTool()])
-out.writerow(['Component Count:', len(net.components)])
+out.writerow(['Component Count:', len(net.components)])
out.writerow(['Ref', 'Value', 'Footprint', 'Datasheet', 'Manufacturer', 'Vendor'])
# Output all of the component information (One component per row)
diff --git a/scripts/bom-in-python/ky/bom_example3.py b/scripts/bom-in-python/bom_csv_grouped_by_value.py
similarity index 83%
rename from scripts/bom-in-python/ky/bom_example3.py
rename to scripts/bom-in-python/bom_csv_grouped_by_value.py
index dcbbf15b32..81d3acecf6 100644
--- a/scripts/bom-in-python/ky/bom_example3.py
+++ b/scripts/bom-in-python/bom_csv_grouped_by_value.py
@@ -5,13 +5,13 @@
#
# Import the KiCad python helper module and the csv formatter
-import ky
+import ky_generic_netlist_reader
import csv
import sys
# 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 = ky.netlist(sys.argv[1])
+net = ky_generic_netlist_reader.netlist(sys.argv[1])
# Open a file to write to, if the file cannot be opened output to stdout
# instead
@@ -22,23 +22,24 @@ except IOError:
f = stdout
# Create a new csv writer object to use as the output formatter
-out = csv.writer(f, delimiter=',', quotechar='\"', quoting=csv.QUOTE_ALL)
+out = csv.writer(f, lineterminator='\n', delimiter=',', quotechar='\"', quoting=csv.QUOTE_ALL)
# Output a set of rows for a header providing general information
out.writerow(['Source:', net.getSource()])
out.writerow(['Date:', net.getDate()])
out.writerow(['Tool:', net.getTool()])
-out.writerow(['Component Count:', len(net.components)])
+out.writerow(['Component Count:', len(net.components)])
out.writerow(['Ref', 'Qnty', 'Value', 'Part', 'Datasheet', 'Description', 'Vendor'])
-# Get all of the components in groups of matching parts + values (see ky.py)
+# Get all of the components in groups of matching parts + values
+# (see ky_generic_netlist_reader.py)
grouped = net.groupComponents()
# Output all of the component information
for group in grouped:
refs = ""
- # Add the reference of every component in the group and keep a reference
+ # 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:
refs += component.getRef() + ", "
diff --git a/scripts/bom-in-python/bom_html_by_value.py b/scripts/bom-in-python/bom_html_by_value.py
new file mode 100644
index 0000000000..4c7fa5f2a5
--- /dev/null
+++ b/scripts/bom-in-python/bom_html_by_value.py
@@ -0,0 +1,119 @@
+#
+# Example python script to generate a BOM from a KiCad generic netlist
+#
+# Example: Sorted and Grouped HTML BOM with more advanced grouping
+#
+
+# Import the KiCad python helper module and the csv formatter
+import ky_generic_netlist_reader
+import sys
+
+# Start with a basic html template
+html = """
+
+
+
+
+ KiCad BOM Example 5
+
+
+
+
+
+
+
+
+
+ """
+
+def myEqu(self, other):
+ """myEqu is a more advanced equivalence function for components which is
+ used by component grouping. Normal operation is to group components based
+ on their Value, Library source, and Library part.
+
+ In this example of a more advanced equivalency operator we also compare the
+ custom fields Voltage, Tolerance and Manufacturer as well as the assigned
+ footprint. If these fields are not used in some parts they will simply be
+ ignored (they will match as both will be empty strings).
+
+ """
+ result = True
+ if self.getValue() != other.getValue():
+ result = False
+ elif self.getLib() != other.getLib():
+ result = False
+ elif self.getPart() != other.getPart():
+ result = False
+ elif self.getFootprint() != other.getFootprint():
+ result = False
+ elif self.getField("Tolerance") != other.getField("Tolerance"):
+ result = False
+ elif self.getField("Manufacturer") != other.getField("Manufacturer"):
+ result = False
+ elif self.getField("Voltage") != other.getField("Voltage"):
+ result = False
+
+ return result
+
+# Override the component equivalence operator - it is important to do this
+# before loading the netlist, otherwise all components will have the original
+# equivalency operator.
+ky_generic_netlist_reader.component.__equ__ = myEqu
+
+# Generate an instance of a generic netlist, and load the netlist tree from
+# video.xml. If the file doesn't exist, execution will stop
+net = ky_generic_netlist_reader.netlist(sys.argv[1])
+
+# Open a file to write too, if the file cannot be opened output to stdout
+# instead
+try:
+ f = open(sys.argv[2], 'w')
+except IOError:
+ print >> sys.stderr, __file__, ":", e
+ f = stdout
+
+# 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(net.components)))
+
+row = "| Ref | " + "Qnty | "
+row += "Value | " + "Part | "
+row += "Description | "
+#row += "Datasheet | "
+row += "PartNumber | " + "Vendor |
|---|
"
+
+html = html.replace('', row + "")
+
+# Get all of the components in groups of matching parts + values
+# (see ky_generic_netlist_reader.py)
+grouped = net.groupComponents()
+
+# 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:
+ refs += component.getRef() + ", "
+ c = component
+
+ row = "| " + refs +" | " + str(len(group))
+ row += " | " + c.getValue() + " | "
+ row += c.getLib() + "/" + c.getPart() + " | "
+ #row += c.getDatasheet() + " | "
+ row += c.getDescription() + " | "
+ row += c.getField("PartNumber") + " | "
+ row += c.getField("Vendor")
+ row += " |
"
+
+ html = html.replace('', row + "")
+
+# Print the formatted html to output file
+print >> f, html
diff --git a/scripts/bom-in-python/ky/bom_example4.py b/scripts/bom-in-python/bom_html_grouped_by_value.py
similarity index 89%
rename from scripts/bom-in-python/ky/bom_example4.py
rename to scripts/bom-in-python/bom_html_grouped_by_value.py
index 201c041e39..d1cb8912f7 100644
--- a/scripts/bom-in-python/ky/bom_example4.py
+++ b/scripts/bom-in-python/bom_html_grouped_by_value.py
@@ -5,7 +5,7 @@
#
# Import the KiCad python helper module and the csv formatter
-import ky
+import ky_generic_netlist_reader
import sys
# Start with a basic html template
@@ -27,10 +27,10 @@ html = """