ddclark/Ennnn_NAME_PCBA
Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Renamed README.md to README_KiCAD_template.md to differentiate it from the project README

Browse Source 
- Created project README.md
This commit is contained in:
David Clark 2024-09-14 20:26:48 -07:00
parent f680ecfb71
commit f12005ce67
3 changed files with 224 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
1_Design/Ennnn_NAME_PCBA.kicad_pro
View File

@ -221,7 +221,87 @@
"mfg": "",
"mpn": ""
},
"layer_presets": [],
"layer_presets": [
{
"activeLayer": -2,
"layers": [
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
40,
44,
49,
55,
56,
57,
58,
59
],
"name": "Front Assembly",
"renderLayers": [
125,
126,
127,
128,
129,
130,
133,
134,
135,
136,
137,
138,
140,
141,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
157,
158,
159,
160,
161,
164,
165
]
}
],
"viewports": []
},
"boards": [],

143
README.md
View File

@ -1,142 +1 @@
# DDCEE KiCAD project template
## DDCEE KiCAD Library
- clone the git repo located at https://gitea.clarknm.com/ddclark/KiCAD_DDCEE_Library
- the repo contains
-
| Folder | Use |
| ------------ | --------------------- |
| `symbols` | schematic symbols |
| `footprints` | PCB Footprints |
| `templates` | Title block templates |
- use Preferences -> Configure Paths... to add the folling:
-
| Name | Path |
| ----------------------- | ---------------------------------- |
| KICAD_DDCEE_LIBRARIES | <path>/KiCAD_DDC_Library |
| KICAD_USER_TEMPLATE_DIR | <path>/KiCAD_DDC_Library/templates |
- In the schematic editor use Preferences -> Manage Symbol Libraries... to add
-
| Nickname | Library Path | Library Format | | Options | Description |
| -------- | --------------------------------- | -------------- | --- | ------- | ------------------ |
| DDCEE | ${KICAD_DDCEE_LIBRARIES}/symbols/ | KiCad | | | DDC Custom Symbols |
- In the PCB editor use Preferences -> Manage Footprint Libraries... to add
-
| Nickname | Library Path | Library Format | | Options | Description |
| -------- | ----------------------------------- | -------------- | --- | ------- | --------------------- |
| DDCEE | ${KICAD_DDCEE_LIBRARIES}/footprints | KiCad | | | DDC Custom Footprints |
### Naming Conventions
- symbols and footprints will be named with the following convention
- `TT_<n>P_<fp>_<value>_<mfgr pn>`
-
| | Use |
| ------- | --------------------------------------- |
| TT | type (see table below) |
| n | Number of pins |
| fp | Footprint (not required in symbol name) |
| value | Component value (passives) |
| mfgr pn | Manufacturer Part Number |
| | |
### Symbol Types
Symbol types include but are not limited to:
| Type Identifier | Comoponent Type |
| --------------- | -------------------- |
| IC | Integrated Circuit |
| CN | Connector |
| R | Resistor |
| C | Capacitor |
| L | Inductor |
| D | Diode |
| LED | Light Emitting Diode |
| FB | Ferrite Bead |
| LG | Logo |
| SOM | System on Module |
| SOC | System on Chip |
| TP | Test Point |
| | |
## Default Fields
The DDCEE KiCAD symbol library symbol template has the following default fields defined:
| Field | Use |
| --------------------------- | --- |
| Detailed Description | |
| Manufacturer | |
| Manufacturer PN | |
| Supplier 1 | |
| Supplier 1 PN | |
| Supplier 1 Link | |
| Supplier 2 | |
| Supplier 2 PN | |
| Supplier 2 Link | |
| Supplier 3 | |
| Supplier 3 PN | |
| Supplier 3 Link | |
| Assembly instructions | |
| Alternate Manufacturer 1 | |
| Alternate Manufacturer 1 PN | |
| Alternate Manufacturer 2 | |
| Alternate Manufacturer 2 PN | |
These fields are in addition to the standard KiCAD symbol fields.
These fields are defined in the Ennnn_NAME_PCBA.kicad_sch template file
# PCBA Project Versioning
## Background
A PCBA has four design ouputs that completely define the board. These outputs are
- Schematic
- The *schematic* defines all of the components on the bord and how the components are interconnected. This is done in an abstrac way with notional symbols representing components and component connections. The Bill of Material (BoM) is directly tied to the schematic.
- PCB layout artwork
- The *layout* defines the physical implementation of the electronic components and their interconnections on a specific board geometry.
- PCB fabrication diagram
- The *fabrication diagram* defines the manufacturing board. These parameters can include but are not limited to -
- Layer stackup (including thickness)
- Copper weight
- Materials
- Solder mask color
- Testing requirements
- Controlled impedance requirements
- PCBA assembly diagram
- The *assembly diagram* defines specific assembly steps and proceedures. These steps and proceedures can include but are not limited to -
- Mechanical Parts that need to be installed on the board
- Coatings
- Packaging
- Cuts and jumps
- ESD handling requirements
Each of these design outputs should be versioned independently.
## Rationale
- Schematic
- Component values can be changed and pin compatible direct replacement parts can be substituted without affecting the artwork, fabrication, or assembly requirements.
- PCB Layout artwork
- Components can be re-arranged on the board and still adhere to the same schematic, fabrication and assembly parameters.
- If changes in schematic, fabrication, or assembly require a layout change then the layout artwork revision should be incrimented.
- PCB Fabrication Diagram
- Fabrication requirements can change without a change in schematic, artwork, or assembly. For instance core materials and thickness can be changed.
- If changes in schematic, layout artwork, or assembly diagram require changes in the fabrication diagram then the fabrication diagram revision should be incrimented.
- PCBA Assembly Diagram
- Assembly requirements can change without a change in schematic, layout artwork, or fabrication diagram. For instance a conformal coating could be added or removed or a wave solder process could be changed to a hand solder process.
*A change log should be kept for the various design outputs*
https://keepachangelog.com/en/1.1.0/
## Part Number Nomenclature
| Output | Part No | PCB Layer | Revision | Comment |
| --------------------- | --------- | ----------- | -------- | ------------------------------------- |
| Schematic | Ennnn_SCH | Silk | Variable | Schematic can be changed without spin |
| Artwork | Ennnn_ART | Etch | Fixed | Artwork change requires spin |
| PCB Fab Diagram | Ennnn_FAB | Solder Mask | Fixed | PCB fab requires spin |
| PCBA Assembly Diagram | Ennnn_ASY | Silk | Variable | PCBA can be reworked without spin |
# Ennnn_NAME_PCBA

142
README_KiCAD_template.md Normal file
View File

@ -0,0 +1,142 @@
# DDCEE KiCAD project template
## DDCEE KiCAD Library
- clone the git repo located at https://gitea.clarknm.com/ddclark/KiCAD_DDCEE_Library
- the repo contains
-
| Folder | Use |
| ------------ | --------------------- |
| `symbols` | schematic symbols |
| `footprints` | PCB Footprints |
| `templates` | Title block templates |
- use Preferences -> Configure Paths... to add the folling:
-
| Name | Path |
| ----------------------- | ---------------------------------- |
| KICAD_DDCEE_LIBRARIES | <path>/KiCAD_DDC_Library |
| KICAD_USER_TEMPLATE_DIR | <path>/KiCAD_DDC_Library/templates |
- In the schematic editor use Preferences -> Manage Symbol Libraries... to add
-
| Nickname | Library Path | Library Format | | Options | Description |
| -------- | --------------------------------- | -------------- | --- | ------- | ------------------ |
| DDCEE | ${KICAD_DDCEE_LIBRARIES}/symbols/ | KiCad | | | DDC Custom Symbols |
- In the PCB editor use Preferences -> Manage Footprint Libraries... to add
-
| Nickname | Library Path | Library Format | | Options | Description |
| -------- | ----------------------------------- | -------------- | --- | ------- | --------------------- |
| DDCEE | ${KICAD_DDCEE_LIBRARIES}/footprints | KiCad | | | DDC Custom Footprints |
### Naming Conventions
- symbols and footprints will be named with the following convention
- `TT_<n>P_<fp>_<value>_<mfgr pn>`
-
| | Use |
| ------- | --------------------------------------- |
| TT | type (see table below) |
| n | Number of pins |
| fp | Footprint (not required in symbol name) |
| value | Component value (passives) |
| mfgr pn | Manufacturer Part Number |
| | |
### Symbol Types
Symbol types include but are not limited to:
| Type Identifier | Comoponent Type |
| --------------- | -------------------- |
| IC | Integrated Circuit |
| CN | Connector |
| R | Resistor |
| C | Capacitor |
| L | Inductor |
| D | Diode |
| LED | Light Emitting Diode |
| FB | Ferrite Bead |
| LG | Logo |
| SOM | System on Module |
| SOC | System on Chip |
| TP | Test Point |
| | |
## Default Fields
The DDCEE KiCAD symbol library symbol template has the following default fields defined:
| Field | Use |
| --------------------------- | --- |
| Detailed Description | |
| Manufacturer | |
| Manufacturer PN | |
| Supplier 1 | |
| Supplier 1 PN | |
| Supplier 1 Link | |
| Supplier 2 | |
| Supplier 2 PN | |
| Supplier 2 Link | |
| Supplier 3 | |
| Supplier 3 PN | |
| Supplier 3 Link | |
| Assembly instructions | |
| Alternate Manufacturer 1 | |
| Alternate Manufacturer 1 PN | |
| Alternate Manufacturer 2 | |
| Alternate Manufacturer 2 PN | |
These fields are in addition to the standard KiCAD symbol fields.
These fields are defined in the Ennnn_NAME_PCBA.kicad_sch template file
# PCBA Project Versioning
## Background
A PCBA has four design ouputs that completely define the board. These outputs are
- Schematic
- The *schematic* defines all of the components on the bord and how the components are interconnected. This is done in an abstrac way with notional symbols representing components and component connections. The Bill of Material (BoM) is directly tied to the schematic.
- PCB layout artwork
- The *layout* defines the physical implementation of the electronic components and their interconnections on a specific board geometry.
- PCB fabrication diagram
- The *fabrication diagram* defines the manufacturing board. These parameters can include but are not limited to -
- Layer stackup (including thickness)
- Copper weight
- Materials
- Solder mask color
- Testing requirements
- Controlled impedance requirements
- PCBA assembly diagram
- The *assembly diagram* defines specific assembly steps and proceedures. These steps and proceedures can include but are not limited to -
- Mechanical Parts that need to be installed on the board
- Coatings
- Packaging
- Cuts and jumps
- ESD handling requirements
Each of these design outputs should be versioned independently.
## Rationale
- Schematic
- Component values can be changed and pin compatible direct replacement parts can be substituted without affecting the artwork, fabrication, or assembly requirements.
- PCB Layout artwork
- Components can be re-arranged on the board and still adhere to the same schematic, fabrication and assembly parameters.
- If changes in schematic, fabrication, or assembly require a layout change then the layout artwork revision should be incrimented.
- PCB Fabrication Diagram
- Fabrication requirements can change without a change in schematic, artwork, or assembly. For instance core materials and thickness can be changed.
- If changes in schematic, layout artwork, or assembly diagram require changes in the fabrication diagram then the fabrication diagram revision should be incrimented.
- PCBA Assembly Diagram
- Assembly requirements can change without a change in schematic, layout artwork, or fabrication diagram. For instance a conformal coating could be added or removed or a wave solder process could be changed to a hand solder process.
*A change log should be kept for the various design outputs*
https://keepachangelog.com/en/1.1.0/
## Part Number Nomenclature
| Output | Part No | PCB Layer | Revision | Comment |
| --------------------- | --------- | ----------- | -------- | ------------------------------------- |
| Schematic | Ennnn_SCH | Silk | Variable | Schematic can be changed without spin |
| Artwork | Ennnn_ART | Etch | Fixed | Artwork change requires spin |
| PCB Fab Diagram | Ennnn_FAB | Solder Mask | Fixed | PCB fab requires spin |
| PCBA Assembly Diagram | Ennnn_ASY | Silk | Variable | PCBA can be reworked without spin |