Skip to content

Feature: Additional header lines #593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Simon-SGB wants to merge 4 commits into from
Closed

Feature: Additional header lines #593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ece74fa
Add argument to add a header line
Oct 14, 2026
d7b55a4
Add header lines to config
Oct 14, 2026
3bb8500
Add header_lines to pcbdata metadata in ibom main
Oct 14, 2026
9119dc7
Show header-lines in frontend
Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions InteractiveHtmlBom/core/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ class Config:
kicad_text_formatting = True

# Extra fields section
header_lines = []
extra_data_file = None
netlist_initial_directory = '' # This is relative to pcb file directory
show_fields = default_show_group_fields
Expand Down Expand Up @@ -457,6 +458,10 @@ def add_options(cls, parser, version):
help='Do not blacklist components with empty value.')

# Fields section
parser.add_argument('--header-line', dest='header_lines',
action='append', default=[], metavar='TEXT',
help='Additional line shown in the BOM header. '
'Can be given multiple times.')
parser.add_argument('--netlist-file',
help='(Deprecated) Path to netlist or xml file.')
parser.add_argument('--extra-data-file',
Expand Down Expand Up @@ -632,6 +637,7 @@ def set_from_args(self, args):
self.include_nets = args.include_nets

# Fields
self.header_lines = args.header_lines
self.extra_data_file = args.extra_data_file or args.netlist_file
if args.extra_fields is not None:
self.show_fields = self.default_show_group_fields + \
Expand Down
1 change: 1 addition & 0 deletions InteractiveHtmlBom/core/ibom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,7 @@ def main(parser, config, logger):

pcbdata["bom"] = generate_bom(components, config)
pcbdata["ibom_version"] = config.version
pcbdata["metadata"]["header_lines"] = list(config.header_lines)

# build BOM
bom_file = generate_file(pcb_file_dir, pcb_file_name, pcbdata, config)
Expand Down
1 change: 1 addition & 0 deletions InteractiveHtmlBom/web/ibom.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
<td id="board-info">
<div id="title" class="title metadata-field">Title</div>
<div id="company" class="metadata-field">Company</div>
<div id="header-lines"></div>
</td>
<td id="revision-info">
<div id="revision" class="title metadata-field">Revision</div>
Expand Down
7 changes: 7 additions & 0 deletions InteractiveHtmlBom/web/ibom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -895,6 +895,13 @@ function populateMetadata() {
document.getElementById("title").innerHTML = pcbdata.metadata.title;
document.getElementById("revision").innerHTML = "Rev: " + pcbdata.metadata.revision;
document.getElementById("company").innerHTML = pcbdata.metadata.company;
var container = document.getElementById("header-lines");
(pcbdata.metadata.header_lines || []).forEach(function (line) {
var div = document.createElement("div");
div.textContent = line;
container.appendChild(div);
});

document.getElementById("filedate").innerHTML = pcbdata.metadata.date;
["title", "revision", "company", "date"].forEach(function(field) {
var element = document.getElementById(field === "date" ? "filedate" : field);
Expand Down