Commit 9da39717 authored by jean-pierre charras's avatar jean-pierre charras
Browse files

Add a python script example in demo folder to create various plot files from a... 

Add a python script example in demo folder to create various plot files from a board. Fix also some issues in plot controller helper class.
Important note: from a python script one cannot plot the palge layout, because the page layout template file is not stored in the board file, but it is part of the project.
Because when using a python script, the project is not loaded, the page layout template is not known.
Trying to plot it crashes the script.
parent 665f346a

demos/CMakeLists.txt

+12 −4
Original line number Diff line number Diff line 
install( DIRECTORY complex_hierarchy

    ecc83 electric flat_hierarchy

    kit-dev-coldfire-xilinx_5213 interf_u microwave

    pic_programmer pspice "sonde xilinx" test_xil_95108 video

install( DIRECTORY

    complex_hierarchy

    ecc83 electric

    flat_hierarchy

    interf_u

    kit-dev-coldfire-xilinx_5213

    microwave

    pic_programmer pspice

    python_scripts_examples

    "sonde xilinx"

    test_pads_inside_pads

    test_xil_95108 video

    DESTINATION ${KICAD_DEMOS}

    COMPONENT resources

    )

demos/python_scripts_examples/plot_board.py

0 → 100644
+211 −0
Original line number Diff line number Diff line 
'''

    A python script example to create various plot files from a board:

    Fab files

    Doc files

    Gerber files



    Important note:

        this python script does not plot frame references.

        the reason is it is not yet possible from a python script because plotting

        plot frame references needs loading the corresponding page layout file

        (.wks file) or the default template.



        This info (the page layout template) is not stored in the board, and therefore

        not available.



        Do not try to change SetPlotFrameRef(False) to SetPlotFrameRef(true)

        the result is the pcbnew lib will crash if you try to plot

        the unknown frame references template.

'''



import sys



from pcbnew import *

filename=sys.argv[1]



board = LoadBoard(filename)



pctl = PLOT_CONTROLLER(board)



popt = pctl.GetPlotOptions()



popt.SetOutputDirectory("plot/")



# Set some important plot options:

popt.SetPlotFrameRef(False)

popt.SetLineWidth(FromMM(0.35))



popt.SetAutoScale(False)

popt.SetScale(1)

popt.SetMirror(False)

popt.SetUseGerberAttributes(True)

popt.SetExcludeEdgeLayer(False);

popt.SetScale(1)

popt.SetUseAuxOrigin(True)



# This by gerbers only (also the name is truly horrid!)

popt.SetSubtractMaskFromSilk(False)



pctl.SetLayer(F_SilkS)

pctl.OpenPlotfile("Silk", PLOT_FORMAT_PDF, "Assembly guide")

pctl.PlotLayer()



# Once the defaults are set it become pretty easy...

# I have a Turing-complete programming language here: I'll use it...

# param 0 is a string added to the file base name to identify the drawing

# param 1 is the layer ID

plot_plan = [

    ( "CuTop", F_Cu, "Top layer" ),

    ( "CuBottom", B_Cu, "Bottom layer" ),

    ( "PasteBottom", B_Paste, "Paste Bottom" ),

    ( "PasteTop", F_Paste, "Paste top" ),

    ( "SilkTop", F_SilkS, "Silk top" ),

    ( "SilkBottom", B_SilkS, "Silk top" ),

    ( "MaskBottom", B_Mask, "Mask bottom" ),

    ( "MaskTop", F_Mask, "Mask top" ),

    ( "EdgeCuts", Edge_Cuts, "Edges" ),

]





for layer_info in plot_plan:

    pctl.SetLayer(layer_info[1])

    pctl.OpenPlotfile(layer_info[0], PLOT_FORMAT_GERBER, layer_info[2])

    pctl.PlotLayer()



# Our fabricators want two additional gerbers:

# An assembly with no silk trim and all and only the references

# (you'll see that even holes have designators, obviously)

popt.SetSubtractMaskFromSilk(False)

popt.SetPlotReference(True)

popt.SetPlotValue(False)

popt.SetPlotInvisibleText(True)



pctl.SetLayer(F_SilkS)

pctl.OpenPlotfile("AssyTop", PLOT_FORMAT_PDF, "Assembly top")

pctl.PlotLayer()



# And a gerber with only the component outlines (really!)

popt.SetPlotReference(False)

popt.SetPlotInvisibleText(False)

pctl.SetLayer(F_SilkS)

pctl.OpenPlotfile("AssyOutlinesTop", PLOT_FORMAT_PDF, "Assembly outline top")

pctl.PlotLayer()



# The same could be done for the bottom side, if there were components

popt.SetUseAuxOrigin(False)



## For documentation we also want a general layout PDF

## I usually use a shell script to merge the ps files and then distill the result

## Now I can do it with a control file. As a bonus I can have references in a

## different colour, too.



popt.SetPlotReference(True)

popt.SetPlotValue(True)

popt.SetPlotInvisibleText(False)

# Remember that the frame is always in color 0 (BLACK) and should be requested

# before opening the plot

popt.SetPlotFrameRef(False)

pctl.SetLayer(Dwgs_User)



pctl.OpenPlotfile("Layout", PLOT_FORMAT_PDF, "General layout")

pctl.PlotLayer()



# Do the PCB edges in yellow

popt.SetColor(YELLOW)

pctl.SetLayer(Edge_Cuts)

pctl.PlotLayer()



## Comments in, uhmm... green

popt.SetColor(GREEN)

pctl.SetLayer(Cmts_User)

pctl.PlotLayer()



# Bottom mask as lines only, in red

#popt.SetMode(LINE)

popt.SetColor(RED)

pctl.SetLayer(B_Mask)

pctl.PlotLayer()



# Top mask as lines only, in blue

popt.SetColor(BLUE)

pctl.SetLayer(F_Mask)

pctl.PlotLayer()



# Top paste in light blue, filled

popt.SetColor(BLUE)

#popt.SetMode(FILLED)

pctl.SetLayer(F_Paste)

pctl.PlotLayer()



# Top Silk in cyan, filled, references in dark cyan

popt.SetReferenceColor(DARKCYAN)

popt.SetColor(CYAN)

pctl.SetLayer(F_SilkS)

pctl.PlotLayer()



popt.SetTextMode(PLOTTEXTMODE_STROKE)

pctl.SetLayer(F_Mask)

pctl.OpenPlotfile("Assembly", PLOT_FORMAT_SVG, "Master Assembly")

pctl.SetColorMode(True)



# We want *everything*

popt.SetPlotReference(True)

popt.SetPlotValue(True)

popt.SetPlotInvisibleText(True)



# Remember than the DXF driver assigns colours to layers. This means that

# we will be able to turn references on and off simply using their layers

# Also most of the layer are now plotted in 'line' mode, because DXF handles

# fill mode almost like sketch mode (this is to keep compatibility with

# most CAD programs; most of the advanced primitive attributes required are

# handled only by recent autocads...); also the entry level cads (qcad

# and derivatives) simply don't handle polyline widths...



# Here I'm using numbers for colors and layers, I'm too lazy too look them up:P

popt.SetReferenceColor(19)

popt.SetValueColor(21)



popt.SetColor(0)

#popt.SetMode(LINE)

pctl.SetLayer(B_SilkS)

pctl.PlotLayer()

popt.SetColor(14)

pctl.SetLayer(F_SilkS)

pctl.PlotLayer()

popt.SetColor(2)

pctl.SetLayer(B_Mask)

pctl.PlotLayer()

popt.SetColor(4)

pctl.SetLayer(F_Mask)

pctl.PlotLayer()

popt.SetColor(1)

pctl.SetLayer(B_Paste)

pctl.PlotLayer()

popt.SetColor(9)

pctl.SetLayer(F_Paste)

pctl.PlotLayer()

popt.SetColor(3)

pctl.SetLayer(Edge_Cuts)

pctl.PlotLayer()



# Export the copper layers too... exporting one of them in filled mode with

# drill marks will put the marks in the WHITE later (since it tries to blank

# the pads...); these will be obviously great reference points for snap

# and stuff in the cad. A pctl function to only plot them would be

# better anyway...



popt.SetColor(17)

#popt.SetMode(FILLED)

popt.SetDrillMarksType(PCB_PLOT_PARAMS.FULL_DRILL_SHAPE)

pctl.SetLayer(B_Cu)

pctl.PlotLayer()

popt.SetColor(20)

popt.SetDrillMarksType(PCB_PLOT_PARAMS.NO_DRILL_SHAPE)

pctl.SetLayer(F_Cu)

pctl.PlotLayer()



# At the end you have to close the last plot, otherwise you don't know when

# the object will be recycled!

pctl.ClosePlot()



# We have just generated 21 plotfiles with a single script

demos/test_pads_inside_pads/test_pads_inside_pads.kicad_pcb

+57 −85
Original line number Diff line number Diff line 
(kicad_pcb (version 3) (host pcbnew "(2013-01-12 BZR 3902)-testing")

(kicad_pcb (version 4) (host pcbnew "(2015-04-25 BZR 5623)-product")



  (general

    (links 12)

    (no_connects 0)

    (area 74.91259 30.97059 111.463666 65.151)

    (area 79.121 35.179 111.052429 65.3542)

    (thickness 1.6002)

    (drawings 0)

    (tracks 4)
@@ -14,21 +14,21 @@ 


  (page A4)

  (layers

    (15 Dessus signal)

    (0 Dessous signal)

    (16 B.Adhes user)

    (17 F.Adhes user)

    (18 B.Paste user)

    (19 F.Paste user)

    (20 B.SilkS user)

    (21 F.SilkS user)

    (22 B.Mask user)

    (23 F.Mask user)

    (24 Dwgs.User user)

    (25 Cmts.User user)

    (26 Eco1.User user)

    (27 Eco2.User user)

    (28 Edge.Cuts user)

    (0 Dessus signal)

    (31 Dessous signal)

    (32 B.Adhes user)

    (33 F.Adhes user)

    (34 B.Paste user)

    (35 F.Paste user)

    (36 B.SilkS user)

    (37 F.SilkS user)

    (38 B.Mask user)

    (39 F.Mask user)

    (40 Dwgs.User user)

    (41 Cmts.User user)

    (42 Eco1.User user)

    (43 Eco2.User user)

    (44 Edge.Cuts user)

  )



  (setup
@@ -57,12 +57,12 @@ 
    (pad_drill 0.8128)

    (pad_to_mask_clearance 0.254)

    (aux_axis_origin 0 0)

    (visible_elements FFFFFFBF)

    (visible_elements 7FFFFFFF)

    (pcbplotparams

      (layerselection 3178497)

      (layerselection 0x00030_80000001)

      (usegerberextensions true)

      (excludeedgelayer true)

      (linewidth 60)

      (linewidth 0.150000)

      (plotframeref false)

      (viasonmask false)

      (mode 1)
@@ -75,7 +75,6 @@ 
      (psa4output false)

      (plotreference true)

      (plotvalue true)

      (plotothertext true)

      (plotinvisibletext false)

      (padsonsilk false)

      (subtractmaskfromsilk false)
@@ -97,67 +96,47 @@ 
    (via_drill 0.635)

    (uvia_dia 0.508)

    (uvia_drill 0.127)

    (add_net "")

    (add_net /NET1)

    (add_net /NET2)

  )



  (module 1pin (layer Dessus) (tedit 4EE506A9) (tstamp 4EE505BA)

  (module 1pin (layer Dessus) (tedit 553E7303) (tstamp 4EE505BA)

    (at 89.535 45.593)

    (descr "module 1 pin (ou trou mecanique de percage)")

    (tags DEV)

    (path /4EDF7CC5)

    (fp_text reference P1 (at 0 -3.048) (layer F.SilkS)

    (fp_text reference P1 (at 0 -12) (layer F.SilkS)

      (effects (font (size 1.016 1.016) (thickness 0.254)))

    )

    (fp_text value CONN_1 (at 0 2.794) (layer F.SilkS) hide

    (fp_text value CONN_1 (at 0 12) (layer F.SilkS) hide

      (effects (font (size 1.016 1.016) (thickness 0.254)))

    )

    (fp_circle (center 0 0) (end 0 -2.286) (layer F.SilkS) (width 0.381))

    (pad 1 smd rect (at 0 0) (size 20.32 20.32)

      (layers Dessus F.Paste F.Mask)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at -8.255 -7.62) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at -3.81 -7.62) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at 0 -7.62) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at 3.81 -7.62) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at 8.255 -7.62) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at 8.255 -4.445) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at 3.81 -4.445) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at 0 -4.445) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at -3.81 -4.445) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at -8.255 -4.445) (size 1.524 1.524) (drill 0.762)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (fp_line (start -11 -11) (end 11 -11) (layer F.SilkS) (width 0.15))

    (fp_line (start 11 -11) (end 11 11) (layer F.SilkS) (width 0.15))

    (fp_line (start 11 11) (end -11 11) (layer F.SilkS) (width 0.15))

    (fp_line (start -11 11) (end -11 -11) (layer F.SilkS) (width 0.15))

    (pad 1 smd rect (at 0 0) (size 20.32 20.32) (layers Dessus F.Paste F.Mask)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at -8.255 -7.62) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at -3.81 -7.62) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at 0 -7.62) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at 3.81 -7.62) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at 8.255 -7.62) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at 8.255 -4.445) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at 3.81 -4.445) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at 0 -4.445) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at -3.81 -4.445) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

    (pad 1 thru_hole circle (at -8.255 -4.445) (size 1.524 1.524) (drill 0.762) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

  )



  (module 1pin (layer Dessus) (tedit 200000) (tstamp 4EE505BC)
@@ -172,10 +151,8 @@ 
      (effects (font (size 1.016 1.016) (thickness 0.254)))

    )

    (fp_circle (center 0 0) (end 0 -2.286) (layer F.SilkS) (width 0.381))

    (pad 1 thru_hole circle (at 0 0) (size 4.064 4.064) (drill 3.048)

      (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2)

    )

    (pad 1 thru_hole circle (at 0 0) (size 4.064 4.064) (drill 3.048) (layers *.Cu *.Mask F.SilkS)

      (net 2 /NET2))

  )



  (module 1pin (layer Dessus) (tedit 200000) (tstamp 4EE505BE)
@@ -190,10 +167,8 @@ 
      (effects (font (size 1.016 1.016) (thickness 0.254)))

    )

    (fp_circle (center 0 0) (end 0 -2.286) (layer F.SilkS) (width 0.381))

    (pad 1 thru_hole circle (at 0 0) (size 4.064 4.064) (drill 3.048)

      (layers *.Cu *.Mask F.SilkS)

      (net 1 /NET1)

    )

    (pad 1 thru_hole circle (at 0 0) (size 4.064 4.064) (drill 3.048) (layers *.Cu *.Mask F.SilkS)

      (net 1 /NET1))

  )



  (module 1pin (layer Dessus) (tedit 4EE8A1D1) (tstamp 4EE505C0)
@@ -208,16 +183,13 @@ 
      (effects (font (size 1.016 1.016) (thickness 0.254)))

    )

    (fp_circle (center 0 0) (end 0 -2.286) (layer F.SilkS) (width 0.381))

    (pad 1 thru_hole circle (at 0 0) (size 4.064 4.064) (drill 3.048)

      (layers *.Cu *.Mask F.SilkS)

      (net 1 /NET1)

      (die_length 7.62)

    )

    (pad 1 thru_hole circle (at 0 0) (size 4.064 4.064) (drill 3.048) (layers *.Cu *.Mask F.SilkS)

      (net 1 /NET1) (die_length 7.62))

  )



  (segment (start 107.061 61.468) (end 87.122 61.468) (width 0.2032) (layer Dessous) (net 1))

  (segment (start 97.79 41.148) (end 103.759 41.148) (width 0.2032) (layer Dessous) (net 2))

  (segment (start 107.696 45.085) (end 107.696 45.593) (width 0.2032) (layer Dessous) (net 2))

  (segment (start 103.759 41.148) (end 107.696 45.085) (width 0.2032) (layer Dessous) (net 2))

  (segment (start 107.696 45.085) (end 107.696 45.593) (width 0.2032) (layer Dessous) (net 2))

  (segment (start 97.79 41.148) (end 103.759 41.148) (width 0.2032) (layer Dessous) (net 2))



)

helpers/tools_to_build_newstroke-font/font.brd

deleted100644 → 0
+0 −533

File deleted.

Preview size limit exceeded, changes collapsed.

helpers/tools_to_build_newstroke-font/font.kicad_pcb

0 → 100644
+376 −0

File added.

Preview size limit exceeded, changes collapsed.