Interactive Html Bom Plugin for KiCad

qu1ck · August 8, 2018, 4:36am

I wasn’t able to reproduce this. Please add repro steps in the bug.

qu1ck · August 8, 2018, 7:50am

I just implemented dark mode in html. I know I was tired of staring at mostly white screen

Also recorded a screen capture to showcase the plugin, added it to first post and the demo page for whoever finds this in the future.

qu1ck · August 13, 2018, 8:01am

Last beta before stable release:

Again, bunch of fixes and few cool features: dark mode, keyboard shortcuts, optimized render and reverse lookup by clicking on component drawing!

ramprasadajay · August 14, 2018, 6:34am

Nice update. Waiting for the stable release with more features.

maui · August 14, 2018, 3:32pm

Hi @qu1ck
I would like to use the toolbar button technique to add an other button to pcbnew toolbar (i.e. annular action plugin) and I noticed that if I simply add the button with a function similar to your check_for_bom_button() routine, sometimes pcbnew get stuck or starts with a messed toolbar…
At the moment I delayed my adding function in init to let your script add its iBOM btn, but I would like to have something more flexible…
Do you think it would be possible to handle the event to add more than a button from different plugins? Have you any suggestion?
Thanks
Maurice

qu1ck · August 14, 2018, 11:26pm

Hi @maui,
The button code in my plugin is probably the dirtiest hack I ever wrote. It just plain doesn’t work on linux because it tries to issue draw calls from wrong thread, which X11 doesn’t like, it is not thread safe and will likely not work well if many buttons are added in different threads.
There is no way to do this properly right now, support needs to be added in pcbnew plugin system. I have some ideas about that and will work with KiCad devs to make it reality when I get to write them down.

In the meantime make sure that you launch the function in a separate daemon thread in your plugin. It has to work asynchronously and try to add the button with a delay. Pcbnew window has to finish loading before button is added, otherwise pcbnew will get messed up or just overwrite the toolbar state.

Also try increasing and varying the delay in your button adding thread to minimize the chances of it racing against ibom button thread.

If nothing works then, well you have to chose which button you want in pcbnew. Disabling button code is as simple as commenting out last 3 lines of __init__.py. The plugin will still show up in tools -> external plugins.

maui · August 15, 2018, 7:13am

@qu1ck
thanks a lot for your clarifications… I’m using already the two buttons in my personal repo… I will wait for your code in kicad’s main branch for a full btn support
Maurice

qu1ck · August 15, 2018, 9:34am

I just sent devs a patch. Let’s see how it goes

qu1ck · August 28, 2018, 6:51pm

I ended up implementing this myself.

In recent nightlies you can now have buttons on the toolbar with custom icons. See plugin documentation on how to do that. Users can show/hide and reorder them at will.

This is good news for my plugin too as it unblocks installs for linux. That will be available soon.

SembazuruCDE · August 28, 2018, 7:43pm

Sweet! Thank you for all your work.

qu1ck · August 29, 2018, 6:04am

I just pushed to master update that should fix crashes on Linux. If you use KiCad nightlies on linux please test this, you can install the plugin in ~/.kicad/scripting/plugins or ~/.kicad_plugins.
Ubuntu nightlies have scripting turned off for whatever reason. I hope other distributions have it enabled so it should work. I tested this on debian 8 and 10 with kicad built from source.

If I will not get any bug reports I’ll tag current revision as V1.

Edit: you can install on stable 5.0 in linux as well, there just will be no button and you should be able to use it from tools menu.

qu1ck · September 4, 2018, 6:44pm

Would you look at that, its featured on hackaday

BTW v1 is out.

R_INYURU · September 7, 2018, 8:08am

I have created .kicad_plugin and extracted the plugin, I then restarted KiCAD but I can’t find the plugin in tools menu.

I am using:

Application: kicad
Version: 5.0.0-fee4fd1~66~ubuntu16.04.1, release build
Libraries:
wxWidgets 3.0.4
libcurl/7.58.0 OpenSSL/1.0.2n zlib/1.2.11 libidn2/2.0.4 libpsl/0.19.1 (+libidn2/2.0.4) nghttp2/1.30.0 librtmp/2.3
Platform: Linux 4.15.0-33-generic x86_64, 64 bit, Little endian, wxGTK
Build Info:
wxWidgets: 3.0.2 (wchar_t,wx containers,compatible with 2.8) GTK+ 2.24
Boost: 1.58.0
OpenCASCADE Community Edition: 6.8.0
Curl: 7.47.0
Compiler: GCC 5.4.0 with C++ ABI 1009

Build settings:
USE_WX_GRAPHICS_CONTEXT=OFF
USE_WX_OVERLAY=OFF
KICAD_SCRIPTING=ON
KICAD_SCRIPTING_MODULES=ON
KICAD_SCRIPTING_WXPYTHON=OFF
KICAD_SCRIPTING_ACTION_MENU=ON
BUILD_GITHUB_PLUGIN=ON
KICAD_USE_OCE=ON
KICAD_USE_OCC=OFF
KICAD_SPICE=ON

qu1ck · September 7, 2018, 9:25am

It should be .kicad_plugins. Also make sure you don’t have any intermediate folders. It should be .kicad_plugins/InteractiveHtmlBom/__init__.py …

R_INYURU · September 7, 2018, 1:13pm

Thanks, there was an intermediate folder.
I removed it and opened the PCBnew, when I tried to refresh plugins in tools menu it freezes, then I restart KiCAD but when I try to open PCBnew, KiCAD is crushing.

Note: recently I have upgrade ubuntu from 16.04 to 18.04 but KiCAD shows the version as of ubuntu 16.04.

qu1ck · September 7, 2018, 6:12pm

Ubuntu 18.04 and derivatives (mint 19) have known issue with mismatch of wxwidgets and wxpython gtk versions. I’m sorry but there is nothing I can do about it, you have to use the plugin from command line.
KiCad devs are aware of this and are working to fix this in 5.1.

On Debian testing I was able to work around this by downgrading python-wxgtk3.0 version to 3.0.2.0+dfsg-6 which is build against gtk2. If you know what you are doing you might be able to do the same on ubuntu.

R_INYURU · September 9, 2018, 5:12pm

Thanks you, just I will use the command.

qu1ck · September 16, 2018, 6:10am

v1.1 is out!

As usual, aside from bugfixes there are some cool new features:

Highlight first pin of all components (option in settings)
All bom columns are sortable by clicking on header.
Checkbox columns can be cleared/set for all displayed rows by double clicking header.
Board rotation (option in settings)
Pixel perfect text rendering with native kicad font.

Rene_Poschl · September 17, 2018, 11:45am

What is your used pin number list for that?

qu1ck · September 17, 2018, 4:45pm

Right now just “1” or “A1”. Are there other common names I should check?

github.com

openscopeproject/InteractiveHtmlBom/blob/master/InteractiveHtmlBom/generate_interactive_bom.py#L305


#!/usr/bin/python3
from __future__ import absolute_import

import argparse
import os
import sys


# python 2 and 3 compatibility hack
def to_utf(s):
    if isinstance(s, bytes):
        return s.decode('utf-8')
    else:
        return s


if __name__ == "__main__":
    # Add ../ to the path
    # Works if this script is executed without installing the module
    script_dir = os.path.dirname(os.path.abspath(__file__))
    sys.path.insert(0, os.path.dirname(script_dir))
    os.environ['INTERACTIVE_HTML_BOM_CLI_MODE'] = 'True'
    import InteractiveHtmlBom

    from InteractiveHtmlBom.core import ibom
    from InteractiveHtmlBom.core.config import Config
    from InteractiveHtmlBom.ecad import get_parser_by_extension
    from InteractiveHtmlBom.version import version
    from InteractiveHtmlBom.errors import (ExitCodes, ParsingException,
                                          exit_error)

    create_wx_app = 'INTERACTIVE_HTML_BOM_NO_DISPLAY' not in os.environ
    if create_wx_app:
        import wx
        app = wx.App()

    parser = argparse.ArgumentParser(
            description='KiCad InteractiveHtmlBom plugin CLI.',
            formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    parser.add_argument('file',
                        type=lambda s: to_utf(s),
                        help="KiCad PCB file")
    config = Config(version)
    config.add_options(parser, config.FILE_NAME_FORMAT_HINT)
    args = parser.parse_args()
    logger = ibom.Logger(cli=True)
    if not os.path.isfile(args.file):
        exit_error(logger, ExitCodes.ERROR_FILE_NOT_FOUND,
                   "File %s does not exist." % args.file)
    print("Loading %s" % args.file)
    parser = get_parser_by_extension(os.path.abspath(args.file), config, logger)
    if args.show_dialog:
        if not create_wx_app:
            exit_error(logger, ExitCodes.ERROR_NO_DISPLAY, "Can not show dialog when "
                       "INTERACTIVE_HTML_BOM_NO_DISPLAY is set.")
        try:
            ibom.run_with_dialog(parser, config, logger)
        except ParsingException as e:
            exit_error(logger, ExitCodes.ERROR_PARSE, e)
    else:
        config.set_from_args(args)
        try:
            ibom.main(parser, config, logger)
        except ParsingException as e:
            exit_error(logger, ExitCodes.ERROR_PARSE, str(e))