#
# Example python script to generate a BOM from a KiCad generic netlist
#
# Example: Sorted and Grouped CSV BOM
#

"""
    @package
    Generate a Tab delimited list (csv file type).
    Components are sorted by ref and grouped by value with same footprint
    Components with a field 'Installed' set to 'NU' (Normally Uninstalled) are not included in the BOM
    Fields are (if exist)
    'Ref', 'Qnty', 'Value', 'Footprint', 'Description', 'Vendor', 'Vendor_nr', 'Manufacturer', 'Manufacturer_nr'

    Command line:
    python "pathToFile/custom_bom_csv_grouped_by_value_with_fp.py" "%I" "%O.csv"
"""

# Import the KiCad python helper module and the csv formatter
import kicad_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 = 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, sys.stderr)
    f = sys.stdout

# Create a new csv writer object to use as the output formatter
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( ['Generator:', sys.argv[0]] )
#out.writerow(['Component Count:', len(net.getInterestingComponents())])
out.writerow(['REF', 'QNTY', 'VALUE', 'DESCRIPTION', 'VENDOR', 'VENDOR_NR', 'MANUFACTURER', 'MANUFACTURER_NR'])

# Get all of the components in groups of matching parts + values
# (see ky_generic_netlist_reader.py)
grouped = net.groupComponents(net.getInterestingComponents())

# 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

    if not (refs == ""):
        refs = refs[:-2] # Remove last comma
        # Fill in the component groups common data
        out.writerow([refs, len(group), c.getValue(), c.getField("Description"), c.getField("Vendor"),
        c.getField("Vendor_nr"), c.getField("Manufacturer"), c.getField("Manufacturer_nr")])