Versions Compared

Key

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

...

  1. Open the panel via the panels button (or the components shortcut in the schematics toolbar!)

    Image Added
    1. If you see this just hit the blue “Use Existing Components”

  2. Select component type via the dropdown menu at the top of the panel

  3. Filter results (opened via the button in the top left of the panel)

  4. Just Click + Drag the component in or Right-click and select “Place”

  5. Adjust component position as needed (click and drag)!

...

Expand
  1. Within the same menus as the above tool, select the “Board Level Annotate…” tool (Tools > Annotation > Board Level Annotate…)

  2. Click “Annotate Options”

  3. In the pop-up, set the new designator naming scheme

    Image Added
    1. This can be set by clicking the dropdown menu, or typing your own variables from scratch

    2. See {link} https://nerdocs.atlassian.net/wiki/spaces/NER/pages/118718470/Vault+Guidelines#Annotations for what we recommend to select

  4. Click OK

  5. Click Annotate

  6. Click Accept Changes

  7. Click Execute

  8. Close everything out!

{further directions for using the tools needed in hierarchy}

Improving Readability

...

  1. “OK”

  2. Click “Annotate” and then whichever dropdown button makes sense for you (undesignated for new parts only, or all for all components in the project)

    Image Added
    1. You should see the right column update per your settings

  3. Click “Accept Changes (Create ECO)” in the bottom right

  4. Click “Execute Changes” in the bottom left of the ECO window

  5. Close everything out!

Improving Readability

As with all design work, schematics are used express solutions to open ended problems. With no restrictions on how solutions are approached, it is very important to document your work in a way that everyone can understand! With our team size and various experience levels there is a very wide audience that must be able to comprehend your work.

...

Additionally, check out the Vault Guidelines https://nerdocs.atlassian.net/wiki/spaces/NER/pages/118718470/Vault+Guidelines#Schematics when working on schematics. We have a handful of club-wide recommendations and requirements to setup some baseline consistency across the team.

...

Net labels serve two functions: connecting and naming. Given any existing wire in a schematic, a net label can be placed to provide a more descriptive name.

{image of a net label on a continuous wire}

These

...

These names can be very helpful for correlating schematics to the layout, as the net names will transfer into the PCB layout. It’s recommended to keep the name short but informative.

Info

By default, Altium will name nets without labels based on the component designators and pad numbers the net connects to. For example, NetC5_2, NetU14_6, etc.

Net labels additionally can be used to actually define nets and make new connections. Duplicate net labels can be placed and Altium will consider all wires labeled the same a single net.

{image of net labels connecting things}

Net labels are frequently used for both purposes. Connections without wires are often helpful for complex schematics as well as any The above screenshot uses many labels for connections from the component on the left (IB, IA, GPIO, etc) as well as for power (VREG and GND)

Info

Note how VREG and GND in this example have special shapes. This is a special type of label called a power port!

Net labels are frequently used for both purposes. Connections without wires are often helpful for complex schematics as well as any connections that have to otherwise traverse large portions of your page.

Check out some of NERs more complex schematics to see how we historically use net labels (anything with a microcontroller pretty much)

The Vault Guidelines highlight https://nerdocs.atlassian.net/wiki/spaces/NER/pages/118718470/Vault+Guidelines#Schematics highlight a few suggestions regarding how to use net labels in NER projects. {need to actually add a section and then update this link to that section}

How to Add Net Labels

Expand

There are a few different places to access the net label tool.

{explain and images of accessing from schematic toolbar}

{explain and images of accessing from right click menu}

{explain and images of accessing from main toolbar}

Notes

As the name implies, notes are for adding notes to your schematic. These can cover anything from clarifying how a circuit works, including calculations proving functionality, or notation on how to place the components once in layout.

{directions to add notes and screenshots}

Check out the Vault Guidelines for more about how we do notes including color coding, numerical annotations, and more. {need to actual update guidelines and update link to that header}

Hierarchical Pages

Altium allows for hierarchical designs, which primarily impact schematic design, but can also be used to improve speed of layouts for large or repetitive boards.

In summary, hierarchical design is when schematic pages are embedded inside other schematic pages. This creates a tree structure that enables benefits such as reusing pages for repetitive circuits and creating organized sections of your circuitry.

{image of stacked hierarchy in shepherd}

The above screenshot shows how hierarchical design was used in Shepherd BMS 17D and the below is a example from Altium of how higher sheets connect to the lower ones via “ports.”

...

Setting up for Hierarchy

Altium has 5 options for “Net Identifier Scope,” which essentially defines how your hierarchy will be created. This setting is found in the project options which is found by right clicking in your schematic and selecting “Project Options,” or by opening via the task bar ({X > X > X})

{screenshots of two methods}

These options are:

  • Automatic

  • Flat

  • Hierarchical

  • Strict Hierarchical

  • Global

We typically use Strict Hierarchy, which ensures that all connections between sheets must be explicitly defined with ports. You can read more about the other options here: https://www.altium.com/documentation/altium-designer/accessing-defining-managing-project-options#options

Implementing Hierarchy

Actually creating a hierarchical design is as simple as adding a sheet symbol into any schematic. From there Altium will treat your design as hierarchical according to the setting you chose above.

  1. X

  2. X

  3. X

  4. X

  5. X

{show how to add sheet symbols and ports (steps and images)}

Tips on Hierarchy

Expand

Hiding Rooms

Check out Altium Reference, Tips, Troubleshooting
  • You can right click the “Wire” button in the schematic toolbar and then switch to “Net Label”

    Image Added
    • Note that the schematic panel will remember your most recent tool within these sub menus

  • You can right click anywhere in the schematic and navigate to “Place” > “Net Label”

    Image Added

  • You can navigate the toolbar to “Place” > “Net Label”

    Image Added

Once in the tool, you simply click on a wire to add a label. Then double click or open the properties panel to edit the name. As with other tools, you can also hit Tab while moving to pause movement and edit the properties.

Notes

As the name implies, notes are for adding notes to your schematic. These can cover anything from clarifying how a circuit works, including calculations proving functionality, or notation on how to place the components once in layout.

Expand

There are a few different places to access the net label tool.

  • You can right click the “Text String” button in the schematic toolbar and then switch to “Note”

    Image Added
    • Note that the schematic panel will remember your most recent tool within these sub menus

  • You can right click anywhere in the schematic and navigate to “Place” > “Note”

    Image Added

  • You can navigate the toolbar to “Place” > “Note”

    Image Added

Once in the tool, you simply click in the schematic to designate one corner and click somewhere else to define the other corner. Then double click or open the properties panel to edit the name. As with other tools, you can also hit Tab while moving to pause movement and edit the properties.

Image Added

Check out the https://nerdocs.atlassian.net/wiki/spaces/NER/pages/118718470/Vault+Guidelines#Notes for more about how we do notes including color coding, numerical annotations, and more.

Hierarchical Pages

Altium allows for hierarchical designs, which primarily impact schematic design, but can also be used to improve speed of layouts for large or repetitive boards.

In summary, hierarchical design is when schematic pages are embedded inside other schematic pages. This creates a tree structure that enables benefits such as reusing pages for repetitive circuits and creating organized sections of your circuitry.

...

The above screenshot shows how hierarchical design was used in Shepherd BMS 17D and the below is a example from Altium of how higher sheets connect to the lower ones via “ports.”

...

Setting up for Hierarchy

Altium has 5 options for “Net Identifier Scope,” which essentially defines how your hierarchy will be created. This setting is found in the project options which is found by right clicking in your schematic and selecting “Project Options,” or by opening via the task bar (“Project” > “Project Options”)

...

These options are:

  • Automatic

  • Flat

  • Hierarchical

  • Strict Hierarchical

  • Global

We typically use Strict Hierarchy, which ensures that all connections between sheets must be explicitly defined with ports. You can read more about the other options here: https://www.altium.com/documentation/altium-designer/accessing-defining-managing-project-options#options

Implementing Hierarchy

Actually creating a hierarchical design is as simple as adding a sheet symbol into any schematic. From there Altium will treat your design as hierarchical according to the setting you chose above.

Step-by-step:

Expand
  1. First create a separate schematic file for your sub-sheet. This is done by right clicking the project name in the project panel, then navigating to “Add New to Project” > “Schematic”

    Image Added
  2. Rename, update the template, etc to get the schematic to a good spot

    Image Added
  3. In your top sheet, select the “Place Sheet Symbol” button from the schematic toolbar

    Image Added
  4. Similar to notes, you click once to set the first corner, and then a second time to set the opposite corner

    Image Added

  5. Once placed, open the properties to set the link to the sub-sheet

    Image Added

    1. Set the “File Name” field to select the sub-sheet schematic

    2. Set the “Designator” to be a unique name for this instance of the sheet

Tips on Hierarchy

Hiding Rooms

Check out https://nerdocs.atlassian.net/wiki/spaces/NER/pages/158073007/Altium+Reference+Tips+Troubleshooting#View-Configuration for how to hide rooms when you’re in layout.

...

Room Creation

By default, hierarchical sheets will each create a “component room” when pulled into PCB layout. These rooms can be moved, copied, and manipulated with all the components and copper put within them. Additionally, rules (and any other queries) can be applied on the room level.

These are generated any time changes from schematics are pushed from schematics to layout. This behavior can be turned off or modified as needed.

Hierarchical Annotations

See above ({ link }) for how to annotate hierarchical projects.

Easy Copying

As shown in the Shepherd screenshot at the start of this section, hierarchy can be used for repetitive circuits. This saves time not only in schematic, but also in layout thanks to rooms.

  1. X {need to figure out steps to get repeater to work}

  2. X

  3. X

  4. X

Classes and Other Parameters

...