Skip to content

Commit eed67f7

Browse files
committed
Improve documentation regarding GUI
1 parent 48d7dea commit eed67f7

6 files changed

+58
-20
lines changed

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ tasks in a standard KiCAD workflow like:
1616

1717
## Do You Enjoy KiKit or Does It Save You Time?
1818

19-
Then definitely consider [**supporting me on GitHub
20-
Sponsors**](https://github.com/sponsors/yaqwsx) or buy me a coffee:
21-
22-
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E2181LU)
19+
Then definitely consider:
20+
- [**supporting me on GitHub Sponsors**](https://github.com/sponsors/yaqwsx)
21+
- or become my [Patreon](https://patreon.com/yaqwsx),
22+
- or buy me a coffee: [![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E2181LU)
2323

2424
Your support will allow me to allocate time to properly maintain my projects
2525
like this.
@@ -39,6 +39,8 @@ therefore, you can install it via pip:
3939
pip3 install kikit
4040
```
4141

42+
Then you can install the Pcbnew action plugins via KiCAD's PCM.
43+
4244
For more detailed instructions with steps to enable GUI plugins, please see the
4345
[installation guide](doc/installation.md).
4446

doc/panelization.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ include components sticking out of the board outline, you can specify tolerance
7777

7878
#### `appendBoard`
7979
```
80-
appendBoard(self, filename, destination, sourceArea=None, origin=Origin.Center,
81-
rotationAngle=0, shrink=False, tolerance=0, bufferOutline=1000,
82-
netRenamer=None, refRenamer=None, inheritDrc=True,
80+
appendBoard(self, filename, destination, sourceArea=None, origin=Origin.Center,
81+
rotationAngle=0, shrink=False, tolerance=0, bufferOutline=1000,
82+
netRenamer=None, refRenamer=None, inheritDrc=True,
8383
interpretAnnotations=True)
8484
```
8585

@@ -103,7 +103,7 @@ None
103103

104104
#### `addCornerFiducials`
105105
```
106-
addCornerFiducials(self, fidCount, horizontalOffset, verticalOffset,
106+
addCornerFiducials(self, fidCount, horizontalOffset, verticalOffset,
107107
copperDiameter, openingDiameter)
108108
```
109109
Add up to 4 fiducials to the top-left, top-right, bottom-left and
@@ -120,7 +120,7 @@ None
120120

121121
#### `addCornerTooling`
122122
```
123-
addCornerTooling(self, holeCount, horizontalOffset, verticalOffset, diameter,
123+
addCornerTooling(self, holeCount, horizontalOffset, verticalOffset, diameter,
124124
paste=False)
125125
```
126126
Add up to 4 tooling holes to the top-left, top-right, bottom-left and
@@ -166,9 +166,9 @@ diameter. The paste option allows to place the hole on the paste layers.
166166

167167
#### `addText`
168168
```
169-
addText(self, text, position, orientation=0, width=1500000, height=1500000,
170-
thickness=300000, hJustify=EDA_TEXT_HJUSTIFY_T.GR_TEXT_HJUSTIFY_CENTER,
171-
vJustify=EDA_TEXT_VJUSTIFY_T.GR_TEXT_VJUSTIFY_CENTER,
169+
addText(self, text, position, orientation=0, width=1500000, height=1500000,
170+
thickness=300000, hJustify=EDA_TEXT_HJUSTIFY_T.GR_TEXT_HJUSTIFY_CENTER,
171+
vJustify=EDA_TEXT_VJUSTIFY_T.GR_TEXT_VJUSTIFY_CENTER,
172172
layer=Layer.F_SilkS)
173173
```
174174
Add text at given position to the panel. If appending to the bottom
@@ -188,9 +188,9 @@ Adds a horizontal V-CUT at pos (integer in KiCAD units).
188188

189189
#### `appendBoard`
190190
```
191-
appendBoard(self, filename, destination, sourceArea=None, origin=Origin.Center,
192-
rotationAngle=0, shrink=False, tolerance=0, bufferOutline=1000,
193-
netRenamer=None, refRenamer=None, inheritDrc=True,
191+
appendBoard(self, filename, destination, sourceArea=None, origin=Origin.Center,
192+
rotationAngle=0, shrink=False, tolerance=0, bufferOutline=1000,
193+
netRenamer=None, refRenamer=None, inheritDrc=True,
194194
interpretAnnotations=True)
195195
```
196196
Appends a board to the panel.
@@ -256,7 +256,7 @@ Add tab annotations to the corners of the individual substrates.
256256

257257
#### `buildTabAnnotationsFixed`
258258
```
259-
buildTabAnnotationsFixed(self, hcount, vcount, hwidth, vwidth, minDistance,
259+
buildTabAnnotationsFixed(self, hcount, vcount, hwidth, vwidth, minDistance,
260260
ghostSubstrates)
261261
```
262262
Add tab annotations for the individual substrates based on number of
@@ -372,9 +372,9 @@ Generate vertical cuts for the frame corners and return them
372372

373373
#### `makeGrid`
374374
```
375-
makeGrid(self, boardfile, sourceArea, rows, cols, destination, verSpace,
376-
horSpace, rotation,
377-
placementClass=<class 'kikit.panelize.BasicGridPosition'>,
375+
makeGrid(self, boardfile, sourceArea, rows, cols, destination, verSpace,
376+
horSpace, rotation,
377+
placementClass=<class 'kikit.panelize.BasicGridPosition'>,
378378
netRenamePattern=Board_{n}-{orig}, refRenamePattern=Board_{n}-{orig})
379379
```
380380
Place the given board in a regular grid pattern with given spacing

doc/panelizeCli.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ structure. The configuration contains several categories (e.g., `layout`,
66
(e.g., `tabsCount`). All categories and their parameters are described further
77
below.
88

9+
Note that you can use the [pcbnew action plugin](panelizeGui.md) to
10+
interactively construct the panelization configuration structure.
11+
912
# Configurations
1013

1114
The configuration can be supplied to KiKit via a JSON file with comments and
@@ -45,7 +48,7 @@ following
4548
"type": "auto",
4649
"millradius": "0mm",
4750
"copperfill": false
48-
}
51+
}
4952
}
5053
```
5154

doc/panelizeGui.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Panelization GUI
2+
3+
The panelization feature of KiKit is also available via GUI in the KiCAD's PCB
4+
editor (Pcbnew). The main use-case for the GUI is to quickly construct the
5+
desired KiKit command and fine-tune the panel. It also serves as a quick help in
6+
case you are not sure about parameter naming.
7+
8+
The GUI is designed to be run in a standalone instance of Pcbnew (not executed
9+
from a project) as the generated panel replaces the currently open board.
10+
11+
You can invoke the GUI via clicking on the panelization icon:
12+
13+
![Pcbnew toolbar with the icon](resources/panelizeToolbar.png)
14+
15+
Then the following window will open:
16+
17+
![Panelization plugin Window](resources/panelizeWindow.png)
18+
19+
There are three parts of the window:
20+
21+
- the left column where you can edit individual parameter sections. These
22+
sections are in 1:1 correspondence to the panelization CLI. For the help on
23+
their meaning please refer to [CLI documentation](panelizeCli.md)
24+
- the right column with:
25+
- the constructed KiKit command (that you can put into your Makefile)
26+
- the constructed JSON preset that you can save and later use.
27+
28+
Note that both, the command and JSON preset, does not include a parameter if it
29+
is the same with the default, built-in, preset.
30+
31+
Once you are happy with the parameters, you can click the "Panelize" button and
32+
the panel will appear in the Pcbnew work area. You can then edit the parameters
33+
and regenerate the panel.

doc/resources/panelizeToolbar.png

10.9 KB
Loading

doc/resources/panelizeWindow.png

54.8 KB
Loading

0 commit comments

Comments
 (0)