98 lines
3.5 KiB
Python
98 lines
3.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2022 Salvador E. Tropea
|
|
# Copyright (c) 2022 Instituto Nacional de Tecnología Industrial
|
|
# License: GPL-3.0
|
|
# Project: KiBot (formerly KiPlot)
|
|
import os
|
|
from .gs import GS
|
|
from .optionable import BaseOptions
|
|
from .misc import CMD_PCBNEW_IPC_NETLIST, URL_PCBNEW_IPC_NETLIST, CMD_EESCHEMA_DO, URL_EESCHEMA_DO, FAILED_EXECUTE
|
|
from .kiplot import check_script, exec_with_retry, add_extra_options
|
|
from .macros import macros, document, output_class # noqa: F401
|
|
from . import log
|
|
|
|
logger = log.get_logger()
|
|
|
|
|
|
class NetlistOptions(BaseOptions):
|
|
def __init__(self):
|
|
with document:
|
|
self.output = GS.def_global_output
|
|
""" Filename for the output (%i=netlist/IPC-D-356, %x=net/d356) """
|
|
self.format = 'classic'
|
|
""" [classic,ipc] The `classic` format is the KiCad internal format, and is generated
|
|
from the schematic. The `ipc` format is the IPC-D-356 format, useful for PCB
|
|
testing, is generated from the PCB """
|
|
super().__init__()
|
|
|
|
def config(self, parent):
|
|
super().config(parent)
|
|
if self.format == 'classic':
|
|
self._expand_id = 'netlist'
|
|
self._expand_ext = 'net'
|
|
else:
|
|
self._expand_id = 'IPC-D-356'
|
|
self._expand_ext = 'd356'
|
|
|
|
def run(self, name):
|
|
if self.format == 'ipc':
|
|
command = CMD_PCBNEW_IPC_NETLIST
|
|
url = URL_PCBNEW_IPC_NETLIST
|
|
subcommand = 'ipc_netlist'
|
|
extra = ['--output_name', name]
|
|
file = GS.pcb_file
|
|
else:
|
|
command = CMD_EESCHEMA_DO
|
|
url = URL_EESCHEMA_DO
|
|
subcommand = 'netlist'
|
|
extra = []
|
|
file = GS.sch_file
|
|
output_dir = os.path.dirname(name)
|
|
check_script(command, url, '1.6.11')
|
|
# Output file name
|
|
cmd = [command, subcommand]+extra+[file, output_dir]
|
|
cmd, video_remove = add_extra_options(cmd)
|
|
# Execute it
|
|
ret = exec_with_retry(cmd)
|
|
if ret:
|
|
logger.error(command+' returned %d', ret)
|
|
exit(FAILED_EXECUTE)
|
|
# Rename the output if needed
|
|
if not extra:
|
|
cur = self._parent.expand_filename(output_dir, '%f.%x')
|
|
logger.debug('Moving '+cur+' -> '+name)
|
|
os.rename(cur, name)
|
|
# Remove the video if needed
|
|
if video_remove:
|
|
video_name = os.path.join(self.expand_filename_pcb(GS.out_dir), command[:-3]+'_'+subcommand+'_screencast.ogv')
|
|
if os.path.isfile(video_name):
|
|
os.remove(video_name)
|
|
|
|
|
|
@output_class
|
|
class Netlist(BaseOutput): # noqa: F821
|
|
""" Netlist
|
|
Generates the list of connections for the project.
|
|
The netlist can be generated in the classic format and in IPC-D-356 format,
|
|
useful for board testing """
|
|
def __init__(self):
|
|
super().__init__()
|
|
with document:
|
|
self.options = NetlistOptions
|
|
""" [dict] Options for the `netlist` output """
|
|
|
|
@staticmethod
|
|
def get_conf_examples(name, layers, templates):
|
|
gb1 = {}
|
|
gb1['name'] = 'classic_'+name
|
|
gb1['comment'] = 'Schematic netlist in KiCad format'
|
|
gb1['type'] = name
|
|
gb1['dir'] = 'Export'
|
|
gb2 = {}
|
|
gb2['name'] = 'ipc_'+name
|
|
gb2['comment'] = 'IPC-D-356 netlist for testing'
|
|
gb2['type'] = name
|
|
gb2['dir'] = 'Export'
|
|
gb2['options'] = {'format': 'ipc'}
|
|
return [gb1, gb2]
|