-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathgenerate_chip.py
1106 lines (1028 loc) · 45.1 KB
/
generate_chip.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
"""
Generate the following packages:
- Chip resistors SMT
- Chip capacitors SMT
"""
import sys
from os import path
from uuid import uuid4
from typing import Dict, Iterable, Optional, Tuple
from common import format_ipc_dimension as fd
from common import init_cache, now, save_cache
from entities.common import (
Align, Angle, Author, Category, Created, Deprecated, Description, Fill, GeneratedBy, GrabArea, Height, Keywords,
Layer, Name, Polygon, Position, Position3D, Rotation, Rotation3D, Value, Version, Vertex, Width, generate_courtyard
)
from entities.component import SignalUUID
from entities.device import ComponentPad, ComponentUUID, Device, PackageUUID
from entities.package import (
AssemblyType, AutoRotate, ComponentSide, CopperClearance, Footprint, Footprint3DModel, FootprintPad, LetterSpacing,
LineSpacing, Mirror, Package, Package3DModel, PackagePad, PackagePadUuid, PadFunction, Shape, ShapeRadius, Size,
SolderPasteConfig, StopMaskConfig, StrokeText, StrokeWidth
)
generator = 'librepcb-parts-generator (generate_chip.py)'
line_width = 0.25
line_width_thin = 0.15
line_width_thinner = 0.05
pkg_text_height = 1.0
label_offset = 1.1
label_offset_thin = 0.8
silkscreen_clearance = 0.15
handsoldering_toe_extension = 0.5
# Based on IPC 7351B (Table 3-5)
DENSITY_LEVELS = { # For 1608 and up
'A': {'toe': 0.55, 'heel': 0.00, 'side': 0.05, 'courtyard': 0.50},
'B': {'toe': 0.35, 'heel': 0.00, 'side': 0.00, 'courtyard': 0.25},
'C': {'toe': 0.15, 'heel': 0.00, 'side': -0.05, 'courtyard': 0.12},
}
# Based on IPC 7351B (Table 3-6)
# Heel has been set to 0.00 instead of -0.05, since IPC 7351C will probably
# use those values too.
DENSITY_LEVELS_SMALL = { # Below 1608
'A': {'toe': 0.20, 'heel': 0.00, 'side': 0.05, 'courtyard': 0.20},
'B': {'toe': 0.10, 'heel': 0.00, 'side': 0.00, 'courtyard': 0.15},
'C': {'toe': 0.00, 'heel': 0.00, 'side': 0.00, 'courtyard': 0.10},
}
def get_by_density(length: float, level: str, key: str) -> float:
if length >= 1.6:
table = DENSITY_LEVELS
else:
table = DENSITY_LEVELS_SMALL
return table[level][key]
# Initialize UUID cache
uuid_cache_file = 'uuid_cache_chip.csv'
uuid_cache = init_cache(uuid_cache_file)
def uuid(category: str, full_name: str, identifier: str, create: bool = True) -> str:
"""
Return a uuid for the specified pin.
Params:
category:
For example 'cmp' or 'pkg'.
full_name:
For example "RESC3216X65".
identifier:
For example 'pad-1' or 'pin-13'.
"""
key = '{}-{}-{}'.format(category, full_name, identifier).lower().replace(' ', '~')
if key not in uuid_cache:
if not create:
raise ValueError('Unknown UUID: {}'.format(key))
uuid_cache[key] = str(uuid4())
return uuid_cache[key]
class BodyDimensions:
"""
Dimensions of the physical body.
"""
def __init__(
self,
length: float,
width: float,
height: float,
lead_length: Optional[float] = None,
lead_width: Optional[float] = None,
):
self.length = length
self.width = width
self.height = height
self.lead_length = lead_length
self.lead_width = lead_width
@property
def gap(self) -> Optional[float]:
if self.lead_length:
return (self.length - 2 * self.lead_length)
return None
class FootprintDimensions:
"""
Information about the footprint itself.
L
+--+ +--+
| | G | | W
+--+ +--+
L = Length, W = Width, G = Gap
"""
def __init__(self, pad_length: float, pad_width: float, pad_gap: float):
self.pad_length = pad_length
self.pad_width = pad_width
self.pad_gap = pad_gap
class ChipConfig:
"""
Chip configuration.
Note: Specify either footprints or gap, but not both.
"""
def __init__(
self,
size_imperial: str, # String, e.g. "1206"
body: BodyDimensions,
*,
footprints: Optional[Dict[str, FootprintDimensions]] = None,
gap: Optional[float] = None,
meta: Optional[Dict[str, str]] = None # Metadata that can be used in description
):
self._size_imperial = size_imperial
self.body = body
self.footprints = footprints
self.gap = gap
self.meta = meta
if self.footprints and self.gap:
raise ValueError('Only set either footprints or gap, but not both')
if not self.footprints and not self.gap:
raise ValueError('Set footprints or gap')
if self.footprints:
for density_level in self.footprints.keys():
if density_level not in ['A', 'B', 'C']:
raise ValueError('Invalid density level: {}'.format(density_level))
def size_metric(self) -> str:
return str(int(self.body.length * 10)).rjust(2, '0') + \
str(int(self.body.width * 10 if self.body.width < 10 else self.body.width)).rjust(2, '0')
def size_imperial(self) -> str:
return self._size_imperial
class PolarizationConfig:
def __init__(
self,
*,
name_marked: str,
id_marked: str,
name_unmarked: str,
id_unmarked: str
):
self.name_marked = name_marked
self.id_marked = id_marked
self.name_unmarked = name_unmarked
self.id_unmarked = id_unmarked
def generate_pkg(
library: str,
author: str,
package_type: str,
name: str,
description: str,
polarization: Optional[PolarizationConfig],
configs: Iterable[ChipConfig],
generate_3d_models: bool,
pkgcat: str,
keywords: str,
version: str,
create_date: Optional[str]
) -> None:
category = 'pkg'
for config in configs:
fmt_params: Dict[str, str] = {
'size_metric': config.size_metric(),
'size_imperial': config.size_imperial(),
}
fmt_params_name = {
**fmt_params,
'length': fd(config.body.length),
'width': fd(config.body.width),
'height': fd(config.body.height),
'lead_length': fd(config.body.lead_length) if config.body.lead_length else None,
'lead_width': fd(config.body.lead_width) if config.body.lead_width else None,
'package_type': package_type,
}
fmt_params_desc = {
**fmt_params,
'length': config.body.length,
'width': config.body.width,
'height': config.body.height,
'meta': config.meta,
}
full_name = name.format(**fmt_params_name)
full_desc = description.format(**fmt_params_desc) + \
"\n\nGenerated with {}".format(generator)
full_keywords = ",".join(filter(None, [
config.size_metric(), config.size_imperial(),
keywords.format(**fmt_params_desc).lower(),
]))
def _uuid(identifier: str) -> str:
return uuid(category, full_name, identifier)
# UUIDs
uuid_pkg = _uuid('pkg')
if polarization:
uuid_pads = [
_uuid('pad-{}'.format(polarization.id_marked)),
_uuid('pad-{}'.format(polarization.id_unmarked)),
]
else:
uuid_pads = [_uuid('pad-1'), _uuid('pad-2')]
print('Generating pkg "{}": {}'.format(full_name, uuid_pkg))
package = Package(
uuid=uuid_pkg,
name=Name(full_name),
description=Description(full_desc),
keywords=Keywords(full_keywords),
author=Author(author),
version=Version(version),
created=Created(create_date or now()),
deprecated=Deprecated(False),
generated_by=GeneratedBy(''),
categories=[Category(pkgcat)],
assembly_type=AssemblyType.SMT,
)
package.add_pad(PackagePad(uuid_pads[0], Name(polarization.name_marked if polarization else '1')))
package.add_pad(PackagePad(uuid_pads[1], Name(polarization.name_unmarked if polarization else '2')))
def add_footprint_variant(
key: str,
name: str,
density_level: str,
*,
gap: Optional[float] = None,
dimensions: Optional[FootprintDimensions] = None
) -> None:
"""
Generate a footprint variant.
Note: Either the toe extension or footprint dimensions must be set.
"""
if gap is not None and dimensions is not None:
raise ValueError('Only toe extension or footprint may be set')
if gap is None and dimensions is None:
raise ValueError('Either toe extension or footprint must be set')
uuid_footprint = _uuid('footprint-{}'.format(key))
uuid_text_name = _uuid('text-name-{}'.format(key))
uuid_text_value = _uuid('text-value-{}'.format(key))
uuid_silkscreen_top = _uuid('line-silkscreen-top-{}'.format(key))
uuid_silkscreen_bot = _uuid('line-silkscreen-bot-{}'.format(key))
uuid_outline = _uuid('polygon-outline-{}'.format(key))
uuid_courtyard = _uuid('polygon-courtyard-{}'.format(key))
uuid_body_top = _uuid('polygon-body-top-{}'.format(key))
uuid_body_bot = _uuid('polygon-body-bot-{}'.format(key))
uuid_body_left = _uuid('polygon-body-left-{}'.format(key))
uuid_body_right = _uuid('polygon-body-right-{}'.format(key))
uuid_body_around = _uuid('polygon-body-around-{}'.format(key))
uuid_polarization_mark = _uuid('polygon-polarization-mark-{}'.format(key))
# Max boundary
max_x = 0.0
max_y = 0.0
# Line width adjusted for size of element
if config.body.length >= 2.0:
silk_lw = line_width
doc_lw = line_width
elif config.body.length >= 1.0:
silk_lw = line_width_thin
doc_lw = line_width_thin
else:
silk_lw = line_width_thin
doc_lw = line_width_thinner
footprint = Footprint(
uuid=uuid_footprint,
name=Name(name),
description=Description(''),
position_3d=Position3D.zero(),
rotation_3d=Rotation3D.zero(),
)
package.add_footprint(footprint)
# Pads
if dimensions is not None:
pad_width = dimensions.pad_width
pad_length = dimensions.pad_length
pad_gap = dimensions.pad_gap
pad_dx = (pad_gap / 2 + pad_length / 2) # x offset (delta-x)
elif gap is not None:
pad_gap = gap
pad_width = config.body.width + get_by_density(config.body.length, density_level, 'side')
pad_toe = get_by_density(config.body.length, density_level, 'toe')
pad_length = (config.body.length - gap) / 2 + pad_toe
pad_dx = (gap / 2 + pad_length / 2) # x offset (delta-x)
else:
raise ValueError('Either dimensions or gap must be set')
for p in [0, 1]:
pad_uuid = uuid_pads[p - 1]
sign = -1 if p == 1 else 1
footprint.add_pad(FootprintPad(
uuid=pad_uuid,
side=ComponentSide.TOP,
shape=Shape.ROUNDED_RECT,
position=Position(sign * pad_dx, 0),
rotation=Rotation(0),
size=Size(pad_length, pad_width),
radius=ShapeRadius(0),
stop_mask=StopMaskConfig.AUTO,
solder_paste=SolderPasteConfig.AUTO,
copper_clearance=CopperClearance(0.0),
function=PadFunction.STANDARD_PAD,
package_pad=PackagePadUuid(pad_uuid),
holes=[],
))
max_x = max(max_x, pad_length / 2 + sign * pad_dx)
max_y = max(max_y, config.body.width / 2)
max_y = max(max_y, pad_width / 2)
# Documentation
half_gap = (config.body.gap or pad_gap) / 2
if dimensions is None:
# We assume that leads are across the entire width of the part (e.g. MLCC)
dx = config.body.length / 2
dy = config.body.width / 2
footprint.add_polygon(Polygon(
uuid=uuid_body_left,
layer=Layer('top_documentation'),
width=Width(0),
fill=Fill(True),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(-dx, dy), Angle(0)), # NW
Vertex(Position(-half_gap, dy), Angle(0)), # NE
Vertex(Position(-half_gap, -dy), Angle(0)), # SE
Vertex(Position(-dx, -dy), Angle(0)), # SW
Vertex(Position(-dx, dy), Angle(0)), # NW
],
))
footprint.add_polygon(Polygon(
uuid=uuid_body_right,
layer=Layer('top_documentation'),
width=Width(0),
fill=Fill(True),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(dx, dy), Angle(0)), # NE
Vertex(Position(half_gap, dy), Angle(0)), # NW
Vertex(Position(half_gap, -dy), Angle(0)), # SW
Vertex(Position(dx, -dy), Angle(0)), # SE
Vertex(Position(dx, dy), Angle(0)), # NE
],
))
dy = config.body.width / 2 - doc_lw / 2
footprint.add_polygon(Polygon(
uuid=uuid_body_top,
layer=Layer('top_documentation'),
width=Width(doc_lw),
fill=Fill(False),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(-half_gap, dy), Angle(0)),
Vertex(Position(half_gap, dy), Angle(0)),
],
))
footprint.add_polygon(Polygon(
uuid=uuid_body_bot,
layer=Layer('top_documentation'),
width=Width(doc_lw),
fill=Fill(False),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(-half_gap, -dy), Angle(0)),
Vertex(Position(half_gap, -dy), Angle(0)),
],
))
else:
# We have more precise information about the lead (e.g. molded
# packages where leads are not the full width of the package).
dx = config.body.length / 2 - doc_lw / 2
dy = config.body.width / 2 - doc_lw / 2
footprint.add_polygon(Polygon(
uuid=uuid_body_around,
layer=Layer('top_documentation'),
width=Width(doc_lw),
fill=Fill(False),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(-dx, dy), Angle(0)),
Vertex(Position(dx, dy), Angle(0)),
Vertex(Position(dx, -dy), Angle(0)),
Vertex(Position(-dx, -dy), Angle(0)),
Vertex(Position(-dx, dy), Angle(0)),
],
))
dx = config.body.length / 2
dy = (config.body.lead_width or dimensions.pad_width) / 2
footprint.add_polygon(Polygon(
uuid=uuid_body_left,
layer=Layer('top_documentation'),
width=Width(0),
fill=Fill(True),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(-dx, dy), Angle(0)),
Vertex(Position(-half_gap, dy), Angle(0)),
Vertex(Position(-half_gap, -dy), Angle(0)),
Vertex(Position(-dx, -dy), Angle(0)),
Vertex(Position(-dx, dy), Angle(0)),
],
))
footprint.add_polygon(Polygon(
uuid=uuid_body_right,
layer=Layer('top_documentation'),
width=Width(0),
fill=Fill(True),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(dx, dy), Angle(0)),
Vertex(Position(half_gap, dy), Angle(0)),
Vertex(Position(half_gap, -dy), Angle(0)),
Vertex(Position(dx, -dy), Angle(0)),
Vertex(Position(dx, dy), Angle(0)),
],
))
if polarization:
polarization_mark_width = config.body.width / 8
dx_outer = half_gap - polarization_mark_width / 2
dx_inner = half_gap - polarization_mark_width * 1.5
dy = config.body.width / 2 - doc_lw
footprint.add_polygon(Polygon(
uuid=uuid_polarization_mark,
layer=Layer('top_documentation'),
width=Width(0),
fill=Fill(True),
grab_area=GrabArea(True),
vertices=[
Vertex(Position(-dx_outer, dy), Angle(0)),
Vertex(Position(-dx_inner, dy), Angle(0)),
Vertex(Position(-dx_inner, -dy), Angle(0)),
Vertex(Position(-dx_outer, -dy), Angle(0)),
Vertex(Position(-dx_outer, dy), Angle(0)),
],
))
# Silkscreen
if config.body.length > 1.0:
if polarization:
dx_unmarked = pad_dx + pad_length / 2
dx_marked = dx_unmarked + silk_lw / 2 + silkscreen_clearance
dy = max(
config.body.width / 2 + silk_lw / 2, # Based on body width
pad_width / 2 + silk_lw / 2 + silkscreen_clearance, # Based on pad width
)
footprint.add_polygon(Polygon(
uuid=uuid_silkscreen_top,
layer=Layer('top_legend'),
width=Width(silk_lw),
fill=Fill(False),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(dx_unmarked, dy), Angle(0)),
Vertex(Position(-dx_marked, dy), Angle(0)),
Vertex(Position(-dx_marked, -dy), Angle(0)),
Vertex(Position(dx_unmarked, -dy), Angle(0)),
],
))
else:
assert gap is not None, \
"Support for non-polarized packages with irregular pads not yet fully implemented"
dx = gap / 2 - silk_lw / 2 - silkscreen_clearance
dy = config.body.width / 2 + silk_lw / 2
footprint.add_polygon(Polygon(
uuid=uuid_silkscreen_top,
layer=Layer('top_legend'),
width=Width(silk_lw),
fill=Fill(False),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(-dx, dy), Angle(0)),
Vertex(Position(dx, dy), Angle(0)),
],
))
footprint.add_polygon(Polygon(
uuid=uuid_silkscreen_bot,
layer=Layer('top_legend'),
width=Width(silk_lw),
fill=Fill(False),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(-dx, -dy), Angle(0)),
Vertex(Position(dx, -dy), Angle(0)),
],
))
# Package outlines
dx = config.body.length / 2
dy = config.body.width / 2
footprint.add_polygon(Polygon(
uuid=uuid_outline,
layer=Layer('top_package_outlines'),
width=Width(0),
fill=Fill(False),
grab_area=GrabArea(False),
vertices=[
Vertex(Position(-dx, dy), Angle(0)), # NW
Vertex(Position(dx, dy), Angle(0)), # NE
Vertex(Position(dx, -dy), Angle(0)), # SE
Vertex(Position(-dx, -dy), Angle(0)), # SW
],
))
# Courtyard
courtyard_excess = get_by_density(config.body.length, density_level, 'courtyard')
footprint.add_polygon(generate_courtyard(
uuid=uuid_courtyard,
max_x=max_x,
max_y=max_y,
excess_x=courtyard_excess,
excess_y=courtyard_excess,
))
# Labels
if config.body.width < 2.0:
offset = label_offset_thin
else:
offset = label_offset
dy = config.body.width / 2 + offset # y offset (delta-y)
footprint.add_text(StrokeText(
uuid=uuid_text_name,
layer=Layer('top_names'),
height=Height(pkg_text_height),
stroke_width=StrokeWidth(0.2),
letter_spacing=LetterSpacing.AUTO,
line_spacing=LineSpacing.AUTO,
align=Align('center bottom'),
position=Position(0.0, dy),
rotation=Rotation(0.0),
auto_rotate=AutoRotate(True),
mirror=Mirror(False),
value=Value('{{NAME}}'),
))
footprint.add_text(StrokeText(
uuid=uuid_text_value,
layer=Layer('top_values'),
height=Height(pkg_text_height),
stroke_width=StrokeWidth(0.2),
letter_spacing=LetterSpacing.AUTO,
line_spacing=LineSpacing.AUTO,
align=Align('center top'),
position=Position(0.0, -dy),
rotation=Rotation(0.0),
auto_rotate=AutoRotate(True),
mirror=Mirror(False),
value=Value('{{VALUE}}'),
))
if config.gap:
add_footprint_variant('density~b', 'Density Level B (median protrusion)', 'B', gap=config.gap)
add_footprint_variant('density~a', 'Density Level A (max protrusion)', 'A', gap=config.gap)
elif config.footprints:
a = config.footprints.get('A')
b = config.footprints.get('B')
c = config.footprints.get('C')
if b:
add_footprint_variant('density~b', 'Density Level B (median protrusion)', 'B', dimensions=b)
if a:
add_footprint_variant('density~a', 'Density Level A (max protrusion)', 'A', dimensions=a)
if c:
add_footprint_variant('density~c', 'Density Level C (min protrusion)', 'C', dimensions=c)
else:
raise ValueError('Either gap or footprints must be set')
# Generate 3D models (for certain package types)
if package_type in ['RESC', 'CAPC', 'CAPPM', 'INDC']:
uuid_3d = uuid('pkg', full_name, '3d')
if generate_3d_models:
generate_3d(library, package_type, full_name, uuid_pkg, uuid_3d, config)
package.add_3d_model(Package3DModel(uuid_3d, Name(full_name)))
for footprint in package.footprints:
footprint.add_3d_model(Footprint3DModel(uuid_3d))
else:
# For unsupported package types, approve the warnings
for footprint in package.footprints:
package.add_approval(
"(approved missing_footprint_3d_model\n" +
" (footprint {})\n".format(footprint.uuid) +
")"
)
package.serialize(path.join('out', library, category))
def generate_3d(
library: str,
package_type: str,
full_name: str,
uuid_pkg: str,
uuid_3d: str,
config: ChipConfig,
) -> None:
import cadquery as cq
from cadquery_helpers import StepAssembly, StepColor
print(f'Generating pkg 3D model "{full_name}": {uuid_3d}')
length = config.body.length
width = config.body.width
height = config.body.height
max_fillet = 0.05 if package_type == 'RESC' else 0.25
fillet = min(height * 0.2, max_fillet)
gap = config.gap or config.body.gap
if gap is None:
raise RuntimeError('Generating 3D models not supported for configs without gap')
edge = (length - gap) / 2
translation = (0, 0, height / 2)
edge_offset = length / 2 - edge
if package_type != 'CAPPM':
inner = cq.Workplane("XY") \
.box(length - 2 * edge, width, height) \
.edges('+X').fillet(fillet) \
.translate(translation)
left = cq.Workplane("XY") \
.box(edge, width, height) \
.edges('+X or <X').fillet(fillet) \
.translate(translation) \
.translate((-edge_offset - edge / 2, 0, 0))
right = cq.Workplane("XY") \
.box(edge, width, height) \
.edges('+X or >X').fillet(fillet) \
.translate(translation) \
.translate((edge_offset + edge / 2, 0, 0))
else:
lead_tickness = 0.1
lead_length = config.body.lead_length
lead_width = config.body.lead_width
if lead_length is None or lead_width is None:
raise RuntimeError('Generating 3D models for CAPPM not supported for configs without lead')
body_pts = [(0, 0),
(0, length / 2 - lead_length - lead_tickness),
(lead_tickness, length / 2 - lead_length - lead_tickness),
(lead_tickness, length / 2 - 2 * lead_tickness),
(height * .6, length / 2 - lead_tickness),
(height + lead_tickness, length / 2 - lead_tickness),
(height + lead_tickness, 0)]
lead_pts = [(0, 0),
(0, lead_length),
(height * .6 + lead_tickness, lead_length),
(height * .6 + lead_tickness, lead_length - lead_tickness),
(lead_tickness, lead_length - lead_tickness),
(lead_tickness, 0)]
inner = cq.Workplane('ZX') \
.polyline(body_pts).mirrorX().extrude(width / 2, both=True) \
.edges("|Z").fillet(fillet)
left = cq.Workplane('ZX', origin=(length / 2 - lead_length, 0, 0)) \
.polyline(lead_pts).close().extrude(lead_width / 2, both=True) \
.edges('>X and |Y').fillet(lead_tickness / 1.1)
right = left.mirror(mirrorPlane="ZY")
marking = cq.Workplane('XY', origin=(-(length * .4 - lead_tickness - 0.01), 0, lead_tickness + height)) \
.box(length * 0.2, width - 2 * fillet, 0.02)
if package_type == 'RESC':
inner_color = cq.Color('gray16')
elif package_type == 'CAPC':
inner_color = cq.Color('bisque3')
elif package_type == 'CAPPM':
inner_color = cq.Color('lightgoldenrod1')
elif package_type == 'INDC':
inner_color = cq.Color('lightsteelblue3')
else:
raise RuntimeError(f'Unsupported 3D package type: {package_type}')
assembly = StepAssembly(full_name)
assembly.add_body(inner, 'inner', inner_color)
assembly.add_body(left, 'left', StepColor.LEAD_SMT)
assembly.add_body(right, 'right', StepColor.LEAD_SMT)
if package_type == 'CAPPM':
assembly.add_body(marking, 'marking', cq.Color('darkgoldenrod1'))
out_path = path.join('out', library, 'pkg', uuid_pkg, f'{uuid_3d}.step')
assembly.save(out_path, fused=True)
def generate_dev(
library: str,
author: str,
name: str,
description: str,
packages: Iterable[Tuple[str, str, str]],
cmp: str,
cat: str,
signals: Iterable[str],
keywords: str,
version: str,
create_date: Optional[str],
pad_ids: Optional[Iterable[str]] = None,
) -> None:
category = 'dev'
for (size_metric, size_imperial, pkg_name) in packages:
fmt_params: Dict[str, str] = {
'size_metric': size_metric,
'size_imperial': size_imperial,
}
full_name = name.format(**fmt_params)
full_desc = description.format(**fmt_params) + \
"\n\nGenerated with {}".format(generator)
full_keywords = "{},{},{}".format(size_metric, size_imperial, keywords)
def _uuid(identifier: str) -> str:
return uuid(category, full_name, identifier)
# UUIDs
uuid_dev = _uuid('dev')
pkg = uuid('pkg', pkg_name, 'pkg', create=False)
pads = [uuid('pkg', pkg_name, 'pad-{}'.format(i), create=False)
for i in (pad_ids or ['1', '2'])]
print('Generating dev "{}": {}'.format(full_name, uuid_dev))
device = Device(
uuid=uuid_dev,
name=Name(full_name),
description=Description(full_desc),
keywords=Keywords(full_keywords),
author=Author(author),
version=Version(version),
created=Created(create_date or now()),
deprecated=Deprecated(False),
generated_by=GeneratedBy(''),
categories=[Category(cat)],
component_uuid=ComponentUUID(cmp),
package_uuid=PackageUUID(pkg),
)
for (pad, signal) in sorted(zip(pads, signals)):
device.add_pad(ComponentPad(pad_uuid=pad, signal=SignalUUID(signal)))
# Approve "no parts" warning because it's a generic device
device.add_approval("(approved no_parts)")
device.serialize(path.join('out', library, category))
if __name__ == '__main__':
if '--help' in sys.argv or '-h' in sys.argv:
print(f'Usage: {sys.argv[0]} [--3d]')
print()
print('Options:')
print(' --3d Generate 3D models using cadquery')
sys.exit(1)
generate_3d_models = '--3d' in sys.argv
if not generate_3d_models:
warning = 'Note: Not generating 3D models unless the "--3d" argument is passed in!'
print(f'\033[1;33m{warning}\033[0m')
# Chip resistors (RESC)
generate_pkg(
library='LibrePCB_Base.lplib',
author='Danilo B.',
package_type='RESC',
name='{package_type}{size_metric} ({size_imperial})',
description='Generic chip resistor {size_metric} (imperial {size_imperial}).\n\n'
'Length: {length}mm\nWidth: {width}mm',
polarization=None,
configs=[
# Configuration: Values taken from Samsung specs.
ChipConfig('01005', BodyDimensions(.4, .2, 0.15), gap=0.2), # noqa
ChipConfig('0201', BodyDimensions(.6, .3, 0.26), gap=0.28), # noqa
ChipConfig('0402', BodyDimensions(1.0, .5, 0.35), gap=0.5), # noqa
ChipConfig('0603', BodyDimensions(1.6, .8, 0.55), gap=0.8), # noqa
ChipConfig('0805', BodyDimensions(2.0, 1.25, 0.70), gap=1.2), # noqa
ChipConfig('1206', BodyDimensions(3.2, 1.6, 0.70), gap=1.8), # noqa
ChipConfig('1210', BodyDimensions(3.2, 2.55, 0.70), gap=1.8), # noqa
ChipConfig('1218', BodyDimensions(3.2, 4.6, 0.70), gap=1.8), # noqa
ChipConfig('2010', BodyDimensions(5.0, 2.5, 0.70), gap=3.3), # noqa
ChipConfig('2512', BodyDimensions(6.4, 3.2, 0.70), gap=4.6), # noqa
],
generate_3d_models=generate_3d_models,
pkgcat='a20f0330-06d3-4bc2-a1fa-f8577deb6770',
keywords='r,resistor,chip,generic',
version='0.4',
create_date='2018-12-19T00:08:03Z',
)
# J-Lead resistors (RESJ)
generate_pkg(
library='LibrePCB_Base.lplib',
author='Danilo B.',
package_type='RESJ',
name='{package_type}{size_metric} ({size_imperial})',
description='Generic J-lead resistor {size_metric} (imperial {size_imperial}).\n\n'
'Length: {length}mm\nWidth: {width}mm',
polarization=None,
configs=[
ChipConfig('4527', BodyDimensions(11.56, 6.98, 5.84), gap=5.2),
],
generate_3d_models=generate_3d_models,
pkgcat='a20f0330-06d3-4bc2-a1fa-f8577deb6770',
keywords='r,resistor,j-lead,generic',
version='0.4',
create_date='2019-01-04T23:06:17Z',
)
# Chip capacitors (CAPC)
generate_pkg(
library='LibrePCB_Base.lplib',
author='murray',
package_type='CAPC',
name='{package_type}{size_metric} ({size_imperial})',
description='Generic chip capacitor {size_metric} (imperial {size_imperial}).\n\n'
'Length: {length}mm\nWidth: {width}mm',
polarization=None,
configs=[
# C0402
ChipConfig('01005', BodyDimensions(0.4, 0.2, 0.2), gap=0.15),
# C0603
ChipConfig('0201', BodyDimensions(0.6, 0.3, 0.3), gap=0.2),
# C1005
ChipConfig('0402', BodyDimensions(1.0, 0.5, 0.5), gap=0.4),
# C1608
ChipConfig('0603', BodyDimensions(1.6, 0.8, 0.8), gap=0.6),
# C2012
ChipConfig('0805', BodyDimensions(2.0, 1.25, 1.25), gap=0.8),
# C3216
ChipConfig('1206', BodyDimensions(3.2, 1.6, 1.6), gap=1.8),
# C3225
ChipConfig('1210', BodyDimensions(3.2, 2.5, 2.5), gap=1.8),
# C4520
ChipConfig('1808', BodyDimensions(4.5, 2.0, 2.0), gap=2.8),
# C4532
ChipConfig('1812', BodyDimensions(4.5, 3.2, 3.2), gap=2.8),
# C4564
ChipConfig('1825', BodyDimensions(4.5, 6.4, 3.2), gap=2.8),
# C5750
ChipConfig('2220', BodyDimensions(5.7, 5.0, 2.8), gap=4.3),
# C9210
ChipConfig('3640', BodyDimensions(9.2, 10.16, 2.8), gap=6.4),
],
generate_3d_models=generate_3d_models,
pkgcat='414f873f-4099-47fd-8526-bdd8419de581',
keywords='c,capacitor,chip,generic',
version='0.4',
create_date='2015-06-21T12:37:34Z',
)
# Molded polarized capacitors (CAPPM)
# Based on the table "Common Molded Body Tantalum Capacitors" in the IPC7351C draft
# and KEMET documentation: https://content.kemet.com/datasheets/KEM_T2005_T491.pdf
# (see Table 2: Land Dimensions / Courtyard)
generate_pkg(
library='LibrePCB_Base.lplib',
author='Danilo B., eto-',
package_type='CAPPM',
name='{package_type}{length}X{width}X{height}L{lead_length}X{lead_width}',
description='Generic polarized molded inward-L capacitor (EIA {meta[eia]}).\n\n'
'Length: {length}mm\nWidth: {width}mm\nMax height: {height}mm\n\n'
'EIA Size Code: {meta[eia]}\n'
'KEMET Case Code: {meta[kemet]}\nAVX Case Code: {meta[avx]}',
polarization=PolarizationConfig(
name_marked='+',
id_marked='p',
name_unmarked='-',
id_unmarked='n',
),
configs=[
ChipConfig('', BodyDimensions(3.2, 1.6, 1.0, 0.8, 1.2), footprints={
'A': FootprintDimensions(2.20, 1.35, 0.62),
'B': FootprintDimensions(1.80, 1.23, 0.82),
'C': FootprintDimensions(1.42, 1.13, 0.98),
}, meta={'eia': '3216-10', 'kemet': 'I', 'avx': 'K'}),
ChipConfig('', BodyDimensions(3.2, 1.6, 1.2, 0.8, 1.2), footprints={
'A': FootprintDimensions(2.20, 1.35, 0.62),
'B': FootprintDimensions(1.80, 1.23, 0.82),
'C': FootprintDimensions(1.42, 1.13, 0.98),
}, meta={'eia': '3216-12', 'kemet': 'S', 'avx': 'S'}),
ChipConfig('', BodyDimensions(3.2, 1.6, 1.8, 0.8, 1.2), footprints={
'A': FootprintDimensions(2.20, 1.35, 0.62),
'B': FootprintDimensions(1.80, 1.23, 0.82),
'C': FootprintDimensions(1.42, 1.13, 0.98),
}, meta={'eia': '3216-18', 'kemet': 'A', 'avx': 'A'}),
ChipConfig('', BodyDimensions(3.5, 2.8, 1.2, 0.8, 2.2), footprints={
'A': FootprintDimensions(2.20, 2.35, 0.92),
'B': FootprintDimensions(1.80, 2.23, 1.12),
'C': FootprintDimensions(1.42, 2.13, 1.28),
}, meta={'eia': '3528-12', 'kemet': 'T', 'avx': 'T'}),
ChipConfig('', BodyDimensions(3.5, 2.8, 2.1, 0.8, 2.2), footprints={
'A': FootprintDimensions(2.21, 2.35, 0.92),
'B': FootprintDimensions(1.80, 2.23, 1.12),
'C': FootprintDimensions(1.42, 2.13, 1.28),
}, meta={'eia': '3528-21', 'kemet': 'B', 'avx': 'B'}),
ChipConfig('', BodyDimensions(6.0, 3.2, 1.5, 1.3, 2.2), footprints={
'A': FootprintDimensions(2.77, 2.35, 2.37),
'B': FootprintDimensions(2.37, 2.23, 2.57),
'C': FootprintDimensions(1.99, 2.13, 2.73),
}, meta={'eia': '6032-15', 'kemet': 'U', 'avx': 'W'}),
ChipConfig('', BodyDimensions(6.0, 3.2, 2.8, 1.3, 2.2), footprints={
'A': FootprintDimensions(2.77, 2.35, 2.37),
'B': FootprintDimensions(2.37, 2.23, 2.57),
'C': FootprintDimensions(1.99, 2.13, 2.73),
}, meta={'eia': '6032-28', 'kemet': 'C', 'avx': 'C'}),
ChipConfig('', BodyDimensions(7.3, 6.0, 3.8, 1.3, 4.1), footprints={
'A': FootprintDimensions(2.77, 4.25, 3.68),
'B': FootprintDimensions(2.37, 4.13, 3.87),
'C': FootprintDimensions(1.99, 4.03, 4.03),
}, meta={'eia': '7360-38', 'kemet': 'E', 'avx': 'V'}),
ChipConfig('', BodyDimensions(7.3, 4.3, 2.0, 1.3, 2.4), footprints={
'A': FootprintDimensions(2.77, 2.55, 3.67),
'B': FootprintDimensions(2.37, 2.43, 3.87),
'C': FootprintDimensions(1.99, 2.33, 4.03),
}, meta={'eia': '7343-20', 'kemet': 'V', 'avx': 'Y'}),
ChipConfig('', BodyDimensions(7.3, 4.3, 3.1, 1.3, 2.4), footprints={
'A': FootprintDimensions(2.77, 2.55, 3.67),
'B': FootprintDimensions(2.37, 2.43, 3.87),
'C': FootprintDimensions(1.99, 2.33, 4.03),
}, meta={'eia': '7343-31', 'kemet': 'D', 'avx': 'D'}),
ChipConfig('', BodyDimensions(7.3, 4.3, 4.3, 1.3, 2.4), footprints={
'A': FootprintDimensions(2.77, 2.55, 3.67),
'B': FootprintDimensions(2.37, 2.43, 3.87),
'C': FootprintDimensions(1.99, 2.33, 4.03),
}, meta={'eia': '7343-43', 'kemet': 'X', 'avx': 'E'}),
],
generate_3d_models=generate_3d_models,
pkgcat='414f873f-4099-47fd-8526-bdd8419de581',
keywords='c,capacitor,j-lead,inward-l,molded,generic,kemet {meta[kemet]},avx {meta[avx]}',
version='0.3',
create_date='2019-11-18T21:56:00Z',
)
# Chip inductors (INDC)
generate_pkg(
library='LibrePCB_Base.lplib',
author='U. Bruhin',
package_type='INDC',
name='{package_type}{size_metric} ({size_imperial})',
description='Generic chip inductor {size_metric} (imperial {size_imperial}).\n\n'
'Length: {length}mm\nWidth: {width}mm',
polarization=None,
configs=[
# Configuration: Values taken from Taiyo Yuden, TDK and Murata specs.
ChipConfig('01005', BodyDimensions(0.4, 0.2, 0.2), gap=0.15),
ChipConfig('0201', BodyDimensions(0.6, 0.3, 0.3), gap=0.3),
ChipConfig('0402', BodyDimensions(1.0, 0.5, 0.5), gap=0.5),
ChipConfig('0603', BodyDimensions(1.6, 0.8, 0.8), gap=0.7),
ChipConfig('0805', BodyDimensions(2.0, 1.25, 1.25), gap=1.0),
ChipConfig('1008', BodyDimensions(2.5, 2.0, 2.0), gap=1.3),
ChipConfig('1206', BodyDimensions(3.2, 1.6, 1.6), gap=2.0),
ChipConfig('1210', BodyDimensions(3.2, 2.5, 2.5), gap=2.0),
],
generate_3d_models=generate_3d_models,
pkgcat='812c8e64-3a47-49d8-987f-2cfba377c8ae',
keywords='l,inductor,ferrite,bead,chip,generic',
version='0.1',
create_date='2023-11-05T09:15:41Z',
)
# Generic devices
generate_dev(
library='LibrePCB_Base.lplib',
author='Danilo B.',
name='Resistor {size_metric} ({size_imperial})',
description='Generic SMD resistor {size_metric} (imperial {size_imperial}).',
packages=[
# Metric, Imperial, Name
('0402', '01005', 'RESC0402 (01005)'),
('0603', '0201', 'RESC0603 (0201)'),
('1005', '0402', 'RESC1005 (0402)'),