TPS54331DDA

Znibb's Personal Kicad LIBrary

Table of Contents

• 1. Description
• 2. Setup
  • 2.1. Inventree
  • 2.2. Kicad
• 3. Usage
  • 3.1. Helper scripts
  • 3.2. Bulk update Inventree
  • 3.3. Adding components to categories
  • 3.4. Assemblies
  • 3.5. Releasing a project
  • 3.6. Customizing category symbols
• 4. KiCad layer specific usage
• 5. EMS Capabilities

1. Description

The name of your KiCad symbol libraries will be LIBRARY_FILE_NAME - TOP_LEVEL_CATEGORY/SUBCATEGORY, meaning that if your setup is using:

- Library file name: zpklib.kicad_httplib
- Inventree top level category name: kicad-parts
- Subcategory: Resistor

your resistors will show up under a symbol library named zpklib - kicad-parts/Resistor

2. Setup

2.1. Inventree

1. Log into the Inventree web UI and access the Django admin panel by appending /admin/ to the URL (NOTE the trailing forward slash)
2. Scroll down to USERS->API Tokens, click it and then click ADD API TOKEN +
3. Take nto of the Key, select which User the key is for and click SAVE

2.2. Kicad

1. Create a python venv and install the required packages: ./setup-venv.sh
2. Create the httplib file: setup-inventree-httplib.sh
3. Check that the Inventree server is reachable: ./check_inventree_connection.py
4. Open the KiCad main window, go to Preferences->Configure Paths...
5. Add an Environment Variable called ZPKLIB_DIR that points to your local library path and click OK
6. Go to Preferences->Manage Symbol Libraries... and click Add existing->HTTP (.kicad_httplib)
7. Select zpklib.kicad_httplib and click Open

3. Usage

3.1. Helper scripts

3.2. Bulk update Inventree

1. Source the venv: . .venv/bin/activate
2. Analyze the contents of inventree_structure.yaml
3. Applying the structure by running: ./patch_inventree_structure.py

3.3. Adding components to categories

1. Source the venv: . .venv/bin/activate
2. Run ./create_part.py

3.4. Assemblies

1. Source the venv: . .venv/bin/activate
2. Reserve an assembly IPN (can be run from any directory): ./next_assembly_ipn.py. It prompts for the assembly name, creates the part under electronic-assemblies and prints the IPN and a link to it
3. In KiCad, go to Schematic Setup->Project->Text Variables and add PART_NUMBER with the printed IPN
4. Generate the production files, then upload the assembly information (BOM, revision, description and image) to that IPN: ./update_assembly.py PROJECT_DIR

3.5. Releasing a project

1. In the Kicad project, set the VERSION and RELEASE_DATE text variables, add a ## vX.Y.Z section to CHANGELOG.md, run the production jobset, then commit and push
2. Create the git tag and GitHub release and upload the production files: ./release_project.py PROJECT_DIR

The script needs git and an authenticated gh. It aborts if the working tree is dirty, HEAD isn't pushed, or any file name's _vX.Y.Z_ doesn't match VERSION. If the tag or release already exists you are asked before it is overwritten. The uploaded files are set by FILE_PATTERNS at the top of the script, and the release notes are the matching CHANGELOG.md section.

3.6. Customizing category symbols

Kicad handles the default symbol fields reference, value, footprint, datasheet, description, keywords in it's own batch, showing reference and value while hiding the rest by default.

To hide any of the default fields add:

kicad:
    hide_fields: "FIELD_NAME"

to that category in inventree_structure.yaml.

The rest of the symbol fields are considered "extra" fields. To make an extra field visible on the symbol add:

kivad:
    show_extra_fields: "FIELD_NAME"

to that category in inventree_structure.yaml.

4. KiCad layer specific usage

5. EMS Capabilities

EMS:

• JLCPCB