PCB-FPW developer documentation based on version: 0.0.11

Functions

res.h File Reference

Header file for functions for RES footprints. More...

Go to the source code of this file.

Functions

int res_create_element ()
 Create an Element for a RES package.
int res_create_packages_list ()
 Create a list of RES packages with pre-defined values.
int res_drc ()
 Do some Design Rule Checking for the RES package type.
int res_get_default_footprint_values ()
 Look up default values for RES footprint.
int res_set_gui_constraints ()
 Set GUI constraints for the RES package type.
int res_write_footprint ()
 Write a TH footprint for a RES package.
void res_init ()

Detailed Description

Header file for functions for RES footprints.

Author:
Copyright 2007, 2008, 2009, 2010, 2011 by Bert Timmerman <bert.timmerman@xs4all.nl>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Definition in file res.h.


Function Documentation

int res_create_element (  ) 
int res_create_packages_list (  ) 

Create a list of RES packages with pre-defined values.

The data in this list can be used in a combo box to select a pre-defined package.

Returns:
EXIT_SUCCESS when a packages list was created, EXIT_FAILURE when errors were encountered.

Definition at line 421 of file res.c.

int res_drc (  ) 

Do some Design Rule Checking for the RES package type.

  • check for allowed pad shapes.
  • check for zero sized packages.
  • check for a zero sized courtyard.
  • check for minimum clearance between copper (X-direction).
  • check for minimum clearance between copper (Y-direction).
  • If any fiducials exist:
    • check for zero fiducial pad diameter.
    • check for zero width solder mask clearance.
    • check for minimum clearance between copper (between pads and fiducials, if any fiducials exist).
  • check for clearance of the package length with regard to the courtyard dimensions.
  • check for clearance of the package width with regard to the courtyard dimensions.
  • check for any silk lines or texts touching bare copper.
  • check for soldermask clearance (solder mask overlapping copper at the solder fillet area or worse).
  • check for a reasonable silk line width.
Returns:
EXIT_SUCCESS when no DRC violations were encountered, EXIT_FAILURE when DRC violations were found.

Todo:
Check for any silk lines or texts touching bare copper.
Todo:
Check for soldermask clearance (solder mask overlapping copper at the solder fillet area or worse).

Definition at line 480 of file res.c.

References courtyard_clearance_with_package, courtyard_length, courtyard_width, fiducial, footprint_name, footprint_type, MIL, MIL_100, MM, NO_UNITS, package_body_height, package_body_length, package_body_width, pad_clearance, pad_diameter, pad_length, pad_shapes_type, pitch_x, pitch_y, silkscreen_line_width, silkscreen_package_outline, units_type, and verbose.

Referenced by write_footprint().

int res_get_default_footprint_values (  ) 

Look up default values for RES footprint.

Footprint values can be looked up by placing a question mark "?" in front of the footprint name.
If the footprint name is recognised known values will be loaded and the entries involved in the GUI will be updated accordingly.
Currently the following footprints are supported:

  • RES600-320X170,
  • RES770-420X200,
  • RES1030-640X250,
  • RES1130-700X280,
  • RES1190-800X300,
  • RES1390-1000X350
  • RES1440-1050X200,
  • RES1670-1200X400,
  • RES1680-1200X500,
  • RES1740-1050X200,
  • RES1760-1250X500,
  • RES1770-1270X550,
  • RES1860-1350X500,
  • RES2080-1600X550,
  • RES2160-1650X650,
  • RES2210-1700X450,
  • RES2830-2350X850,
  • RES3060-2550X900,
  • RES5480-5000X1000,
  • RES5480-5000X1250,
  • RES6510-6000X1450,
  • RES6880-6400X1450.
Returns:
EXIT_SUCCESS when default values for a footprint were found, EXIT_FAILURE when the footprint name was not found.

Definition at line 773 of file res.c.

References count_x, count_y, courtyard, courtyard_length, courtyard_line_width, courtyard_width, fiducial, fiducial_pad_diameter, fiducial_pad_solder_mask_clearance, footprint_name, footprint_units, number_of_columns, number_of_pins, number_of_rows, package_body_height, package_body_length, package_body_width, package_is_radial, pad_diameter, pad_length, pad_shape, pad_shapes_type, pad_solder_mask_clearance, pad_width, pin_drill_diameter, pitch_x, pitch_y, silkscreen_length, silkscreen_line_width, silkscreen_package_outline, silkscreen_width, thermal, thermal_length, thermal_width, and verbose.

Referenced by on_footprint_name_entry_changed().

int res_set_gui_constraints (  ) 

Set GUI constraints for the RES package type.

This function is only to be compiled for GUI targets.

Returns:
EXIT_SUCCESS when the function is completed.

Definition at line 1639 of file res.c.

References gui_constraints_disable_heel_and_toe_goals_tab_widgets(), gui_constraints_disable_thermal_tab_widgets(), UPPER_LEFT, and widget.

Referenced by on_footprint_type_entry_changed().

Here is the call graph for this function:

int res_write_footprint (  )