forked from htho/fzz2scad
-
Notifications
You must be signed in to change notification settings - Fork 4
/
fzz2scadLib.py
1078 lines (871 loc) · 43.1 KB
/
fzz2scadLib.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
'''
fzz2scad: Creates OpenSCAD 3D models of PCBs from Fritzing-Sketches.
Copyright (C) 2015 Hauke Thorenz <htho@thorenz.net>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
'''
# import statements: We use pythons included batteries!
import zipfile
import xml.etree.ElementTree as ET
import html
import os
import math
import re
import sys
import collections
import copy
import json
VERSION = 0.1
# This is a blacklist for modules fzz2oscad can't handle.
# This list is NOT for parts that don't have any models yet.
# Missing models are simply ignored.
moduleIdRef_blacklist = frozenset([
"WireModuleID",
"ViaModuleID",
"generic_male_pin_header_.*",
"generic_female_pin_header_.*"
])
moduleIdRef_blacklist_pattern = frozenset([re.compile(s) for s in moduleIdRef_blacklist])
# This is a whitelist for <pcbView layer="x"> that determine if a part
# belongs to the pcbView.
pcbView_layer_whitelist = frozenset([
"board",
"copper0"
])
pcbView_layer_whitelist_pattern = frozenset([re.compile(s) for s in pcbView_layer_whitelist])
# ####################### I/O HELPER FUNCTIONS ########################
def printConsole(message, minimumVerbosityLevel):
"""Write the given string to the console. To be printed
args.verbose needs to be >= minimumVerbosityLevel."""
global args
if args.verbose >= minimumVerbosityLevel:
print(message)
def printErrorConsole(message, minimumVerbosityLevel):
print(message, file=sys.stderr)
def getXMLRoot(zipFile, xmlFileName):
"""get the xml root of the XML File in the given zip File."""
ret = None
with zipfile.ZipFile(zipFile, 'r') as zf:
with zf.open(xmlFileName, 'r') as xf:
ret = ET.parse(xf)
return ret
def getFilesThatEndWith(zipFile, endswith):
"""get a list of the files in the given zip file which names end with
the given string."""
ret = list()
with zipfile.ZipFile(zipFile, 'r') as zf:
namelist = zf.namelist()
for name in namelist:
if name.endswith(endswith):
ret = ret + [name]
return ret
def determineOutFile(defaultFilenameToDeriveFrom=None, defaultExtensionInfix=None, defaultExtensionOverride=None):
global args
if args.output is None:
return None
else:
if args.output == "":
if defaultFilenameToDeriveFrom is None:
outFile = "out"
if defaultExtensionInfix is not None:
outFile = outFile + "." + defaultExtensionInfix
if defaultExtensionOverride is not None:
outFile = outFile + "." + defaultExtensionOverride
else:
outFile = os.path.basename(defaultFilenameToDeriveFrom).rsplit(".", 1)
if defaultExtensionInfix is not None:
outFile[0] = outFile[0] + "." + defaultExtensionInfix
if defaultExtensionOverride is not None:
outFile[1] = defaultExtensionOverride
outFile = outFile[0] + outFile[1]
else:
outFile = args.output
return outFile
def outputHelper(fileContent, outFile):
global args
override = True
if outFile is not None and os.path.exists(outFile):
if args.override:
override = True
pass
elif args.dont_override:
override = False
else:
ans = None
while ans is None:
tmp_ans = input("'{}' already exists. Do you want to override it? (y/n)".format(outFile))
if tmp_ans.strip().lower() == "y":
ans = True
elif tmp_ans.strip().lower() == "n":
ans = False
else:
print("Please type 'y' for Yes and 'n' for No.\n")
if ans is True:
override = True
else:
override = False
if outFile is None or override is False:
printConsole(fileContent, 0)
else:
with open(outFile, 'w') as f:
f.write(fileContent)
# ####################### HELPERS #####################################
def update(d, u):
# from http://stackoverflow.com/a/3233356/1635906
for k, v in u.items():
if isinstance(v, collections.Mapping):
r = update(d.get(k, {}), v)
d[k] = r
else:
d[k] = u[k]
return d
# static dictionary with information about the different parts.
# key: moduleIdRef
# value: dict() (see getPrototype())
partPrototypes = dict()
def getPrototype(moduleIdRef):
"""Get static Information about this part.
return dict('svgWidth':?, 'svgHeihgt':?, 'svgOffsetX':?. 'svgOffsetY':?)
svgWidth/Height: Size of the SVG that represents this parts PCB
footprint. Needed for rotation.
Offset: Position of connector0 IN the SVG
"""
if moduleIdRef not in partPrototypes:
printConsole("INFO: Creating Prototype for moduleIdRef='" + moduleIdRef + "'...", 2)
partPrototypes[moduleIdRef] = dict()
if moduleIdRef == "HoleModuleID":
# Fetching information from https://github.com/fritzing/fritzing-app/blob/master/resources/parts/svg/core/pcb/hole.svg
partPrototypes[moduleIdRef]['svgWidth'] = Dimension("0.075in")
partPrototypes[moduleIdRef]['svgHeight'] = Dimension("0.075in")
# positionInSketch of center IN the svg.
partPrototypes[moduleIdRef]['svgOffsetX'] = Dimension("27.7") * (Dimension("0.075in") / Dimension("75"))
partPrototypes[moduleIdRef]['svgOffsetY'] = -(Dimension("27.7") * (Dimension("0.075in") / Dimension("75")))
else:
global inputFzzFileName
global xmlRoot
fzpFileNamePath = xmlRoot.find("./instances/instance[@moduleIdRef='" + moduleIdRef + "']").attrib['path']
fzpRoot = getXMLRoot(inputFzzFileName, "part." + os.path.basename(fzpFileNamePath))
connector0svgId = fzpRoot.find("./connectors/connector[@id='connector0']/views/pcbView/p[@layer='copper0']").attrib['svgId']
svgFileName = (fzpRoot.find("./views/pcbView/layers").attrib['image']).replace("/", ".")
svgRoot = getXMLRoot(inputFzzFileName, "svg." + svgFileName)
viewBoxValues = svgRoot.find(".").attrib['viewBox'].split()
viewBoxWidthOfAUnit = Dimension(svgRoot.find(".").attrib['width']) / Dimension(viewBoxValues[2])
viewBoxHeightOfAUnit = Dimension(svgRoot.find(".").attrib['height']) / Dimension(viewBoxValues[3])
svgConnector0Element = svgRoot.find(".//*[@id='" + connector0svgId + "']")
# width and height of the svg (important for correct rotations)
partPrototypes[moduleIdRef]['svgWidth'] = Dimension(svgRoot.find(".").attrib['width'])
partPrototypes[moduleIdRef]['svgHeight'] = Dimension(svgRoot.find(".").attrib['height'])
# positionInSketch of connector0 IN the svg.
partPrototypes[moduleIdRef]['svgOffsetX'] = Dimension(svgConnector0Element.attrib['cx']) * viewBoxWidthOfAUnit
partPrototypes[moduleIdRef]['svgOffsetY'] = Dimension(svgConnector0Element.attrib['cy']) * viewBoxHeightOfAUnit
# negating on purpose! We need to transform the coordinate system from positive y to negative y:
partPrototypes[moduleIdRef]['svgOffsetY'] = -partPrototypes[moduleIdRef]['svgOffsetY']
printConsole(" Prototype '" + moduleIdRef + "': " + repr(partPrototypes[moduleIdRef]), 2)
return partPrototypes[moduleIdRef]
# ####################### TXT HELPER FUNCTIONS ########################
def txt_from_note(noteXmlElement):
text = noteXmlElement.find("text").text
text = html.unescape(text)
htmlRoot = ET.fromstring(text)
pElements = htmlRoot.findall("*/p")
ret = ""
for p in pElements:
if p.text is not None:
ret = ret + p.text + "\n"
return ret
def txt_prefix_each_line(string, prefix, ignorefirst=False, ignorelast=False):
"""prefix each line in the given string with the given prefix.
Useful for block indention."""
ret = list()
splitted = string.splitlines()
if len(splitted) == 0:
return ""
if ignorefirst:
ret.append(splitted[0])
splitted = splitted[1:]
if len(splitted) == 0:
return "\n".join(ret)
last = None
if ignorelast:
last = splitted[-1]
splitted = splitted[:-1]
if len(splitted) == 0:
return "\n".join(ret.append(last))
for line in splitted:
ret.append(prefix + line)
if ignorelast:
ret.append(last)
return "\n".join(ret)
def txt_match_in_patternset(string, patternset):
for pattern in patternset:
if pattern.fullmatch(string):
return True
return False
# ####################### CLASSES ########################
class AbstractPart:
def __init__(self, moduleIdRef, title, xPos, yPos, rotationAndTranslationVectors, attributes):
"""Create a new part instance. This Constructor will seldom be
called directly."""
self.moduleIdRef = moduleIdRef
self.module_name = "m" + moduleIdRef
for c in self.module_name:
if c not in frozenset("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_"):
self.module_name = self.module_name.replace(c, "_")
self.title = title
self.rotation = rotationAndTranslationVectors[0]
self.translationRotation = rotationAndTranslationVectors[1]
self.attributes = dict()
for titleExpression, attribute_data in attributes.items():
titlePattern = re.compile(titleExpression)
if titlePattern.fullmatch(self.title):
self.attributes = update(self.attributes, copy.deepcopy(attribute_data))
zPos = Dimension(0)
if "z" in self.attributes.keys():
zPos = Dimension(self.attributes.pop("z"))
self.positionInSketch = (xPos, yPos, zPos)
self.positionAbsolute = (self.positionInSketch[0] + self.translationRotation[0], self.positionInSketch[1] + self.translationRotation[1], self.positionInSketch[2] + self.translationRotation[2])
self.parameters = dict()
if "parameters" in self.attributes.keys():
self.parameters = self.attributes.pop("parameters")
def export(self, internal_name):
if internal_name == "title":
return self.title
elif internal_name == "positionInSketch":
return Dimension.dimensionList2MmList(self.positionInSketch)
elif internal_name == "positionAbsolute":
return Dimension.dimensionList2MmList(self.positionAbsolute)
elif internal_name == "rotation":
return list(self.rotation)
elif internal_name == "translationRotation":
return Dimension.dimensionList2MmList(self.translationRotation)
else:
return None
def parametersAsString(self):
ret = []
for k, v in self.parameters.items():
v = Dimension(v)
ret.append("{}={}".format(k, v.asMm()))
return ",".join(ret)
def _getInfoText(self):
data = dict()
data['module_name'] = self.module_name
# Information extracted from the sketch
data['moduleIdRef'] = self.moduleIdRef
data['title'] = self.title
data['positionInSketch'] = Dimension.dimensionList2MmList(self.positionInSketch)
data['rotation'] = str(list(self.rotation))
data['translationRotation'] = Dimension.dimensionList2MmList(self.translationRotation)
# Information extracted from the configuration
data['attributes'] = self.attributes
data['parameters'] = self.parametersAsString()
return data
class Part(AbstractPart):
"""A Part (e.g. Switch or LED)."""
@staticmethod
def buildFromInstanceXmlElement(instanceXmlElement, attributes):
"""Create a Part from the given instance Element in the tree of
of an .fz file.
"""
moduleIdRef = instanceXmlElement.attrib['moduleIdRef']
xPos = Dimension(instanceXmlElement.find("./views/pcbView/geometry").attrib['x'])
yPos = Dimension(instanceXmlElement.find("./views/pcbView/geometry").attrib['y'])
schematicGeometry = instanceXmlElement.find("./views/schematicView/geometry")
schematicCoords = (Dimension(schematicGeometry.attrib['x']), Dimension(schematicGeometry.attrib['y']))
bottom = False
try:
bottom_attrib = instanceXmlElement.find("./views/pcbView").attrib['bottom']
if bottom_attrib == "true":
bottom = True
except KeyError:
# It's okay! This just means bottom = False.
# I heard this approach is "pythonic" ?
pass
# negating on purpose! We need to transform the coordinate system
# from positive y to negative y:
yPos = -yPos
return Part(
moduleIdRef,
instanceXmlElement.find("./title").text,
xPos,
yPos,
transformMatrixElement2RotationAndTranslationVector(instanceXmlElement.find("./views/pcbView/geometry/transform")),
attributes,
bottom,
schematicCoords
)
def __init__(self, moduleIdRef, title, xPos, yPos, rotationAndTranslationVectors, attributes, bottom, schematicCoords):
"""Create a new part instance. This Constructor will seldom be
called directly."""
super().__init__(moduleIdRef, title, xPos, yPos, rotationAndTranslationVectors, attributes)
self.bottom = bottom
self.schematicCoords = schematicCoords
self.prototype = getPrototype(self.moduleIdRef)
self.svgDimension = (self.prototype['svgWidth'], self.prototype['svgHeight'], Dimension(0))
self.svgOffset = (self.prototype['svgOffsetX'], self.prototype['svgOffsetY'], Dimension(0))
self.positionAbsolute = (self.positionAbsolute[0] + self.svgOffset[0], self.positionAbsolute[1] + self.svgOffset[1], self.positionAbsolute[2] + self.svgOffset[2])
def export(self, internal_name):
if internal_name == "isBottom":
if self.bottom:
return 1
else:
return 0
elif internal_name == "svgOffset":
return Dimension.dimensionList2MmList(self.svgOffset)
elif internal_name == "svgDimension":
return Dimension.dimensionList2MmList(self.svgDimension)
else:
return AbstractPart.export(self, internal_name)
def _getInfoText(self, showGroundplate=False):
data = AbstractPart._getInfoText(self)
# Information about the prototype
data['svgDimension'] = Dimension.dimensionList2MmList(self.svgDimension)
data['svgOffset'] = Dimension.dimensionList2MmList(self.svgOffset)
data['mirror'] = [0, 0, 0]
if self.bottom:
data['mirror'] = [0, 0, 1]
groundplateHeight = Dimension(1.0, "mm") # How tall should the groundplate be?
groundplateCube = Dimension.dimensionList2MmList(((self.svgDimension[0]), (self.svgDimension[1]), (groundplateHeight)))
data['groundplate'] = ""
if showGroundplate:
data['groundplate'] = "mirror([0, 1, 0]) %cube({groundplateCube},false);".format(groundplateCube=groundplateCube, **data)
return data
def asScad(self, showGroundplate=False):
"""get a string representation to be used in an scad file."""
data = self._getInfoText(showGroundplate)
data["selfStr"] = str(self)
return """// {selfStr}
translate({positionInSketch}) //position in the Sketch
translate({translationRotation}) //translation that corrects the rotation
rotate({rotation}) //rotation
mirror({mirror}) //mirror if on bottom
{{
{groundplate}
translate({svgOffset}) /* translation for the position of connector0 in the svg */
{module_name}({parameters});
}}
""".format(**data)
def __str__(self):
data = self._getInfoText()
return "Part: module_name: '{module_name}', moduleIdRef: '{moduleIdRef}', title: '{title}', attributes: '{attributes}', parameters: '{parameters}', positionInSketch: '{positionInSketch}mm'".format(**data)
class Hole(AbstractPart):
"""A Part representing a Hole."""
@staticmethod
def buildFromInstanceXmlElement(instanceXmlElement, attributes):
"""Create this Hole from the given instanceXmlElement """
title = instanceXmlElement.find("./title").text
xPos = Dimension(instanceXmlElement.find("./views/pcbView/geometry").attrib['x'])
yPos = Dimension(instanceXmlElement.find("./views/pcbView/geometry").attrib['y'])
diameterString = instanceXmlElement.find("./property[@name='hole size']").attrib['value']
# The value of diameterString looks like this: "4.2mm,0.0mm" th left value is the diameter, the right value is the thickness of a ring - it can be ignored.
diameterValue = Dimension(str(diameterString).split(sep=",", maxsplit=1)[0])
# negating on purpose! We need to transform the coordinate system
# from positive y to negative y:
yPos = -yPos
return Hole(
instanceXmlElement.attrib['moduleIdRef'],
title,
xPos,
yPos,
transformMatrixElement2RotationAndTranslationVector(instanceXmlElement.find("./views/pcbView/geometry/transform")),
diameterValue,
attributes
)
def __init__(self, moduleIdRef, title, xPos, yPos, rotationAndTranslationVectors, diameter, attributes):
super().__init__(moduleIdRef, title, xPos, yPos, rotationAndTranslationVectors, attributes)
self.diameter = diameter
if "drillDepth" not in self.parameters:
raise AttributeError('A Hole must have the parameter \'drillDepth\'. Add a note like this to the PCB Layer: {{"attributes": {{"{}":{{"parameters":"drillDepth=50"}}}}\nNote that the diameter is extracted from the sketch, so it must not be set as attribute here.'.format(self.title))
self.parameters['diameter'] = str(self.diameter)
self.prototype = getPrototype(moduleIdRef)
# Information about the prototype
svgWidth = Dimension(self.prototype['svgWidth'].asMm() * self.diameter.asMm(), "mm")
svgHeight = Dimension(self.prototype['svgHeight'].asMm() * self.diameter.asMm(), "mm")
self.svgDimension = (svgWidth, svgHeight, Dimension(0))
svgOffsetX = Dimension(self.prototype['svgOffsetX'].asMm() * self.diameter.asMm(), "mm")
svgOffsetY = Dimension(self.prototype['svgOffsetY'].asMm() * self.diameter.asMm(), "mm")
self.svgOffset = (svgOffsetX, svgOffsetY, Dimension(0))
self.positionAbsolute = (self.positionAbsolute[0] + self.svgOffset[0], self.positionAbsolute[1] + self.svgOffset[1], self.positionAbsolute[2] + self.svgOffset[2])
def export(self, internal_name):
if internal_name == "diameter":
return self.diameter.asMm()
elif internal_name == "svgOffset":
return Dimension.dimensionList2MmList(self.svgOffset)
elif internal_name == "svgDimension":
return Dimension.dimensionList2MmList(self.svgDimension)
else:
return AbstractPart.export(self, internal_name)
def _getInfoText(self, showGroundplate=False):
data = AbstractPart._getInfoText(self)
# Information about the prototype
data['svgDimension'] = Dimension.dimensionList2MmList(self.svgDimension)
data['svgOffset'] = Dimension.dimensionList2MmList(self.svgOffset)
data['diameter'] = self.diameter.asMm()
groundplateHeight = Dimension(1.0, "mm") # How tall should the groundplate be?
groundplateCube = Dimension.dimensionList2MmList(((self.svgDimension[0]), (self.svgDimension[1]), (groundplateHeight)))
data['groundplate'] = ""
if showGroundplate:
data['groundplate'] = "%mirror([0, 1, 0]) cube({groundplateCube}, true);".format(groundplateCube=groundplateCube, **data)
return data
def asScad(self, showGroundplate=False):
"""get a string representation to be used in an scad file."""
data = self._getInfoText(showGroundplate)
data["selfStr"] = str(self)
return """// {selfStr}
translate({positionInSketch}) //position in the sketch
translate({translationRotation}) //translation that corrects the rotation
rotate({rotation}) //rotation
translate({svgOffset}) /* translation for the xy position in the svg */
{{
{groundplate}
{module_name}({parameters});
}}
""".format(**data)
def __str__(self):
data = self._getInfoText()
return "Part: module_name: '{module_name}', moduleIdRef: '{moduleIdRef}', title: '{title}', attributes: '{attributes}', parameters: '{parameters}', positionInSketch: '{positionInSketch}mm', diameter: '{diameter}mm'".format(**data)
class PCB(AbstractPart):
"""A PCB."""
@staticmethod
def buildFromInstanceXmlElement(instanceXmlElement, xmlRoot, attributes):
"""Create this PCB from the given instanceXmlElement """
title = instanceXmlElement.find("./title").text
boardXmlElement = xmlRoot.find("./boards/board[@instance='" + title + "']")
xPos = Dimension(instanceXmlElement.find("./views/pcbView/geometry").attrib['x'])
yPos = Dimension(instanceXmlElement.find("./views/pcbView/geometry").attrib['y'])
# negating on purpose! We need to transform the coordinate system
# from positive y to negative y:
yPos = -yPos
return PCB(
instanceXmlElement.attrib['moduleIdRef'],
title,
xPos,
yPos,
transformMatrixElement2RotationAndTranslationVector(instanceXmlElement.find("./views/pcbView/geometry/transform")),
Dimension(boardXmlElement.attrib['width']),
Dimension(boardXmlElement.attrib['height']),
attributes
)
def __init__(self, moduleIdRef, title, xPos, yPos, rotationAndTranslationVectors, width, depth, attributes):
super().__init__(moduleIdRef, title, xPos, yPos, rotationAndTranslationVectors, attributes)
if "pcbHeight" not in self.parameters.keys():
raise AttributeError('A PCB must have the parameter \'pcbHeight\'. Add a note like this to the PCB Layer: {{"attributes": {{"{}":{{"parameters":"{{"pcbHeight"="1.2mm"}}}}}}}}'.format(self.title))
self.dimensions = (width, depth, Dimension(self.parameters["pcbHeight"]))
self.parameters['width'] = str(self.dimensions[0])
self.parameters['depth'] = str(self.dimensions[1])
def export(self, internal_name):
if internal_name == "dimensions":
return Dimension.dimensionList2MmList(self.dimensions)
else:
return AbstractPart.export(self, internal_name)
def _getInfoText(self, showGroundplate=False):
data = AbstractPart._getInfoText(self)
return data
def asScad(self, showGroundplate=False):
"""get a string representation to be used in an scad file."""
data = self._getInfoText(showGroundplate)
data["selfStr"] = str(self)
return """// {selfStr}
translate({positionInSketch}) //position in the sketch
translate({translationRotation}) //translation that corrects the rotation
rotate({rotation}) //rotation
{module_name}({parameters});
""".format(**data)
def __str__(self):
data = self._getInfoText()
return "PCB: module_name: '{module_name}', moduleIdRef: '{moduleIdRef}', title: '{title}', attributes: '{attributes}', parameters: '{parameters}', positionInSketch: '{positionInSketch}''".format(**data)
class Dimension:
"""A dimension. Unit conversion included."""
unit_conversion_table = dict({
'pxI': 72,
'px': 90,
'pt': 72,
'pc': 6,
'mm': 25.4,
'cm': 2.54,
'in': 1,
'mil': 1000
})
def __init__(self, inputStringOrValue, unit="", isIllustrator=False):
"""Create a new Dimension. Unit us either supplied in the input
string or suplied with the unit variable."""
if type(inputStringOrValue) is str:
# split the input string into value and unit
unitFromInput = ""
value = inputStringOrValue
while not value[-1].isdigit():
unitFromInput = value[-1] + unitFromInput
value = value[:-1]
if unit != "" and unitFromInput != "" and unit != unitFromInput:
raise ValueError("Can't interpret input! The string has the unit '{}' but the unit given is '{}'.".format(unitFromInput, unit))
elif unit == "" and unitFromInput != "":
unit = unitFromInput
else: # (unit != "" and unitFromInput == "") or (unit == unitFromInput)
# uint = unit
pass
else:
value = inputStringOrValue
if unit == "":
unit = "px"
if isIllustrator:
if unit == "px":
unit = unit + "I"
else:
raise ValueError("Only the unit 'px' can have isIllustrator==true, '{}' dont.".format(unit))
if unit in Dimension.unit_conversion_table:
value = float(value) / Dimension.unit_conversion_table[unit]
else:
raise ValueError("The unit '{}' is not known!".format(unit))
self.isIllustrator = isIllustrator
self.value = value
def getAs(self, unit):
if unit in Dimension.unit_conversion_table:
if Dimension.unit_conversion_table[unit] is int:
return math.fsum([self.value] * Dimension.unit_conversion_table[unit])
else:
return self.value * Dimension.unit_conversion_table[unit]
else:
raise ValueError("The unit '{}' is not known!".format(unit))
def asMm(self):
return self.getAs("mm")
def asIn(self):
return self.getAs("in")
def asPx(self):
return self.getAs("px")
def __str__(self):
return str(self.value) + "in"
def __repr__(self):
return str(self.value) + "in"
def __lt__(self, other):
return self.value < other.value
def __le__(self, other):
return self.value <= other.value
def __eq__(self, other):
return self.value == other.value
def __ne__(self, other):
return self.value != other.value
def __gt__(self, other):
return self.value > other.value
def __ge__(self, other):
return self.value >= other.value
def __add__(self, other):
v = self.value + other.value
ret = Dimension(0)
ret.value = v
return ret
def __sub__(self, other):
v = self.value - other.value
ret = Dimension(0)
ret.value = v
return ret
def __mul__(self, other):
if isinstance(other, Dimension):
v = self.value * other.value
else:
v = self.value * other
ret = Dimension(0)
ret.value = v
return ret
def __truediv__(self, other):
if isinstance(other, Dimension):
v = self.value / other.value
else:
v = self.value / other
ret = Dimension(0)
ret.value = v
return ret
def __neg__(self):
ret = Dimension(0)
ret.value = -self.value
return ret
@staticmethod
def dimensionList2MmList(v):
ret = list()
for i in v:
ret.append(i.asMm())
return ret
# ###################### STRING HELPERS ########################
def transformMatrixToRotationVectorAndTranslationVector(m):
"""staff.city.ac.uk/~sbbh653/publications/euler.pdf"""
translationVector = (m[0][3], m[1][3], m[2][3])
if m[2][0] != 1 or m[2][0] != -1:
theta1 = -math.asin(m[2][0])
theta2 = math.pi - theta1
psi1 = math.atan2((m[2][1] / math.cos(theta1)), (m[2][2] / math.cos(theta1)))
psi2 = math.atan2((m[2][1] / math.cos(theta2)), (m[2][2] / math.cos(theta2)))
phi1 = math.atan2((m[1][0] / math.cos(theta1)), (m[0][0] / math.cos(theta1)))
phi2 = math.atan2((m[1][0] / math.cos(theta2)), (m[0][0] / math.cos(theta2)))
psi = (math.degrees(psi1), math.degrees(psi2))
theta = (math.degrees(theta1), math.degrees(theta2))
phi = (math.degrees(phi1), math.degrees(phi2))
zeros = [0, 0]
for v in (psi, theta, phi):
if v[0] == 0:
zeros[0] = zeros[0] + 1
if v[1] == 0:
zeros[1] = zeros[1] + 1
if zeros[0] > zeros[1]:
return ((psi[0], theta[0], phi[0]), translationVector)
else:
return ((psi[1], theta[1], phi[1]), translationVector)
else:
phi = 0
if m[2][0] == -1:
theta = math.pi / 2
psi = phi + math.atan2(m[0][1], m[0][2])
else:
theta = -math.pi / 2
psi = -phi + math.atan2(-m[0][1], -m[0][2])
return ((math.degrees(psi), math.degrees(theta), math.degrees(phi)), translationVector)
def transformMatrixElement2RotationAndTranslationVector(element):
"""Get a OpenSCAD compatible 4x4 matrix of the given 3x3 Qtransform Matrix.
http://qt-project.org/doc/qt-4.8/qtransform.html
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#multmatrix
http://forum.openscad.org/Multmatrix-and-its-mysterious-4th-row-for-idiots-td10506.html"""
if element is None:
return ((0, 0, 0), (Dimension(0), Dimension(0), Dimension(0)))
data = dict(element.attrib)
data['m31'] = Dimension(data['m31']).asMm()
data['m32'] = Dimension(data['m32']).asMm()
# negating on purpose! We need to transform the coordinate system
# from positive y to negative y:
data['m32'] = -data['m32']
m = [
[float(data['m11']), float(data['m12']), 0, float(data['m31'])],
[float(data['m21']), float(data['m22']), 0, float(data['m32'])],
[0, 0, 1, 0],
[0, 0, 0, 1]
]
r = transformMatrixToRotationVectorAndTranslationVector(m)
rotationVector = r[0]
translationVector = (Dimension(r[1][0], "mm"), Dimension(r[1][1], "mm"), Dimension(r[1][2], "mm"))
return (rotationVector, translationVector)
def transformElement2MatrixString(element):
"""Get a OpenSCAD compatible 4x4 matrix of the given 3x3 Qtransform Matrix.
http://qt-project.org/doc/qt-4.8/qtransform.html
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#multmatrix
http://forum.openscad.org/Multmatrix-and-its-mysterious-4th-row-for-idiots-td10506.html"""
if element is None:
return None
data = dict(element.attrib)
data['m31'] = Dimension(data['m31']).asMm()
data['m32'] = Dimension(data['m32']).asMm()
# negating on purpose! We need to transform the coordinate system
# from positive y to negative y:
data['m32'] = -data['m32']
return """[
[ {m11:<10}, {m12:<10}, 0 , {m31:<10}],
[ {m21:<10}, {m22:<10}, 0 , {m32:<10}],
[ 0 , 0 , 1 , 0 ],
[ 0 , 0 , 0 , 1 ]
]""".format(**data)
# ####################### WORKHORSES ########################
def getParts(xmlRoot, attributes=dict()):
boardsTitles = list() # which of the parts are boards?
for boardElement in xmlRoot.findall("./boards/board"):
boardsTitles = boardsTitles + [boardElement.attrib['instance']]
relevantParts = dict()
for instance in xmlRoot.findall("./instances/instance"):
try:
if not txt_match_in_patternset(instance.find("./views/pcbView").attrib['layer'], pcbView_layer_whitelist_pattern):
printConsole("INFO: Ignoring '{}' as it is not whitelisted!".format(instance.attrib['moduleIdRef']), 3)
continue
except AttributeError:
continue
if not txt_match_in_patternset(str(instance.attrib['moduleIdRef']), moduleIdRef_blacklist_pattern):
geometry = instance.find("./views/pcbView/geometry")
if geometry is not None:
instanceTitle = instance.find("./title").text
if instanceTitle in boardsTitles:
p = PCB.buildFromInstanceXmlElement(instance, xmlRoot, attributes)
elif instance.attrib['moduleIdRef'] == "HoleModuleID":
p = Hole.buildFromInstanceXmlElement(instance, attributes)
else:
p = Part.buildFromInstanceXmlElement(instance, attributes)
printConsole("INFO: Adding '{}' title='{}'".format(instance.attrib['moduleIdRef'], p.title), 2)
relevantParts[p.title] = p
else:
printConsole("INFO: Strange! '{}' does not have XPath:'{}' that IS strange!".format(instance.attrib, "./views/pcbView/geometry"), 2)
else:
printConsole("INFO: Ignoring '{}' as it is blacklisted!".format(instance.attrib['moduleIdRef']), 2)
return relevantParts
def getConfig(xmlRoot, moduleNameOrPrefix):
"""Extract the configuration from the sketch.
TODO: Allow more than one note and merging of configuration notes"""
ret = dict({"attributes": dict(), "modules": dict()})
for instance in xmlRoot.findall("./instances/instance[@moduleIdRef='NoteModuleID']"):
try:
title = instance.find("./title").text
if title == "fzz2scad_config" or title.startswith("fzz2scad_config"):
txt = txt_from_note(instance)
try:
jsonData = json.loads(txt)
except ValueError as err:
printConsole("ERROR: Problem with json syntax from the note named: '{}':".format(instance.find("./title").text), 0)
printConsole(txt_prefix_each_line(txt, " ", False, False), 0)
printConsole(err, 0)
raise err
if "attributes" in jsonData.keys():
update(ret["attributes"], jsonData["attributes"])
if "modules" in jsonData.keys():
for moduleName in list(jsonData["modules"].keys()):
ret["modules"][moduleNameOrPrefix + "_" + moduleName] = jsonData["modules"].pop(moduleName)
except AttributeError:
pass
if not ret["modules"]: # empty?
ret["modules"][moduleNameOrPrefix] = {"default": True}
return ret
def xyInAbcd(xy=(), abcd=dict()):
if xy is None or abcd is None:
return False
elif xy[0] < abcd[0] or abcd[1] < xy[0]:
return False
elif xy[1] < abcd[2] or abcd[3] < xy[1]:
return False
else:
return True
def splitPartsToModules(xmlRoot, parts, configModules):
ret = dict()
defaultModuleName = None
for moduleName, modelConfig in configModules.items():
printConsole("INFO: Processing module '{}'.".format(moduleName), 2)
ret[moduleName] = dict()
if "frames" in modelConfig:
printConsole("INFO: Found 'frames' list in configuration for module '{}'.".format(moduleName), 2)
for frameTitle in modelConfig['frames']:
# find frame from schema, find items in this frame, add to list
printConsole("INFO: Looking for frame '{}'.".format(frameTitle), 2)
instance = xmlRoot.find("./instances/instance[@moduleIdRef='SchematicFrameModuleID'][title='" + frameTitle + "']")
if instance:
# get coordinates of the frame
geometry = instance.find(".views/schematicView/geometry")
x1 = Dimension(geometry.attrib["x"])
y1 = Dimension(geometry.attrib["y"])
x2 = x1 + Dimension(instance.find(".property[@name='width']").attrib["value"], unit="mm")
y2 = y1 + Dimension(instance.find(".property[@name='height']").attrib["value"], unit="mm")
abcd = (x1, x2, y1, y2)
printConsole("INFO: Found Frame '{}' for model '{}' with Coordinates '(x1,x2,y1,y2)={}'.".format(frameTitle, moduleName, abcd), 2)
# find parts that are in abcd
for partTitle in sorted(list(parts.keys())):
if isinstance(parts[partTitle], Part) and xyInAbcd(parts[partTitle].schematicCoords, abcd):
printConsole("INFO: Part '{}' in Frame '{}' {}.".format(partTitle, frameTitle, str(parts[partTitle].schematicCoords)), 2)
ret[moduleName][partTitle] = parts.pop(partTitle)
else:
printConsole("WARNING: Frame '{}' not found but it was set in the configuration for the model '{}'.".format(frameTitle, moduleName), 1)
if "pcb" in modelConfig:
# TODO find the pcb and the items on this pcb, add to list
pass
if "default" in modelConfig:
defaultModuleName = moduleName
if "parts" in modelConfig:
printConsole("INFO: Found 'parts' list in cofiguration for module '{}'.".format(moduleName), 2)
for partTitle in modelConfig["parts"]:
if partTitle in parts:
printConsole("INFO: Adding Part '{}' to Module '{}' as it is set in the 'parts' list in the configuration.".format(partTitle, moduleName), 2)
ret[moduleName][partTitle] = parts.pop(partTitle)
else:
printConsole("WARNING: Part '{}' not found but it was set in the configuration for the module '{}'.".format(partTitle, moduleName), 1)
if defaultModuleName is not None:
printConsole("INFO: Found the default module '{}'.".format(defaultModuleName), 2)
for partTitle in list(parts.keys()):
printConsole("INFO: Adding the part '{}' to the default module '{}'.".format(partTitle, defaultModuleName), 2)
ret[defaultModuleName][partTitle] = parts.pop(partTitle)
elif defaultModuleName is None and parts: # parts is not empty
printConsole("WARINING: There is no default module. But there are parts without a module.", 1)
printConsole("WARINING: These parts do not belong to any module:\n " + repr(parts.keys()) + "\n Check your Sketch. You may add {\"default\" : true} to a module.", 1)
return ret
def createModuleString(moduleName, moduleParts, configuration, showGroundplate):
moduleCommentTemplate = """
@created-with: fzz2scad v{version!s} (https://github.com/htho/fzz2scad)
{module-dependencies}
"""
moduleTemplate = """{moduleComment}
module {module_name}(){{
{translate}{{
difference(){{
union(){{
{parts}
}}
{holes}
}}
}}
}}
{export}
"""
values = dict()
values['version'] = VERSION
values['module_name'] = moduleName
values["export"] = dict() # external_name, value