Skip to content

zharovdv/InteractiveHTMLBOM4Altium2

Repository files navigation

Interactive HTML BOM plugin for Altium Designer

Supports Altium Designer

This plugin inspired with InteractiveHtmlBomForAD, but (i hope) less of bugs and more of features.

Plugin is ready to use as OutJob Report Output. Based on plugin for KiCad InteractiveHtmlBom.

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 Altium Designer pascal script and API to read Project/SCH/PCB data and render silkscreen, footprint pads, text, and drawings.

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

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.

Example

How to Run

Plugin could be used in a few ways, as a OutJob or as a Script.

Script

  1. Download the entire set of files on your computer or clone repository the way your prefer.
  2. Integrate the script into Altium Designer.
    If you are a newcomer to Altium scripts, please read the "how to" help page.
  3. Run script from pcb layout.
  4. A GUI will open. Select options and run.

OutJob

  1. Download the entire set of files on your computer or clone repository the way your prefer.
  2. Add InteractiveHTMLBOM4Altium2.pas to Project.
  3. In Output Job File add new Report Output, select InteractiveHTMLBOM4Altium2.pas in Script Output.
  4. Configure and generate content.

GUI Screenshot

Note: May take a long time to run depending on board size, board density, & speed of computer. It took my PC 5 seconds to place 200 components and about 50 seconds to place 2000 components on a much more dense board. My PC is relatively fast, so your mileage may vary.

Features

Format

Set output format for generated file.

  1. HTML - fully self contained html page, generated without any dependencies, based on InteractiveHtmlBom with custom js
  2. JS - js file for my own needs
  3. JSON - json file in custom format for my own needs
  4. JSON Generic - json file complies to the schema, that is needed to generate the InteractiveHtmlBom. See project wiki for installation and usage instructions.

About

InteractiveHTMLBOM script for Altium Designer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published