Add my tool to BOM list

hildogjr · May 18, 2019, 6:01pm

Where KiCad/Eeschema keep the info of the BOM plugins list? (How can I add externally my tool to this list?)

bobc · May 18, 2019, 6:25pm

It’s in the “eeschema” config file, in the KiCad config folder. There is an entry “bom_plugins” which has the list in sexpr style.

Edit; there is some code in KiPi which may or may not be useful …

github.com

bobc/kicad-getlibs/blob/master/kipi/kicad_getlibs.py#L968


                new_list.append (plugin)

    if changes and not args.test:
        s = sexpdata.dumps (new_list)
        # save into config
        config = update_config_file (config, "bom_plugins", escape(s))
        write_config_file (os.path.join(paths.kicad_config_dir, "eeschema"), config)

# xsltproc -o "%O.csv" "C:\Program Files\KiCad\bin\scripting\plugins\bom_cvs.xsl" "%I"

def add_bom_plugin_entry (paths, name, cmd):
    # get from eeschema config
    config = read_config_file (os.path.join(paths.kicad_config_dir, "eeschema"))
    bom_plugins_raw = [p for p in config if p.startswith ("bom_plugins")]

    new_list = []
    new_list.append (Symbol("plugins"))

    if len(bom_plugins_raw)==1:
        bom_plugins_raw = after (bom_plugins_raw[0], "bom_plugins=")
        bom_plugins_raw = de_escape (bom_plugins_raw)

hildogjr · May 18, 2019, 6:30pm

Thanks @bobc.
This file answer my next question: where is the file at MacOS and Windows.

bobc · May 18, 2019, 6:40pm

That’s a very good question!

If the user is using the default setup, in Windows it’s in “C:\Users\__user__\AppData\Roaming\kicad”. However, if the user has redefined KICAD_CONFIG_HOME then you should be able to get that from the process environment. If you are running a script outside of the KiCad process environment you may need to ask the user.

There is also code in KiPi to get the config location in MacOS, I don’t really know anything about MacOS though https://github.com/bobc/kicad-getlibs/blob/master/kipi/kicad_getlibs.py#L170 so it might not even work.

system · August 16, 2019, 6:40pm

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.