KiCad PCB EDA Suite
excellon_image.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2011-2016 Jean-Pierre Charras jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef EXCELLON_IMAGE_H
26 #define EXCELLON_IMAGE_H
27 
28 
32  DRILL_M_TOOL_DOWN, // tool down (starting a routed hole)
33  DRILL_M_TOOL_UP, // tool up (ending a routed hole)
58  DRILL_M_END_LIST // not used: sentinel
59 };
60 
61 
63  DRILL_G_UNKNOWN = DRILL_M_END_LIST+1, // Use next available value
74 };
75 
76 // Helper struct to analyze Excellon commands
78 {
79  std::string m_Name; // key string
80  int m_Code; // internal code, used as id in functions
81  int m_asParams; // 0 = no param, -1 = skip params, 1 = read params
82 };
83 
84 // Helper struct to store Excellon points in routing mode
85 #define ROUTE_CCW 1
86 #define ROUTE_CW -1
87 
89 {
90  int m_x; // X coordinate
91  int m_y; // y coordinate
92  int m_cx; // center X coordinate in circular routing mode
93  // (when the IJ command is used)
94  int m_cy; // center y coordinate in circular routing mode
95  // (when the IJ command is used)
96  int m_radius; // radius in circular routing mode (when the A## command is used)
97  int m_rmode; // routing mode: 0 = circular, ROUTE_CCW (1) = ccw, ROUTE_CW (-1) = cw
98  int m_arc_type_info; // arc using radius or center coordinates
99 
101  m_x( 0 ), m_y( 0 ), m_cx( 0 ), m_cy( 0 ), m_radius( 0 ),
102  m_rmode( 0 ), m_arc_type_info( 0 )
103  {}
104 
105  EXCELLON_ROUTE_COORD( const wxPoint& aPos ):
106  m_x( aPos.x ), m_y( aPos.y ),
107  m_cx( 0 ), m_cy( 0 ), m_radius( 0 ), m_rmode( 0 ),
109  {}
110 
111  EXCELLON_ROUTE_COORD( const wxPoint& aPos, const wxPoint& aCenter, int aMode ):
112  m_x( aPos.x ), m_y( aPos.y ),
113  m_cx( aCenter.x ), m_cy( aCenter.y ), m_radius( 0 ), m_rmode( aMode ),
115  {}
116 
117  EXCELLON_ROUTE_COORD( const wxPoint& aPos, int aRadius, int aMode ):
118  m_x( aPos.x ), m_y( aPos.y ),
119  m_cx( 0 ), m_cy( 0 ), m_radius( aRadius ), m_rmode( aMode ),
121  {}
122 
123  wxPoint GetPos() { return wxPoint( m_x, m_y ); }
124 };
125 
133 {
134 public: EXCELLON_IMAGE( int layer ) :
135  GERBER_FILE_IMAGE( layer )
136  {
138  m_SlotOn = false;
139  m_RouteModeOn = false;
140  }
141 
142 
144 
145  virtual void ResetDefaultValues() override
146  {
148  SelectUnits( false );
149  }
150 
151 
160  bool LoadFile( const wxString& aFullFileName );
161 
162 private:
163  bool Execute_HEADER_And_M_Command( char*& text );
164  bool Select_Tool( char*& text );
165  bool Execute_EXCELLON_G_Command( char*& text );
166  bool Execute_Drill_Command( char*& text );
167 
172  bool readToolInformation( char*& aText );
173 
174  int TCodeNumber( char*& aText )
175  {
176  return DCodeNumber( aText );
177  }
178 
182  void FinishRouteCommand();
183 
184  void SelectUnits( bool aMetric );
185 
186 private:
188  READ_HEADER_STATE, // When we are in this state, we are reading header
189  READ_PROGRAM_STATE // When we are in this state, we are reading drill data
190  };
191 
192  excellon_state m_State; // state of excellon file analysis
193  bool m_SlotOn; // true during an oblong drill definition
194  // by G85 (canned slot) command
195  bool m_RouteModeOn; // true during a route mode (for instance a oval hole) or
196  // a cutout.
197  std::vector<EXCELLON_ROUTE_COORD> m_RoutePositions; // The list of points in a route mode
198 };
199 
200 
201 /*
202  * EXCELLON commands are given here.
203  * Pcbnew uses only few excellon commands
204  */
205 
206 /*
207  * see http://www.excellon.com/manuals/program.htm
208  */
209 
210 /* coordinates units:
211  * Coordinates are measured either in inch or metric (millimeters).
212  * Inch coordinates are in six digits (00.0000) with increments as small as 0.0001 (1/10,000).
213  * Metric coordinates can be measured in microns (thousandths of a millimeter)
214  * in one of the following three ways:
215  * Five digit 10 micron resolution (000.00)
216  * Six digit 10 micron resolution (0000.00)
217  * Six digit micron resolution (000.000)
218  *
219  * Leading and trailing zeros:
220  * Excellon (CNC-7) uses inches in six digits and metric in five or six digits.
221  * The zeros to the left of the coordinate are called leading zeros (LZ).
222  * The zeros to right of the coordinate are called trailing zeros (TZ).
223  * The CNC-7 uses leading zeros unless you specify otherwise through a part program.
224  * You can do so with the INCH/METRIC command.
225  * With leading zeros, the leading zeros must always be included.
226  * Trailing zeros are unneeded and may be left off.
227  * For trailing zeros, the reverse of the above is true.
228  */
229 
230 /*
231  * EXCELLON Commands Used in a Header
232  * The following table provides you with a list of commands which
233  * are the most used in a part program header.
234  * COMMAND DESCRIPTION
235  * AFS Automatic Feeds and Speeds
236  * ATC Automatic Tool Change
237  * BLKD Delete all Blocks starting with a slash (/)
238  * CCW Clockwise or Counter-clockwise Routing
239  * CP Cutter Compensation
240  * DETECT Broken Tool Detection
241  * DN Down Limit Set
242  * DTMDIST Maximum Rout Distance Before Toolchange
243  * EXDA Extended Drill Area
244  * FMAT Format 1 or 2
245  * FSB Turns the Feed/Speed Buttons off
246  * HPCK Home Pulse Check
247  * ICI Incremental Input of Part Program Coordinates
248  * INCH Measure Everything in Inches
249  * METRIC Measure Everything in Metric
250  * M48 Beginning of Part Program Header
251  * M95 End of Header
252  * NCSL NC Slope Enable/Disable
253  * OM48 Override Part Program Header
254  * OSTOP Optional Stop Switch
255  * OTCLMP Override Table Clamp
256  * PCKPARAM Set up pecking tool,depth,infeed and retract parameters
257  * PF Floating Pressure Foot Switch
258  * PPR Programmable Plunge Rate Enable
259  * PVS Pre-vacuum Shut-off Switch
260  * R,C Reset Clocks
261  * R,CP Reset Program Clocks
262  * R,CR Reset Run Clocks
263  * R,D Reset All Cutter Distances
264  * R,H Reset All Hit Counters
265  * R,T Reset Tool Data
266  * SBK Single Block Mode Switch
267  * SG Spindle Group Mode
268  * SIXM Input From External Source
269  * T Tool Information
270  * TCST Tool Change Stop
271  * UP Upper Limit Set
272  * VER Selection of X and Y Axis Version
273  * Z Zero Set
274  * ZA Auxiliary Zero
275  * ZC Zero Correction
276  * ZS Zero Preset
277  * Z+# or Z-# Set Depth Offset
278  * % Rewind Stop
279  * #/#/# Link Tool for Automatic Tool Change
280  * / Clear Tool Linking
281  */
282 
283 /*
284  * Beyond The Header: The Part Program Body
285  * COMMAND DESCRIPTION
286  * A# Arc Radius
287  * B# Retract Rate
288  * C# Tool Diameter
289  * F# Table Feed Rate;Z Axis Infeed Rate
290  * G00X#Y# Route Mode; XY is the starting point
291  * G01X#Y# Linear (Straight Line) Route Mode YX is the ending point
292  * G02X#Y#... Circular CW Mode. Radius value (A#) or Center position (I#J#) follows
293  * G03X#Y#... Circular CCW Mode. Radius value (A#) or Center position (I#J#) follows
294  * G04X# Variable Dwell
295  * G05 Drill Mode
296  * G07 Override current tool feed or speed
297  * G32X#Y#A# Routed Circle Canned Cycle
298  * CW G33X#Y#A# Routed Circle Canned Cycle
299  * CCW G34,#(,#) Select Vision Tool
300  * G35(X#Y#) Single Point Vision Offset (Relative to Work Zero)
301  * G36(X#Y#) Multipoint Vision Translation (Relative to Work Zero)
302  * G37 Cancel Vision Translation or Offset (From G35 or G36)
303  * G38(X#Y#) Vision Corrected Single Hole Drilling (Relative to Work Zero)
304  * G39(X#Y#) Vision System Autocalibration
305  * G40 Cutter Compensation Off
306  * G41 Cutter Compensation Left
307  * G42 Cutter Compensation Right
308  * G45(X#Y#) Single Point Vision Offset (Relative to G35 or G36)
309  * G46(X#Y#) Multipoint Vision Translation (Relative to G35 or G36)
310  * G47 Cancel Vision Translation or Offset (From G45 or G46)
311  * G48(X#Y#) Vision Corrected Single Hole Drilling (Relative to G35 or G36)
312  * G82(G81) Dual In Line Package
313  * G83 Eight Pin L Pack
314  * G84 Circle
315  * G85 Slot
316  * G87 Routed Step Slot Canned Cycle
317  * G90 Absolute Mode
318  * G91 Incremental Input Mode
319  * G93X#Y# Zero Set
320  * H# Maximum hit count
321  * I#J# Arc Center Offset
322  * M00(X#Y#) End of Program - No Rewind
323  * M01 End of Pattern
324  * M02X#Y# Repeat Pattern Offset
325  * M06(X#Y#) Optional Stop
326  * M08 End of Step and Repeat
327  * M09(X#Y#) Stop for Inspection
328  * M14 Z Axis Route Position With Depth Controlled Contouring
329  * M15 Z Axis Route Position
330  * M16 Retract With Clamping
331  * M17 Retract Without Clamping
332  * M18 Command tool tip check
333  * M25 Beginning of Pattern
334  * M30(X#Y#) End of Program Rewind
335  * M45,long message\ Long Operator message on multiple\ part program lines
336  * M47,text Operator Message
337  * M50,# Vision Step and Repeat Pattern Start
338  * M51,# Vision Step and Repeat Rewind
339  * M52(#) Vision Step and Repeat Offset Counter Control
340  * M02XYM70 Swap Axes
341  * M60 Reference Scaling enable
342  * M61 Reference Scaling disable
343  * M62 Turn on peck drilling
344  * M63 Turn off peck drilling
345  * M71 Metric Measuring Mode
346  * M72 Inch Measuring Mode
347  * M02XYM80 Mirror Image X Axis
348  * M02XYM90 Mirror Image Y Axis
349  * M97,text Canned Text
350  * M98,text Canned Text
351  * M99,subprogram User Defined Stored Pattern
352  * P#X#(Y#) Repeat Stored Pattern
353  * R#M02X#Y# Repeat Pattern (S&R)
354  * R#(X#Y#) Repeat Hole
355  * S# Spindle RPM
356  * T# Tool Selection; Cutter Index
357  * Z+# or Z-# Depth Offset
358  * % Beginning of Pattern (see M25 command)
359  * / Block Delete
360  */
361 
362 /*
363  * Example of a Header
364  * COMMAND PURPOSE
365  * M48 The beginning of a header
366  * INCH,LZ Use the inch measuring system with leading zeros
367  * VER,1 Use Version 1 X and Y axis layout
368  * FMAT,2 Use Format 2 commands
369  * 1/2/3 Link tools 1, 2, and 3
370  * T1C.04F200S65 Set Tool 1 for 0.040" with infeed rate of 200 inch/min Speed of 65,000 RPM
371  * DETECT,ON Detect broken tools
372  * M95 End of the header
373  */
374 
375 #endif // EXCELLON_IMAGE_H
EXCELLON_ROUTE_COORD(const wxPoint &aPos, const wxPoint &aCenter, int aMode)
virtual void ResetDefaultValues() override
Hold the image data and parameters for one gerber file and layer parameters.
bool Select_Tool(char *&text)
bool LoadFile(const wxString &aFullFileName)
Read and load a drill (EXCELLON format) file.
bool Execute_HEADER_And_M_Command(char *&text)
EXCELLON_ROUTE_COORD(const wxPoint &aPos, int aRadius, int aMode)
int DCodeNumber(char *&Text)
Definition: rs274d.cpp:428
bool Execute_Drill_Command(char *&text)
std::string m_Name
EXCELLON_IMAGE(int layer)
excellon_state m_State
int TCodeNumber(char *&aText)
EXCELLON_ROUTE_COORD(const wxPoint &aPos)
bool readToolInformation(char *&aText)
Read a tool definition like T1C0.02 or T1F00S00C0.02 or T1C0.02F00S00 and enter params in TCODE list.
Handle a drill image.
drill_M_code_t
void FinishRouteCommand()
End a route command started by M15 ot G01, G02 or G03 command.
std::vector< EXCELLON_ROUTE_COORD > m_RoutePositions
bool Execute_EXCELLON_G_Command(char *&text)
void SelectUnits(bool aMetric)
drill_G_code_t
virtual void ResetDefaultValues()