# -*- coding: utf-8 -*- # Copyright (c) 2020-2022 Salvador E. Tropea # Copyright (c) 2020-2022 Instituto Nacional de Tecnología Industrial # License: GPL-3.0 # Project: KiBot (formerly KiPlot) import os import re import json try: import pcbnew except ImportError: # This is caught by __main__, ignore the error here class pcbnew(object): pass from datetime import datetime, date from sys import exit from shutil import copy2 from .misc import EXIT_BAD_ARGS, W_DATEFORMAT, W_UNKVAR, WRONG_INSTALL from .log import get_logger logger = get_logger(__name__) class GS(object): """ Class to keep the global settings. Is a static class, just a placeholder for some global variables. """ # PCB name and useful parts pcb_file = None # /.../dir/pcb.kicad_pcb pcb_no_ext = None # /.../dir/pcb pcb_dir = None # /.../dir pcb_basename = None # pcb # SCH name and useful parts sch_file = None # /.../dir/file.sch sch_no_ext = None # /.../dir/file sch_dir = None # /.../dir sch_basename = None # file # Project and useful parts pro_file = None # /.../dir/file.kicad_pro (or .pro) pro_no_ext = None # /.../dir/file pro_dir = None # /.../dir pro_basename = None # file pro_ext = '.pro' pro_variables = None # KiCad 6 text variables defined in the project vars_regex = re.compile(r'\$\{([^\}]+)\}') # Main output dir out_dir = None out_dir_in_cmd_line = False filter_file = None board = None sch = None debug_enabled = False debug_level = 0 kibot_version = None n = datetime.now() kicad_version = '' kicad_conf_path = None kicad_share_path = None kicad_dir = 'kicad' kicad_plugins_dirs = [] work_layer = 'Rescue' # KiCad version: major*1e6+minor*1e3+patch kicad_version_n = 0 kicad_version_major = 0 kicad_version_minor = 0 kicad_version_patch = 0 # Data from the SCH because it doesn't have a Python API sch_title = None sch_date = None sch_rev = None sch_comp = None sch_com = [None]*9 # Data from the board title block pcb_title = None pcb_date = None pcb_rev = None pcb_comp = None pcb_com = [None]*9 # Current variant/s variant = None # All the outputs outputs = None # Name for the output we are generating current_output = None test_boolean = True test_number = 5 stackup = None # Preprocessor definitions cli_defines = {} # # Global defaults # # Options from command line cli_global_defs = {} # The variant value, but already solved solved_global_variant = None # This is used as default value for classes supporting "output" option def_global_output = '%f-%i%I%v.%x' # The class that controls the global options class_for_global_opts = None global_castellated_pads = None global_copper_thickness = None global_cross_footprints_for_dnp = None global_cross_no_body = None global_csv_accept_no_ref = None global_date_format = None global_date_time_format = None global_drc_exclusions_workaround = None global_dir = None global_disable_3d_alias_as_env = None global_drill_size_increment = None global_edge_connector = None global_edge_plating = None global_extra_pth_drill = None global_field_3D_model = None global_hide_excluded = None global_kiauto_time_out_scale = None global_kiauto_wait_start = None global_impedance_controlled = None # This value will overwrite GS.def_global_output if defined # Classes supporting global "output" option must call super().__init__() # after defining its own options to allow Optionable do the overwrite. global_output = None global_pcb_finish = None global_pcb_material = None global_remove_solder_paste_for_dnp = None global_remove_adhesive_for_dnp = None global_restore_project = None global_set_text_variables_before_output = None global_silk_screen_color = None global_silk_screen_color_bottom = None global_silk_screen_color_top = None global_solder_mask_color = None global_solder_mask_color_bottom = None global_solder_mask_color_top = None global_time_format = None global_time_reformat = None global_units = None global_use_dir_for_preflights = None global_variant = None @staticmethod def set_sch(name): if name: name = os.path.abspath(name) GS.sch_file = name GS.sch_basename = os.path.splitext(os.path.basename(name))[0] GS.sch_no_ext = os.path.splitext(name)[0] GS.sch_dir = os.path.dirname(name) @staticmethod def set_pcb(name): if name: name = os.path.abspath(name) GS.pcb_file = name GS.pcb_basename = os.path.splitext(os.path.basename(name))[0] GS.pcb_no_ext = os.path.splitext(name)[0] GS.pcb_dir = os.path.dirname(name) @staticmethod def set_pro(name): if name: name = os.path.abspath(name) GS.pro_file = name GS.pro_basename = os.path.splitext(os.path.basename(name))[0] GS.pro_no_ext = os.path.splitext(name)[0] GS.pro_dir = os.path.dirname(name) @staticmethod def load_pro_variables(): if GS.pro_variables is not None: return GS.pro_variables if GS.pro_file is None or GS.pro_ext == '.pro': return {} # Get the text_variables with open(GS.pro_file, 'rt') as f: pro_text = f.read() data = json.loads(pro_text) GS.pro_variables = data.get('text_variables', {}) logger.debug("Current text variables: {}".format(GS.pro_variables)) return GS.pro_variables @staticmethod def read_pro(): if GS.pro_file: # Note: We use binary mode to preserve the original end of lines # Otherwise git could see changes in the file with open(GS.pro_file, 'rb') as f: return f.read() @staticmethod def write_pro(prj): if GS.pro_file and prj: with open(GS.pro_file, 'wb') as f: f.write(prj) @staticmethod def load_sch_title_block(): if GS.sch_title is not None: return assert GS.sch is not None GS.sch_title = GS.sch.title GS.sch_date = GS.sch.date GS.sch_rev = GS.sch.revision GS.sch_comp = GS.sch.company GS.sch_com = GS.sch.comment @staticmethod def format_date(d, fname, what): if not d: return datetime.fromtimestamp(os.path.getmtime(fname)).strftime(GS.global_date_time_format) elif GS.global_time_reformat: try: dt = date.fromisoformat(d) except ValueError as e: logger.warning(W_DATEFORMAT+"Trying to reformat {} time, but not in ISO format ({})".format(what, d)) logger.warning(W_DATEFORMAT+"Problem: {}".format(e)) return d return dt.strftime(GS.global_date_format) return d @staticmethod def get_pcb_comment(title_block, num): if GS.ki6: # Backward compatibility ... what's this? # Also: Maintaining the same numbers used before (and found in the file) is asking too much? return title_block.GetComment(num) if num == 0: return title_block.GetComment1() if num == 1: return title_block.GetComment2() if num == 2: return title_block.GetComment3() if num == 3: return title_block.GetComment4() return '' @staticmethod def get_modules(): if GS.ki6: return GS.board.GetFootprints() return GS.board.GetModules() @staticmethod def get_modules_board(board): if GS.ki6: return board.GetFootprints() return board.GetModules() @staticmethod def get_aux_origin(): if GS.board is None: return (0, 0) if GS.ki6: settings = GS.board.GetDesignSettings() return settings.GetAuxOrigin() return GS.board.GetAuxOrigin() @staticmethod def get_center(m): if GS.ki5: return m.GetCenter() return m.GetPosition() @staticmethod def get_fp_size(m): if GS.ki5: pads = m.Pads() r = pcbnew.EDA_RECT() for pad in pads: r.Merge(pad.GetBoundingBox()) rot = m.GetOrientationDegrees() if rot == 270 or rot == 90: return (r.GetHeight(), r.GetWidth()) return (r.GetWidth(), r.GetHeight()) # KiCad 6 r = m.GetFpPadsLocalBbox() return (r.GetWidth(), r.GetHeight()) @staticmethod def unit_name_to_scale_factor(units): if units == 'millimeters': return 1.0/pcbnew.IU_PER_MM if units == 'mils': return 1.0/pcbnew.IU_PER_MILS # Inches return 0.001/pcbnew.IU_PER_MILS @staticmethod def make_bkp(fname): bkp = fname+'-bak' if os.path.isfile(bkp): os.remove(bkp) os.rename(fname, bkp) @staticmethod def zones(): return pcbnew.ZONES() if GS.ki6 else pcbnew.ZONE_CONTAINERS() @staticmethod def layers_contains(layers, id): if GS.ki6: return layers.Contains(id) return id in layers.Seq() @staticmethod def expand_text_variables(text, extra_vars=None): vars = GS.load_pro_variables() new_text = '' last = 0 text_l = len(text) for match in GS.vars_regex.finditer(text): vname = match.group(1) value = vars.get(vname, None) if value is None and extra_vars is not None: value = extra_vars.get(vname, None) if value is None: value = '${'+vname+'}' logger.warning(W_UNKVAR+"Unknown text variable `{}`".format(vname)) if match.start(): new_text += text[last:match.start()] new_text += value last = match.end() if last < text_l: new_text += text[last:text_l] if new_text != text: if GS.debug_level > 3: logger.debug('Replacing KiCad text variables: {} -> {}'.format(text, new_text)) return new_text @staticmethod def load_pcb_title_block(): if GS.pcb_title is not None: return GS.pcb_title = '' GS.pcb_date = '' GS.pcb_rev = '' GS.pcb_comp = '' # This is based on InterativeHtmlBom expansion title_block = GS.board.GetTitleBlock() GS.pcb_date = GS.format_date(GS.expand_text_variables(title_block.GetDate()), GS.pcb_file, 'PCB') GS.pcb_title = GS.expand_text_variables(title_block.GetTitle()) if not GS.pcb_title: GS.pcb_title = GS.pcb_basename GS.pcb_rev = GS.expand_text_variables(title_block.GetRevision()) GS.pcb_comp = GS.expand_text_variables(title_block.GetCompany()) for num in range(9): GS.pcb_com[num] = GS.expand_text_variables(GS.get_pcb_comment(title_block, num)) logger.debug("PCB title: `{}`".format(GS.pcb_title)) logger.debug("PCB date: `{}`".format(GS.pcb_date)) logger.debug("PCB revision: `{}`".format(GS.pcb_rev)) logger.debug("PCB company: `{}`".format(GS.pcb_comp)) for num in range(4 if GS.ki5 else 9): logger.debug("PCB comment {}: `{}`".format(num+1, GS.pcb_com[num])) @staticmethod def check_pcb(): if not GS.pcb_file: logger.error('No PCB file found (*.kicad_pcb), use -b to specify one.') exit(EXIT_BAD_ARGS) @staticmethod def check_sch(): if not GS.sch_file: logger.error('No SCH file found (*.sch), use -e to specify one.') exit(EXIT_BAD_ARGS) @staticmethod def copy_project(new_pcb_name): pro_name = GS.pro_file if pro_name is None or not os.path.isfile(pro_name): return None pro_copy = new_pcb_name.replace('.kicad_pcb', GS.pro_ext) logger.debug('Copying project `{}` to `{}`'.format(pro_name, pro_copy)) copy2(pro_name, pro_copy) return pro_copy @staticmethod def load_board(): """ Will be repplaced by kiplot.py """ raise AssertionError() @staticmethod def load_sch(): """ Will be repplaced by kiplot.py """ raise AssertionError() @staticmethod def get_useful_layers(useful, layers, include_copper=False): """ Filters layers selecting the ones from useful """ from .layer import Layer if include_copper: # This is a list of layers that we could add useful = {la._id for la in Layer.solve(useful)} # Now filter the list of layers using the ones we are interested on return [la for la in layers if (include_copper and la.is_copper()) or la._id in useful] # Similar but keeping the sorting of useful use = {la._id for la in layers} return [la for la in Layer.solve(useful) if la._id in use] @staticmethod def ensure_tool(context, name): """ Looks for a mandatory dependency """ return GS.check_tool_dep(context, name, fatal=True) @staticmethod def check_tool(context, name): """ Looks for a dependency """ return GS.check_tool_dep(context, name, fatal=False) @staticmethod def get_resource_path(name): # Try relative to the script dir_name = os.path.join(os.path.dirname(__file__), 'resources', name) if os.path.isdir(dir_name): return dir_name # Try using the system level path dir_name = os.path.join('usr', 'share', 'kibot', name) if os.path.isdir(dir_name): return dir_name logger.error('Missing resource directory `{}`'.format(name)) exit(WRONG_INSTALL)