114 lines
4.6 KiB
Python
114 lines
4.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2020-2024 Salvador E. Tropea
|
|
# Copyright (c) 2020-2024 Instituto Nacional de Tecnología Industrial
|
|
# License: AGPL-3.0
|
|
# Project: KiBot (formerly KiPlot)
|
|
"""
|
|
Dependencies:
|
|
- from: KiAuto
|
|
role: mandatory
|
|
version: 2.0.0
|
|
"""
|
|
import os
|
|
from .macros import macros, document, pre_class # noqa: F401
|
|
from .error import KiPlotConfigurationError
|
|
from .gs import GS
|
|
from .optionable import Optionable
|
|
from .kicad.config import KiConf
|
|
from .kiplot import load_board
|
|
from .misc import DRC_ERROR, KICAD_VERSION_7_0_1_1, W_DRC7BUG
|
|
from .log import get_logger
|
|
|
|
logger = get_logger(__name__)
|
|
|
|
|
|
class Run_DRCOptions(Optionable):
|
|
""" DRC options """
|
|
def __init__(self):
|
|
super().__init__()
|
|
with document:
|
|
self.enabled = True
|
|
""" Enable the DRC. This is the replacement for the boolean value """
|
|
self.dir = ''
|
|
""" Sub-directory for the report """
|
|
self.ignore_unconnected = False
|
|
""" Ignores the unconnected nets. Useful if you didn't finish the routing.
|
|
It will also ignore KiCad 6 warnings """
|
|
self._unknown_is_error = True
|
|
|
|
|
|
@pre_class
|
|
class Run_DRC(BasePreFlight): # noqa: F821
|
|
""" [boolean=false|dict] 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.
|
|
KiCad 6 introduced `warnings` they are currently counted be the `unconnected` counter of KiBot.
|
|
This will change in the future.
|
|
If you use DRC exclusions please consult the `drc_exclusions_workaround` global option """
|
|
def __init__(self, name, value):
|
|
super().__init__(name, value)
|
|
if isinstance(value, bool):
|
|
self._enabled = value
|
|
self._dir = ''
|
|
self._ignore_unconnected = False
|
|
elif isinstance(value, dict):
|
|
f = Run_DRCOptions()
|
|
f.set_tree(value)
|
|
f.config(self)
|
|
self._enabled = f.enabled
|
|
self._dir = f.dir
|
|
self._ignore_unconnected = f.ignore_unconnected
|
|
else:
|
|
raise KiPlotConfigurationError('must be boolean or dict')
|
|
self._pcb_related = True
|
|
self._expand_id = 'drc'
|
|
self._expand_ext = 'txt'
|
|
|
|
def get_targets(self):
|
|
""" Returns a list of targets generated by this preflight """
|
|
load_board()
|
|
out_pattern = GS.global_output if GS.global_output is not None else GS.def_global_output
|
|
name = Optionable.expand_filename_pcb(self, out_pattern)
|
|
out_dir = self.expand_dirname(GS.out_dir)
|
|
if GS.global_dir and GS.global_use_dir_for_preflights:
|
|
out_dir = os.path.join(out_dir, self.expand_dirname(GS.global_dir))
|
|
return [os.path.abspath(os.path.join(out_dir, self._dir, name))]
|
|
|
|
@classmethod
|
|
def get_doc(cls):
|
|
return cls.__doc__, Run_DRCOptions
|
|
|
|
def run(self):
|
|
command = self.ensure_tool('KiAuto')
|
|
if GS.ki7:
|
|
# KiCad 7 can do some library parity checks, but we need to be sure that the KICAD7* vars are defined
|
|
KiConf.init(GS.pcb_file)
|
|
if GS.kicad_version_n < KICAD_VERSION_7_0_1_1:
|
|
logger.warning(W_DRC7BUG+"KiCad 7.0.0/1 fails to load the global footprints table. "
|
|
"You may get a lot of `lib_footprint_issues` reports. "
|
|
"Try enabling the global `drc_exclusions_workaround` option.")
|
|
output = self.get_targets()[0]
|
|
os.makedirs(os.path.dirname(output), exist_ok=True)
|
|
logger.debug('DRC report: '+output)
|
|
cmd = [command, 'run_drc', '-o', os.path.basename(output)]
|
|
if GS.filter_file:
|
|
cmd.extend(['-f', GS.filter_file])
|
|
if GS.global_drc_exclusions_workaround:
|
|
cmd.append('-F')
|
|
if self._ignore_unconnected or BasePreFlight.get_option('ignore_unconnected'): # noqa: F821
|
|
cmd.append('-i')
|
|
cmd.extend([GS.pcb_file, os.path.dirname(output)])
|
|
# If we are in verbose mode enable debug in the child
|
|
cmd = self.add_extra_options(cmd)
|
|
logger.info('- Running the DRC')
|
|
ret = self.exec_with_retry(cmd)
|
|
if ret:
|
|
if ret > 127:
|
|
ret = -(256-ret)
|
|
if ret < 0:
|
|
msg = f'DRC violations: {-ret}'
|
|
else:
|
|
msg = f'DRC returned {ret}'
|
|
GS.exit_with_error(msg, DRC_ERROR)
|