# How to use the 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>`
        - `TT` - type
        - `n` - number of pins
        - `fp` - footprint
        - `value' - component value
        - `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 also defined in the Pnnnnnn_NAME_PCBA.kicad_sch template file