forked from obra/kicad-automation-scripts
-
Notifications
You must be signed in to change notification settings - Fork 18
/
misc.py
293 lines (279 loc) · 11.5 KB
/
misc.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# -*- coding: utf-8 -*-
# Copyright (c) 2020-2021 Salvador E. Tropea
# Copyright (c) 2020-2021 Instituto Nacional de Tecnologïa Industrial
# License: Apache 2.0
# Project: KiAuto (formerly kicad-automation-scripts)
import os
import re
import json
import configparser
from contextlib import contextmanager
from sys import exit, path
from subprocess import check_output, DEVNULL
# Default W,H for recording
REC_W = 1366
REC_H = 960
# Return error codes
# Positive values are ERC/DRC errors
NO_SCHEMATIC = 1
WRONG_ARGUMENTS = 2 # This is what argsparse uses
EESCHEMA_CFG_PRESENT = 11
KICAD_CFG_PRESENT = 3
NO_PCB = 4
PCBNEW_CFG_PRESENT = 5
WRONG_LAYER_NAME = 6
WRONG_PCB_NAME = 7
WRONG_SCH_NAME = 8
PCBNEW_ERROR = 9
EESCHEMA_ERROR = 10
NO_PCBNEW_MODULE = 11
USER_HOTKEYS_PRESENT = 12
CORRUPTED_PCB = 13
NO_EN_LOCALE = 14
MISSING_TOOL = 15
# Wait 40 s to pcbnew/eeschema window to be present
WAIT_START = 60
# Name for testing versions
NIGHTLY = 'nightly'
# Scale factor for the timeouts
TIME_OUT_MULT = 1.0
KICAD_VERSION_5_99 = 5099000
KICAD_SHARE = '/usr/share/kicad/'
KICAD_NIGHTLY_SHARE = '/usr/share/kicad-nightly/'
@contextmanager
def hide_stderr():
""" Low level stderr supression, used to hide KiCad bugs. """
newstderr = os.dup(2)
devnull = os.open('/dev/null', os.O_WRONLY)
os.dup2(devnull, 2)
os.close(devnull)
yield
os.dup2(newstderr, 2)
class Config(object):
def __init__(self, logger, input_file=None, args=None):
self.export_format = 'pdf'
if input_file:
self.input_file = input_file
self.input_no_ext = os.path.splitext(input_file)[0]
#
# As soon as we init pcbnew the following files are modified:
#
if os.path.isfile(self.input_no_ext+'.pro'):
self.start_pro_stat = os.stat(self.input_no_ext+'.pro')
else:
self.start_pro_stat = None
if os.path.isfile(self.input_no_ext+'.kicad_pro'):
self.start_kicad_pro_stat = os.stat(self.input_no_ext+'.kicad_pro')
else:
self.start_kicad_pro_stat = None
if os.path.isfile(self.input_no_ext+'.kicad_prl'):
self.start_kicad_prl_stat = os.stat(self.input_no_ext+'.kicad_prl')
else:
self.start_kicad_prl_stat = None
if args:
# Session debug
self.use_wm = args.use_wm # Use a Window Manager, dialogs behaves in a different way
self.start_x11vnc = args.start_x11vnc
self.rec_width = args.rec_width
self.rec_height = args.rec_height
self.record = args.record
self.video_dir = args.output_dir
self.wait_for_key = args.wait_key
self.time_out_scale = args.time_out_scale
# Others
if hasattr(args, 'file_format'):
self.export_format = args.file_format.lower()
else:
# Session debug
self.use_wm = False
self.start_x11vnc = False
self.rec_width = REC_W
self.rec_height = REC_H
self.record = False
self.video_dir = None
self.wait_for_key = False
self.time_out_scale = 1.0
self.colordepth = 24
self.video_name = None
self.video_dir = self.output_dir = ''
# Executable and dirs
self.eeschema = 'eeschema'
self.pcbnew = 'pcbnew'
self.kicad2step = 'kicad2step'
self.kicad_conf_dir = 'kicad'
ng_ver = os.environ.get('KIAUS_USE_NIGHTLY')
if ng_ver:
self.eeschema += '-'+NIGHTLY
self.pcbnew += '-'+NIGHTLY
self.kicad2step += '-'+NIGHTLY
self.kicad_conf_dir += os.path.join(NIGHTLY, ng_ver)
# Path to the Python module
path.insert(0, '/usr/lib/kicad-nightly/lib/python3/dist-packages')
# Detect KiCad version
try:
import pcbnew
except ImportError:
logger.error("Failed to import pcbnew Python module."
" Is KiCad installed?"
" Do you need to add it to PYTHONPATH?")
exit(NO_PCBNEW_MODULE)
kicad_version = pcbnew.GetBuildVersion()
try:
# Debian sid may 2021 mess:
really_index = kicad_version.index('really')
kicad_version = kicad_version[really_index+6:]
except ValueError:
pass
m = re.search(r'(\d+)\.(\d+)\.(\d+)', kicad_version)
if m is None:
logger.error("Unable to detect KiCad version, got: `{}`".format(kicad_version))
exit(NO_PCBNEW_MODULE)
self.kicad_version_major = int(m.group(1))
self.kicad_version_minor = int(m.group(2))
self.kicad_version_patch = int(m.group(3))
self.kicad_version = self.kicad_version_major*1000000+self.kicad_version_minor*1000+self.kicad_version_patch
logger.debug('Detected KiCad v{}.{}.{} ({} {})'.format(self.kicad_version_major, self.kicad_version_minor,
self.kicad_version_patch, kicad_version, self.kicad_version))
self.ki5 = self.kicad_version < KICAD_VERSION_5_99
# Config file names
if not self.ki5:
self.kicad_conf_path = pcbnew.GetSettingsManager().GetUserSettingsPath()
# No longer needed for 202112021512+6.0.0+rc1+287+gbb08ef2f41+deb11
# if ng_ver:
# self.kicad_conf_path = self.kicad_conf_path.replace('/kicad/', '/kicadnightly/')
else:
# Bug in KiCad (#6989), prints to stderr:
# `../src/common/stdpbase.cpp(62): assert "traits" failed in Get(test_dir): create wxApp before calling this`
# Found in KiCad 5.1.8, 5.1.9
# So we temporarily supress stderr
with hide_stderr():
self.kicad_conf_path = pcbnew.GetKicadConfigPath()
logger.debug('Config path {}'.format(self.kicad_conf_path))
# First we solve kicad_common because it can redirect to another config dir
self.conf_kicad = os.path.join(self.kicad_conf_path, 'kicad_common')
self.conf_kicad_bkp = None
if not self.ki5:
self.conf_kicad += '.json'
self.conf_kicad_json = True
else:
self.conf_kicad_json = False
# Read the environment redefinitions used by KiCad
if os.path.isfile(self.conf_kicad):
self.load_kicad_environment(logger)
if 'KICAD_CONFIG_HOME' in self.env and self.ki5:
# The user is redirecting the configuration
# KiCad 5 unintentionally allows it, is a bug, and won't be fixed:
# https://forum.kicad.info/t/kicad-config-home-inconsistencies-and-detail/26875
self.kicad_conf_path = self.env['KICAD_CONFIG_HOME']
logger.debug('Redirecting KiCad config path to: '+self.kicad_conf_path)
else:
logger.warning('Missing KiCad main config file '+self.conf_kicad)
# - eeschema config
self.conf_eeschema = os.path.join(self.kicad_conf_path, 'eeschema')
self.conf_eeschema_bkp = None
# - pcbnew config
self.conf_pcbnew = os.path.join(self.kicad_conf_path, 'pcbnew')
self.conf_pcbnew_bkp = None
# Config files that migrated to JSON
# Note that they remain in the old format until saved
if not self.ki5:
self.conf_eeschema += '.json'
self.conf_pcbnew += '.json'
self.conf_eeschema_json = True
self.conf_pcbnew_json = True
self.pro_ext = 'kicad_pro'
self.prl_ext = 'kicad_prl'
self.conf_colors = os.path.join(self.kicad_conf_path, 'colors', 'user.json')
self.conf_colors_bkp = None
self.conf_3dview = os.path.join(self.kicad_conf_path, '3d_viewer.json')
self.conf_3dview_bkp = None
else:
self.conf_eeschema_json = False
self.conf_pcbnew_json = False
self.pro_ext = 'pro'
self.prl_ext = None
self.conf_colors = self.conf_colors_bkp = None
self.conf_3dview = self.conf_3dview_bkp = None
# - hotkeys
self.conf_hotkeys = os.path.join(self.kicad_conf_path, 'user.hotkeys')
self.conf_hotkeys_bkp = None
# - sym-lib-table
self.user_sym_lib_table = os.path.join(self.kicad_conf_path, 'sym-lib-table')
self.user_fp_lib_table = os.path.join(self.kicad_conf_path, 'fp-lib-table')
self.sys_sym_lib_table = [KICAD_SHARE+'template/sym-lib-table']
self.sys_fp_lib_table = [KICAD_SHARE+'template/fp-lib-table']
if ng_ver:
# 20200912: sym-lib-table is missing
self.sys_sym_lib_table.insert(0, KICAD_NIGHTLY_SHARE+'template/sym-lib-table')
self.sys_fp_lib_table.insert(0, KICAD_NIGHTLY_SHARE+'template/fp-lib-table')
# Some details about the UI
if not self.ki5:
# KiCad 5.99.0
# self.ee_window_title = r'\[.*\] — Eeschema$' # "PROJECT [HIERARCHY_PATH] - Eeschema"
# KiCad 6.0.0 rc1
self.ee_window_title = r'\[.*\] — Schematic Editor$' # "PROJECT [HIERARCHY_PATH] - Schematic Editor"
self.pn_window_title = r'PCB Editor$'
else:
# KiCad 5.1.6
self.ee_window_title = r'Eeschema.*\.sch' # "Eeschema - file.sch"
self.pn_window_title = r'^Pcbnew'
# Collected errors and unconnecteds (warnings)
self.errs = []
self.wrns = []
# Error filters
self.err_filters = []
def load_kicad_environment(self, logger):
self.env = {}
if self.conf_kicad_json:
env = self.get_config_vars_json(self.conf_kicad)
if env:
self.env = env
else:
env = self.get_config_vars_ini(self.conf_kicad)
if env:
for k, v in env.items():
self.env[k.upper()] = v
logger.debug('KiCad environment: '+str(self.env))
@staticmethod
def get_config_vars_json(file):
with open(file, "rt") as f:
data = json.load(f)
if 'environment' in data and 'vars' in data['environment']:
return data['environment']['vars']
return None
@staticmethod
def get_config_vars_ini(file):
config = configparser.ConfigParser()
with open(file, "rt") as f:
data = f.read()
config.read_string('[Various]\n'+data)
if 'EnvironmentVariables' in config:
return config['EnvironmentVariables']
return None
def get_en_locale(logger):
''' Looks for a usable locale with english as language '''
try:
res = check_output(['locale', '-a'], stderr=DEVNULL).decode('utf8')
except FileNotFoundError:
logger.warning("The `locale` command isn't installed. Guessing `C.UTF-8` is supported")
res = 'C.UTF-8'
found = re.search(r'en(.*)UTF-?8', res, re.I)
if found:
res = found.group(0)
else:
found = re.search(r'C\.UTF-?8', res, re.I)
if found:
res = found.group(0)
else:
logger.error("No suitable english locale found. Please add `en_US.utf8` to your system")
exit(NO_EN_LOCALE)
logger.debug('English locale: '+res)
return res
__author__ = 'Salvador E. Tropea'
__copyright__ = 'Copyright 2018-2022, INTI/Productize SPRL'
__credits__ = ['Salvador E. Tropea', 'Seppe Stas', 'Jesse Vincent', 'Scott Bezek']
__license__ = 'Apache 2.0'
__email__ = 'stropea@inti.gob.ar'
__status__ = 'stable'
__url__ = 'https://github.com/INTI-CMNB/KiAuto/'
__version__ = '1.6.9'