-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathxmlWriteSpools.py
418 lines (346 loc) · 16 KB
/
xmlWriteSpools.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
#
# MIT license
#
# Part of kicadToCreo script
# This sample was created from one of the kicad bom scripts
# Write spool data (cables)
# ToDo: Add tape, shrink, tube spools
#
# Copyright (C) LasseFyr 2019.
#
# This has been tested only with Creo 4.0 070
#
"""
@package
Generate a net list file.
Command line:
Run kicadToCreo script from Kicad eeschema with default parameters "%I" "%O"
"""
from __future__ import print_function
import kicad_netlist_reader
import sys
class xmlWriteSpools:
_CBL_PARAMS = ["Value" ,"color","Num_conductors","Thickness","Density","Min_bend_radius","Sub_thickness","Vendor" ,"Vendor_pn" ,"Type"]
_CBL_DEFAULTS = ["NOT_DEFINED","Gray" ,"0" ,"4.5" ,"2.0e-5" ,"1" ,"2.0" ,"No Vendor","No Vendor_pn","prefab"]
def __init__(self):
self.SP_T1 = "NORMAL_SPOOL" #for master spool
self.SUB_SP= "WIRE_SPOOL"
self.SP_T2 = "INLINE_SPOOL" #for the wires inside a spool
self.DEF_COLOR = "GRAY"
self.MIN_BEND = "5"
self.MIN_THICKNESS = "1" #In millimeters
self.idNum = 1 # This is the first component
self.__spoolData = ""
self.cblSpoolName = []
self.cblSpoolId = []
def writeSpoolData(self, netlist, outputFileName):
isOutputFileOpended = False
try:
fout=open(outputFileName, "a")
isOutputFileOpended = True
except IOError:
print("Error opening file -- filename = \""+outputFileName+"\"", file=sys.stderr)
fout = sys.stdout
components = netlist.getInterestingComponents()
self.writeWireSpool(components)
print(self.__spoolData, file = fout)
# Zero the array before otherSpool
self.__spoolData = ""
self.writeOtherSpool(components)
print(self.__spoolData, file = fout)
# Zero the array before CblSpool
self.__spoolData = ""
self.writeCblSpool(components)
print(self.__spoolData, file = fout)
#-----------------------------------------------------------------------------------------
# def writeCblSpool(self, components ):
#
# Write spool data for Cables
# Quick and dirty Cable spool data write
#-----------------------------------------------------------------------------------------
def writeCblSpool(self, components ):
spoolList = [] # Spool list is empty
condIdIndex = 1 # This is used for spool indices
for comp in components:
refDes = comp.getRef()
part = comp.getLibPart()
description = comp.getDescription()
if refDes[:3] != "CBL":
continue
spoolName = comp.getField("Value")
if not spoolName:
print(refDes+ " no Spool name defined!", file=sys.stderr)
spoolName = "NOT_DEFINED"
continue
# Check if Spool has been processed ------------------------------------------------------
exitCompInComponentsLoop = False
for thisSpool in spoolList:
if thisSpool == spoolName:
exitCompInComponentsLoop = True
if exitCompInComponentsLoop == True:
continue
spoolList.append(spoolName)
# Component NUM_OF_PINS how many pins in this component-----------------------------------
pins = part.element.getChild("pins")
if pins: # more than one
howManyPins = len(pins.getChildren())
#print("Pins "+str(howManyPins))
else: # no Pins continue
continue
colorTable = []
for i in range(1, int(howManyPins/2+1)): #(each net has two counter parts)
wireColor = comp.getField("color"+str(i))
if not wireColor:
wireColor = "Gray"
colorTable.append( wireColor )
#print (colorTable)
numOfCoductors = comp.getField("Num_conductors")
if int(numOfCoductors) != int(howManyPins/2):
print( "CBL_SPOOL: Num_conductors different from Numofpins/2 "+ numOfCoductors)
thickness = comp.getField("Thickness")
if not thickness:
thickness = "4.5"
mainColor = comp.getField("Color")
if not mainColor:
mainColor = "Gray"
density = comp.getField("Density")
if not density:
density = "2.0e-5"
minBendRadius = comp.getField("Min_bend_radius")
if not minBendRadius:
minBendRadius = "1"
subThickness = comp.getField("Sub_thickness")
if not subThickness:
subThickness = "2.0"
vendor = comp.getField("Vendor")
if not vendor:
vendor = "No Vendor"
vendorPn = comp.getField("Vendor_pn")
if not vendorPn:
vendorPn = "No Vendor Part No."
type = comp.getField("Type")
if not type:
type = "prefab"
self.__spoolData += "<SPOOL name=\""+spoolName+"\" type=\"NORMAL_SPOOL\" subType=\"CABLE_SPOOL\" >\n"
self.__spoolData += "<SYS_PARAMETER id=\"cbl_"+spoolName+"\" />\n"
self.__spoolData += "<PARAMETER name=\"UNITS\" value=\"MM\" />\n"
self.__spoolData += "<PARAMETER name=\"OBJ_TYPE\" value=\"CABLE\" />\n"
self.__spoolData += "<PARAMETER name=\"MIN_BEND_RADIUS\" value=\""+minBendRadius+"\" />\n"
self.__spoolData += "<PARAMETER name=\"THICKNESS\" value=\""+thickness+"\" />\n"
self.__spoolData += "<PARAMETER name=\"NUM_COND\" value=\""+numOfCoductors+"\" />\n"
self.__spoolData += "<PARAMETER name=\"DENSITY\" value=\""+density+"\" />\n"
self.__spoolData += "<PARAMETER name=\"MASS_UNITS\" value=\"KG\" />\n"
self.__spoolData += "<PARAMETER name=\"COLOR\" value=\""+mainColor+"\" />\n"
self.__spoolData += "<PARAMETER name=\"VENDOR\" value=\""+vendor+"\" />\n"
self.__spoolData += "<PARAMETER name=\"VENDOR_PN\" value=\""+vendorPn+"\" />\n"
if description:
self.__spoolData += "<PARAMETER name=\"SPECIFICATION\" value=\""+description+"\" />\n"
firstSpoolIndex = condIdIndex
for i in range(1, int(howManyPins/2+1)): #(each net has two counter parts)
self.__spoolData += "<CONDUCTOR id=\"cond_"+str(condIdIndex)+"\" name=\""+spoolName+"-"+str(i)+"\" spoolID=\"sp"+str(condIdIndex)+"\" />\n"
self.pushCblSpoolId((spoolName+"-"+str(i)), condIdIndex)
condIdIndex+=1
self.__spoolData += "</SPOOL>\n"
#print ("range is " + str(int(howManyPins/2)))
for i in range(1, int(howManyPins/2+1)): #(each net has two counter parts)
self.__spoolData += "<SPOOL name=\""+spoolName+":"+str(i)+"\" type=\"INLINE_SPOOL\" subType=\"WIRE_SPOOL\" >\n"
self.__spoolData += "<SYS_PARAMETER id=\"sp"+str(firstSpoolIndex)+"\" />\n"
self.__spoolData += "<PARAMETER name=\"COLOR\" value=\""+colorTable[(i-1)]+"\" />\n"
self.__spoolData += "<PARAMETER name=\"COND_ID\" value=\""+str(i)+"\" />\n"
self.__spoolData += "<PARAMETER name=\"MIN_BEND_RADIUS\" value=\""+minBendRadius+"\" />\n"
self.__spoolData += "<PARAMETER name=\"UNITS\" value=\"MM\" />\n"
self.__spoolData += "<PARAMETER name=\"THICKNESS\" value=\""+subThickness+"\" />\n"
self.__spoolData += "</SPOOL>\n"
firstSpoolIndex+=1
def pushCblSpoolId(self, spoolName, spoolNumber):
self.cblSpoolName.append(spoolName)
self.cblSpoolId.append(spoolNumber)
def printCblSpoolNames(self):
print(self.cblSpoolName)
def getCblSpoolId(self, spoolName):
try:
myInt = self.cblSpoolName.index(spoolName)
except ValueError:
return -1
return myInt
#-----------------------------------------------------------------------------------------
# def writeWireSpool(self, components ):
#
# Write spool data for Wires
# Quick and dirty Spool data for wires
#-----------------------------------------------------------------------------------------
def writeWireSpool(self, components ):
spoolList = [] # Spool list is empty
for comp in components:
refDes = comp.getRef()
part = comp.getLibPart()
description = comp.getDescription()
if refDes[:1] != "W":
continue
spoolName = comp.getField("Value")
if not spoolName:
print(refDes+ " no Spool name defined!")
spoolName = "NOT_DEFINED"
continue
# Check if Spool has been processed ------------------------------------------------------
exitCompInComponentsLoop = False
for thisSpool in spoolList:
if thisSpool == spoolName:
exitCompInComponentsLoop = True
if exitCompInComponentsLoop == True:
continue
spoolList.append(spoolName)
self.__spoolData += "<SPOOL name=\""+spoolName+"\" type=\""+self.SP_T1+"\" subType=\""+self.SUB_SP+"\" >\n"
self.__spoolData += "<SYS_PARAMETER id=\"w_"+spoolName+"\" />\n"
# Wire COLOR -----------------------------------------------------------------------------
spoolColor = comp.getField("Color")
if not spoolColor:
print("No Spool color defined!")
spoolColor = self.DEF_COLOR
self.__spoolData += "<PARAMETER name=\"COLOR\" value=\""+spoolColor+"\" />\n"
# Wire DENSITY ---------------------------------------------------------------------------
density = comp.getField("Density")
if not density:
print("No Density for wire defined!")
else:
self.__spoolData += "<PARAMETER name=\"DENSITY\" value=\""+density+"\" />\n"
self.__spoolData += "<PARAMETER name=\"MASS_UNITS\" value=\"KG\" />\n"
# Wire MIN_BEND_RADIUS -------------------------------------------------------------------
minBend = comp.getField("Min_bend_radius")
if not minBend:
print("No minimum bend radius defined!")
minBend = self.MIN_BEND
self.__spoolData += "<PARAMETER name=\"MIN_BEND_RADIUS\" value=\""+minBend+"\" />\n"
# Wire TYPE (always wire)-----------------------------------------------------------------
self.__spoolData += "<PARAMETER name=\"OBJ_TYPE\" value=\"WIRE\" />\n"
# Wire THICKNESS -------------------------------------------------------------------------
thickness = comp.getField("Thickness")
if not thickness:
print("No Thickness defined!")
thickness = self.MIN_THICKNESS
self.__spoolData += "<PARAMETER name=\"THICKNESS\" value=\""+thickness+"\" />\n"
# Wire UNITS (default to mm)--------------------------------------------------------------
self.__spoolData += "<PARAMETER name=\"UNITS\" value=\"MM\" />\n"
# Wire WIRE_GAUGE (Optional) -------------------------------------------------------------
gauge = comp.getField("Gauge")
if not gauge:
print("No Gauge defined!")
else:
self.__spoolData += "<PARAMETER name=\"WIRE_GAUGE\" value=\""+gauge+"\" />\n"
# Wire USER_PARAMETERS (Vendor and Vendor_pn) --------------------------------------------
user_parameter = comp.getField("Vendor")
if user_parameter:
self.__spoolData += "<PARAMETER name=\"VENDOR\" value=\""+user_parameter+"\" />\n"
user_parameter = comp.getField("Vendor_pn")
if user_parameter:
self.__spoolData += "<PARAMETER name=\"VENDOR_PN\" value=\""+user_parameter+"\" />\n"
# Wire USER_PARAMETERS (Specification) ---------------------------------------------------
if description:
self.__spoolData += "<PARAMETER name=\"SPECIFICATION\" value=\""+description+"\" />\n"
# Wire END SPOOL DEFINE ------------------------------------------------------------------
self.__spoolData += "</SPOOL>\n"
#-----------------------------------------------------------------------------------------
# def writeOtherSpool(self, components ):
#
# Write spool data for Tubes, Tapes, and Shrinks
# There seems to be some issues when reading the Sheath spool types
#
# With type parameter I was able to get the type to be "Sheath"
# but the diameters become "0"
#
#
# MORE FROM PTC:
# Sheath type spools are exported to NWF as cable spool and to XML as wire in Creo Parametric
# Creo Parametric 4.0 to 6.0
# Created: 21-Aug-2019 | Modified: 21-Aug-2019
# Sheath type spools are exported to NWF as cable spool and to XML as wire in Creo Parametric
#
# Sheath type spools are exported to NWF as cable spool and to XML as wire
# When importing .nwf file the parameter spool TYPE changed it's value from SHEATH to PREFAB
#
# Resolution:
# Reported to R&D as SPR 7732529
# Workaround:
# Load the .nwf file, save the ribbon spool to .spl file
# Change the parameter TYPE in the spl file to SHEATH
# Load the .spl file (overwrite the existing spool).
#
#-----------------------------------------------------------------------------------------
def writeOtherSpool(self, components ):
spoolList = [] # Spool list is empty
for comp in components:
refDes = comp.getRef()
part = comp.getLibPart()
description = comp.getDescription()
if not (refDes.startswith("TUBE") or refDes.startswith("SHRINK") or refDes.startswith("TAPE")):
continue
spoolName = comp.getField("Value")
if not spoolName:
print(refDes+ " no Spool name defined!")
spoolName = "NOT_DEFINED"
continue
# Check if Spool has been processed ------------------------------------------------------
exitCompInComponentsLoop = False
for thisSpool in spoolList:
if thisSpool == spoolName:
exitCompInComponentsLoop = True
if exitCompInComponentsLoop == True:
continue
spoolList.append(spoolName)
self.__spoolData += "<SPOOL name=\""+spoolName+"\" type=\"NORMAL_SPOOL\" subType=\"SHEATH_SPOOL\" >\n"
self.__spoolData += "<SYS_PARAMETER id=\"Sh_"+spoolName+"\" />\n"
# Sheath TYPE (Shrink, Tube, or Tape) ----------------------------------------------------
self.__spoolData += "<PARAMETER name=\"TYPE\" value=\"SHEATH\" />\n"
sheathType = comp.getField("Sheath_type")
sheathType = sheathType.upper()
if not sheathType:
print("No Sheath Type defined for " + refDes+"!")
sheathType = "TUBE"
self.__spoolData += "<PARAMETER name=\"SHEATH_TYPE\" value=\""+sheathType+"\" />\n"
# Sheath WALL THICKNESS -------------------------------------------------------------------------
thickness = comp.getField("Wall_Thickness")
if not thickness:
print("No Wall Thickness defined for "+refDes+"! Using default value = 1")
thickness = "1"
self.__spoolData += "<PARAMETER name=\"WALL_THICKNESS\" value=\""+thickness+"\" />\n"
# Sheath COLOR -----------------------------------------------------------------------------
spoolColor = comp.getField("Color")
if not spoolColor:
print("No Spool color defined!")
spoolColor = self.DEF_COLOR
self.__spoolData += "<PARAMETER name=\"COLOR\" value=\""+spoolColor+"\" />\n"
# Sheath MIN_BEND_RADIUS -------------------------------------------------------------------
minBend = comp.getField("Min_bend_radius")
if not minBend:
print("No minimum bend radius defined!")
minBend = self.MIN_BEND
self.__spoolData += "<PARAMETER name=\"MIN_BEND_RADIUS\" value=\""+minBend+"\" />\n"
# Sheath UNITS (default to mm)--------------------------------------------------------------
self.__spoolData += "<PARAMETER name=\"UNITS\" value=\"MM\" />\n"
# Sheath Inner Diameter -------------------------------------------------------------------
innerDiam = comp.getField("Preshrink_inner_diameter")
if not innerDiam:
print("No Inned Diameter defined for " + refDes+"!")
innerDiam = "10"
self.__spoolData += "<PARAMETER name=\"PRESHRINK_INNER_DIAMETER\" value=\""+innerDiam+"\" />\n"
# Sheath Outer Diameter -------------------------------------------------------------------
outerDiam = comp.getField("Outer_Diameter")
if not outerDiam:
print("No Outer Diameter defined for " + refDes+"!")
innerDiam = "11"
if int(innerDiam) >= int(outerDiam):
print("Inner diameter larger than Outer diameter for " + refDes+"!")
outerDiam = str(int(innerDiam)+1)
self.__spoolData += "<PARAMETER name=\"OUTER_DIAMETER\" value=\""+outerDiam+"\" />\n"
# Sheath USER_PARAMETERS (Vendor and Vendor_pn) --------------------------------------------
user_parameter = comp.getField("Vendor")
if user_parameter:
self.__spoolData += "<PARAMETER name=\"VENDOR\" value=\""+user_parameter+"\" />\n"
user_parameter = comp.getField("Vendor_pn")
if user_parameter:
self.__spoolData += "<PARAMETER name=\"VENDOR_PN\" value=\""+user_parameter+"\" />\n"
# Sheath USER_PARAMETERS (Specification) ---------------------------------------------------
if description:
self.__spoolData += "<PARAMETER name=\"SPECIFICATION\" value=\""+description+"\" />\n"
# Sheath END SPOOL DEFINE ------------------------------------------------------------------
self.__spoolData += "</SPOOL>\n"