Skip to content

Update reference doc #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ducky64 merged 2 commits into from
Jul 7, 2026
Merged

Update reference doc #534

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e0418a
Update reference.md
ducky64 Jul 7, 2026
80b5a8a
Update reference.md
ducky64 Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,11 +163,19 @@ def refinements(self) -> Refinements:

- Some blocks, particularly discrete components like `Resistor`s and `Fet`s, are implemented as automatic selection from a parts table.
- These are some common top-level refinements:
- Class refinement `(SelectorArea, ["footprint_area"], Range.from_lower(1.5))`: require a minimum footprint courtyard area, in mm²
- Common minimum areas for passives, in mm²: 01005=0.72, 0201=0.98, 0402=1.74, 0603=4.32, 0805=6.38, 1206=10.21.
- Class refinement `(SelectorArea, ["filter_area"], Range.from_lower(1.5))`: require a minimum footprint courtyard area, in mm²

| Package | Minimum Area (mm²) |
|---------|------------------|
| 01005 | 0.72 |
| 0201 | 0.98 |
| 0402 | 1.74 |
| 0603 | 4.32 |
| 0805 | 6.38 |
| 1206 | 10.21 |
- Instance refinement `(["part_table_block", "excluded_parts"], ["1N2127"])`: exclude parts from selection, e.g., if they're out-of-stock.
- Instance refinement `(["part_table_block", "part"], "1N2127")`: require a particular part.
- Instance refinement `(["part_table_block", "footprint_spec"], "Diode_SMD:D_SMA")`: require a particular footprint.
- Instance refinement `(["part_table_block", "filter_footprints"], ["Diode_SMD:D_SMA"])`: require specific footprints.


### IoController
Expand Down Expand Up @@ -258,6 +266,7 @@ class MyBoard(SimpleBoardTop):
```

- `multipack()` is a blend of `contents()` (in that `PackedBlocks` are declared within) and `refinements()` (in that it uses `List[str]` to reference blocks in the design hierarchy).
- All multipack Blocks, Blocks that allow other components to be packed into it, extend `MultipackBlock`.
- `self.PackedBlock(...)` is similar to `self.Block(...)`.
- `self.pack(...)` takes two arguments:
- `multipack_part`: the multipack element that is part of the packed block, either a block or an element of a dynamically-sized packed block array.
Expand Down
Loading