# quick reference for generating land patterns using pcblander

###########################################################################
# pad definition
###########################################################################

# basic pad parameters - need to be set
pad_shape =  # "rectangular" or "circular"
pad_type = # "hole" or "pad"
# pad clearances - need to be defined
mask_clearance = # any units - 2x desired solder mask distance from pad
metal_clearance = # any units - clearance of a metal plane from pad


# pad/hole dimensions
# when pad_type == "pad"
# pad_height = # any units
# pad_width  = # any units

# when pad_type == "hole"
# drill_diameter = # any units
# pad_diameter = # any units (set to 0 for a hole with no pad around it)





###########################################################################
# pad or hole placement
##########################################################################

# pad/hole generators are:
# array() generates a two dimensional array of pad/holes centered at (x,y).
# The number of pads generated is determined by sets of pads, where
# a set is of the form {pad1,pad2,pad4:pad5, ... }.
# If one pad set is null or {}, generates just a row or column of pads.
# array(x, y, {x pad set}, {y pad set})


# when placing arrays, rows or columns of pads ...
# pitch_x = # units - horizontal distance between pad centers
# pitch_y =# units - vertical distance between pad centers

# placement modifiers
# pad omit causes pad generators to skip a pad - leaves gaps
# pad_omit = {pad set}, as in (1,2,3,8:10} 




###########################################################################
# silk placement
##########################################################################
# Silk generators use the silk_thickness parameter to determine the
# thickness of a silk line.
silk_thickness = # units - thickness of silk line

# silk generators are:
# silkarc(x,y,radius, starting angle (degress), ending angle (degrees))
# silkbox(x,y, width, height)
# silkcircle(x,y,radius)
# silkline(x,y, xdistance, y distance) - (x,y) is center point of line
# silksegment(x1,y1,x2,y2)



#origin_x
#origin_y
#output_directory


##########################################################################
# generating output
##########################################################################
# This should be done at the bottom of the file to capture all the
# placement operations.  After generating output, all the previous
# placements are cleared.
# If the "output_directory variable" is defined, will try to
# write the file to that directory.  If it is not defined or "", will
# write to the current directory.
# writeland(file_name) # if file_name is "" or empty, writes to standard out 
# writeland_and_source(file_name) # adds commented source to top of output



###########################################################################
# Note on placement of elememnts
###########################################################################
# all elements are placed using STANDARD (x,y) coordinates.  x is 0 at the
# orign and increases to the right.  y is 0 at the origin and increases
# upwards.  For most components, (0,0) shout be at their center.


##########################################################################
# Note on units
##########################################################################
# Units can be pure numbers (basic pcb units) or decimal numbers followed
# by a unit name(with or without a space).  Unit names are defined in 
# landgen.inc.  More names can be added in any included scripteaser file.
# Predefined defined unit names are:
# cm
# in
# ins
# inches
# mm
# mil
# mils


##########################################################################
# Useful utilities
##########################################################################

# Create a BGA pad name from a row/column pair.  Pads with row=0 return just 
# the column number.  Row 1 is "A", 2 is "B", ...  So genpad(2,56) would
# return "B56".  
# genpad(column, row) 

##########################################################################
# Useful utilities from landutils.inc
##########################################################################

# Create a numeric set of pads from a range and step.  Returns a bracketed 
# set of pads starting at start, ending (inclusive) at stop, Each pad is
# step apart from the next pad.  Note, this is a simple macro, so
# stop must be equal to (start + N * step) or the macro won't terminate.
# gen_padset(start, stop, step)

# mycolumn(x,y, {pad set}) - makes column of pads centered at (x,y)
# myrow(x,y, {pad set}) - makes row of pads centered at (x,y)

# good for doing a row/column of pads with first pad(pad 1) square
# pads1 is in shape pad_shape.  pads2 is in the other shape.
# twoshapesrow(x,y, pads1, pads2)
# twoshapescolumn(x,y, pads1, pads2)

# mywriteland(file_name) - returns success or error string
# mywriteland_and_source(file_name) - returns success or error string

# silk1(x,y, height, silk_thickness) # place a scaled "1"
# silkplus(x,y, height, silk_thickness) # place a scaled "+"
# silkbox_brackets (x,y,width, height) # brackets at top left, lower right