1clickBOM.com
1clickBOM

Available on ChromeAdd to Firefox

Summary

1-click BOM is a browser extension that fills your shopping carts for you on sites like Digikey and Mouser. It's main purpose is to work with the electronic project sharing site kitnic.it. But you can also use it from a spreadsheet or load an online .tsv file from any other site.

Table of Contents

News

Which retailers?

Currently supported retailers are:

Check the roadmap for more details on planned features.

Usage

Making a 1-click-BOM

Eagle

  1. In the schematic window, select "File -> Export -> BOM". Select "List Type" values and "Output Format" CSV (see image) and press save.
  2. Open the .csv in a spreadsheet program (LibreOffice, Excel). Select a semi-colon seperator when importing.
  3. Select everything in your spreadsheet program, copy and paste into the extension.
  4. Press "complete" in the extension, wait till it's done and then press copy.
  5. Open a new spreadsheet and paste into it. Save it as tab-seperated values, with a .tsv extension and UTF-8 encoding.
  6. Check over all the part numbers and make sure they are correct. Put them into your shopping cart using the extension to confirm they have the right minimum order quantity etc.

KiCad

  1. Download the Python files from the output_scripts/kicad directory. Put them all together into a directory where you want to keep them.
  2. In Eeschema, the schematic tool, select Tools -> Generate Bill of Materials then Add Plugin and then Generate Select:
  3. Open the resulting file in a spreadsheet program or text editor and copy and paste it into the extension
  4. Try auto-completing in the extension if you wish, check all the values afterwards
  5. To sync any changes back into your schematic you can use KiField.

Generally

You can copy and paste into the extension from a text editor or spread sheet program (LibreOffice, Excel). You must have a column for references, one for the quantity and at least one of: decription, part number or a retailer column. You can have multiple part number columns for specifying multiple possible manufacturer part numbers per schematic reference.

When saving files from your external editor or spreadsheet save them as tab-seperated values with a .tsv extension with UTF-8 encoding.

Here is a small example which is well suited for auto-completing:

References Qty Description Part Number
C1 1 1uF 0603 X5R
C2 1 10uF 0603 X5R
D1 1 1N4148WS
Q1 1 IRF7309PBF
R1 1 10k 0603
R2,R4 2 100k 0603
R3 1 300k 0603
SW1 1 4-1437565-1

You can find this and other examples in TSV format in the examples directory.

Field Matching

The examples are mostly in the format that the extension will output. Reading is less strict. Below are tables of title aliases 1-click-BOM recognizes. If you have any more suggestions please get in touch. (Capitalisation is ignored, characters within brackets, like(s), denote they are optional.)

References Quantity Description MPN
ref(s) qty(s) comment(s) part(-)number(s)
reference(s) quantity(s) description(s) partnumber(s)
line-note(s) cmnt(s) part number(s)
line note(s) descr(s) m(/)f part(s)
part(s) manuf(.) part(s)
mpn(s)
m(/)f part number(s)
manuf(.) part number(s)
manufacturer part(s)
manufacturer part number(s)
Digikey Mouser RS Newark Farnell
digi(-)key mouser rs newark farnell
rs(-)online fec
rs(-)delivers premier
radio( )spares element14
rs( )components

Loading an online BOM

If you visit a page on kitnic.it or one that ends in .tsv and has data in the right format available 1clickBOM will show a blue badge and button with an arrow. Clicking the blue button will load the data into the extension.

Load from page

Load from page

Let's go shopping!

Once the data is added you can use 1clickBOM to add the items to your carts using the buttons on the popup. You can also quickly view and empty your carts.

Completion

1-click BOM can try and complete an incomplete BOM for you by searching Octopart and Findchips. A complete BOM is where every part has a manufacturer part number and a part number for every retailer. Simply press the button labeled 'Complete' and 1clickBOM will use other fields to search for the fields that are left blank. This works well sometimes and other times selects completely random parts. It really depends on the fields you already give it. We are very much still working on improving this .

Issues

If you need any help or think you found a bug please get in touch via GitHub, or visit the Kitnic chat room

Roadmap

Development

Build and Test Requirements

The code is available on GitHub. To get started you will need:

The rest of the dependencies can be retrieved via npm install.

Build and Test Instructions

Build

Load

Test

Tests are written in QUnit 1.11 and can only be run in Chrome/Chromium. Open a console on background page and execute Test() or test a specific module, e.g. Farnell, with Test('Farnell')

Most of the tests are functional tests that require interaction with the various retailer sites and they make a lot of network requests to test across all the different possible locations. Sometimes they will fail because they are not an accurate representation of actual extension use. If a test fails or doesn't complete, run it again before investigating. Try and re-create the issue manually before trying to fix it.

License

1clickBOM is free and open source software. It is licensed under a CPAL license which means you are free to use the code in your own applications (even proprietary ones) as long as you display appropriate attribution and share your code-improvements to 1clickBOM itself under the CPAL as well. This also applies to software you are solely making available to users over a network i.e. software as a service. See the LICENSE file for details.

logo