Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Templates are made by us, so if anything seems odd, let an admin know and we can make edits!

Expand
  1. Open the “Components” panel. Location depends on your configuration, but often is in the right sidebar. If not open, you can open it via the “Panels” button in the bottom right

    Image Modified
  2. Search for the component MPN you are trying to add

    1. This is a check to make sure we don’t already have it made!

      Image Modified
  3. Select “Create component”

    Image Modified
  4. Select the applicable category for your new component

    Image Modified
  5. Hit OK!

  6. Your new component, using the corresponding template, will now open.

2. Enter MPN and Import Data

Simply entering the manufacturer part number and selecting the associated manufacturer can jumpstart your component creation by importing parameters!

The below expand features this process for a new resistor.

Expand
  1. Set the “Name” field to the manufacturer part number

    1. On popular distributors, such as Digikey, there is a dedicated field for MPN and a copy button

      Image Modified
    2. Ensure you do not use the supplier part number

      Image Modified

  2. Click the most accurate MPN/manufacturer to start the data import

    Image Modified
    1. Note: If you just hit enter and not select a dropdown, no import will occur.

  3. Turn on “Show only matching with template” and disable all imports except of parameters

    Image Modified

  4. Confirm the accuracy of parameters against the datasheet

    1. Disable any parameters that are incorrect

  5. Click “OK”

    1. You should now have some parameters filled in and a “Part Choice” should be filled in

      Image Modified
Note

It is also possible to import a symbol and footprint from this step. Do not do this to start. We require first checking options A and B for each, before importing a symbol or footprint from here. See those sections for more info and then come back to this if an import is needed.

3. Fill in Parameters

Fill in the remaining parameters, if possible, from the datasheet

Not all parameters are required. All are recommended, but only the exclamation marked ones are required

...

4. Symbol

As shown in the flowchart, there are a few different ways to assign a symbol. Each lettered section is a different method, with the first being the simplest, and the last being the most comprehensive.

a. Default Symbol

Templates with common symbols, such as capacitors, resistors, and inductors, have a symbol automatically associated upon creating the component!

...

If this symbol is accurate to your component, you’re already done!

Note

Some parts rated for higher power may have multiple electrically equivalent pins (a capacitor with 4 pins for example). Do not change the symbol for this. We address this with the footprint process.

b. Symbol Exists in Vault

Some components are semi-communized. For example, transformers which are often 1:1 but may be 1:1:1, both of which we have symbols for already. Another example is simple ICs, such as a 3 pin linear regulator (Vin, Vout, GND).

In any of these situations, it is always best to do a quick check of the vault for any symbol that may suit your part. For this approach I will demonstrate using the AP2120N-3.3TRG1 linear regulator.

Expand
  1. We start with previous steps completed and no symbol applied

    Image Added

  2. Select the dropdown under “Add Symbol” and select “Existing…”

    Image Added

  3. An explorer window will open from which you can search for a symbol

    Image Added
    1. All symbols are found in a dedicated folder within “Managed Content”

    2. It is recommend to search in the path that matches (roughly) the type of component you are making. In this case, “Integrated Circuits (ICs)” > “PMIC - Linear Regulators”

  4. Clicking on symbol names will open a preview of the symbol. If a symbol looks good, hit “OK”!

    Image Added

  5. Done!

    Image Added
Note

In this example you can see that the pin numbers do not align to the datasheet. This mismatch will be addressed in the footprint stage with https://nerdocs.atlassian.net/wiki/spaces/NER/pages/146243680/Component+Creation#Pin-Swapping.

c. Importing a Symbol from Online

Often times a symbol is available for download either from the manufacturer directly or a 3rd party, which can save a lot of time for larger components.

Given how non-standardized symbols are, it oftentimes is faster to make it yourself, but use your own past experiences and judgment to decide when you should or shouldn’t import!

For this demonstration, the NCV57001DWR2G isolated gate driver will be used.

Expand
  1. Find a model. See https://nerdocs.atlassian.net/wiki/spaces/NER/pages/158073007/Altium+Reference#EDA-(Footprint-Sources) for places to look. In this case I found a download on the manufacturer’s website

    Image Added

  2. Download the model. This often requires making a free account with whatever website is hosting the files. Depending on the website, you may also need to specify your software, which for us is Altium Designer.

    Image Added

  3. Open the schematic library file. Sometimes they may provide an “Integrated” library. Either work fine.

    Image Added

  4. Confirm the symbol is usable. In this case, there are some fixes needed, but overall it looks good.

    Image Added

  5. Create a blank symbol from your component by using the dropdown and selecting “New”

    Image Added

  6. Open properties and update the Designator and Name per https://nerdocs.atlassian.net/wiki/spaces/NER/pages/118718470/Vault+Guidelines#Symbols.1

    Image AddedImage Added

  7. Return to the downloaded symbol. Use Ctrl + A to select all and Ctrl + C to copy

    Image Added

  8. Paste into the new symbol file

  9. This is a good time to make any fixes to make this compliant to https://nerdocs.atlassian.net/wiki/spaces/NER/pages/118718470/Vault+Guidelines#Symbols.1. In this case no changes are needed, but sometimes pin types, color, or names may need updating.

  10. Save (Ctrl + S) and close the symbol file.

    Image Added

  11. You should now see on the component your new component, including updated name!

    Image Added
    1. The name and designator letter are great spot checks to make sure you didn’t forget the properties!

  12. Open the menu to the top right of the symbol preview and click “Select Target Folder…”

    Image Added

  13. Select where to store this symbol (within a subfolder of the Symbols folder) and click “OK”. In this case, “PMIC - Gate Driver” is the most accurate folder

    Image Added

  14. Done! Your symbol will now show its full name and destination for saving

    Image Added

During https://nerdocs.atlassian.net/wiki/spaces/NER/pages/146243680/Component+Creation#2.-Enter-MPN-and-Import-Data you may be able to import a symbol along side the parameters. If you choose to do so, you must follow the above directions.

d. Creating a Symbol

...

{}

5. Footprint

...

from Scratch

Sometimes a symbol just isn’t available anywhere. Or a component is made custom by us. Or quite simply, the symbol is simple enough it just makes more sense to make the symbol from scratch.

For this demonstration, the NCV57001DWR2G isolated gate driver will be used.

Expand
  1. Prepare yourself by finding the component pinout within the datasheet.

    Image Added
    1. This is usually within the first few pages, sometimes (like this one) are even on the first page!

  2. Under the “Add Symbol” dropdown, click “New”

    Image Added
  3. With nothing selected (click blank space), open the Properties panel

  4. Set your properties. Primarily Designator and Name

    Image Added
  5. Right click the line icon to open the shapes menu and select the rectangle tool

    Image Added

  6. Make an initial box for the symbol. Requirements for color pallet and pin spacing are here: https://nerdocs.atlassian.net/wiki/spaces/NER/pages/118718470/Vault+Guidelines#Symbol-Layout

    Image Added

  7. Select the pin tool from the toolbar

    Image Added

  8. Press tab while the tool is running to set the pin number (designator) and name. These are based on the datasheet

    Image Added
    1. You may additionally want to adjust the pin length (in increments of 100mils), confirm the type is set to passive, and decide to hide or show pin names and numbers

  9. Click the pause button to resume placement of the pin

    Image Added
  10. Orient and place the pin using standard controls (X and Y to mirror, space to rotate, left click to place, etc)

    Image Added
    1. Note that the crosshairs while placing are where wires connect, not where the pin should connect to the box (name text should be in the yellow box, not outside)

  11. Repeat #8-10 to populate all pins

    1. The tool will automatically increment the pin number for more rapid placement!

      Image Added
  12. Once all placed you may need to adjust your pin placement and block size. This is done via standard clicking and dragging

    Image AddedImage Added

  13. Save (Ctrl + S) and close the symbol file.

    Image Added

  14. You should now see on the component your new component, including updated name!

    Image Added
    1. The name and designator letter are great spot checks to make sure you didn’t forget the properties!

  15. Open the menu to the top right of the symbol preview and click “Select Target Folder…”

    Image Added

  16. Select where to store this symbol (within a subfolder of the Symbols folder) and click “OK”. In this case, “PMIC - Gate Driver” is the most accurate folder

    Image Added

  17. Done! Your symbol will now show its full name and destination for saving

    Image Added

5. Footprint

As shown in the flowchart, there are a few different ways to assign a symbol. Each lettered section is a different method, with the first being the simplest, and the last being the most comprehensive.

a. Default Footprint

This currently isn’t a thing for any of our templates. But it could be! If so, just evaluate if the auto-populated footprint is accurate to your datasheet.

b. Footprint Exists in Vault

It is always best to use an existing footprint. This allows for

6. Add SPNs

{}

7. Mark as Ready to Review

...