Skip to content

Commit

Permalink
Added starting Kicad checklists to project docs
Browse files Browse the repository at this point in the history
  • Loading branch information
madeinoz67 committed Jan 4, 2025
1 parent e3e256c commit efcde4b
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 6 deletions.
19 changes: 19 additions & 0 deletions {{cookiecutter.project_name}}/docs/checklists/kicad_jlpcb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Kicad Checklist for Manufacturing with JLPCB

- [ ] Design schematic should be complete and error-free, ensuring all components are correctly placed and connected.
- [ ] Design footprints for each component have been created or verified against manufacturer's guidelines.
- [ ] All passive and active components have their values correctly labeled.
- [ ] Component placements and routing follow the manufacturer's recommendations and design rules.
- [ ] Board layout adheres to the required standards (size, thickness, etc.).
- [ ] Ensure there are no unconnected nets or floating nodes on the board.
- [ ] Verify all power and ground connections are robust and able to handle the expected current.
- [ ] Designated areas for mounting holes are present and marked correctly in the design files.
- [ ] Create a Bill of Materials (BOM) including part numbers, quantities, and references using the KiCad tool.
- [ ] Include any necessary decals or silkscreen text on the board layout.
- [ ] Generate Gerber files from the PCB new tool in KiCad for manufacturing. These should include: top copper layer, bottom copper layer, drill holes, edge cuts, and other necessary layers as per your design.
- [ ] Check that the Gerber files are free of errors and contain all required information.
- [ ] Ensure the Gerber file format matches the manufacturer's requirements (e.g., RS-274X).
- [ ] Save a copy of all design files in a safe location for future reference.
- [ ] Submit the necessary manufacturing files to the selected PCB manufacturer, ensuring they are properly labeled and identified.
- [ ] Verify that the manufacturer has received all required information and files.
- [ ] Follow up with the manufacturer to ensure your order is being processed as expected.
10 changes: 10 additions & 0 deletions {{cookiecutter.project_name}}/docs/checklists/kicad_pcb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- [ ] Check all components are placed correctly on the PCB layout.
- [ ] Verify all traces are routed properly with no shorts or overlaps.
- [ ] Ensure there's a clearance between traces and any copper pours.
- [ ] Confirm that all vias are present and routed correctly.
- [ ] Make sure the design rules for Kicad PCB are followed, including trace widths, spacings, and drill sizes.
- [ ] Check that all components have proper footprint assignments.
- [ ] Verify that all necessary courtyards or keepouts are present around sensitive areas.
- [ ] Ensure all text layers (silkscreen, pin numbers) are readable and correct.
- [ ] Confirm that all required documentation is included in the design files (schematic, board layout, gerber files).
- [ ] Review the PCB for any potential manufacturing issues or design flaws.
50 changes: 50 additions & 0 deletions {{cookiecutter.project_name}}/docs/checklists/kicad_schematic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## KiCad Schematic Checklist - initial project setup

- [ ] Ensure the latest version of KiCad is installed and up-to-date.
- [ ] Add JLPCB Fabrication Toolkit Plugin to KiCad.
- [ ] Add JLPCB Kicad library as a submodule in kicad library folder '$ git submodule add https://github.com/CDFER/JLCPCB-Kicad-Library.git'
- [ ] Add any custom Kicad libraries to the 'kicad_libraries' folder.
- [ ] Stack-up aligns with manufacturer capabilities.
- [ ] Schematic template is set up correctly with the project name, revision, and date.

## ESP32 Schematic Checklist

- [ ] ESP32 is correctly placed and oriented, antenna has clearance.
- [ ] ESP32 is connected to the correct power and ground nets.
- [ ] GPIO 34 is only used for input.
- [ ] GPIO 35 is only used for input.
- [ ] GPIO 36 is only used for input.
- [ ] GPIO 39 is only used for input.
- [ ] Do Not Use GPIO 6 (used for flash)
- [ ] Do Not Use GPIO 7 (used for flash)
- [ ] Do Not Use GPIO 8 (used for flash)
- [ ] Do Not Use GPIO 9 (used for flash)
- [ ] Do Not Use GPIO 10 (used for flash)
- [ ] Do Not Use GPIO 11 (used for flash)

## Power Supply Schematic Checklist - schematic design

- [ ] For battery powered projects, ensure the battery management circuit is included.
- [ ] Ensure reverse polarity protection is included.
- [ ] Ensure Poly Fuses are included and sized correctly.

## KiCad Schematic Checklist - schematic design

- [ ] Ensure all components are correctly annotated.
- [ ] Ensure all components are correctly placed and connected.
- [ ] Ensure all components are correctly labeled.
- [ ] Ensure all power and ground connections are robust and able to handle the expected current.
- [ ] Ensure all components are correctly connected to the correct nets.
- [ ] Ensure all components are correctly connected to the correct power and ground nets.
- [ ] Ensure all components are correctly populated with their appropriate footprints.
- [ ] Ensure all components are correctly connected to the correct footprints.
- [ ] Ensure all components are correctly populated with their appropriate value.
- [ ] Ensure all components are correctly populated with their appropriate reference designator.
- [ ] Ensure all components are correctly populated with their appropriate part number.
- [ ] Ensure all components are correctly populated with their appropriate manufacturer's part number.
- [ ] Ensure all components are correctly populated with their appropriate manufacturer's datasheet.
- [ ] Ensure all components can handle expected voltages.
- [ ] Mark all unused pins as no connect.
- [ ] Ensure the schematic is not missing any parts.
- [ ] Ensure the schematic is not missing any power or ground connections.
- [ ] Ensure the schematic is not missing any footprints.
2 changes: 0 additions & 2 deletions {{cookiecutter.project_name}}/docs/checklists/sample.md

This file was deleted.

2 changes: 0 additions & 2 deletions {{cookiecutter.project_name}}/docs/checklists/sample2.md

This file was deleted.

7 changes: 5 additions & 2 deletions {{cookiecutter.project_name}}/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ theme:
nav:
- Home: index.md
- Checklists:
- KiCAD:
- Schematic: checklists/kicad_schematic.md
- PCB: checklists/kicad_pcb.md
- Manufacturing - JLPCB: checklists/kicad_jlpcb.md
- checklists/sample.md
- checklists/sample2.md
- Hardware:
Expand Down Expand Up @@ -71,9 +75,8 @@ markdown_extensions:
generic: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_generator: !!python/name:materialx.emoji.to_svg # Copyright

# Copyright
copyright: Copyright © 2021 {{cookiecutter.author_name}}

# footer customisation
Expand Down

0 comments on commit efcde4b

Please sign in to comment.