import os import re from subprocess import (check_output, STDOUT, CalledProcessError) from .error import KiPlotConfigurationError from .misc import (KICAD2STEP, KICAD2STEP_ERR) from .kiplot import (GS) from kiplot.macros import macros, document, output_class # noqa: F401 from . import log logger = log.get_logger(__name__) @output_class class STEP(BaseOutput): # noqa: F821 """ STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure) Exports the PCB as a 3D model. This is the most common 3D format for exchange purposes. This output is what you get from the 'File/Export/STEP' menu in pcbnew. """ def __init__(self, name, type, description): super(STEP, self).__init__(name, type, description) # Options with document: self.metric_units = True """ use metric units instead of inches. """ self._origin = 'grid' """ determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet. The drill option uses the auxiliar reference defined by the user. You can define any other origin using the format 'X,Y', i.e. '3.2,-10' """ self.no_virtual = False """ used to exclude 3D models for components with 'virtual' attribute """ self.min_distance = -1 """ the minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm) """ self.output = '' """ name for the generated STEP file (the name of the PCB if empty) """ # pragma: no cover @property def origin(self): return self._origin @origin.setter def origin(self, val): if (val not in ['grid', 'drill']) and (re.match(r'[-\d\.]+\s*,\s*[-\d\.]+\s*$', val) is None): raise KiPlotConfigurationError('Origin must be `grid` or `drill` or `X,Y`') self._origin = val def run(self, output_dir, board): # Output file name output = self.output if not output: output = os.path.splitext(os.path.basename(GS.pcb_file))[0]+'.step' output = os.path.abspath(os.path.join(output_dir, output)) # Make units explicit if self.metric_units: units = 'mm' else: units = 'in' # Base command with overwrite cmd = [KICAD2STEP, '-o', output, '-f'] # Add user options if self.no_virtual: cmd.append('--no-virtual') if self.min_distance >= 0: cmd.extend(['--min-distance', "{}{}".format(self.min_distance, units)]) if self.origin == 'drill': cmd.append('--drill-origin') elif self.origin == 'grid': cmd.append('--grid-origin') else: cmd.extend(['--user-origin', "{}{}".format(self.origin.replace(',', 'x'), units)]) # The board cmd.append(GS.pcb_file) # Execute and inform is successful logger.debug('Executing: '+str(cmd)) try: cmd_output = check_output(cmd, stderr=STDOUT) except CalledProcessError as e: # pragma: no cover # Current kicad2step always returns 0!!!! # This is why I'm excluding it from coverage logger.error('Failed to create Step file, error %d', e.returncode) if e.output: logger.debug('Output from command: '+e.output.decode()) exit(KICAD2STEP_ERR) logger.debug('Output from command:\n'+cmd_output.decode())