README updates, added example images
This commit is contained in:
parent
000aa189ed
commit
c1069ae769
49
README.md
49
README.md
|
|
@ -53,8 +53,55 @@ Multiple BoM output formats are supported:
|
||||||
* XML
|
* XML
|
||||||
* HTML
|
* HTML
|
||||||
|
|
||||||
|
Output file format selection is set by the output filename. e.g. "bom.html" will be written to a HTML file, "bom.csv" will be written to a CSV file.
|
||||||
|
|
||||||
### Configuration File
|
### Configuration File
|
||||||
BoM generation options can be configured (on a per-project basis) by editing the *.bom* file in the PCB project directory. This file is generated the first time that the KiBoM script is run, and allows configuration of the following options.
|
BoM generation options can be configured (on a per-project basis) by editing the *.bom* file in the PCB project directory. This file is generated the first time that the KiBoM script is run, and allows configuration of the following options.
|
||||||
* Number Rows: Add row numbers to the BoM output
|
* Number Rows: Add row numbers to the BoM output
|
||||||
* Ignore DNF: Component groups marked as 'DNF' (do not fit) will be excluded from the BoM output
|
* Ignore DNF: Component groups marked as 'DNF' (do not fit) will be excluded from the BoM output
|
||||||
* Ignore Columns: A list of columns can be marked as 'ignore', and will not be output to the BoM file. By default, the *Part_Lib* and *Footprint_Lib* columns are ignored.
|
* Ignore Columns: A list of columns can be marked as 'ignore', and will not be output to the BoM file. By default, the *Part_Lib* and *Footprint_Lib* columns are ignored.
|
||||||
|
|
||||||
|
## Example - HTML Output
|
||||||
|
|
||||||
|
A simple schematic is shown below. Here a number of resistors, capacitors, and one IC have been added to demonstrate the BoM output capability.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Here, a number of logical groups can be seen:
|
||||||
|
|
||||||
|
** R1 R2 **
|
||||||
|
Resistors R1 and R2 have the same value (470 Ohm) even though the value is expressed differently.
|
||||||
|
Resistors R1 and R2 have the same footprint
|
||||||
|
|
||||||
|
** R3 R4 **
|
||||||
|
Resistors R3 and R4 have the same value and the same footprint
|
||||||
|
|
||||||
|
** R5 **
|
||||||
|
While R5 has the same value as R3 and R4, it is in a different footprint and thus cannot be placed in the same group.
|
||||||
|
|
||||||
|
** C1 C2 **
|
||||||
|
C1 and C2 have the same value and footprint
|
||||||
|
|
||||||
|
** C3 C4 **
|
||||||
|
C3 and C4 have the same value and footprint
|
||||||
|
|
||||||
|
** C5 **
|
||||||
|
C5 has a different footprint to C3 and C4, and thus is grouped separately
|
||||||
|
|
||||||
|
A HTML BoM file is generated as follows:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
To add the BoM script, the Command Line options should be configured as follows:
|
||||||
|
* path-to-python-script (KiBOM_CLI.py)
|
||||||
|
* netlist-file "%I"
|
||||||
|
* output_path "%O_bom.html" (replace file extension for different output file formats)
|
||||||
|
|
||||||
|
Hit the "Generate" button, and the output window should show that the BoM generation was successful.
|
||||||
|
|
||||||
|
The output HTML file is generated as follows:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Here the components are correctly grouped, with links to datasheets where appropriate, and fields color-coded.
|
||||||
|
|
||||||
|
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 94 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Loading…
Reference in New Issue