ebomgen

README

eBOMGen

1. Introduction

eBOMGen is a tool to auto generate bom from EDA design file, it support Kicad, Eagle, Orcad, Altium or Mentor Graphics etc.

2. Getting started

2.1. Install

git clone github.com/saycv/ebomgen
cd ebomgen && make install

2.2. Usage

echo Process PADSLogic ASCII file
ebomgen -t padslogic -i test/pads/SCH/ex1.txt -o test/pads/BOM
echo Process PADSPCB ASCII file
ebomgen -t padspcb -i test/pads/PCB/ex2.asc -o test/pads/BOM

echo Process AltiumPCB ASCII file
ebomgen -t altiumpcb -i test/altium/PCB/ex4.PcbDoc -o test/altium/BOM

3. TODO

• Process Altium file
• Process Eagle file
• Process Kicad file
• Process OrCAD file
• Process PADSLogic or PADSPCB file
• Export CSV file
• Export Exls file
• Sorted Components
• Sorted References
• Calc BOMCOST based WEB
• Calc BOMMTBF based PCP
• More humane
• More smart

4. Example

4.1. BOM

Item,References,Quantity,Value,Footprint,Description
1,"C1,C2",2,"???"," DCAP1","Capacitor"
2,"C3,C4,C5,C6,C7,C8,C9,C10,C11,C12,C13,C14,C15,C16,C17,C18,C19,C20,C21,C22",20,".01UF"," DCAP1","Capacitor"
3,"R1,R2",2,"1K"," R1/8W","Resistor"
4,"Y1",1,"XTAL1"," XTAL1","Crystal"
5,"U12,U13,U14,U15,U16,U17,U18,U19,U20,U21",10,"6167"," DIP20","IC"
6,"U1",1,"74139"," DIP16","IC"
7,"U9,U11",2,"7400"," DIP14","IC"
8,"U2,U6",2,"7404"," DIP14","IC"
9,"U3",1,"7402"," DIP14","IC"
10,"U7",1,"7440"," DIP14","IC"
11,"U8",1,"7420"," DIP14","IC"
12,"U4",1,"7474"," DIP14","IC"
13,"U5",1,"7432"," DIP14","IC"
14,"P1",1,"CON\26P\ED"," CON\26P\ED","Connector"

4.2. BOMCOST

Item,References,Quantity,Value,Footprint,Description,UnitPrice,TotalPrice
1,"C3,C4,C5,C6,C7,C8,C9,C10,C11,C12,C13,C14,C15,C16,C17,C18,C19,C20,C21,C22",20,".01UF"," DCAP1","Capacitor","0.00220","=C2*G2"
2,"C1,C2",2,"???"," DCAP1","Capacitor","0.00220","=C3*G3"
3,"R1,R2",2,"1K"," R1/8W","Resistor","0.00260","=C4*G4"
4,"Y1",1,"XTAL1"," XTAL1","Crystal","","=C5*G5"
5,"U12,U13,U14,U15,U16,U17,U18,U19,U20,U21",10,"6167"," DIP20","IC","0.14043","=C6*G6"
6,"U1",1,"74139"," DIP16","IC","2.92616","=C7*G7"
7,"U4",1,"7474"," DIP14","IC","0.20825","=C8*G8"
8,"U7",1,"7440"," DIP14","IC","1.98000","=C9*G9"
9,"U5",1,"7432"," DIP14","IC","0.34000","=C10*G10"
10,"U8",1,"7420"," DIP14","IC","0.08910","=C11*G11"
11,"U2,U6",2,"7404"," DIP14","IC","0.99180","=C12*G12"
12,"U3",1,"7402"," DIP14","IC","0.08316","=C13*G13"
13,"U9,U11",2,"7400"," DIP14","IC","0.35960","=C14*G14"
14,"P1",1,"CON\26P\ED"," CON\26P\ED","Connector","1.40880","=C15*G15"
,,,,,,Total BOMCOST,=sum(H2:H15),USD
,,,,,,Total BOMCOST,=sum(H16*7.087600),CNY

4.3. BOMMTBF

Documentation

Index

• Variables
• func AddGroup(groupdeflist []types.EBOMGroup, reference string, pt string, gt string, ...) []types.EBOMGroup
• func AddGroup3(groupdeflist []types.EBOMGroup, reference string, pt string, gt string) []types.EBOMGroup
• func CalcMtbfBasedPCP(config configuration.Configuration) error
• func CalcMtbfBasedPCPMain(config configuration.Configuration) error
• func ExtractComponents(config configuration.Configuration) error
• func FetchPriceFromDigikey(hc *webecd.DigikeyClient, query string) (types.EBOMWebPart, error)
• func FetchPriceFromSzlcsc(hc *webecd.SzlcscClient, query string) (types.EBOMWebPart, error)
• func FetchPriceFromWebecd(config configuration.Configuration) error
• func MergeToOneFile(config configuration.Configuration) error
• func MergeToOneFileMain(config configuration.Configuration) error
• func SetPrecedence(groupdeflist []types.EBOMGroup) []types.EBOMGroup
• func UnmarshalRfqPPFile(filePath string) (map[string]interface{}, map[string]interface{}, error)
• type ComponentItems
  • func (items *ComponentItems) Len() int
  • func (items *ComponentItems) Less(i, j int) bool
  • func (items *ComponentItems) Swap(i, j int)
• type RefItems
  • func (items *RefItems) Len() int
  • func (items *RefItems) Less(i, j int) bool
  • func (items *RefItems) Swap(i, j int)

Variables

var (
	// BuildCommit lastest build commit (set by Makefile)
	BuildCommit = ""
	// BuildTag if the `BuildCommit` matches a tag
	BuildTag = ""
	// BuildTime set by build script (set by Makefile)
	BuildTime = ""
)

Functions

func AddGroup

func AddGroup(groupdeflist []types.EBOMGroup, reference string, pt string, gt string, unt string) []types.EBOMGroup

func AddGroup3

func AddGroup3(groupdeflist []types.EBOMGroup, reference string, pt string, gt string) []types.EBOMGroup

func CalcMtbfBasedPCP

func CalcMtbfBasedPCP(config configuration.Configuration) error

func CalcMtbfBasedPCPMain

func CalcMtbfBasedPCPMain(config configuration.Configuration) error

func ExtractComponents

func ExtractComponents(config configuration.Configuration) error

ExtractComponents converts the content of the given filename into an BOM document. The conversion result is written in the given writer `output`, whereas the document metadata (title, etc.) (or an error if a problem occurred) is returned as the result of the function call.

func FetchPriceFromDigikey

func FetchPriceFromDigikey(hc *webecd.DigikeyClient, query string) (types.EBOMWebPart, error)

func FetchPriceFromSzlcsc

func FetchPriceFromSzlcsc(hc *webecd.SzlcscClient, query string) (types.EBOMWebPart, error)

func FetchPriceFromWebecd

func FetchPriceFromWebecd(config configuration.Configuration) error

func MergeToOneFile

func MergeToOneFile(config configuration.Configuration) error

func MergeToOneFileMain

func MergeToOneFileMain(config configuration.Configuration) error

func SetPrecedence

func SetPrecedence(groupdeflist []types.EBOMGroup) []types.EBOMGroup

func UnmarshalRfqPPFile

func UnmarshalRfqPPFile(filePath string) (map[string]interface{}, map[string]interface{}, error)

Types

type ComponentItems

type ComponentItems struct {
	// contains filtered or unexported fields
}

func (*ComponentItems) Len

func (items *ComponentItems) Len() int

func (*ComponentItems) Less

func (items *ComponentItems) Less(i, j int) bool

func (*ComponentItems) Swap

func (items *ComponentItems) Swap(i, j int)

type RefItems

type RefItems struct {
	// contains filtered or unexported fields
}

func (*RefItems) Len

func (items *RefItems) Len() int

func (*RefItems) Less

func (items *RefItems) Less(i, j int) bool

func (*RefItems) Swap

func (items *RefItems) Swap(i, j int)