templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Finished the core functionality of --quick-start 

- New --quick-start options:
  - --start starting point for the search
  - -d output directory for the targets
  - --dry only configs, no targets
- Added some warning filters
- Sorted scan and generation
This commit is contained in:
Salvador E. Tropea 2022-04-28 14:50:58 -03:00
parent 01c015eb27
commit 5b637d265e
4 changed files with 141 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -131,7 +131,7 @@ This section is used to specify tasks that will be executed before generating an
- `filter`: [string=''] Name for the filter, for documentation purposes.
- *filter_msg*: Alias for filter.
- `number`: [number=0] Error number we want to exclude. KiCad 5 only.
- `regex`: [string='None'] Regular expression to match the text for the error we want to exclude.
- `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.
- `pcb_replace`: [dict] Replaces tags in the PCB. I.e. to insert the git hash or last revision date.
@ -421,6 +421,7 @@ global:
- `extra_pth_drill`: [number=0.1] How many millimeters the manufacturer will add to plated holes.
This is because the plating reduces the hole, so you need to use a bigger drill.
For more information consult: https://www.eurocircuits.com/pcb-design-guidelines/drilled-holes/.
- `field_3D_model`: [string='_3D_model'] Name for the field controlling the 3D models used for a component.
- `filters`: [list(dict)] KiBot warnings to be ignored.
* Valid keys:
- `error`: [string=''] Error id we want to exclude. A name for KiCad 6 or a number for KiCad 5, but always a string.
@ -428,14 +429,14 @@ global:
- `filter`: [string=''] Name for the filter, for documentation purposes.
- *filter_msg*: Alias for filter.
- `number`: [number=0] Error number we want to exclude. KiCad 5 only.
- `regex`: [string='None'] Regular expression to match the text for the error we want to exclude.
- `regex`: [string=''] Regular expression to match the text for the error we want to exclude.
- *regexp*: Alias for regex.
- `impedance_controlled`: [boolean=false] The PCB needs specific dielectric characteristics.
KiCad 6: you should set this in the Board Setup -> Physical Stackup.
- `kiauto_time_out_scale`: [number=0.0] Time-out multiplier for KiAuto operations.
- `kiauto_wait_start`: [number=0] Time to wait for KiCad in KiAuto operations.
- `out_dir`: [string=''] Base output dir, same as command line `--out-dir`.
- `output`: [string=''] Default pattern for output file names.
- `output`: [string='%f-%i%I%v.%x'] Default pattern for output file names. Affected by global options.
- `pcb_finish`: [string='HAL'] Finishing used to protect pads. Currently used for documentation and to choose default colors.
KiCad 6: you should set this in the Board Setup -> Board Finish -> Copper Finish option.
Currently known are None, HAL, HASL, HAL SnPb, HAL lead-free, ENIG, ENEPIG, Hard gold, ImAg, Immersion Silver,
@ -2814,7 +2815,7 @@ Usage:
[-q | -v...] [-i] [-C] [-m MKFILE] [-g DEF]... [TARGET...]
kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] --list
kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] --example
kibot [-v...] --quick-start
kibot [-v...] [--start PATH] [-d OUT_DIR] [--dry] --quick-start
kibot [-v...] --help-filters
kibot [-v...] --help-global-options
kibot [-v...] --help-list-outputs
@ -2828,18 +2829,12 @@ Arguments:
TARGET Outputs to generate, default is all
Options:
-h, --help Show this help message and exit
-b BOARD, --board-file BOARD The PCB .kicad-pcb board file
-c CONFIG, --plot-config CONFIG The plotting config file to use
-C, --cli-order Generate outputs using the indicated order
-d OUT_DIR, --out-dir OUT_DIR The output directory [default: .]
-e SCHEMA, --schematic SCHEMA The schematic file (.sch)
-g DEF, --global-redef DEF Overwrite a global value (VAR=VAL)
--help-filters List supported filters and details
--help-list-outputs List supported outputs
--help-output HELP_OUTPUT Help for this particular output
--help-outputs List supported outputs and details
--help-preflights List supported preflights and details
-i, --invert-sel Generate the outputs not listed as targets
-l, --list List available outputs (in the config file)
-m MKFILE, --makefile MKFILE Generate a Makefile (no targets created)
@ -2849,7 +2844,21 @@ Options:
-s PRE, --skip-pre PRE Skip preflights, comma separated or `all`
-v, --verbose Show debugging information
-V, --version Show program's version number and exit
-x, --example Create a template configuration file.
-x, --example Create a template configuration file
Quick start options:
--quick-start Generates demo config files and their outputs
--start PATH Starting point for the search [default: .]
--dry Just generate the config files
Help options:
-h, --help Show this help message and exit
--help-filters List supported filters and details
--help-global-options List supported global variables
--help-list-outputs List supported outputs
--help-output HELP_OUTPUT Help for this particular output
--help-outputs List supported outputs and details
--help-preflights List supported preflights and details
```

27
kibot/__main__.py
View File

@ -12,7 +12,7 @@ Usage:
[-q | -v...] [-i] [-C] [-m MKFILE] [-g DEF]... [TARGET...]
kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] --list
kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] --example
kibot [-v...] [--start PATH] --quick-start
kibot [-v...] [--start PATH] [-d OUT_DIR] [--dry] --quick-start
kibot [-v...] --help-filters
kibot [-v...] --help-global-options
kibot [-v...] --help-list-outputs
@ -26,32 +26,37 @@ Arguments:
TARGET Outputs to generate, default is all
Options:
-h, --help Show this help message and exit
-b BOARD, --board-file BOARD The PCB .kicad-pcb board file
-c CONFIG, --plot-config CONFIG The plotting config file to use
-C, --cli-order Generate outputs using the indicated order
-d OUT_DIR, --out-dir OUT_DIR The output directory [default: .]
-e SCHEMA, --schematic SCHEMA The schematic file (.sch)
--start PATH Starting point for --quick-start
-g DEF, --global-redef DEF Overwrite a global value (VAR=VAL)
--help-filters List supported filters and details
--help-global-options List supported global variables
--help-list-outputs List supported outputs
--help-output HELP_OUTPUT Help for this particular output
--help-outputs List supported outputs and details
--help-preflights List supported preflights and details
-i, --invert-sel Generate the outputs not listed as targets
-l, --list List available outputs (in the config file)
-m MKFILE, --makefile MKFILE Generate a Makefile (no targets created)
-p, --copy-options Copy plot options from the PCB file
-P, --copy-and-expand As -p but expand the list of layers
-q, --quiet Remove information logs
--quick-start Generates demo config files and their outputs
-s PRE, --skip-pre PRE Skip preflights, comma separated or `all`
-v, --verbose Show debugging information
-V, --version Show program's version number and exit
-x, --example Create a template configuration file
Quick start options:
--quick-start Generates demo config files and their outputs
--start PATH Starting point for the search [default: .]
--dry Just generate the config files
Help options:
-h, --help Show this help message and exit
--help-filters List supported filters and details
--help-global-options List supported global variables
--help-list-outputs List supported outputs
--help-output HELP_OUTPUT Help for this particular output
--help-outputs List supported outputs and details
--help-preflights List supported preflights and details
"""
__author__ = 'Salvador E. Tropea, John Beard'
__copyright__ = 'Copyright 2018-2021, Salvador E. Tropea/INTI/John Beard'
@ -276,7 +281,7 @@ def main():
sys.exit(0)
if args.quick_start:
# Some kind of wizard to get usable examples
generate_examples(args.start)
generate_examples(args.start, args.dry)
sys.exit(0)
# Determine the YAML file

114
kibot/kiplot.py
View File

@ -27,6 +27,7 @@ from .misc import (PLOT_ERROR, MISSING_TOOL, CMD_EESCHEMA_DO, URL_EESCHEMA_DO, C
MOD_SMD, MOD_THROUGH_HOLE, MOD_VIRTUAL, W_PCBNOSCH, W_NONEEDSKIP, W_WRONGCHAR, name2make, W_TIMEOUT,
W_KIAUTO, W_VARSCH, NO_SCH_FILE, NO_PCB_FILE, W_VARPCB, NO_YAML_MODULE, WRONG_ARGUMENTS)
from .error import PlotError, KiPlotConfigurationError, config_error, trace_dump
from .config_reader import CfgYamlReader
from .pre_base import BasePreFlight
from .kicad.v5_sch import Schematic, SchFileError, SchError
from .kicad.v6_sch import SchematicV6
@ -358,7 +359,7 @@ def get_output_dir(o_dir, obj, dry=False):
return outdir
def config_output(out, dry=False):
def config_output(out, dry=False, dont_stop=False):
if out._configured:
return
# Should we load the PCB?
@ -367,13 +368,20 @@ def config_output(out, dry=False):
load_board()
if out.is_sch():
load_sch()
ok = True
try:
out.config(None)
except KiPlotConfigurationError as e:
config_error("In section '"+out.name+"' ("+out.type+"): "+str(e))
msg = "In section '"+out.name+"' ("+out.type+"): "+str(e)
if dont_stop:
logger.error(msg)
else:
config_error(msg)
ok = False
return ok
def run_output(out):
def run_output(out, dont_stop=False):
if out._done:
return
GS.current_output = out.name
@ -382,19 +390,24 @@ def run_output(out):
out._done = True
except PlotError as e:
logger.error("In output `"+str(out)+"`: "+str(e))
exit(PLOT_ERROR)
if not dont_stop:
exit(PLOT_ERROR)
except KiPlotConfigurationError as e:
config_error("In section '"+out.name+"' ("+out.type+"): "+str(e))
msg = "In section '"+out.name+"' ("+out.type+"): "+str(e)
if dont_stop:
logger.error(msg)
else:
config_error(msg)
def generate_outputs(outputs, target, invert, skip_pre, cli_order):
def generate_outputs(outputs, target, invert, skip_pre, cli_order, dont_stop=False):
logger.debug("Starting outputs for board {}".format(GS.pcb_file))
preflight_checks(skip_pre)
# Check if the preflights pulled options
for out in RegOutput.get_prioritary_outputs():
config_output(out)
logger.info('- '+str(out))
run_output(out)
if config_output(out, dont_stop=dont_stop):
logger.info('- '+str(out))
run_output(out)
# Check if all must be skipped
n = len(target)
if n == 0 and invert:
@ -412,17 +425,17 @@ def generate_outputs(outputs, target, invert, skip_pre, cli_order):
# Use the CLI order
for name in target:
out = RegOutput.get_output(name)
config_output(out)
logger.info('- '+str(out))
run_output(out)
if config_output(out, dont_stop=dont_stop):
logger.info('- '+str(out))
run_output(out, dont_stop)
else:
# Use the declaration order
for out in RegOutput.get_outputs():
if (((n == 0 or ((out.name not in target) and invert)) and out.run_by_default) or
((out.name in target) and not invert)):
config_output(out)
logger.info('- '+str(out))
run_output(out)
if config_output(out, dont_stop=dont_stop):
logger.info('- '+str(out))
run_output(out, dont_stop)
else:
logger.debug('Skipping `%s` output', str(out))
@ -732,7 +745,9 @@ def look_for_used_layers():
return layers
def generate_one_example(dest_dir):
def discover_files(dest_dir):
""" Look for schematic and PCBs at the dest_dir.
Return the name of the example file to generate. """
GS.pcb_file = None
GS.sch_file = None
# Check if we have useful files
@ -740,6 +755,12 @@ def generate_one_example(dest_dir):
GS.set_sch(solve_schematic(dest_dir, sug_e=False))
GS.set_pcb(solve_board_file(dest_dir, sug_b=False))
GS.set_pro(solve_project_file())
return fname
def generate_one_example(dest_dir):
""" Generate a example config for dest_dir """
fname = discover_files(dest_dir)
# Abort if none
if not GS.pcb_file and not GS.sch_file:
return None
@ -761,6 +782,14 @@ def generate_one_example(dest_dir):
layers = look_for_used_layers()
if GS.sch_file:
load_sch()
# Filter some warnings
fil = [{'number': 1007}, # No information for a component in a distributor
{'number': 1015}, # More than one component in a search for a distributor
{'number': 58}, # Missing project file
]
glb = {'filters': fil}
f.write(yaml.dump({'global': glb}, sort_keys=False))
f.write('\n')
# A helper for the JLCPCB stuff
fil = {'name': 'only_jlc_parts'}
fil['comment'] = 'Only parts with JLC (LCSC) code'
@ -800,6 +829,21 @@ def generate_one_example(dest_dir):
return fname
def generate_targets(config_file):
""" Generate all possible targets for the configuration file """
# Reset the board and schematic
GS.board = None
GS.sch = None
# Reset the list of outputs
RegOutput.reset()
# Read the config file
cr = CfgYamlReader()
with open(config_file) as cf_file:
outputs = cr.read(cf_file)
# Do all the job
generate_outputs(outputs, [], False, None, False, dont_stop=True)
def _walk(path, depth):
""" Recursively list files and directories up to a certain depth """
depth -= 1
@ -810,7 +854,7 @@ def _walk(path, depth):
yield from _walk(entry.path, depth)
def generate_examples(start_dir):
def generate_examples(start_dir, dry):
if not start_dir:
start_dir = '.'
else:
@ -818,7 +862,7 @@ def generate_examples(start_dir):
logger.error('Invalid dir {} to quick start'.format(start_dir))
exit(WRONG_ARGUMENTS)
# Set default global options
glb = GS.global_opts_class()
glb = GS.class_for_global_opts()
glb.set_tree({})
glb.config(None)
# Look for candidate dirs
@ -829,13 +873,43 @@ def generate_examples(start_dir):
candidates.add(os.path.dirname(f))
# Try to generate the configs in the candidate places
confs = []
for c in candidates:
for c in sorted(candidates):
logger.info('Analyzing `{}` dir'.format(c))
res = generate_one_example(c)
if res:
confs.append(res)
logger.info('')
logger.debug(confs)
confs.sort()
# Just the configs, not the targets
if dry:
return
# Try to generate all the stuff
if GS.out_dir_in_cmd_line:
out_dir = GS.out_dir
else:
out_dir = 'Generated'
for n, c in enumerate(confs):
conf_dir = os.path.dirname(c)
if len(confs) > 1:
subdir = '%03d-%s' % (n+1, conf_dir.replace('/', ',').replace(' ', '_'))
dest = os.path.join(out_dir, subdir)
else:
dest = out_dir
GS.out_dir = dest
logger.info('Generating targets for `{}`, destination: `{}`'.format(c, dest))
os.makedirs(dest, exist_ok=True)
# Create a log file with all the debug we can
fl = log.set_file_log(os.path.join(dest, 'kibot.log'))
old_lvl = GS.debug_level
GS.debug_level = 10
# Detect the SCH and PCB again
discover_files(conf_dir)
# Generate all targets
generate_targets(c)
# Close the debug file
log.remove_file_log(fl)
GS.debug_level = old_lvl
logger.info('')
# To avoid circular dependencies: Optionable needs it, but almost everything needs Optionable

11
kibot/registrable.py
View File

@ -50,6 +50,17 @@ class RegOutput(Optionable, Registrable):
def __init__(self):
super().__init__()
@staticmethod
def reset():
# List of defined filters
RegOutput._def_filters = {}
# List of defined variants
RegOutput._def_variants = {}
# List of defined outputs
RegOutput._def_outputs = OrderedDict()
# List of priority outputs
RegOutput._prio_outputs = OrderedDict()
@staticmethod
def add_variants(variants):
RegOutput._def_variants.update(variants)