- Add dedicated /kicad/ directory with organized subdirectories for libraries, schematics, gerbers, plots, and backups - Create comprehensive KiCad 9 library structure (symbols, footprints, 3D models) - Add manufacturing-ready directories for production files (gerbers, drill, pick-and-place) - Update all README files with KiCad-specific documentation and workflows - Add KiCad-optimized .gitignore file for proper version control - Create KICAD-PROJECT-TEMPLATE.md comprehensive usage guide - Add hardware assembly documentation and BOM management - Include detailed manufacturing file generation instructions - Add docs structure with design-notes and user-manual directories - Provide complete workflow from design to manufacturing with quality checklists
70 lines
2.3 KiB
Markdown
70 lines
2.3 KiB
Markdown
# /hardware/bom
|
|
|
|
Bill of Materials for your KiCad project.
|
|
|
|
## Purpose
|
|
This directory contains Bill of Materials (BOM) files generated from your KiCad schematic and additional BOM-related documentation.
|
|
|
|
## File Types
|
|
- **`.csv`**: Comma-separated values format (most common)
|
|
- **`.xlsx`**: Excel spreadsheet format
|
|
- **`.xml`**: XML format for automated processing
|
|
- **`.html`**: HTML format for web viewing
|
|
- **`.pdf`**: PDF format for documentation
|
|
|
|
## Generating BOM from KiCad
|
|
1. Open your schematic (`.kicad_sch`)
|
|
2. Go to **Tools → Generate Bill of Materials**
|
|
3. Select or configure a BOM plugin
|
|
4. Set output directory to `hardware/bom/`
|
|
5. Click **Generate**
|
|
|
|
## Recommended BOM Formats
|
|
|
|
### Basic BOM (`ProjectName-BOM.csv`)
|
|
- Reference designators
|
|
- Values
|
|
- Footprints
|
|
- Quantities
|
|
- Manufacturer part numbers
|
|
- Supplier part numbers
|
|
|
|
### Extended BOM (`ProjectName-BOM-Extended.xlsx`)
|
|
- All basic information plus:
|
|
- Descriptions
|
|
- Manufacturer names
|
|
- Supplier links
|
|
- Pricing information
|
|
- Stock availability
|
|
- Alternative parts
|
|
|
|
## BOM Structure Example
|
|
```
|
|
Reference | Value | Footprint | Qty | MPN | Supplier | SPN
|
|
----------|------------|------------------|-----|---------------|----------|-------------
|
|
R1,R2,R3 | 10k | R_0603_1608Metric| 3 | RC0603FR-0710KL| Digi-Key | 311-10.0KHRCT-ND
|
|
C1,C2 | 100nF | C_0603_1608Metric| 2 | GRM188R71C104KA01D| Mouser | 81-GRM188R71C104KA1D
|
|
U1 | STM32F401 | LQFP-64_10x10mm | 1 | STM32F401RET6 | Digi-Key | 497-11767-ND
|
|
```
|
|
|
|
## BOM Management Best Practices
|
|
- Include manufacturer part numbers (MPN)
|
|
- Add supplier part numbers for purchasing
|
|
- Include alternative/substitute parts
|
|
- Document any special requirements
|
|
- Update BOM with design changes
|
|
- Version control BOM files
|
|
- Include pricing and availability data
|
|
|
|
## KiCad BOM Plugins
|
|
- **bom_csv_grouped_by_value**: Groups components by value
|
|
- **bom_csv_sorted_by_ref**: Sorts by reference designator
|
|
- **kibom**: Advanced BOM generator with many options
|
|
- **InteractiveHtmlBom**: Creates interactive HTML BOMs
|
|
|
|
## File Naming Convention
|
|
- `ProjectName-BOM.csv` - Basic BOM
|
|
- `ProjectName-BOM-v1.0.csv` - Versioned BOM
|
|
- `ProjectName-BOM-Extended.xlsx` - Detailed BOM with pricing
|
|
- `ProjectName-BOM-Assembly.csv` - Assembly-specific BOM
|