You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/drc_guide.md
+3-24Lines changed: 3 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,23 +11,14 @@ The Design Rule Check (DRC) functionality allows you to:
11
11
3. Track your progress over time as you fix issues
12
12
4. Compare current results with previous checks
13
13
14
-
## KiCad 9.0+ Compatibility
15
-
16
-
**Important Update**: With KiCad 9.0+, the DRC functionality has been reimplemented to work with the new KiCad APIs. The server now supports two methods for running DRC:
17
-
18
-
1.**KiCad CLI Method** (Recommended) - Uses the `kicad-cli` command-line tool to run DRC checks without requiring a running instance of KiCad.
19
-
20
-
2.**IPC API Method** - Connects to a running instance of KiCad through the new IPC API using the `kicad-python` package.
21
-
22
-
The server automatically selects the best available method based on your KiCad installation.
14
+
It does this all by using the `kicad-cli` command-line tool to run DRC checks without requiring a running instance of KiCad.
23
15
24
16
## Prerequisites
25
17
26
18
For optimal DRC functionality with KiCad 9.0+, you should have:
27
19
28
20
- KiCad 9.0 or newer installed
29
21
-`kicad-cli` available in your system PATH (included with KiCad 9.0+)
30
-
- For IPC API functionality: the `kicad-python` package installed (`pip install kicad-python`)
31
22
32
23
## Using DRC Features
33
24
@@ -43,7 +34,7 @@ Please run a DRC check on my project at /Users/username/Documents/KiCad/my_proje
43
34
```
44
35
45
36
The tool will:
46
-
-Automatically select the best available method (CLI or IPC API)
37
+
-Use the kicad CLI to run the DRC check
47
38
- Analyze your PCB design for rule violations
48
39
- Generate a comprehensive report
49
40
- Save the results to your DRC history
@@ -141,19 +132,7 @@ If the DRC check fails to run:
141
132
142
133
1. Ensure your KiCad project exists at the specified path
143
134
2. Verify that the project contains a PCB file (.kicad_pcb)
144
-
3. Check your KiCad installation:
145
-
- For CLI method: Verify `kicad-cli` is in your PATH or in a standard installation location
146
-
- For IPC API method: Make sure KiCad is running with the API server enabled in Preferences > Plugins
135
+
3. Check your KiCad installation: Verify `kicad-cli` is in your PATH or in a standard installation location
147
136
4. Try using the full absolute path to your project file
148
137
149
-
### Method Selection Issues
150
-
151
-
If you want to force a specific DRC method:
152
-
153
-
1.**CLI Method**: Ensure `kicad-cli` is available in your PATH
154
-
2.**IPC API Method**:
155
-
- Install the `kicad-python` package
156
-
- Launch KiCad before running the DRC check
157
-
- Enable the API server in KiCad preferences
158
-
159
138
If you continue to experience issues, check the server logs for more detailed error information.
0 commit comments