Skip to content

INTI-CMNB/InteractiveHtmlBom

 
 

Repository files navigation

Interactive HTML BOM plugin for KiCad

Supports EasyEDA, Eagle, Fusion360 and Allegro PCB designer

icon

This plugin generates a convenient Bill of Materials (BOM) listing with the ability to visually correlate and easily search for components and their placements on the PCB. It is particularly useful when hand-soldering a prototype, as it allows users to quickly find locations of components groups on the board. It is also possible to reverse lookup the component group by clicking on a footprint on the board drawing.

The plugin utilizes Pcbnew python API to read PCB data and render silkscreen, fab layer, footprint pads, text, and drawings. BOM table fields and grouping is fully configurable, additional columns, such as a manufacturer ID, can be added in Schematic editor and imported either through the netlist file, XML file generated by Eeschema's internal BOM tool, or from board file itself.

There is an option to include tracks/zones data as well as netlist information allowing dynamic highlight of nets on the board.

For full description of functionality see wiki.

Generated html page is fully self contained, doesn't need internet connection to work and can be packaged with documentation of your project or hosted anywhere on the web.

A demo is worth a thousand words.

Installation and Usage

Important: when installing this fork to be used with KiBot you must be sure the generate_interactive_bom.py is in your path. Or at least that the plug-in is accessible from KiCad (KiBot also looks in the KiCad plug-in dirs). For Debian/Ubuntu systems the simplest way is to install the Debian package provided by this fork, check the releases section

See project wiki for instructions.

License and credits

Plugin code is licensed under MIT license, see LICENSE for more info.

Html page uses Split.js, PEP.js and (stripped down) lz-string.js libraries that get embedded into generated bom page.

units.py is borrowed from KiBom plugin (MIT license).

svgpath.py is heavily based on svgpathtools module (MIT license).

About

Interactive HTML BOM generation plugin for KiCad

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 79.1%
  • JavaScript 15.1%
  • CSS 2.9%
  • HTML 2.2%
  • Other 0.7%