-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathsave_restore_layout.py
1232 lines (1042 loc) · 51.8 KB
/
save_restore_layout.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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# save_restore_layout.py
#
# Copyright (C) 2022 Mitja Nemec
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
#
import pcbnew
from collections import namedtuple
import logging
import math
import os
import tempfile
import hashlib
import pickle
with open(os.path.join(os.path.join(os.path.dirname(os.path.abspath(__file__))), 'version.txt')) as fp:
VERSION = fp.readline()
Footprint = namedtuple('Footprint', ['ref', 'fp', 'fp_id', 'sheet_id', 'filename'])
LayoutData = namedtuple('LayoutData', ['version', 'layout', 'hash', 'dict_of_sheets', 'list_of_local_nets',
'level', 'level_filename', 'layer_count'])
logger = logging.getLogger(__name__)
def rotate_around_center(coordinates, angle):
""" rotate coordinates for a defined angle in degrees around coordinate center"""
new_x = coordinates[0] * math.cos(2 * math.pi * angle / 360) \
- coordinates[1] * math.sin(2 * math.pi * angle / 360)
new_y = coordinates[0] * math.sin(2 * math.pi * angle / 360) \
+ coordinates[1] * math.cos(2 * math.pi * angle / 360)
return new_x, new_y
def rotate_around_point(old_position, point, angle):
""" rotate coordinates for a defined angle in degrees around a point """
# get relative position to point
rel_x = old_position[0] - point[0]
rel_y = old_position[1] - point[1]
# rotate around
new_rel_x, new_rel_y = rotate_around_center((rel_x, rel_y), angle)
# get absolute position
new_position = (new_rel_x + point[0], new_rel_y + point[1])
return new_position
def get_sch_hash(sch_file, md5hash):
# load sch file
with open(sch_file, 'rb') as f:
file_contents = f.read().decode('utf-8').replace("\r", "")
sch_lines = file_contents.split('\n')
# remove reference and value fields
filtered_contents = []
for line in sch_lines:
if "(property \"Reference\" " not in line and "(property \"Value\" " not in line:
filtered_contents.append(line)
# calculate the hash
hash_lines = [hashlib.md5(line.encode('utf-8')).hexdigest() for line in filtered_contents]
# sort hashes
hash_lines.sort()
# get hash of hashes
for h in hash_lines:
md5hash.update(h.encode('utf-8'))
return md5hash
def get_index_of_tuple(list_of_tuples, index, value):
for pos, t in enumerate(list_of_tuples):
if t[index] == value:
return pos
def flipped_angle(angle):
if angle > 0:
return 180 - angle
else:
return -180 - angle
def get_footprint_text_items(footprint):
""" get all text item belonging to a footprint """
list_of_items = [footprint.fp.Reference(), footprint.fp.Value()]
footprint_items = footprint.fp.GraphicalItems()
for item in footprint_items:
if type(item) is pcbnew.FP_TEXT:
list_of_items.append(item)
return list_of_items
class PrjData:
def __init__(self, board, dont_parse_schematics=False):
self.board = board
self.level = None
self.src_anchor_fp = None
self.src_sheet = None
self.src_footprints = []
self.src_local_nets = []
self.src_bounding_box = None
self.src_tracks = []
self.src_zones = []
self.src_text = []
self.src_drawings = []
self.pcb_filename = os.path.abspath(board.GetFileName())
self.sch_filename = self.pcb_filename.replace(".kicad_pcb", ".kicad_sch")
self.project_folder = os.path.dirname(self.pcb_filename)
# construct a list of footprints with all pertinent data
logger.info('getting a list of all footprints on board')
footprints = board.GetFootprints()
self.footprints = []
# get dict_of_sheets from layout data only (through footprint Sheetfile and Sheetname properties)
self.dict_of_sheets = {}
unique_sheet_ids = set()
for fp in footprints:
# construct a set of unique sheets from footprint properties
path = fp.GetPath().AsString().upper().replace('00000000-0000-0000-0000-0000', '').split("/")
sheet_path = path[0:-1]
for x in sheet_path:
unique_sheet_ids.add(x)
sheet_id = self.get_sheet_id(fp)
try:
sheet_file = fp.GetProperty('Sheetfile')
sheet_name = fp.GetProperty('Sheetname')
except KeyError:
logger.info("Footprint " + fp.GetReference() +
" does not have Sheetfile property, it will not be considered for placement."
" Most likely it is only in layout")
continue
# footprint is in the schematics and has Sheetfile property
if sheet_file and sheet_id:
self.dict_of_sheets[sheet_id] = [sheet_name, sheet_file]
# footprint is in the schematics but has no Sheetfile properties
elif sheet_id:
logger.info("Footprint " + fp.GetReference() + " does not have Sheetfile property")
raise LookupError("Footprint " + str(
fp.GetReference()) + " doesn't have Sheetfile and Sheetname properties. "
"You need to update the layout from schematics")
# footprint is only in the layout
else:
logger.debug("Footprint " + fp.GetReference() + " is only in layout")
# catch corner cases with nested hierarchy, where some hierarchical pages don't have any footprints
unique_sheet_ids.remove("")
if (len(unique_sheet_ids) > len(self.dict_of_sheets)) and not dont_parse_schematics:
# open root schematics file and parse for other schematics files
# This might be prone to errors regarding path discovery
# thus it is used only in corner cases
schematic_found = {}
self.parse_schematic_files(self.sch_filename, schematic_found)
self.dict_of_sheets = schematic_found
# construct a list of all the footprints
for fp in footprints:
fp_tuple = Footprint(fp=fp,
fp_id=self.get_footprint_id(fp),
sheet_id=self.get_sheet_path(fp)[0],
filename=self.get_sheet_path(fp)[1],
ref=fp.GetReference())
self.footprints.append(fp_tuple)
pass
# TODO check if there is any other footprint fit same ID as anchor footprint
def parse_schematic_files(self, filename, dict_of_sheets):
with open(filename) as f:
contents = f.read().split("\n")
filename_dir = os.path.dirname(filename)
# find (sheet (at and then look in next few lines for new schematics file
for i in range(len(contents)):
line = contents[i]
if "(sheet (at" in line:
sheetname = ""
sheetfile = ""
sheet_id = ""
for j in range(i,i+10):
if "(uuid " in contents[j]:
sheet_id = contents[j].lstrip("(uuid ").rstrip(")")
if "(property \"Sheet name\"" in contents[j]:
sheetname = contents[j].lstrip("(property \"Sheet name\"").split()[0].replace("\"", "")
if "(property \"Sheet file\"" in contents[j]:
sheetfile = contents[j].lstrip("(property \"Sheet file\"").split()[0].replace("\"", "")
sheetfilepath = os.path.join(filename_dir, sheetfile)
# here I should find all sheet data
dict_of_sheets[sheet_id] = [sheetname, sheetfilepath]
# test if newfound file can be opened
if not os.path.exists(sheetfilepath):
raise LookupError(f'File {sheetfilepath} does not exists. This is either due to error in parsing'
f' schematics files, missing schematics file or an error within the schematics')
# open a newfound file and look for nested sheets
self.parse_schematic_files(sheetfilepath, dict_of_sheets)
return
def get_fp_by_ref(self, ref):
for fp in self.footprints:
if fp.ref == ref:
return fp
return None
@staticmethod
def get_footprint_id(footprint):
path = footprint.GetPath().AsString().upper().replace('00000000-0000-0000-0000-0000', '').split("/")
if len(path) != 1:
fp_id = path[-1]
# if path is empty, then footprint is not part of schematics
else:
fp_id = None
return fp_id
@staticmethod
def get_sheet_id(footprint):
path = footprint.GetPath().AsString().upper().replace('00000000-0000-0000-0000-0000', '').split("/")
if len(path) != 1:
sheet_id = path[-2]
# if path is empty, then footprint is not part of schematics
else:
sheet_id = None
return sheet_id
def get_sheet_path(self, footprint):
""" get sheet id """
path = footprint.GetPath().AsString().upper().replace('00000000-0000-0000-0000-0000', '').split("/")
if len(path) != 1:
sheet_path = path[0:-1]
sheet_names = [self.dict_of_sheets[x][0] for x in sheet_path if x in self.dict_of_sheets]
sheet_files = [self.dict_of_sheets[x][1] for x in sheet_path if x in self.dict_of_sheets]
sheet_path = [sheet_names, sheet_files]
else:
sheet_path = ["", ""]
return sheet_path
def get_fp_by_ref(self, ref):
for fp in self.footprints:
if fp.ref == ref:
return fp
return None
def get_footprints_on_sheet(self, level):
footprints_on_sheet = []
level_depth = len(level)
for fp in self.footprints:
if level == fp.sheet_id[0:level_depth]:
footprints_on_sheet.append(fp)
return footprints_on_sheet
def get_footprints_not_on_sheet(self, level):
footprints_not_on_sheet = []
level_depth = len(level)
for fp in self.footprints:
if level != fp.sheet_id[0:level_depth]:
footprints_not_on_sheet.append(fp)
return footprints_not_on_sheet
@staticmethod
def get_nets_from_footprints(footprints):
# go through all footprints and their pads and get the nets they are connected to
nets = []
for fp in footprints:
# get their pads
pads = fp.fp.Pads()
# get net
for pad in pads:
nets.append(pad.GetNetname())
# remove duplicates
nets_clean = []
for i in nets:
if i not in nets_clean:
nets_clean.append(i)
return nets_clean
def get_local_nets(self, src_footprints, other_footprints):
# get nets other footprints are connected to
other_nets = self.get_nets_from_footprints(other_footprints)
# get nets only source footprints are connected to
src_nets = self.get_nets_from_footprints(src_footprints)
src_local_nets = []
for net in src_nets:
if net not in other_nets:
src_local_nets.append(net)
return src_local_nets
@staticmethod
def get_footprints_bounding_box(footprints):
# get first footprint bounding box
bounding_box = footprints[0].fp.GetBoundingBox(False, False)
top = bounding_box.GetTop()
bottom = bounding_box.GetBottom()
left = bounding_box.GetLeft()
right = bounding_box.GetRight()
# iterate through the rest of the footprints and resize bounding box accordingly
for fp in footprints:
fp_box = fp.fp.GetBoundingBox(False, False)
top = min(top, fp_box.GetTop())
bottom = max(bottom, fp_box.GetBottom())
left = min(left, fp_box.GetLeft())
right = max(right, fp_box.GetRight())
position = pcbnew.wxPoint(left, top)
size = pcbnew.wxSize(right - left, bottom - top)
bounding_box = pcbnew.EDA_RECT(position, size)
return bounding_box
class SaveLayout:
def __init__(self, board, src_anchor_fp_ref):
logger.info(f'Working on {board.GetFileName()}')
# get the source board data
self.src_prjdata = PrjData(board)
logger.info("Saving the current board temporary in order to leave current layout intact")
# generate new temporary file
tempdir = tempfile.gettempdir()
self.temp_filename = os.path.join(tempdir, 'temp_board_file_for_save.kicad_pcb')
if os.path.isfile(self.temp_filename):
os.remove(self.temp_filename)
logger.info(f'Saving board as tempfile: {self.temp_filename}')
pcbnew.IO_MGR.Save(pcbnew.IO_MGR.KICAD_SEXP, self.temp_filename, board)
self.board = pcbnew.IO_MGR.Load(pcbnew.IO_MGR.KICAD_SEXP, self.temp_filename)
logger.info(f'Loaded temp boardfile: {self.board.GetFileName()}')
logger.info("Get project schematics and layout data")
self.save_prjdata = PrjData(self.board)
# override project paths
self.save_prjdata.pcb_filename = os.path.abspath(board.GetFileName())
self.save_prjdata.sch_filename = self.save_prjdata.pcb_filename.replace(".kicad_pcb", ".kicad_sch")
self.save_prjdata.project_folder = os.path.dirname(self.save_prjdata.pcb_filename)
self.src_anchor_fp = self.save_prjdata.get_fp_by_ref(src_anchor_fp_ref)
def save_layout(self, level, data_file,
tracks, zones, text, drawings, intersecting):
logger.info("Saving layout for level: " + repr(level))
logger.info("Calculating hash of the layout schematics")
# load schematics and calculate hash of schematics (you have to support nested hierarchy)
list_of_sheet_files = self.src_anchor_fp.filename[len(level) - 1:]
logger.info("Saving hash for files: " + repr(list_of_sheet_files))
md5hash = hashlib.md5()
for sch_file in list_of_sheet_files:
file_path = os.path.join(self.save_prjdata.project_folder, sch_file)
md5hash = get_sch_hash(file_path, md5hash)
hex_hash = md5hash.hexdigest()
# get footprints on a sheet
src_fps = self.save_prjdata.get_footprints_on_sheet(level)
logging.info("Source footprints are: " + repr([x.ref for x in src_fps]))
# get other footprints
other_fps = self.save_prjdata.get_footprints_not_on_sheet(level)
# get nets local to source footprints
local_nets = self.save_prjdata.get_local_nets(src_fps, other_fps)
# get source bounding box
bounding_box = self.save_prjdata.get_footprints_bounding_box(src_fps)
logger.info("Removing everything else from the layout")
# remove text items
self.remove_text(bounding_box, not intersecting, not text)
# remove drawings
self.remove_drawings(bounding_box, not intersecting, not drawings)
# remove zones
self.remove_zones(bounding_box, not intersecting, not zones)
# remove tracks
self.remove_tracks(bounding_box, not intersecting, not tracks)
# remove footprints
self.remove_footprints(other_fps)
# save the layout
logger.info("Saving layout in temporary file")
pcbnew.IO_MGR.Save(pcbnew.IO_MGR.KICAD_SEXP, self.temp_filename, self.board)
# load as text
logger.info("Reading layout as text")
with open(self.temp_filename, 'rb') as f:
layout = f.read().decode('utf-8')
# remove the file
os.remove(self.temp_filename)
logger.info("Saving layout data")
# save all data
level_filename = [self.src_anchor_fp.filename[self.src_anchor_fp.sheet_id.index(x)] for x in level]
level_saved = level_filename[len(level)-1]
copper_layer_count = self.save_prjdata.board.GetCopperLayerCount()
data_to_save = LayoutData(VERSION,
layout,
hex_hash,
self.save_prjdata.dict_of_sheets,
local_nets, level_saved, level_filename,
copper_layer_count)
with open(data_file, 'wb') as f:
pickle.dump(data_to_save, f, 0)
logger.info("Successfully saved the layout")
def remove_drawings(self, bounding_box, containing, remove_all=False):
logger.info("Removing drawing")
# remove all drawings outside of bounding box
drawings_to_delete = []
all_drawings = self.board.GetDrawings()
for drawing in all_drawings:
if isinstance(drawing, pcbnew.PCB_TEXT):
continue
drawing_bb = drawing.GetBoundingBox()
if remove_all:
drawings_to_delete.append(drawing)
else:
if containing:
if not bounding_box.Contains(drawing_bb):
drawings_to_delete.append(drawing)
else:
if not bounding_box.Intersects(drawing_bb):
drawings_to_delete.append(drawing)
for dwg in drawings_to_delete:
self.board.RemoveNative(dwg)
def remove_text(self, bounding_box, containing, remove_all=False):
logger.info("Removing text")
# remove all text outside of bounding box
text_to_delete = []
all_text_items = self.board.GetDrawings()
for text in all_text_items:
if not isinstance(text, pcbnew.PCB_TEXT):
continue
text_bb = text.GetBoundingBox()
if remove_all:
text_to_delete.append(text)
else:
if containing:
if not bounding_box.Contains(text_bb):
text_to_delete.append(text)
else:
if not bounding_box.Intersects(text_bb):
text_to_delete.append(text)
for txt in text_to_delete:
self.board.RemoveNative(txt)
def remove_zones(self, bounding_box, containing, remove_all=False):
logger.info("Removing zones")
# remove all zones outisde of bounding box
all_zones = []
for zoneid in range(self.board.GetAreaCount()):
all_zones.append(self.board.GetArea(zoneid))
# find all zones which are outside the source bounding box
for zone in all_zones:
zone_bb = zone.GetBoundingBox()
if remove_all:
self.board.RemoveNative(zone)
else:
if containing:
if not bounding_box.Contains(zone_bb):
self.board.RemoveNative(zone)
else:
if not bounding_box.Intersects(zone_bb):
self.board.RemoveNative(zone)
def remove_tracks(self, bounding_box, containing, remove_all=False):
logger.info("Removing tracks")
logger.info("Bounding box points: "
+ repr((bounding_box.GetTop(), bounding_box.GetBottom(), bounding_box.GetLeft(), bounding_box.GetRight())))
# find all tracks within the source bounding box
tracks_to_delete = []
# get all the tracks for replication
for track in self.board.GetTracks():
track_bb = track.GetBoundingBox()
# if track is contained or intersecting the bounding box
if remove_all:
tracks_to_delete.append(track)
else:
if containing:
if not bounding_box.Contains(track_bb):
tracks_to_delete.append(track)
else:
if not bounding_box.Intersects(track_bb):
tracks_to_delete.append(track)
for trk in tracks_to_delete:
self.board.RemoveNative(trk)
def remove_footprints(self, footprints):
logger.info("Removing footprints")
for fp in footprints:
self.board.RemoveNative(fp.fp)
def highlight_set_level(self, level, tracks, zones, text, drawings, intersecting):
# find level bounding box
src_fps = self.src_prjdata.get_footprints_on_sheet(level)
fps_bb = self.src_prjdata.get_footprints_bounding_box(src_fps)
fps = []
# set highlight on all the footprints
for fp in src_fps:
self.fp_set_highlight(fp.fp)
fps.append(fp)
# set highlight on other items
items = []
if tracks:
tracks = self.get_tracks(fps_bb, not intersecting)
for t in tracks:
t.SetBrightened()
items.append(t)
if zones:
zones = self.get_zones(fps_bb, not intersecting)
for zone in zones:
zone.SetBrightened()
items.append(zone)
if text:
text_items = self.get_text_items(fps_bb, not intersecting)
for t_i in text_items:
t_i.SetBrightened()
items.append(t_i)
if drawings:
dwgs = self.get_drawings(fps_bb, not intersecting)
for dw in dwgs:
dw.SetBrightened()
items.append(dw)
return fps, items
def highlight_clear_level(self, fps, items):
# set highlight on all the footprints
for fp in fps:
self.fp_clear_highlight(fp.fp)
# set highlight on other items
for item in items:
item.ClearBrightened()
def get_tracks(self, bounding_box, containing, exclusive_nets=None):
# get_all tracks
if exclusive_nets is None:
exclusive_nets = []
all_tracks = self.src_prjdata.board.GetTracks()
tracks = []
# keep only tracks that are within our bounding box
for track in all_tracks:
track_bb = track.GetBoundingBox()
# if track is contained or intersecting the bounding box
if (containing and bounding_box.Contains(track_bb)) or \
(not containing and bounding_box.Intersects(track_bb)):
tracks.append(track)
# even if track is not within the bounding box, but is on the completely local net
else:
# check if it on a local net
if track.GetNetname() in exclusive_nets:
# and add it to the
tracks.append(track)
return tracks
def get_zones(self, bounding_box, containing):
# get all zones
all_zones = []
for zone_id in range(self.src_prjdata.board.GetAreaCount()):
all_zones.append(self.src_prjdata.board.GetArea(zone_id))
# find all zones which are within the bounding box
zones = []
for zone in all_zones:
zone_bb = zone.GetBoundingBox()
if (containing and bounding_box.Contains(zone_bb)) or \
(not containing and bounding_box.Intersects(zone_bb)):
zones.append(zone)
return zones
def get_text_items(self, bounding_box, containing):
# get all text objects in bounding box
all_text = []
for drawing in self.src_prjdata.board.GetDrawings():
if not isinstance(drawing, pcbnew.PCB_TEXT):
continue
text_bb = drawing.GetBoundingBox()
if containing:
if bounding_box.Contains(text_bb):
all_text.append(drawing)
else:
if bounding_box.Intersects(text_bb):
all_text.append(drawing)
return all_text
def get_drawings(self, bounding_box, containing):
# get all drawings in source bounding box
all_drawings = []
for drawing in self.src_prjdata.board.GetDrawings():
if isinstance(drawing, pcbnew.PCB_TEXT):
# text items are handled separately
continue
dwg_bb = drawing.GetBoundingBox()
if containing:
if bounding_box.Contains(dwg_bb):
all_drawings.append(drawing)
else:
if bounding_box.Intersects(dwg_bb):
all_drawings.append(drawing)
return all_drawings
@staticmethod
def fp_set_highlight(fp):
pads_list = fp.Pads()
for pad in pads_list:
pad.SetBrightened()
drawings = fp.GraphicalItems()
for item in drawings:
item.SetBrightened()
@staticmethod
def fp_clear_highlight(fp):
pads_list = fp.Pads()
for pad in pads_list:
pad.ClearBrightened()
drawings = fp.GraphicalItems()
for item in drawings:
item.ClearBrightened()
class RestoreLayout:
def __init__(self, board, dst_anchor_fp_ref, group_name):
logger.info("Getting board info")
self.board = board
self.group_name = group_name
logger.info("Get project schematics and layout data")
self.prj_data = PrjData(self.board)
self.dst_anchor_fp = self.prj_data.get_fp_by_ref(dst_anchor_fp_ref)
def restore_layout(self, layout_file):
logger.info("Loading saved design")
# load saved design
with open(layout_file, 'rb') as f:
data_saved = pickle.load(f)
# check if version matches
saved_version = int(data_saved.version.replace(".", ""))
current_version = int(VERSION.replace(".", ""))
if saved_version > current_version:
raise LookupError("Layout was saved with newer version of the plugin. This is not supported.")
# check layer count
if hasattr(data_saved, 'layer_count'):
if data_saved.layer_count < self.prj_data.board.GetCopperLayerCount():
raise LookupError("Target board has less layers than layers saved. This is not supported.")
else:
logger.info("Saved layout does not have copper layer count saved. Might result in unhandled issues.")
# get saved hierarchy
source_level_filename = data_saved.level_filename
source_level = data_saved.level
logger.info("Source level is:" + repr(source_level_filename))
# find the corresponding hierarchy in the target layout
# this is tricky as target design might be shallower or deeper than source design
logger.info("Destination footprint is:" + repr(self.dst_anchor_fp.ref))
logger.info("Destination levels available are:" + repr(self.dst_anchor_fp.filename))
# check if saved (source) level is available in destination
if source_level not in self.dst_anchor_fp.filename:
raise LookupError("Destination hierarchy: " + repr(self.dst_anchor_fp.filename) + "\n"
+ "does not match source level: " + repr(source_level))
level_index = self.dst_anchor_fp.filename.index(source_level)
level = self.dst_anchor_fp.sheet_id[0:level_index + 1]
destination_level_filename = self.dst_anchor_fp.filename[0:level_index + 1]
logger.info("Destination level is:" + repr(destination_level_filename))
# load schematics and calculate hash of schematics (you have to support nested hierarchy)
list_of_sheet_files = self.dst_anchor_fp.filename[len(destination_level_filename) - 1:]
logger.info("All sch files required are: " + repr(list_of_sheet_files))
logger.info("Getting current schematics hash")
md5hash = hashlib.md5()
for sch_file in list_of_sheet_files:
file_path = os.path.join(self.prj_data.project_folder, sch_file)
md5hash = get_sch_hash(file_path, md5hash)
hex_hash = md5hash.hexdigest()
# check the hash
saved_hash = data_saved.hash
logger.info("Source hash is:" + repr(saved_hash))
logger.info("Destination hash is: " + repr(hex_hash))
if not saved_hash == hex_hash:
raise ValueError("Source and destination schematics don't match!")
# save board from the saved layout only temporary
tempdir = tempfile.gettempdir()
temp_filename = os.path.join(tempdir, 'temp_layout_for_restore.kicad_pcb')
with open(temp_filename, 'wb') as f:
f.write(data_saved.layout.encode('utf-8'))
# restore layout data
saved_board = pcbnew.IO_MGR.Load(pcbnew.IO_MGR.KICAD_SEXP, temp_filename)
# delete temporary file
os.remove(temp_filename)
# get layout data from saved board
logger.info("Get layout data from saved board")
saved_layout = PrjData(saved_board, dont_parse_schematics=True)
saved_fps = saved_layout.footprints
footprints_to_place = self.prj_data.get_footprints_on_sheet(level)
# check if source layout and destination layout to be restored match at least in footprint count
if len(footprints_to_place) != len(saved_fps):
raise ValueError("Source and destination footprint count don't match!")
# sort by ID - I am counting that source and destination sheet have been
# annotated by KiCad in their final form (reset annotation and then re-annotate)
footprints_to_place = sorted(footprints_to_place, key=lambda x: (x.fp_id, x.ref))
saved_fps = sorted(saved_fps, key=lambda x: (x.fp_id, x.ref))
# get the saved layout ID numbers and try to figure out a match (at least the same depth, ...)
# find net pairs
net_pairs = self.get_net_pairs(footprints_to_place, saved_fps)
# Create Group for placed components
if self.group_name:
self.layout_group = pcbnew.PCB_GROUP(self.board)
self.layout_group.SetName(self.group_name)
self.board.Add(self.layout_group)
else:
self.layout_group = None
# replicate modules
src_anchor_fp = saved_fps[footprints_to_place.index(self.dst_anchor_fp)]
self.replicate_footprints(src_anchor_fp, saved_fps, self.dst_anchor_fp, footprints_to_place, self.layout_group)
# replicate tracks
self.replicate_tracks(src_anchor_fp, saved_board.GetTracks(), self.dst_anchor_fp, net_pairs, self.layout_group)
# replicate zones
src_zones = [saved_board.GetArea(zone_id) for zone_id in range(saved_board.GetAreaCount()) ]
self.replicate_zones(src_anchor_fp, src_zones, self.dst_anchor_fp, net_pairs, self.layout_group)
# replicate text
src_text = [item for item in saved_board.GetDrawings() if isinstance(item, pcbnew.PCB_TEXT)]
self.replicate_text(src_anchor_fp, src_text, self.dst_anchor_fp, self.layout_group)
# replicate drawings
source_dwgs = [item for item in saved_board.GetDrawings() if not isinstance(item, pcbnew.PCB_TEXT)]
self.replicate_drawings(src_anchor_fp, source_dwgs, self.dst_anchor_fp, self.layout_group)
pass
@staticmethod
def get_net_pairs(dst_fps, src_fps):
""" find all net pairs between source sheet and current sheet"""
# find all net pairs via same footprint pads,
net_pairs = []
net_dict = {}
# construct footprint pairs
fp_matches = []
for s_fp in src_fps:
fp_matches.append([s_fp.fp, s_fp.fp_id, s_fp.sheet_id])
for d_fp in dst_fps:
for fp in fp_matches:
if fp[1] == d_fp.fp_id:
index = fp_matches.index(fp)
fp_matches[index].append(d_fp.fp)
fp_matches[index].append(d_fp.fp_id)
fp_matches[index].append(d_fp.sheet_id)
# find closest match
fp_pairs = []
fp_pairs_by_reference = []
for index in range(len(fp_matches)):
fp = fp_matches[index]
# get number of matches
matches = (len(fp) - 3) // 3
# if more than one match, get the most likely one
# this is when replicating a sheet which consist of two or more identical subsheets (multiple hierachy)
if matches > 1:
match_len = []
for index in range(0, matches):
match_len.append(len(set(fp[2]) & set(fp[2 + 3 * (index + 1)])))
index = match_len.index(max(match_len))
fp_pairs.append((fp[0], fp[3 * (index + 1)]))
fp_pairs_by_reference.append((fp[0].GetReference(), fp[3 * (index + 1)].GetReference()))
# if only one match
elif matches == 1:
fp_pairs.append((fp[0], fp[3]))
fp_pairs_by_reference.append((fp[0].GetReference(), fp[3].GetReference()))
# can not find at least one matching footprint
elif matches == 0:
raise LookupError("Could not find at least one matching footprint for: " + fp[0].GetReference() +
".\nPlease make sure that schematics and layout are in sync.")
# prepare the list of pad pairs
pad_pairs = []
for x in range(len(fp_pairs)):
pad_pairs.append([])
for pair in fp_pairs:
index = fp_pairs.index(pair)
# get all footprint pads
src_fp_pads = pair[0].Pads()
dst_fp_pads = pair[1].Pads()
# create a list of pads names and pads
s_pads = []
d_pads = []
for pad in src_fp_pads:
s_pads.append((pad.GetName(), pad))
for pad in dst_fp_pads:
d_pads.append((pad.GetName(), pad))
# sort by pad names
s_pads.sort(key=lambda tup: tup[0])
d_pads.sort(key=lambda tup: tup[0])
# extract pads and append them to pad pairs list
pad_pairs[index].append([x[1] for x in s_pads])
pad_pairs[index].append([x[1] for x in d_pads])
for pair in fp_pairs:
index = fp_pairs.index(pair)
# get their pads
src_fp_pads = pad_pairs[index][0]
dst_fp_pads = pad_pairs[index][1]
# I am going to assume pads are in the same order
s_nets = []
d_nets = []
# get netlists for each pad
for p_pad in src_fp_pads:
pad_name = p_pad.GetName()
s_nets.append((pad_name, p_pad.GetNetname()))
for s_pad in dst_fp_pads:
pad_name = s_pad.GetName()
d_nets.append((pad_name, s_pad.GetNetname()))
net_dict[s_pad.GetNetname()] = s_pad.GetNet()
# sort both lists by pad name
# so that they have the same order - needed in some cases
# as the iterator through the pads list does not return pads always in the proper order
s_nets.sort(key=lambda tup: tup[0])
d_nets.sort(key=lambda tup: tup[0])
# build list of net tuples
for net in s_nets:
index = get_index_of_tuple(s_nets, 1, net[1])
net_pairs.append((s_nets[index][1], d_nets[index][1]))
# remove duplicates
net_pairs_clean = list(set(net_pairs))
return net_pairs_clean, net_dict
@staticmethod
def replicate_footprints(src_anchor_fp, src_fps, dst_anchor_fp, dst_fps, layout_group):
logger.info("Replicating footprints")
dst_anchor_fp_angle = dst_anchor_fp.fp.GetOrientationDegrees()
dst_anchor_fp_position = dst_anchor_fp.fp.GetPosition()
src_anchor_fp_angle = src_anchor_fp.fp.GetOrientationDegrees()
anchor_delta_angle = src_anchor_fp_angle - dst_anchor_fp_angle
# go through all footprints
src_footprints = src_fps
dst_footprints = dst_fps
nr_footprints = len(src_footprints)
for fp_index in range(nr_footprints):
src_fp = src_footprints[fp_index]
# find proper match in source footprints
list_of_possible_dst_footprints = []
for d_fp in dst_footprints:
if d_fp.fp_id == src_fp.fp_id:
list_of_possible_dst_footprints.append(d_fp)
# if there is more than one possible anchor, select the correct one
if len(list_of_possible_dst_footprints) == 1:
dst_fp = list_of_possible_dst_footprints[0]
else:
list_of_matches = []
for fp in list_of_possible_dst_footprints:
index = list_of_possible_dst_footprints.index(fp)
matches = 0
for item in src_fp.sheet_id:
if item in fp.sheet_id:
matches = matches + 1
list_of_matches.append((index, matches))
# check if list is empty, if it is, then it is highly likely that schematics and pcb are not in sync
if not list_of_matches:
raise LookupError("Can not find destination footprint for source footprint: " + repr(src_fp.ref)
+ "\n" + "Most likely, schematics and PCB are not in sync")
# select the one with most matches
index, _ = max(list_of_matches, key=lambda item: item[1])
dst_fp = list_of_possible_dst_footprints[index]
# skip locked footprints
# TODO
#if dst_fp.fp.IsLocked() is True and self.replicate_locked_items is False:
# continue
# get footprint to clone position
src_fp_orientation = src_fp.fp.GetOrientationDegrees()
src_fp_pos = src_fp.fp.GetPosition()
# get relative position with respect to source anchor
src_anchor_pos = src_anchor_fp.fp.GetPosition()
src_fp_flipped = src_fp.fp.IsFlipped()
src_fp_delta_pos = src_fp_pos - src_anchor_pos
# new orientation is simple
new_orientation = src_fp_orientation - anchor_delta_angle
old_pos = src_fp_delta_pos + dst_anchor_fp_position
new_pos = rotate_around_point(old_pos, dst_anchor_fp_position, anchor_delta_angle)
# convert to tuple of integers
new_pos = [int(x) for x in new_pos]
# place current footprint - only if current footprint is not also the anchor
if dst_fp.ref != dst_anchor_fp.ref:
dst_fp.fp.SetPosition(pcbnew.wxPoint(*new_pos))
if dst_fp.fp.IsFlipped() != src_fp_flipped:
dst_fp.fp.Flip(dst_fp.fp.GetPosition(), False)
dst_fp.fp.SetOrientationDegrees(new_orientation)
# Copy local settings.
dst_fp.fp.SetLocalClearance(src_fp.fp.GetLocalClearance())
dst_fp.fp.SetLocalSolderMaskMargin(src_fp.fp.GetLocalSolderMaskMargin())
dst_fp.fp.SetLocalSolderPasteMargin(src_fp.fp.GetLocalSolderPasteMargin())
dst_fp.fp.SetLocalSolderPasteMarginRatio(src_fp.fp.GetLocalSolderPasteMarginRatio())
dst_fp.fp.SetZoneConnection(src_fp.fp.GetZoneConnection())
# flip if dst anchor is flipped with regards to src anchor
if src_anchor_fp.fp.IsFlipped() != dst_anchor_fp.fp.IsFlipped():
# ignore anchor fp
if dst_anchor_fp != dst_fp:
dst_fp.fp.Flip(dst_anchor_fp_position, False)
#
src_fp_rel_pos = src_anchor_pos - src_fp_pos
delta_angle = dst_anchor_fp_angle + src_anchor_fp_angle
dst_fp_rel_pos_rot = rotate_around_center([-src_fp_rel_pos[0], src_fp_rel_pos[1]],
-delta_angle)
dst_fp_rel_pos = dst_anchor_fp_position + pcbnew.wxPoint(dst_fp_rel_pos_rot[0],
dst_fp_rel_pos_rot[1])
# also need to change the angle
dst_fp.fp.SetPosition(dst_fp_rel_pos)
src_fp_flipped_orientation = flipped_angle(src_fp_orientation)
flipped_delta = flipped_angle(src_anchor_fp_angle)-dst_anchor_fp_angle
new_orientation = src_fp_flipped_orientation - flipped_delta
dst_fp.fp.SetOrientationDegrees(new_orientation)
dst_fp_orientation = dst_fp.fp.GetOrientationDegrees()
dst_fp_flipped = dst_fp.fp.IsFlipped()
# replicate also text layout - also for anchor footprint. I am counting that the user is lazy and will
# just position the destination anchors and will not edit them
# get footprint text
src_fp_text_items = get_footprint_text_items(src_fp)
dst_fp_text_items = get_footprint_text_items(dst_fp)
# check if both footprints (source and the one for replication) have the same number of text items
if len(src_fp_text_items) != len(dst_fp_text_items):
raise LookupError(
"Source footprint: " + src_fp.ref + " has different number of text items (" + repr(
len(src_fp_text_items))
+ ")\nthan footprint for replication: " + dst_fp.ref + " (" + repr(
len(dst_fp_text_items)) + ")")
# replicate each text item
src_text: pcbnew.FP_TEXT