[DOCs] Clarified how KiCad 6 warnings are counted

Closes #374
This commit is contained in:
Salvador E. Tropea 2023-01-23 14:20:38 -03:00
parent 66c202bfb5
commit 910777735f
4 changed files with 13 additions and 4 deletions

View File

@ -440,6 +440,7 @@ This section is used to specify tasks that will be executed before generating an
- `regex`: [string=''] Regular expression to match the text for the error we want to exclude.
- *regexp*: Alias for regex.
- `ignore_unconnected`: [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing.
It will also ignore KiCad 6 warnings.
- `pcb_replace`: [dict] Replaces tags in the PCB. I.e. to insert the git hash or last revision date.
This is useful for KiCad 5, use `set_text_variables` when using KiCad 6.
This preflight modifies the PCB. Even when a back-up is done use it carefully.
@ -465,6 +466,8 @@ This section is used to specify tasks that will be executed before generating an
The report file name is controlled by the global output pattern (%i=drc %x=txt).
Note that the KiCad 6 *Test for parity between PCB and schematic* option is not supported.
If you need to check the parity use the `update_xml` preflight.
KiCad 6 introduced `warnings` they are currently counted be the `unconnected` counter of KiBot.
This will change in the future.
- `run_erc`: [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct.
The report file name is controlled by the global output pattern (%i=erc %x=txt).
- `sch_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date.

View File

@ -40,6 +40,7 @@ preflight:
error: '10'
regex: 'Regular expression to match'
# [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing.
# It will also ignore KiCad 6 warnings.
ignore_unconnected: false
# [dict] Replaces tags in the PCB. I.e. to insert the git hash or last revision date.
# This is useful for KiCad 5, use `set_text_variables` when using KiCad 6.
@ -55,6 +56,8 @@ preflight:
# The report file name is controlled by the global output pattern (%i=drc %x=txt).
# Note that the KiCad 6 *Test for parity between PCB and schematic* option is not supported.
# If you need to check the parity use the `update_xml` preflight.
# KiCad 6 introduced `warnings` they are currently counted be the `unconnected` counter of KiBot.
# This will change in the future.
run_drc: true
# [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct.
# The report file name is controlled by the global output pattern (%i=erc %x=txt).

View File

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2020 Salvador E. Tropea
# Copyright (c) 2020 Instituto Nacional de Tecnología Industrial
# Copyright (c) 2020-2023 Salvador E. Tropea
# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
from .macros import macros, pre_class # noqa: F401
@ -9,7 +9,8 @@ from .error import (KiPlotConfigurationError)
@pre_class
class Ignore_Unconnected(BasePreFlight): # noqa: F821
""" [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing """
""" [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing.
It will also ignore KiCad 6 warnings """
def __init__(self, name, value):
super().__init__(name, value)
if not isinstance(value, bool):

View File

@ -27,7 +27,9 @@ class Run_DRC(BasePreFlight): # noqa: F821
""" [boolean=false] Runs the DRC (Distance Rules Check). To ensure we have a valid PCB.
The report file name is controlled by the global output pattern (%i=drc %x=txt).
Note that the KiCad 6 *Test for parity between PCB and schematic* option is not supported.
If you need to check the parity use the `update_xml` preflight """
If you need to check the parity use the `update_xml` preflight.
KiCad 6 introduced `warnings` they are currently counted be the `unconnected` counter of KiBot.
This will change in the future """
def __init__(self, name, value):
super().__init__(name, value)
if not isinstance(value, bool):