-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathxess_fp_wizard.py
419 lines (349 loc) · 18.1 KB
/
xess_fp_wizard.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
# MIT license
#
# Copyright (C) 2015 by XESS Corp.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
from __future__ import division
import pcbnew
import FootprintWizardBase
import PadArray as PA
from math import ceil, floor, sqrt
def calc_solderpaste_margin(w,h,fill):
'''Calculate how far in to pull the paste mask to get a certain fill percentage.'''
if fill > 0.99:
return 0
a = (h+w)/2.0
b = w*h*(fill-1.0)
c = sqrt(a**2+b)
return int((a-c)/2.0)
class XessFpWizardDrawingAids(FootprintWizardBase.FootprintWizardDrawingAids):
def Circle(self, x, y, r, filled=False):
"""
Draw a circle at (x,y) of radius r
If filled is true, the width and radius of the line will be set
such that the circle appears filled
"""
circle = pcbnew.EDGE_MODULE(self.module)
start = self.TransformPoint(x, y)
if filled:
circle.SetWidth(int(r))
end = self.TransformPoint(x, y + r/2)
else:
circle.SetWidth(self.dc['width'])
end = self.TransformPoint(x, y + r)
circle.SetLayer(self.dc['layer'])
circle.SetShape(pcbnew.S_CIRCLE)
circle.SetStartEnd(start, end)
self.module.Add(circle)
class XessFpWizard(FootprintWizardBase.FootprintWizard):
def GetValue(self):
return "{}".format(self.parameters["Misc"][self.fp_name_key])
def GetReferencePrefix(self):
return "{}".format(self.parameters["Misc"][self.fp_ref_key])
class XessPeriphPckgWizard(XessFpWizard):
def GetName(self):
return "Edge-Pin Chips"
def GetDescription(self):
return "SOICs, TSSOPs, QFPs, etc."
n_pads_per_col_key = '#Pads (Vertical)'
n_pads_per_row_key = '#Pads (Horizontal)'
total_width_key = 'Total Width (D)'
total_height_key = 'Total Height (E)'
body_width_key = 'Body Width (D1)'
body_height_key = 'Body Height (E1)'
col_to_col_pitch_key = 'Left-to-Right Column Pitch'
row_to_row_pitch_key = 'Top-to-Bottom Row Pitch'
pad_pitch_key = 'Pitch (e)'
pad_width_key = 'Width (b)'
pad_length_key = 'Length (L)'
pad_extension_key = 'Extension'
pad_oval_key = 'Oval (Y) / Rectangular (N)'
pad_smd_key = 'SMD (Y) / Through-Hole (N)'
pad_drill_key = 'Drill Size'
pad_soldermask_margin_key = 'Soldermask Margin'
pad_paste_fill_key = 'Paste Fill (%)'
fp_name_key = 'Footprint Name'
fp_ref_key = 'Reference Prefix'
land_dim_key = 'Land Pattern (Y) / Mechanical (N)'
outline_key = 'Silkscreen Outline (%)'
bevel_key = 'Bevel (%)'
add_index_key = 'Add index (Y/N)'
paddle_enable_key = 'Thermal Pad (Y/N)'
paddle_width_key = 'Width'
paddle_height_key = 'Height'
paddle_orgx_key = 'Center (X)'
paddle_orgy_key = 'Center (Y)'
paddle_soldermask_margin_key = 'Soldermask Margin'
paddle_paste_fill_key = 'Paste Fill (%)'
def GenerateParameterList(self):
self.AddParam("Package", self.n_pads_per_row_key, self.uInteger, 11)
self.AddParam("Package", self.n_pads_per_col_key, self.uInteger, 11)
self.AddParam("Package", self.total_width_key, self.uMM, 12)
self.AddParam("Package", self.total_height_key, self.uMM, 12)
self.AddParam("Package", self.body_width_key, self.uMM, 10)
self.AddParam("Package", self.body_height_key, self.uMM, 10)
self.AddParam("Package", self.col_to_col_pitch_key, self.uMM, 11.25)
self.AddParam("Package", self.row_to_row_pitch_key, self.uMM, 11.25)
self.AddParam("Pad", self.pad_smd_key, self.uBool, True)
self.AddParam("Pad", self.pad_oval_key, self.uBool, False)
self.AddParam("Pad", self.pad_pitch_key, self.uMM, 0.8)
self.AddParam("Pad", self.pad_width_key, self.uMM, 0.45)
self.AddParam("Pad", self.pad_length_key, self.uMM, 0.75)
self.AddParam("Pad", self.pad_extension_key, self.uMM, 0.5)
self.AddParam("Pad", self.pad_soldermask_margin_key, self.uMM, 0)
self.AddParam("Pad", self.pad_paste_fill_key, self.uInteger, 100)
self.AddParam("Pad", self.pad_drill_key, self.uMM, 1)
self.AddParam("Paddle", self.paddle_enable_key, self.uBool, False)
self.AddParam("Paddle", self.paddle_width_key, self.uMM, 0.0)
self.AddParam("Paddle", self.paddle_height_key, self.uMM, 0.0)
self.AddParam("Paddle", self.paddle_orgx_key, self.uMM, 0.0)
self.AddParam("Paddle", self.paddle_orgy_key, self.uMM, 0.0)
self.AddParam("Paddle", self.paddle_soldermask_margin_key, self.uMM, 0)
self.AddParam("Paddle", self.paddle_paste_fill_key, self.uInteger, 70)
self.AddParam("Misc", self.fp_name_key, self.uString, 'Footprint Name')
self.AddParam("Misc", self.fp_ref_key, self.uString, 'U')
self.AddParam("Misc", self.land_dim_key, self.uBool, False)
self.AddParam("Misc", self.outline_key, self.uInteger, 0)
self.AddParam("Misc", self.bevel_key, self.uInteger, 20)
self.AddParam("Misc", self.add_index_key, self.uBool, False)
def CheckParameters(self):
# self.CheckParamInt("Pad", '*'+self.n_pads_per_row_key)
# self.CheckParamInt("Pad", '*'+self.n_pads_per_col_key)
self.CheckParam("Pad", self.pad_oval_key)
self.CheckParam("Pad", self.pad_smd_key)
self.CheckParam("Paddle", self.paddle_enable_key)
self.CheckParam("Misc", self.land_dim_key)
self.CheckParam("Misc", self.add_index_key)
def BuildThisFootprint(self):
self.draw = XessFpWizardDrawingAids(self.module)
misc = self.parameters["Misc"]
pads = self.parameters["Pad"]
pckg = self.parameters["Package"]
paddle = self.parameters["Paddle"]
# Footprints can be specified using land patterns or the IC mechanical dimensions.
land_dim = misc[self.land_dim_key]
outline = misc[self.outline_key] / 100.0
bevel = misc[self.bevel_key] / 100.0
add_index = misc[self.add_index_key]
pad_pitch = pads[self.pad_pitch_key]
pad_width = pads[self.pad_width_key]
pad_length = pads[self.pad_length_key]
pad_extension = pads[self.pad_extension_key]
pad_soldermask_margin = pads[self.pad_soldermask_margin_key]
pad_paste_fill = pads[self.pad_paste_fill_key] / 100.0
pad_shape = pcbnew.PAD_SHAPE_OVAL if pads[self.pad_oval_key] else pcbnew.PAD_SHAPE_RECT
pad_smd = pads[self.pad_smd_key]
pad_drill = pads[self.pad_drill_key]
n_pads_per_row = int(pckg[self.n_pads_per_row_key])
n_pads_per_col = int(pckg[self.n_pads_per_col_key])
# IC epoxy package dimensions.
body_width = pckg[self.body_width_key]
body_height = pckg[self.body_height_key]
# Mechanical dimensions from side-to-side pin-tip to pin-tip.
total_width = pckg[self.total_width_key]
total_height = pckg[self.total_height_key]
if pad_smd is False:
# For through-hole pins, the pins go through the center of the pad.
# So add the pad length to the pin tip-to-tip distance to get the
# pad tip-to-tip distance.
total_width += pad_length
total_height += pad_length
# Land pattern dimensions.
col_to_col_pitch = pckg[self.col_to_col_pitch_key]
row_to_row_pitch = pckg[self.row_to_row_pitch_key]
paddle_enable = paddle[self.paddle_enable_key]
paddle_width = paddle[self.paddle_width_key]
paddle_height = paddle[self.paddle_height_key]
paddle_orgx = paddle[self.paddle_orgx_key]
paddle_orgy = paddle[self.paddle_orgy_key]
paddle_soldermask_margin = paddle[self.paddle_soldermask_margin_key]
paddle_paste_fill = paddle[self.paddle_paste_fill_key] / 100.0
if land_dim: # For footprint land dimensions.
pitch_adjustment = 0
row_to_row_pitch += pitch_adjustment
col_to_col_pitch += pitch_adjustment
else: # For footprint mechanical dimensions.
pitch_adjustment = - pad_length
row_to_row_pitch = total_height + pitch_adjustment
col_to_col_pitch = total_width + pitch_adjustment
if pad_smd is True:
h_pad = PA.PadMaker(self.module).SMDPad(pad_width, pad_length + pad_extension, shape=pad_shape)
v_pad = PA.PadMaker(self.module).SMDPad(pad_length + pad_extension, pad_width, shape=pad_shape)
else:
h_pad = PA.PadMaker(self.module).THPad(pad_width, pad_length + pad_extension, pad_drill, shape=pad_shape)
v_pad = PA.PadMaker(self.module).THPad(pad_length + pad_extension, pad_width, pad_drill, shape=pad_shape)
h_pad.SetLocalSolderMaskMargin(pad_soldermask_margin)
v_pad.SetLocalSolderMaskMargin(pad_soldermask_margin)
m = calc_solderpaste_margin(pad_width, pad_length + pad_extension, pad_paste_fill)
h_pad.SetLocalSolderPasteMargin(m)
v_pad.SetLocalSolderPasteMargin(m)
# left column
if n_pads_per_col != 0:
pin1Pos = pcbnew.wxPoint(-col_to_col_pitch / 2.0, 0)
offset = pcbnew.wxPoint(-pad_extension/2.0, 0)
h_pad.SetOffset(offset)
array = PA.PadLineArray(h_pad, n_pads_per_col, pad_pitch, True, pin1Pos)
array.SetFirstPadInArray(1)
array.AddPadsToModule(self.draw)
# bottom row
if n_pads_per_row != 0:
pin1Pos = pcbnew.wxPoint(0, row_to_row_pitch / 2.0)
offset = pcbnew.wxPoint(0, pad_extension/2.0)
v_pad.SetOffset(offset)
array = PA.PadLineArray(v_pad, n_pads_per_row, pad_pitch, False, pin1Pos)
array.SetFirstPadInArray(n_pads_per_col + 1)
array.AddPadsToModule(self.draw)
# right column
if n_pads_per_col != 0:
pin1Pos = pcbnew.wxPoint(col_to_col_pitch / 2.0, 0)
offset = pcbnew.wxPoint(pad_extension/2.0, 0)
h_pad.SetOffset(offset)
array = PA.PadLineArray(h_pad, n_pads_per_col, -pad_pitch, True, pin1Pos)
array.SetFirstPadInArray(n_pads_per_col + n_pads_per_row + 1)
array.AddPadsToModule(self.draw)
# top row
if n_pads_per_row != 0:
pin1Pos = pcbnew.wxPoint(0, -row_to_row_pitch / 2.0)
offset = pcbnew.wxPoint(0, -pad_extension/2.0)
v_pad.SetOffset(offset)
array = PA.PadLineArray(v_pad, n_pads_per_row, -pad_pitch, False, pin1Pos)
array.SetFirstPadInArray(2 * n_pads_per_col + n_pads_per_row + 1)
array.AddPadsToModule(self.draw)
# Thermal paddle.
if paddle_enable is True:
t_pad = PA.PadMaker(self.module).SMDPad(paddle_width, paddle_height, shape=pcbnew.PAD_SHAPE_RECT)
t_pad_pos = pcbnew.wxPoint(paddle_orgx, paddle_orgy)
t_pad.SetLocalSolderMaskMargin(paddle_soldermask_margin)
m = calc_solderpaste_margin(paddle_width, paddle_height, paddle_paste_fill)
t_pad.SetLocalSolderPasteMargin(m)
array = PA.PadLineArray(t_pad, 1, 0, False, t_pad_pos)
array.SetFirstPadInArray(2*(n_pads_per_col+n_pads_per_row)+1)
array.AddPadsToModule(self.draw)
if n_pads_per_row == 0:
row_to_row_pitch = body_height - pad_length - pad_extension
outline_height = body_height
else:
outline_height = row_to_row_pitch - pad_length + 2 * (pad_length + pad_extension) * outline
if n_pads_per_col == 0:
outline_width = body_width
else:
outline_width = col_to_col_pitch - pad_length + 2 * (pad_length + pad_extension) * outline
# Silkscreen outline
h = outline_height / 2.0
w = outline_width / 2.0
b = min(outline_height * bevel, outline_width * bevel)
self.draw.Polyline([(-w, -h + b), (-w, h), (w, h), (w, -h),
(-w + b, -h), (-w, -h + b)])
# Add corner index.
if add_index is True:
offset = pad_pitch
self.draw.Circle(-w-offset, -h-offset, pad_pitch/2.0, filled=True)
# reference and value
h1 = (row_to_row_pitch + pad_length + pad_extension) / 2.0
h = max(h, h1)
text_size = pcbnew.FromMM(1.2) # IPC nominal
text_offset = h + text_size + pad_pitch/2.0
self.draw.Value(0, -text_offset, text_size)
self.draw.Reference(0, text_offset, text_size)
class XessBgaPckgWizard(XessFpWizard):
def GetName(self):
return "Area-Pin Chips"
def GetDescription(self):
return "Ball Grid Arrays"
n_pads_per_col_key = '#Rows (Vertical)'
n_pads_per_row_key = '#Cols (Horizontal)'
total_width_key = 'Width (D)'
total_height_key = 'Height (E)'
pad_row_pitch_key = 'Row Pitch (e)'
pad_col_pitch_key = 'Column Pitch (e)'
pad_width_key = 'Size (b)'
pad_soldermask_margin_key = 'Soldermask Margin'
pad_paste_fill_key = 'Paste Fill (%)'
fp_name_key = 'Footprint Name'
fp_ref_key = 'Reference Prefix'
outline_key = 'Silkscreen Outline (%)'
bevel_key = 'Bevel (%)'
add_index_key = 'Add index (Y/N)'
def GenerateParameterList(self):
self.AddParam("Package", self.n_pads_per_row_key, self.uInteger, 16)
self.AddParam("Package", self.n_pads_per_col_key, self.uInteger, 16)
self.AddParam("Package", self.total_width_key, self.uMM, 14)
self.AddParam("Package", self.total_height_key, self.uMM, 14)
self.AddParam("Pad", self.pad_row_pitch_key, self.uMM, 0.8)
self.AddParam("Pad", self.pad_col_pitch_key, self.uMM, 0.8)
self.AddParam("Pad", self.pad_width_key, self.uMM, 0.45)
self.AddParam("Pad", self.pad_soldermask_margin_key, self.uMM, 0)
self.AddParam("Pad", self.pad_paste_fill_key, self.uInteger, 100)
self.AddParam("Misc", self.fp_name_key, self.uString, 'Footprint Name')
self.AddParam("Misc", self.fp_ref_key, self.uString, 'U')
self.AddParam("Misc", self.outline_key, self.uInteger, 100)
self.AddParam("Misc", self.bevel_key, self.uInteger, 7)
self.AddParam("Misc", self.add_index_key, self.uBool, False)
def CheckParameters(self):
# self.CheckParamInt("Pad", '*'+self.n_pads_per_row_key)
# self.CheckParamInt("Pad", '*'+self.n_pads_per_col_key)
self.CheckParam("Misc", self.add_index_key)
def BuildThisFootprint(self):
self.draw = XessFpWizardDrawingAids(self.module)
pads = self.parameters["Pad"]
pckg = self.parameters["Package"]
misc = self.parameters["Misc"]
n_pads_per_row = int(pckg[self.n_pads_per_row_key])
n_pads_per_col = int(pckg[self.n_pads_per_col_key])
total_width = pckg[self.total_width_key]
total_height = pckg[self.total_height_key]
pad_row_pitch = pads[self.pad_row_pitch_key]
pad_col_pitch = pads[self.pad_col_pitch_key]
pad_width = pads[self.pad_width_key]
pad_soldermask_margin = pads[self.pad_soldermask_margin_key]
pad_paste_fill = pads[self.pad_paste_fill_key] / 100.0
pad_length = pad_width
pad_shape = pcbnew.PAD_SHAPE_CIRCLE
outline = misc[self.outline_key] / 100.0
bevel = misc[self.bevel_key] / 100.0
add_index = misc[self.add_index_key]
pad = PA.PadMaker(self.module).SMDPad(pad_width, pad_length, shape=pad_shape)
pad.SetLayerSet(pad.SMDMask())
pad.SetLocalSolderMaskMargin(pad_soldermask_margin)
m = int(floor(pad_width * (1.0 - sqrt(pad_paste_fill))))
pad.SetLocalSolderPasteMargin(m)
class BGAPadGridArray(PA.PadGridArray):
def NamingFunction(self, n_x, n_y):
return "%s%d" % (
self.AlphaNameFromNumber(n_y + 1, alphabet="ABCDEFGHJKLMNPRTUVWY"),
n_x + 1)
# Draw pads.
array = BGAPadGridArray(pad, n_pads_per_col, n_pads_per_row, pad_col_pitch, pad_row_pitch)
array.AddPadsToModule(self.draw)
# Draw outline.
h = total_height / 2.0 * outline
w = total_width / 2.0 * outline
b = min(total_height * bevel, total_width * bevel)
self.draw.Polyline([(-w, -h + b), (-w, h), (w, h), (w, -h),
(-w + b, -h), (-w, -h + b)])
# Add corner index.
if add_index is True:
self.draw.Circle(-w-pad_col_pitch, -h-pad_row_pitch, (pad_row_pitch+pad_col_pitch)/4.0, filled=True)
# Add reference and value.
text_size = pcbnew.FromMM(1.2) # IPC nominal
text_offset = h + text_size + pad_row_pitch / 2.0
self.draw.Value(0, -text_offset, text_size)
self.draw.Reference(0, text_offset, text_size)
XessPeriphPckgWizard().register()
XessBgaPckgWizard().register()