EMC2 User Manual
EMC2 User Manual
This handbook is a work in progress. If you are able to help with writing, editing, or graphic
preparation please contact any member of the writing team or join and send an email to emc-
[email protected].
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU Free Documentation License, Version 1.1 or any later version published by the Free Software
Foundation; with no Invariant Sections, no Front-Cover Texts, and one Back-Cover Text: "This EMC
Handbook is the product of several authors writing for linuxCNC.org. As you find it to be of value in
your work, we invite you to contribute to its revision and growth." A copy of the license is included
in the section entitled "GNU Free Documentation License". If you do not find the license you may
order a copy from Free Software Foundation, Inc. 59 Temple Place, Suite 330 Boston, MA 02111-13
Contents
Cover i
Contents 1
1 EMC2 3
1.1 This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 How EMC2 Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3 Graphical User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.4 Thinking Like a Machine Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.5 Modes of Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Forword 3
2 Important Concepts 7
2.1 Trajectory Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1.1 Trajectory Planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1.2 Path Following . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1.3 Programming the Planner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.1.4 Planning Moves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
I Interfaces 9
3 AXIS 10
3.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.2.1 A typical session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.3 Axis Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.3.1 Menu Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.3.1.1 File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.3.1.2 Open... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.3.1.3 Edit... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.3.1.4 Reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
ii
CONTENTS iii
3.7 axis-remote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.8 Manual Tool Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.9 Python modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.10 Lathe Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.11 Advanced Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.11.1 Program Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.11.2 The X Resource Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.11.3 Physical jog wheels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.11.4 axisrc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.11.5 External Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.11.6 Virtual Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.11.7 Special Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4 TkEMC 28
4.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
4.2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
4.2.1 A typical session with TkEMC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
4.3 Elements of the TkEMC window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
4.3.1 Main buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4.3.2 Offset display status bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4.3.3 Coordinate Display Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4.3.3.1 Backplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4.3.4 Automatic control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.3.4.1 Buttons for control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.3.4.2 Text Program Display Area . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.3.5 Manual Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.3.5.1 Implicit keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.3.5.2 The “Spindle” group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.3.5.3 The “Coolant” group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.3.6 Code Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.3.6.1 MDI: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.3.6.2 Active G-Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.3.7 Jog Speed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.3.8 Feed Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.3.9 Spindle speed Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.4 Keyboard Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CONTENTS vi
5 MINI 34
5.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
5.2 Screen layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
5.3 Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
5.4 Control Button Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
5.4.1 MANUAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
5.4.2 AUTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.4.3 MDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.4.4 [FEEDHOLD] – [CONTINUE] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
5.4.5 [ABORT] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
5.4.6 [ESTOP] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
5.5 Left Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
5.5.1 Axis Position Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
5.5.2 Feed rate Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
5.5.3 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
5.6 Right Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
5.6.1 Program Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
5.6.2 Backplot Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
5.6.3 Tool Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
5.6.4 Offset Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
5.7 Keyboard Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
5.7.1 Common Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
5.7.2 Manual Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
5.7.3 Auto Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
5.8 Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6 KEYSTICK 48
6.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.2 Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.3 Using . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
II Using EMC2 50
7.1.2 Spindle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.1.3 Coolant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.1.4 Pallet Shuttle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.1.5 Tool Carousel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.1.6 Tool Changer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.1.7 Message Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.1.8 Feed and Speed Override Switches . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.1.9 Block Delete Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.1.10 Optional Program Stop Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.2 Control and Data Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.2.1 Linear Axes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.2.2 Rotational Axes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.2.3 Controlled Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.2.4 Coordinated Linear Motion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.2.5 Feed Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.2.6 Coolant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.2.7 Dwell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.2.8 Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.2.9 Current Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.2.10 Selected Plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.2.11 Tool Carousel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.2.12 Tool Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.2.13 Pallet Shuttle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.2.14 Feed and Speed Override Switches . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.2.15 Path Control Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.3 Interpreter Interaction with Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.3.1 Feed and Speed Override Switches . . . . . . . . . . . . . . . . . . . . . . . . . . 56
7.3.2 Block Delete Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
7.3.3 Optional Program Stop Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
7.4 Tool File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
7.4.1 Mill Format Tool Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
7.4.2 Lathe Format Tool Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
7.5 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
7.6 Coordinate Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
CONTENTS viii
8 Language Overview 60
8.1 Format of a line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
8.2 Line Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
8.3 Word . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
8.3.1 Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
8.3.2 Numbered Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
8.3.3 Named Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
8.3.4 Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
8.3.5 Binary Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
8.3.6 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
8.4 Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
8.5 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
8.6 Probe Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
8.7 Debugging Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
8.8 Parameters in special comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
8.9 Repeated Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
8.10 Item order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
8.11 Commands and Machine Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
8.12 Modal Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
9 Order of Execution 68
11 G Codes 71
11.1 Quick Reference Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
11.2 G0 Rapid Linear Motion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.3 G1 Linear Motion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.4 G2, G3 Arc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
11.4.1 Center format arcs (preferred format) . . . . . . . . . . . . . . . . . . . . . . . . 73
11.4.2 Radius format arcs (discouraged format) . . . . . . . . . . . . . . . . . . . . . . . 74
11.5 G4 Dwell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
11.6 G10 Set Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
CONTENTS ix
12 M Codes 90
12.1 M0, M1, M2, M30, M60 Program Stopping and Ending . . . . . . . . . . . . . . . . . . 90
12.2 M3, M4, M5 Spindle Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
12.3 M6 Tool Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
12.3.1 Manual Tool Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
12.3.2 Tool Changer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
12.4 M7, M8, M9 Coolant Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
12.5 M48, M49 Override Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.6 M50 Feed Override Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.7 M51 Spindle Speed Override Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.8 M52 Adaptive Feed Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.9 M53 Feed Stop Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.10 M62 to M65 Output Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.11 M66 Input Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
12.12 M100 to M199 User Defined Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
13 O Codes 95
13.1 Subroutines: sub, endsub, return, call . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
13.2 Looping: do, while, endwhile, break, continue . . . . . . . . . . . . . . . . . . . . . . . . 96
13.3 Conditional: if, else, endif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
13.4 Indirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
13.5 Computing values in O-words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
14 Other Codes 97
14.1 F: Set Feed Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
14.2 S: Set Spindle Speed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
14.3 T: Select Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
IV Appendices 122
A Glossary 123
C Index 131
Foreword
EMC2 is modular and flexible. These attributes lead many to see it as a confusing jumble of little
things and wonder why it is the way it is. This page attempts to answer that question before you
get into the thick of things.
EMC started at the National Institute of Standards and Technology in the USA. It grew up
using Unix as it’s operating system. Unix made it different. Among early Unix developers
there grew a set of code writing ideas that some call the Unix way. These early EMC
authors followed those ways.
Eric S. Raymond, in his book The Art of Unix Programming, summarizes the Unix philos-
ophy as the widely-used engineering philosophy, "Keep it Simple, Stupid" (KISS Principle).
He then describes how he believes this overall philosophy is applied as a cultural Unix
norm, although unsurprisingly it is not difficult to find severe violations of most of the
following in actual Unix practice:
* Rule of Modularity: Write simple parts connected by clean interfaces.
* Rule of Clarity: Clarity is better than cleverness.
* Rule of Composition: Design programs to be connected to other programs.
* Rule of Separation: Separate policy from mechanism; separate interfaces from engines.1
Mr Raymond offered several more rules but these four describe essential characteristics of the EMC2
motion control system.
The Modularity rule is critical. Throughout these handbooks you will find talk of the interpreter or
task planner or motion or HAL. Each of these is a module or collection of modules. It’s modularity
that allows you to connect together just the parts you need to run your machine.
The Clarity rule is essential. EMC2 is a work in progress – it is not finished nor will it ever be. It is
complete enough to run most of the machines we want it to run. Much of that progress is achieved
because many users and code developers are able to look at the work of others and build on what
they have done.
The Composition rule allows us to build a predictable control system from the many modules
available by making them connectable. We achieve connectability by setting up standard interfaces
to sets of modules and following those standards.
The Separation rule requires that we make distinct parts that do little things. By separating func-
tions debugging is much easier and replacement modules can be dropped into the system and
comparisons easily made.
What does the Unix way mean for you as a user of EMC2. It means that you are able to make choices
about how you will use the system. Many of these choices are a part of machine integration, but
many also affect the way you will use your machine. As you read you will find many places where
you will need to make comparisons. Eventually you will make choices, "I’ll use this interface rather
than that” or, “I’ll write part offsets this way rather than that way." Throughout these handbooks
we describe the range of abilities currently available.
As you begin your journey into using EMC2 we offer two cautionary notes:2
1 Found at http://en.wikipedia.org/wiki/Unix_philosophy, 07/06/2008
2 Found at http://en.wikipedia.org/wiki/Unix_philosophy, 07/06/2008
1
CONTENTS 2
• "UNIX was not designed to stop its users from doing stupid things, as that would also stop
them from doing clever things." Doug Gwyn
• "Unix is user-friendly. It just isn’t promiscuous about which users it’s friendly with." Steven
King
Chapter 1
EMC2
The focus of this manual is on using EMC. It is intended to be used once EMC is installed and
configured. For standard installations see the Getting Started Guide for step by step instructions
to get you up and going. For detailed information on installation and configuration of EMC see the
Integrator Manual.
The Enhanced Machine Controller (EMC2) is a lot more than just another CNC mill program. It
can control machine tools, robots, or other automated devices. It can control servo motors, stepper
motors, relays, and other devices related to machine tools.
There are four main components to the EMC2 software: a motion controller, a discrete I/O con-
troller, a task executor which coordinates them, and user interfaces. In addition there is a layer
called HAL (Hardware Abstraction Layer) which allows configuration of EMC2 without the need of
recompiling.
Figure 1.1 shows a simple block diagram showing what a typical 3-axis EMC2 system might look
like. This diagram shows a stepper motor system. The PC, running Linux as its operating system,
is actually controlling the stepper motor drives by sending signals through the printer port. These
signals (pulses) make the stepper drives move the stepper motors. The EMC2 can also run servo
motors via servo interface cards or by using an extended parallel port to connect with external
control boards. As we examine each of the components that make up an EMC2 system we will
remind the reader of this typical machine.
3
CHAPTER 1. EMC2 4
A graphical interface is the part of the EMC2 that the machine tool operator interacts with. The
EMC2 comes with several types of user interfaces:
• Axis an OpenGL-based GUI, with an interactive G-Code previewer. This is the only interface
that is currently being developed and improved on.
CHAPTER 1. EMC2 5
As you begin to work with the EMC2 program, you will need to place yourself in the position of
operator. You need to think of yourself in the role of the one in charge of a machine. It is a machine
that is either waiting for your command or executing the command that you have just given it.
Throughout these pages we will give information that will help you become a good operator of the
EMC2 mill. You will need some information right up front here so that the following pages will make
sense to you.
When an EMC2 is running, there are three different major modes used for inputting commands.
These are Manual, Auto, and MDI. Changing from one mode to another makes a big difference in
the way that the EMC2 behaves. There are specific things that can be done in one mode that can
not be done in another. An operator can home an axis in manual mode but not in auto or MDI
modes. An operator can cause the machine to execute a whole file full of G-codes in the auto mode
but not in manual or MDI.
In manual mode, each command is entered separately. In human terms a manual command might
be “turn on coolant” or “jog X at 25 inches per minute.” These are roughly equivalent to flipping a
switch or turning the hand wheel for an axis. These commands are normally handled on one of the
graphical interfaces by pressing a button with the mouse or holding down a key on the keyboard.
In auto mode, a similar button or key press might be used to load or start the running of a whole
program of G-code that is stored in a file. In the MDI mode the operator might type in a block of
code and tell the machine to execute it by pressing the <return> or <enter> key on the keyboard.
Some motion control commands are available and will cause the same changes in motion in all
modes. These include ABOR T, ESTOP, and FEED RATE OVERRIDE. Commands like these should be
self explanatory.
The AXIS user interface removes some of the distinctions between Auto and the other modes by
making Auto-commands available at most times. It also blurs the distinction between Manual and
MDI because some Manual commands like Touch Off are actually implemented by sending MDI
commands.
Chapter 2
Important Concepts
This chapter covers important concepts that should be understood before attempting to run a g
code file.
Trajectory planning, in general, is the means by which EMC follows the path specified by your G
Code program, while still operating within the limits of your machinery.
A G Code program can never be fully obeyed. For example imagine you specify as a single-line
program the following move:
In reality, the whole move can’t be made at F10, since the machine must accelerate from a stop,
move toward X=1, and then decelerate to stop again. Sometimes part of the move is done at F10,
but for many moves, especially short ones, the specified feed rate is never reached at all.
The basic acceleration and deceleration described above is not complex and there is no compromise
to be made. In the INI file the specified machine constraints such as maximum axis velocity and
axis acceleration must be obeyed by the trajectory planner.
A less straightforward problem is that of path following. When you program a corner in G Code, the
trajectory planner can do several things, all of which are right in some cases: it can decelerate to a
stop exactly at the coordinates of the corner, and then accelerate in the new direction. It can also do
what is called blending, which is to keep the feed rate up while going through the corner, making it
necessary to round the corner off in order to obey machine constraints. You can see that there is a
tradeoff here: you can slow down to get better path following, or keep the speed up and have worse
path following. Depending on the particular cut, the material, the tooling, etc., the programmer
may want to compromise differently.
7
CHAPTER 2. IMPORTANT CONCEPTS 8
G61 (exact stop mode) G61 tells the planner to come to an exact stop at every segment’s end. This
ensures exact path following but the full stops can be harmful to the workpiece or the tooling,
depending on the particular cut.
G64 (blend without tolerance mode) G64 is just blending and the naive cam detector is not enabled.
G64 and G64P0 tell the planner to sacrifice path following accuracy in order to keep the feed
rate up. This is necessary for some types of material or tooling where exact stops are harmful,
and can work great as long as the programmer is careful to keep in mind that the tool’s path
will be somewhat more curvy than the program specifies.
G64 Px.xxx (blend tolerance mode) This enables the "naive cam detector" and enables blending
with a tolerance. If you are in inch mode and program G64 P0.05, you tell the planner that
you want continuous feed, but at programmed corners you want it to slow down enough so
that the tool path can stay within 0.05 inches of the programmed path. The exact amount of
slowdown depends on the geometry of the programmed corner and the machine constraints,
but the only thing the programmer needs to worry about is the tolerance. This gives the
programmer complete control over the path following compromise. The blend tolerance can be
changed throughout the program as necessary. Beware that a specification of G64 P0 has the
same effect as G64 alone (above), which is necessary for backward compatibility for old G Code
programs.
Blending without tolerance The controlled point will touch each specified movement at at least
one point. The machine will never move at such a speed that it cannot come to an exact stop
at the end of the current movement (or next movement, if you pause when blending has already
started). The distance from the end point of the move is as large as it needs to be to keep up
the best contouring feed.
Naive Cam Detector Successive G1 moves that involve only the XYZ axes that deviate less than
P- from a straight line are merged into a single straight line. This merged movement replaces
the individual G1 movements for the purposes of blending with tolerance. Between successive
movements, the controlled point will pass no more than P- from the actual endpoints of the
movements. The controlled point will touch at least one point on each movement. The machine
will never move at such a speed that it cannot come to an exact stop at the end of the current
movement (or next movement, if you pause when blending has already started)
Make sure moves are "long enough" to suit your machine/material. Principally because of the rule
that "the machine will never move at such a speed that it cannot come to a complete stop at the
end of the current movement", there is a minimum movement length that will allow the machine to
keep up a requested feed rate with a given acceleration setting.
The acceleration and deceleration phase each use half the inifile MAX_ACCELERATION. In a blend
that is an exact reversal, this causes the total axis acceleration to equal the inifile MAX_ACCELERATION.
In other cases, the actual machine acceleration is somewhat less than the inifile acceleration
To keep up feed rate, the move must be longer than the distance it takes to accelerate from 0 to the
desired feed rate and then stop again. Using A as 1/2 the inifile MAX_ACCELERATION and F as the
feed rate *in units per second*, the acceleration time is ta = F/A and the acceleration distance is da
= (1/2) * F * ta the deceleration time and distance are the same, making the critical distance d = da
+ dd = 2*da = F^2 / A.
For example, for a feed rate of 1 inch per second and an acceleration of 10 inch/sec^2, the critical
distance is 1^2 / 10 = .1 inch. For a feed rate of .5 inch per second, the critical distance is .5^2 /
10 = .025 inch.
Part I
Interfaces
9
Chapter 3
AXIS
3.1 Introduction
AXIS is a graphical front-end for EMC2 which features a live preview and backplot. It is written in
Python and uses Tk and OpenGL to display its user interface.
To select AXIS as the front-end for EMC2, edit the .ini file. In the section [DISPLAY] change the
DISPLAY line to read
DISPLAY = axis
Then, start EMC2 and select that ini file. The sample configuration sim/axis.ini is already con-
figured to use AXIS as its front-end.
When you start AXIS, a window like the one in Figure 3.1 is shown.
9. To mill the same file again, return to step 6. To mill a different file, return to step 4. When
you’re done, exit AXIS.
10
CHAPTER 3. AXIS 11
• A display area that shows a preview of the loaded file (in this case, “axis.ngc”), as well as the
current location of the CNC machine’s “controlled point”. Later, this area will display the path
the CNC machine has moved through, called the “backplot”
• A text display area that shows the G-code source of the loaded file.
• A status bar which shows the state of the machine. In this screenshot, the machine is turned
on, does not have a tool inserted, and the displayed position is “Relative” to the machine offset
(as opposed to “Absolute”), and the “Actual” (as opposed to “Commanded” position)
Some menu items might be greyed out depending on how you have your .ini file configured. For
more information on configuration see the Integrators Manual.
3.3.1.1 File
3.3.1.2 Open...
Opens a standard dialog box to open a g code file to load in AXIS. If you have configured EMC to
use a filter program you can also open it up. See the Integrators manual for more information on
filter programs.
3.3.1.3 Edit...
Edit will open the current g code file for editing if you have an editor configured in your ini file. See
the Integrators Manual for more information on specifying an editor to use.
3.3.1.4 Reload
Reload will reload the current g code file. If you edited it you must reload it for the changes to take
affect. If you stop a file and want to start from the beginning then reload the file. The toolbar reload
is the same as the menu.
3.3.1.6 Properties
Same as Edit if you have defined an editor you can open the tool table and edit it.
If you have loaded Classic Ladder you can edit it from here. See the Integrators Manual on setting
up Classic Ladder
CHAPTER 3. AXIS 13
3.3.1.10 Quit
3.3.1.11 Machine
This is used to start a program from a line. Select the line you want to start from then select Set
next line from the menu and then Run from the tool bar. Use with caution as this will move the tool
to the expected position before the line first then it will execute the rest of the code.
3.3.1.17 Step
3.3.1.18 Pause
Pause a program.
3.3.1.19 Resume
3.3.1.20 Stop
3.3.1.21 Stop at M1
If you have a M1 in your g code and this is checked program execution will stop on the M1 line.
Press Resume to continue.
If a line begins with / and this is checked it will skip that line.
3.3.1.26 Calibration
This is a servo testing pop up widow for each axis. After making changes and testing them it can
save them to your .ini file.
3.3.1.32 Homing
3.3.1.34 View
3.3.1.41 Display MM
3.3.1.55 Help
3. Open a file
9. Zoom In
In the upper-left corner of the program display is the coordinate display. It shows the position of the
machine. To the left of the axis name, an origin symbol ( ) is shown if the axis has been properly
homed. To the right of the axis name, a limit symbol ( ) is shown if the axis is on one of its limit
switches.
To properly interpret these numbers, refer to the “Position:” indicator in the status bar. If the posi-
tion is “Absolute”, then the displayed number is in the machine coordinate system. If it is “Relative”,
then the displayed number is in the offset coordinate system. When the coordinates displayed are
relative, the display will include a cyan “machine origin” marker ( ). If the position is “Commanded”,
then it is the ideal position–for instance, the exact coordinate given in a G0 command. If it is “Ac-
tual”, then it is the position the machine has actually been moved to. These values can differ for
several reasons: Following error, deadband, encoder resolution, or step size. For instance, if you
command a movement to X 0.0033 on your mill, but one step of your stepper motor is 0.00125,
then the “Commanded” position will be 0.0033 but the “Actual” position will be 0.0025 (2 steps) or
0.00375 (3 steps).
When a file is loaded, a preview of it is shown in the display area. Fast moves (such as those
produced by the G0 command) are shown as dotted green lines. Moves at a feed rate (such as those
produced by the G1 command) are shown as solid white lines. Dwells (such as those produced by
the G4 command) are shown as small “X” marks.
The “extents” of the program in each axis are shown. At each end, the least or greatest coordinate
value is indicated. In the middle, the difference between the coordinates is shown. In Figure (3.1),
the X extent of the file is from 0.00 to 6.92 inches, a total of 6.92 inches.
When some coordinates exceed the “soft limits” in the .ini file, the relevant dimension is shown in a
different color and enclosed by a box. In Figure (3.2) the maximum soft limit is exceeded on the X
axis as indicatated by the box surrounding the coordinate value.
The location of the tip of the tool is indicated by the “tool cone”. The cone does not indicate anything
about the shape, length, or radius of the tool.
When a tool is loaded (for instance, with the MDI command T1M6), the cone changes to a cylinder
which shows the diameter of the tool given in the tool table file.
CHAPTER 3. AXIS 18
3.3.3.5 Backplot
When the machine moves, it leaves a trail called the backplot. The color of the line indicates the
type of motion: Yellow for jogs, faint green for rapid movements, red for straight moves at a feed
rate, and magenta for circular moves at a feed rate.
3.3.3.6 Interacting
By left-clicking on a portion of the preview plot, the line will be highlighted in both the graphical
and text displays. By left-clicking on an empty area, the highlighting will be removed.
By dragging with the left mouse button pressed, the preview plot will be shifted (panned).
By dragging with shift and the left mouse button pressed, or by dragging with the mouse wheel
pressed, the preview plot will be rotated. When a line is highlighted, the center of rotation is the
center of the line. Otherwise, the center of rotation is the center of the file as a whole.
By rotating the mouse wheel, or by dragging with the right mouse button pressed, or by dragging
with control and the left mouse button pressed, the preview plot will be zoomed in or out.
By clicking one of the “Preset View” icons, or by pressing “V”, several preset views may be selected.
By left-clicking a line of the program, the line will be highlighted in both the graphical and text
displays.
When the program is running, the line currently being executed is highlighted in red. If no line has
been selected by the user, the text display will automatically scroll to show the current line.
While the machine is turned on but not running a program, the items in the “Manual Control” tab
can be used to move the machining center or turn different parts of it on and off.
When the machine is not turned on, or when a program is running, the manual controls are un-
available.
Many of the items described below are not useful on all machines. When AXIS detects that a partic-
ular pin is not connected in HAL, the corresponding item in the Manual Control tab is removed. For
instance, if the HAL pin motion.spindle-brake is not connected, then the “Brake” button will not
appear on the screen. If the environment variable AXIS_NO_AUTOCONFIGURE is set, this behavior is
disabled and all the items will appear.
“Axis” allows you to manually move the machine. This action is known as “jogging”. First, select the
axis to be moved by clicking it. Then, click and hold the “+” or “-” button depending on the desired
direction of motion. The first four axes can also be moved by the arrow keys (X and Y), PAGE UP
and PAGE DOWN keys (Z) and the [ and ] keys (A).
If “Continuous” is selected, the motion will continue as long as the button or key is pressed. If
another value is selected, the machine will move exactly the displayed distance each time the button
is clicked or the key is pressed. By default, the available values are:
The .ini file setting [DISPLAY]INCREMENTS can be used to override the default. Its value can contain
decimal numbers (e.g., 0.1000) or fractional numbers (e.g., 1/16), optionally followed by a unit (one
of ’cm’, ’mm’, ’um’, ’inch’, ’in’, or ’mil’). If a unit is not specified the machine’s native unit is assumed.
For users who prefer metric units, a good setting might be
INCREMENTS = 1/4 in, 1/16 in, 1/32 in, 1/64 in, 1 mil, .1 mil
or
If your machine has a homing sequence defined, the “Home All” button or the Ctrl-HOME key
will send all axes home. Otherwise, the button will read “Home”, and will send the current axis
home. Pressing the HOME key sends the current axis home, even if a homing sequence is defined.
Depending on your configuration, homing may just set the axis value to be the absolute position
0.0, or it may make the machine move to a specific home location through use of “home switches”.
See Homing section of the Integrators Manual for more information on homing.
By pressing “Touch Off” or the END key, the “G54 offset” for the current axis is changed so that
the current axis value will be the specified value. Expressions may be entered using the rules for
rs274ngc programs, except that variables may not be referred to. The resulting value is shown as a
number.
By pressing “Override Limits”, the machine will temporarily be allowed to jog off of a physical limit
switch.
The buttons on the first row select the direction for the spindle to rotate: Counterclockwise, Stopped,
Clockwise. The buttons on the next row increase or decrease the rotation speed. The checkbox on
the third row allows the spindle brake to be engaged or released. Depending on your machine
configuration, not all the items in this group may appear.
The two buttons allow the “Mist” and “Flood” coolants to be turned on and off. Depending on your
machine configuration, not all the items in this group may appear.
3.3.6.1 History
This shows MDI commands that have been typed earlier in this session.
This allows you to enter a g-code command to be executed. Execute the command by pressing Enter
or by clicking “Go”.
CHAPTER 3. AXIS 21
This shows the “modal codes” that are active in the interpreter. For instance, “G54” indicates that
the “G54 offset” is applied to all coordinates that are entered.
By moving this slider, the programmed feed rate can be modified. For instance, if a program requests
F60 and the slider is set to 120%, then the resulting feed rate will be 72.
By moving this slider, the programmed spindle feed rate can be modified. For instance, if a program
requests F8000 and the slider is set to 80%, then the resulting spindle speed will be 6400. This
item only appears when the HAL pin motion.spindle-speed-out is connected.
By moving this slider, the speed of jogs can be modified. For instance, if the slider is set to 1 in/min,
then a .01 inch jog will complete in about .6 seconds, or 1/100 of a minute. Near the left side (slow
jogs) the values are spaced closely together, while near the right side (fast jogs) they are spaced
much further apart, allowing a wide range of jog speeds with fine control when it is most important.
On machines with a rotary axis, a second jog speed slider is shown. This slider sets the jog rate for
the rotary axes (A, B and C).
CHAPTER 3. AXIS 22
mdi /path/to/emc.nml
Once it is running, it displays the prompt MDI>. When a blank line is entered, the machine’s current
position is shown. When a command is entered, it is sent to EMC to be executed. A sample session
of MDI is shown in Figure 3.7.
CHAPTER 3. AXIS 23
3.7 axis-remote
AXIS includes a program called “axis-remote” which can send certain commands to a running
AXIS. The available commands are shown by running axis-remote --help and include check-
ing whether AXIS is running (--ping), loading a file by name, reloading the currently loaded file
(--reload), and making AXIS exit (--quit).
EMC2 includes a userspace hal component called “hal_manualtoolchange”, which shows a window
(Figure 3.8) when a M6 command is issued. After the OK button is pressed, execution of the program
will continue.
The HAL configuration file configs/sim/axis_manualtoolchange.hal shows the HAL commands
necessary to use this component.
CHAPTER 3. AXIS 24
hal_manualtoolchange can be used even when AXIS is not used as the GUI. This component is most
useful if you have presettable tools and you use the tool table.
AXIS includes several Python modules which may be useful to others. For more information on one
of these modules, use “pydoc <module name>” or read the source code. These modules include:
• emc provides access to the EMC command, status, and error channels
To use these modules in your own scripts, you must ensure that the directory where they reside
is on Python’s module path. When running an installed version of EMC2, this should happen
automatically. When running “in-place”, this can be done by using scripts/emc-environment.
LATHE = 1
in the [DISPLAY] section of the ini file, AXIS selects lathe mode. The “Y” axis is not shown in
coordinate readouts, the view is changed to show the Z axis extending to the right and the X axis
extending towards the bottom of the screen, and several controls (such as those for preset views)
are removed.
Pressing “V” zooms out to show the entire file, if one is loaded.
When in lathe mode, the shape of the loaded tool (if any) is shown.
CHAPTER 3. AXIS 25
AXIS has the ability to send loaded files through a “filter program”. This filter can do any desired
task: Something as simple as making sure the file ends with ’M2’, or something as complicated as
detecting whether the input is a depth image, and generating g-code to mill the shape it defines.
The [FILTER] section of the ini file controls how filters work. First, for each type of file, write a
PROGRAM_EXTENSION line. Then, specify the program to execute for each type of file. This program
is given the name of the input file as its first argument, and must write rs274ngc code to standard
output. This output is what will be displayed in the text area, previewed in the display area, and
executed by EMC when “Run”. The following lines add support for the “image-to-gcode” converter
included with EMC2:
[FILTER]
PROGRAM_EXTENSION = .png,.gif Greyscale Depth Image
png = image-to-gcode
gif = image-to-gcode
In this way, any Python script can be opened, and its output is treated as g-code. One such example
script is available at nc_files/holecircle.py. This script creates g-code for drilling a series of
holes along the circumference of a circle.
If the environment variable AXIS_PROGRESS_BAR is set, then lines written to stderr of the form
CHAPTER 3. AXIS 26
FILTER_PROGRESS=%d
will set the AXIS progress bar to the given percentage. This feature should be used by any filter that
runs for a long time.
The colors of most elements of the AXIS user interface can be customized through the X Resource
Database. The sample file axis_light_background changes the colors of the backplot window to a
“dark lines on white background” scheme, and also serves as a reference for the configurable items
in the display area.
For information about the other items which can be configured in Tk applications, see the Tk
manpages.
Because modern desktop environments automatically make some settings in the X Resource Database
that adversely affect AXIS, by default these settings are ignored. To make the X Resource Database
items override AXIS defaults, include the following line in your X Resources:
*Axis*optionLevel: widgetDefault
this causes the built-in options to be created at the option level “widgetDefault”, so that X Resources
(which are level “userDefault”) can override them.
CHAPTER 3. AXIS 27
To improve the interaction of AXIS with physical jog wheels, the axis currently selected in the GUI
is also reported on a pin with a name like axisui.jog.x. Except for a short time when the active
axis has just been changed, exactly one of these pins is TRUE at one time, and the rest are FALSE.
After AXIS has created these HAL pins, it executes the halfile named in [HAL]POSTGUI_HALFILE.
Unlike [HAL]HALFILE, only one such file may be used.
3.11.4 axisrc
If it exists, the contents of ~/.axisrc are executed as Python source code just before the AXIS gui
is displayed. The details of what may be written in the axisrc are subject to change during the
development cycle.
The lines shown in Figure 3.11 add Control-Q as a keyboard shortcut for Quit and turns on “Dis-
tance to go” by default.
The menu options File > Edit... and File > Edit Tool Table... become available after defining the editor
in the ini section [DISPLAY]. Useful values include EDITOR=gedit and EDITOR=gnome-terminal
-e vim. For more information, see the DISPLAY section of the INI Configuration Chapter in the
Integrators Manual.
AXIS can display a custom virtual control panel in the right-hand pane. You can program buttons,
indicators, data displays and more. For more information, see the Integrators Manual.
Special comments can be inserted into the G Code file to control how the preview of AXIS behaves. In
the case where you want to limit the drawing of the preview use these special comments. Anything
between the (AXIS,hide) and (AXIS,show) will not be drawn during the preview. The (AXIS,hide) and
(AXIS,show) must be used in pairs with the (AXIS,hide) being first. Anything after a (AXIS,stop) will
not be drawn during the preview.
TkEMC
4.1 Introduction
TkEMC is one of the most traditional graphical front-ends for EMC. It is written in Tcl and uses
the Tk toolkit for the display. Being written in TCL makes it very portable (runs on a multitude of
platforms). A separate backplot window can be displayed as shown in Figure(4.1).
28
CHAPTER 4. TKEMC 29
DISPLAY = tkemc
Then, start EMC2 and select that ini file. The sample configuration sim/tkemc.ini is already
configured to use TkEMC as its front-end.
When you start EMC2 with TkEMC, a window like the one in Figure 4.1 is shown.
2. Clear the “E-STOP” condition and turn the machine on (by pressing F1 then F2).
3. “Home” each axis.
4. Load the file to be milled.
8. To mill the same file again, return to step 6. To mill a different file, return to step 4. When
you’re done, exit EMC2.
• A text display area that shows the G-code source of the loaded file.
CHAPTER 4. TKEMC 30
The Offset display status bar displays the currently selected tool (selected with Txx M6), the tool
length offset (if active), and the work offsets (set by right clicking the coordinates).
The main part of the display shows the current position of the tool. The colour of the position
readout depends on the state of the axis. If the axis is unhomed the axis will be displayed in yellow
letters. Once homed it will be displayed in green letters. If there is an error with the current axis
TkEMC will use red letter to show that. (for example if an hardware limit switch is tripped).
To properly interpret these numbers, refer to the radio boxes on the right. If the position is “Ma-
chine”, then the displayed number is in the machine coordinate system. If it is “Relative”, then the
displayed number is in the offset coordinate system. Further down the choices can be “actual” or
“commanded”. Actual refers to the feedback coming from encoders (if you have a servo machine),
and the “commanded” refers to the position command send out to the motors. These values can dif-
fer for several reasons: Following error, deadband, encoder resolution, or step size. For instance, if
you command a movement to X 0.0033 on your mill, but one step of your stepper motor is 0.00125,
then the “Commanded” position will be 0.0033 but the “Actual” position will be 0.0025 (2 steps) or
0.00375 (3 steps).
Another set of radio buttons allows you to choose between “joint” and “world” view. These make little
sense on a normal type of machine (e.g. trivial kinematics), but helps on machines with non-trivial
kinematics like robots or stewart platforms. (you can read more about kinematics in the Integrators
Handbook).
4.3.3.1 Backplot
When the machine moves, it leaves a trail called the backplot. You can start the backplot window
by selecting View->Backplot.
CHAPTER 4. TKEMC 31
The buttons in the lower part of TkEMC (seen in Figure 4.2) are used to control the execution of a
program: “Open” to load a program, “Verify” to check it for errors, “Run” to start the actual cutting,
“Pause” to stop it while running, “Resume” to resume an already paused program, “Step” to advance
one line in the program and “Optional Stop” to toggle the optional stop switch (if the button is green
the program execution will be stopped on any M1 encountered).
When the program is running, the line currently being executed is highlighted in white. The text
display will automatically scroll to show the current line.
TkEMC allows you to manually move the machine. This action is known as “jogging”. First, select
the axis to be moved by clicking it. Then, click and hold the “+” or “-” button depending on the
desired direction of motion. The first four axes can also be moved by the arrow keys (X and Y),
PAGE UP and PAGE DOWN keys (Z) and the [ and ] keys (A).
If “Continuous” is selected, the motion will continue as long as the button or key is pressed. If
another value is selected, the machine will move exactly the displayed distance each time the button
is clicked or the key is pressed. The available values are:
By pressing “Home” or the HOME key, the selected axis will be homed. Depending on your configu-
ration, this may just set the axis value to be the absolute position 0.0, or it may make the machine
move to a specific home location through use of home switches. See the Homing section in the
Integrators Manual for more information on homing.
By pressing “Override Limits”, the machine will temporarily be permitted to jog outside the limits
defined in the .ini file. (Note: if “Override Limits” is active the button will be displayed using a red
colour).
CHAPTER 4. TKEMC 32
The buttons on the first row select the direction for the spindle to rotate: Counterclockwise, Stopped,
Clockwise. The buttons on the next row increase or decrease the rotation speed. The checkbox on
the third row allows the spindle brake to be engaged or released. Depending on your machine
configuration, not all the items in this group may appear.
The two buttons allow the “Mist” and “Flood” coolants to be turned on and off. Depending on your
machine configuration, not all the items in this group may appear.
Manual Data Input (also called MDI), allows G-code programs to be entered manually, one line at
a time. When the machine is not turned on, and not set to MDI mode, the code entry controls are
unavailable.
4.3.6.1 MDI:
This allows you to enter a g-code command to be executed. Execute the command by pressing
Enter.
This shows the “modal codes” that are active in the interpreter. For instance, “G54” indicates that
the “G54 offset” is applied to all coordinates that are entered.
CHAPTER 4. TKEMC 33
By moving this slider, the speed of jogs can be modified. The numbers above refer to axis units
/ second. The text box with the number is clickable. Once clicked a popup window will appear,
allowing for a number to be entered.
By moving this slider, the programmed feed rate can be modified. For instance, if a program requests
F60 and the slider is set to 120%, then the resulting feed rate will be 72. The text box with the
number is clickable. Once clicked a popup window will appear, allowing for a number to be entered.
The spindle speed override slider works exactly like the feed override slider, but it controls to the
spindle speed. If a program requested S500 (spindle speed 500 RPM), and the slider is set to 80%,
then the resulting spindle speed will be 400 RPM. This slider has a minimum and maximum value
defined in the ini file. If those are missing the slider is stuck at 100%. The text box with the number
is clickable. Once clicked a popup window will appear, allowing for a number to be entered.
Almost all actions in TkEMC can be accomplished with the keyboard. Many of the shortcuts are
unavailable when in MDI mode.
The most frequently used keyboard shortcuts are shown in Table 4.1.
MINI
5.1 Introduction1
Mini was designed to be a full screen graphical interface. It was first written for the Sherline CNC
but is available for anyone to use, copy, and distribute under the terms of the GPL copyright.
Rather than popup new windows for each thing that an operator might want to do, Mini allows you
to display these within the regular screen. Parts of this chapter are copied from the instructions
that were written for that mill by Joe Martin and Ray Henry.
The Mini screen is laid out in several sections. (See Figure6.1 ) These include a menu across the
top, a set of main control buttons just below the menu and two rather large columns of information
that show the state of your machine and allow you to enter commands or programs.
When you compare figure6.1 with figure 5.2 you will see many differences. In the second figure
• each axis has been homed – the display numbers are dark green
• the EMC mode is auto – the auto button has a light green background
• the backplotter has been turned on – backplot is visible in the pop-in window
• the tool path from the program is showing in the display.
Once you start working with Mini you will quickly discover how easily it shows the conditions of the
EMC and allows you to make changes to it.
The first row is the menu bar across the top. Here you can configure the screen to display additional
information. Some of the items in this menu are very different from what you may be acustomed
to with other programs. You should take a few minutes and look under each menu item in order to
familiarize yourself with the features that are there.
The menu includes each of the following sections and subsections.
1 Much of this chapter quotes from a chapater of the Sherline CNC operators manual.
34
CHAPTER 5. MINI 35
Program This menu includes both reset and exit functions. Reset will return the EMC to the
condition that it was in when it started. Some startup configuration items like the normal
program units can be specified in the ini file.
View This menu includes several screen elements that can be added so that you can see additional
information during a run. These include
Position_Type This menu item adds a line above the main position displays that shows
whether the displays are in inches or metric and whether they are Machine or Relative
location and if they are Actual positions or Commanded positions. These can be changed
using the Settings menu described below.
Tool_Info This adds a line immediately below the main position displays that shows which
tool has been selected and the length of offset applied.
Offset_Info adds a line immediately below the tool info that shows what offsets have been
applied. This is a total distance for each axis from machine zero.
Show_Restart adds a block of buttons to the right of the program display in auto mode. These
allow the operator to restart a program after an abort or estop. These will pop in whenever
estop or abort is pressed but can be shows by the operator anytime auto mode is active
by selecting this menu item.
Hide_Restart removes the block of buttons that control the restart of a program that has been
aborted or estopped.
Show_Split_Right changes the nature of the right hand column so that it shows both mode
and pop-in information.
Show_Mode_Full changes the right hand column so that the mode buttons or displays fill
the entire right side of the screen. In manual mode, running with mode full you will see
spindle and lube control buttons as well as the motion buttons.
Show_Popin_Full changes the right hand column so that the popin fills the entire right side
of the screen.
Settings These menu items allow the operator to control certain parameters during a run.
Info lets you see a number of active things by writing their values into the MESSAGE pad.
Help opens a text window pop in that displays the contents of the help file.
CHAPTER 5. MINI 36
You will notice between the info menu and the help menu there are a set of four buttons. These
are called check buttons because they have a small box that shows red if they have been selected.
These four buttons, Editor, Backplot, Tools, and Offsets pop in each of these screens. If more than
one pop-in is active (button shown as red) you can toggle between these pop-ins by right clicking
your mouse.
Below the menu line is a horizontal line of control buttons. These are the primary control buttons
for the interface. Using these buttons you can change mode from [MANUAL] to [AUTO] to [MDI]
(Manual Data Input). These buttons show a light green background whenever that mode is active.
You can also use the [FEEDHOLD], [ABORT], and [ESTOP] buttons to control a programmed move.
5.4.1 MANUAL
This button or pressing <F3> sets the EMC to Manual mode and displays an abreviated set of
buttons the operator can use to issue manual motion commands. The labels of the jog buttons
change to match the active axis. Whenever Show_Mode_Full is active in in manual mode, you will
see spindle and lube control buttons as well as the motion buttons. A keyboard <i> or <I> will
switch from continuous jog to incremental jog. Pressing that key again will toggle the increment
size through the available sizes.
A button has been added to designate the present position as the home position. We
felt that a machine of this type (Sherline 5400) would be simpler to operate if it didn’t use
a machine home position. This button will zero out any offsets and will home all axes
right where they are.
Axis focus is important here. Notice (in figure 6.1) that in manual mode you see a line
or groove around the X axis to highlight its position display. This groove says that X is the
active axis. It will be the target for jog moves made with the plus and minus jog buttons.
You can change axis focus by clicking on any other axis display. You can also change axis
focus in manual mode if you press its name key on your keyboard. Case is not important
here. [Y] or [y] will shift the focus to the Y axis. [A] or [a] will shift the focus to the A axis.
To help you remember which axis will jog when you press the jog buttons, the active axis
name is displayed on them.
The EMC can jog (move a particular axis) as long as you hold the button down when it
is set for continuous, or it can jog for a preset distance when it is set for incremental. You
can also jog the active axis by pressing the plus [+] or minus [-] keys on the keyboard.
Again, case is not important for keyboard jogs. The two small buttons between the large
jog buttons let you set which kind of jog you want. When you are in incremental mode,
the distance buttons come alive. You can set a distance by pressing it with the mouse.
You can toggle between distances by pressing [i] or [I] on the keyboard. Incremental jog
has an interesting and often unexpected effect. If you press the jog button while a jog is in
progress, it will add the distance to the position it was at when the second jog command
was issued. Two one-inch jog presses in close succession will not get you two inches of
movement. You have to wait until the first one is complete before jogging again.
Jog speed is displayed above the slider. It can be set using the slider by clicking in the
slider’s open slot on the side you want it to move toward, or by clicking on the [Default]
or [Rapid] buttons. This setting only affects the jog move while in manual mode. Once a
jog move is initiated, jog speed has no effect on the jog. As an example of this, say you
set jog mode to incremental and the increment to 1 inch. Once you press the [Jog] button
it will travel that inch at the rate at which it started.
CHAPTER 5. MINI 37
5.4.2 AUTO
When the Auto button is pressed, or <F4> on the keyboard, the EMC is changed into that mode, a
set of the traditional auto operation buttons is displayed, and a small text window opens to show a
part program. During run the active line will be displayed as white lettering on a red background.
In the auto mode, many of the keyboard keys are bound to controls. For example the numbers
above the querty keys are bound to feed rate override. The 0 sets 100%, 9 sets 90% and such.
Other keys work much the same as they do with the tkemc graphical interface.
Auto mode does not normally display the active or modal codes. If the operator wishes to check
these, use menu Info -> Active_G-Codes. This will write all modal codes onto the message scratch
pad.
If abort or estop is pressed during a run a set of buttons displays to the right of the text that allows
the operator to shift the restart line forward or backwards. If the restart line is not the last active
line, it will be highlighted as white letters on a blue background. Caution, a very slow feed rate, and
a finger poised over the pause button is advised during any program restart.
The real heart of CNC machine tool work is the auto mode. Sherline’s auto mode
displays the typical functions that people have come to expect from the EMC. Along the
top are a set of buttons which control what is happening in auto mode. Below them is
the window that shows the part of the program currently being executed. As the program
runs, the active line shows in white letters on a red background. The first three buttons,
[Open], [Run], and [Pause] do about what you’d expect. [Pause] will stop the run right
where it is. The next button, [Resume], will restart motion. They are like feedhold if used
this way. Once [Pause] is pressed and motion has stopped, [Step] will resume motion and
continue it to the end of the current block. Press [Step] again to get the motion of the
next block. Press [Resume] and the interpreter goes back to reading ahead and running
the program. The combination of [Pause] and [Step] work a lot like single block mode on
many controllers. The difference is that [Pause] does not let motion continue to the end
of the current block. Feed rate Override ... can be very handy as you approach a first cut.
Move in quickly at 100 percent, throttle back to 10% and toggle between [Feedhold] and
10% using the pause button. When you are satisfied that you’ve got it right, hit the zero
to the right of nine and go.
The [Verify] button runs the interpreter through the code without initiating any motion.
If Verify finds a problem it will stop the read near the problem block and put up some sort
of message. Most of the time you will be able to figure out the problem with your program
by reading the message and looking in the program window at the highlighted line. Some
of the messages are not very helpful. Sometimes you will need to read a line or two ahead
of the highlight to see the problem. Occasionally the message will refer to something well
ahead of the highlight line. This often happens if you forget to end your program with an
acceptable code like %, m2, m30, or m60.
5.4.3 MDI
The MDI button or <F5> sets the Manual Data Input mode. This mode displays a single line of text
for block entry and shows the currently active modal codes for the interpreter.
MDI mode allows you to enter single blocks and have the interpreter execute them as
if they were part of a program (kind of like a one-line program). You can execute circles,
arcs, lines and such. You can even test sets of program lines by entering one block,
waiting for that motion to end, and then enter the next block. Below the entry window,
there is a listing of all of the current modal codes. This listing can be very handy. I often
forget to enter a g00 before I command a motion. If nothing happens I look down there to
see if g80 is in effect. G80 stops any motion. If it’s there I remember to issue a block like
g00 x0 y0 z0. In MDI you are entering text from the keyboard so none of the main keys
work for commands to the running machine. [F1] will Estop the control.
CHAPTER 5. MINI 38
Since many of the keyboard keys are needed for entry, most of the bindings that were available in
auto mode are not available here.
Feedhold is a toggle. When the EMC is ready to handle or is handling a motion command this
button shows the feedhold label on a red backgrouund. If feedhold has been pressed then it will
show the continue label. Using it to pause motion has the advantage of being able to restart the
program from where you stopped it. Feedhold will toggle between zero speed and whatever feed
rate override was active before it was pressed. This button and the function that it activates is also
bound to the pause button on most keyboards.
5.4.5 [ABORT]
The abort button stops any motion when it is pressed. It also removes the motion command from
the EMC. No further motions are cued up after this button is pressed. If you are in auto mode, this
button removes the rest of the program from the motion cue. It also records the number of the line
that was executing when it was pressed. You can use this line number to restart the program after
you have cleared up the reasons for pressing it.
5.4.6 [ESTOP]
The estop button is also a toggle but it works in three possible settings.
• When Mini starts up it will show a raised button with red background with black letters that
say “ESTOP PUSH.” This is the correct state of the machine when you want to run a program
or jog an axis. Estop is ready to work for you when it looks like this.
• If you push the estop button while a motion is being executed, you will see a recessed gray
button that says “ESTOPPED.” You will not be able to move an axis or do any work from the
Mini gui when the estop button displays this way. Pressing it with your mouse will return Mini
to normal ready condition.
• A third view is possible here. A recessed green button means that estop has been take off but
the machine has not been turned on. Normally this only happens when <F1> estop has been
pressed but <F2> has not been pressed.
Joe Martin says, “When all else fails press a software [ESTOP].” This does everything that abort does
but adds in a reset so that the EMC returns to the standard settings that it wakes up on. If you
have an external estop circuit that watches the relevant parallel port or DIO pin, a software estop
can turn off power to the motors.
Most of the time, when we abort or E-Stop it’s because something went wrong. Perhaps
we broke a tool and want to change it. We switch to manual mode and raise the spindle,
change tools, and assuming that we got the length the same, get ready to go on. If we
return the tool to the same place where the abort was issued, the EMC will work perfectly.
It is possible to move the restart line back or ahead of where the abort happened. If
you press the [Back] or [Ahead] buttons you will see a blue highlight that shows the
relationship between the abort line and the one on which the EMC will start up again.
By thinking through what is happening at the time of the restart you can place the tool
tip where it will resume work in an acceptable manner. You will need to think through
things like tool offsets barriers to motion along a diagonal line and such before you press
the [Restart] button.
CHAPTER 5. MINI 39
There are two columns below the control line. The left side of the screen displays information of
interest to the operator. There are very few buttons to press here.
The axis position displays work exactly like they do with tkemc. The color of the letters is important.
• Red indicates that the machine is sitting on a limit switch or the polarity of a min or max limit
is set wrong in the ini file.
• Yellow indicates that the machine is ready to be homed.
• Green indicates that the machine has been homed.
The position can be changed to display any one of several values by using the menu settings. The
startup or default settings can be changed in the ini file so these displays wake up just the way that
you want them.
Immediately below the axis position displays is the feed rate override slider. You can operate feed
rate override and feedhold in any mode of operation. Override will change the speed of jogs or feed
rate in manual or MDI modes. You can adjust feed rate override by grabbing the slider with your
mouse and dragging it along the groove. You can also change feed rate a percent at a time by
clicking in the slider’s groove. In auto mode you can also set feed override in 10% increments by
pressing the top row of numbers. This slider is a handy visual reference to how much override is
being applied to programmed feed rate.
5.5.3 Messages
The message display located under the axis positions is a sort of scratch pad for the EMC. If there
are problems it will report them there. If you try to home or move an axis when the [ESTOP] button
is pressed, you’ll get a message that says something about commanding motion when the EMC is
not ready. If an axis faults out for something like falling behind, the message pad will show what
happened. If you want to remind an operator to change a tool, for example, you can add a line of
code to your program that will display in the message box. An example might be (msg, change to
tool #3 and press resume). This line of code, included in a program, will display “change to tool #3
and press resume” in the message box. The word msg, (with comma included) is the command to
make this happen; without msg, the message wouldn’t be displayed. It will still show in the auto
modes’ display of the program file.
To erase messages simply click the message button at the top of the pad or on the keyboard hold
down the [Alt] key and press the [m] key.
The right column is a general purpose place to display and work. Here you can see the modal
buttons and text entry or displays. Here you can view a plot of the tool path that will be commanded
by your program. You can also write programs and control tools and offsets here. The modal screens
have been described above. Each of the popin displays are described in detail below.
CHAPTER 5. MINI 40
The editor is rather limited compared to many modern text editors. It does not have undo nor paste
between windows with the clipboard.These were eliminated because of interaction with a running
program. Future releases will replace these functions so that it will work the way you’ve come
to expect from a text editor. It is included because it has the rather nice feature of being able to
number and renumber lines in the way that the interpreter expects of a file. It will also allow you to
cut and paste from one part of a file to another. In addition, it will allow you to save your changes
and submit them to the EMC interpreter with the same menu click. You can work on a file in here
for a while and then save and load if the EMC is in Auto mode. If you have been running a file and
find that you need to edit it, that file will be placed in the editor when you click on the editor button
on the top menu.
Backplot [Backplot] will show the tool path that can be viewed from a chosen direction. ’3-D’ is the
default. Other choices and controls are displayed along the top and right side of the pop-in. If you
are in the middle of a cut when you press one of these control buttons the machine will pause long
enough to re-compute the view.
Along the right side of the pop-in there is a small pyramid shaped graphic that tries to show the
angle you are viewing the tool path from. Below it are a series of sliders that allow you to change the
angle of view and the size of the plot. You can rotate the little position angle display with these. They
take effect when you press the [Refresh] button. The [Reset] button removes all of the paths from
the display and readies it for a new run of the program but retains your settings for that session.
If backplot is started before a program is started, it will try to use some color lines to indicate the
kind of motion that was used to make it. A green line is a rapid move. A black line is a feed rate
move. Blue and red indicate arcs in counterclockwise and clockwise directions.
The backplotter with Mini allows you to zoom and rotate views after you have run your program but
it is not intended to store a tool path for a long period of time.
The tool page is pretty much like the others. You can set length and diameter values here and
they become effective when you press the [Enter] key. You will need to set up your tool information
before you begin to run a program. You can’t change tool offsets while the program is running or
when the program is paused.
The [Add Tools] and [Remove Tools] buttons work on the bottom of the tool list so you will want to fill
in tool information in decending order. Once a new tool has been added, you can use it in a program
with the usual G-code commands. There is a 32 tool limit in the current EMC configuration files
but you will run out of display space in Mini long before you get there. (Hint You can use menu ->
view -> show popin full to see more tools if you need.)
The offset page can be used to display and setup work offsets. The coordinate system is selected
along the left hand side of the window. Once you have selected a coordinate system you can enter
values or move an axis to a teach position. You can also teach using an edgefinder by adding the
radius and length to the offset_by widgets. When you do this you may need to add or subtract the
radius depending upon which surface you choose to touch from. This is selected with the add or
subtract radiobuttons below the offset windows.
CHAPTER 5. MINI 41
The zero all for the active coordinate system button will remove any offsets that you have showing
but they are not set to zero in the variable file until you press the write and load file button as well.
This write and load file button is the one to use when you have set all of the axis values that you
want for a coordinate system.
A number of the bindings used with tkemc have been preserved with mini. A few of the bindings
have been changed to extend that set or to ease the operation of a machine using this interface.
Some keys operate the same regradless of the mode. Others change with the mode that EMC is
operating in.
c select C axis
Left Right Arrow jog X axis
Up Down Arrow jog Y axis
Page Up Down jog Z axis
5.8 Misc
One of the features of Mini is that it displays any axis above number 2 as a rotary and will display
degree units for it. It also converts to degree units for incremental jogs when a rotary axis has the
focus.
CHAPTER 5. MINI 43
KEYSTICK
6.1 Introduction
6.2 Installing
48
CHAPTER 6. KEYSTICK 49
6.3 Using
Keystick is very simple to use. In the MDI Mode you simply start typing the g code and it shows up
in the bottom text area. The “?” key toggles help.
Part II
Using EMC2
50
Chapter 7
This section gives a brief description of how a machining center is viewed from the input and output
ends of the Interpreter. It is assumed the reader is already familiar with machining centers.
Both the RS274/NGC input language and the output canonical machining functions have a view
of (1) mechanical components of a machining center being controlled and (2) what activities of the
machining center may be controlled, and what data is used in control.
The view here includes some items that a given machining center may not have, such as a pallet
shuttle. The RS274/NGC language and canonical machining functions may be used with such a
machine provided that no NC program used with the controller includes commands intended to
activate physical capabilities the machine does not have. For such a machine, it would be useful
to modify the Interpreter so it will reject input commands and will not produce output canonical
function calls addressed to non-existent equipment.
A machining center has many mechanical components that may be controlled or may affect the way
in which control is exercised. This section describes the subset of those components that interact
with the Interpreter. Mechanical components that do not interact directly with the Interpreter, such
as the jog buttons, are not described here, even if they affect control.
7.1.1 Axes
Any machining center has one or more Axes. Different types of machining centers have different
combinations. For instance, a “4-axis milling machine” may have XYZA or XYZB axes. A lathe
typically has XZ axes. A foam-cutting machine may have XYUZ axes.
12
The X, Y, and Z axes produce linear motion in three mutually orthogonal directions.
1 If the motion of mechanical components is not independent, as with hexapod machines, the RS274/NGC language and
the canonical machining functions will still be usable, as long as the lower levels of control know how to control the actual
mechanisms to produce the same relative motion of tool and workpiece as would be produced by independent axes. This is
called kinematics.
2 In EMC, the case of a XYYZ “gantry” machine with two motors for one axis is better handled by kinematics rather than
51
CHAPTER 7. MACHINING CENTER OVERVIEW 52
The U, V, and W axes produce linear motion in three mutually orthogonal directions. Typically, X
and U are parallel, Y and V are parallel, and Z and W are parallel.
The A, B and C axes produce angular motion (rotation). Typically, A rotates around a line parallel
to X, B rotates around a line parallel to Y, and C rotates around a line parallel to Z.
7.1.2 Spindle
A machining center has a spindle which holds one cutting tool, probe, or other item. The spindle can
rotate in either direction, and it can be made to rotate at a constant rate, which may be changed.
Except on machines where the spindle may be moved by moving a rotational axis, the axis of the
spindle is kept parallel to the Z-axis and is coincident with the Z-axis when X and Y are zero. The
spindle can be stopped in a fixed orientation or stopped without specifying orientation.
7.1.3 Coolant
A machining center has components to provide mist coolant and/or flood coolant.
A machining center has a pallet shuttle system. The system has two movable pallets on which
workpieces can be fixtured. Only one pallet at a time is in position for machining.
A machining center has a tool carousel with slots for tools fixed in tool holders.
A machining center has a mechanism for changing tools (fixed in tool holders) between the spindle
and the tool carousel.
A machining center has separate feed and speed override switches, which let the operator specify
that the actual feed rate or spindle speed used in machining should be some percentage of the
programmed rate. See Section 7.3.1.
CHAPTER 7. MACHINING CENTER OVERVIEW 53
A machining center has an optional program stop switch. See Section 7.3.3.
The X, Y, and Z axes form a standard right-handed coordinate system of orthogonal linear axes.
Positions of the three linear motion mechanisms are expressed using coordinates on these axes.
The U, V and W axes also form a standard right-handed coordinate system. X and U are parallel, Y
and V are parallel, and Z and W are parallel.
The rotational axes are measured in degrees as wrapped linear axes in which the direction of positive
rotation is counterclockwise when viewed from the positive end of the corresponding X, Y, or Z-axis.
By “wrapped linear axis,” we mean one on which the angular position increases without limit (goes
towards plus infinity) as the axis turns counterclockwise and deceases without limit (goes towards
minus infinity) as the axis turns clockwise. Wrapped linear axes are used regardless of whether or
not there is a mechanical limit on rotation.
Clockwise or counterclockwise is from the point of view of the workpiece. If the workpiece is fastened
to a turntable which turns on a rotational axis, a counterclockwise turn from the point of view of the
workpiece is accomplished by turning the turntable in a direction that (for most common machine
configurations) looks clockwise from the point of view of someone standing next to the machine.3
The controlled point is the point whose position and rate of motion are controlled. When the tool
length offset is zero (the default value), this is a point on the spindle axis (often called the gauge
point) that is some fixed distance beyond the end of the spindle, usually near the end of a tool
holder that fits into the spindle. The location of the controlled point can be moved out along the
spindle axis by specifying some positive amount for the tool length offset. This amount is normally
the length of the cutting tool in use, so that the controlled point is at the end of the cutting tool. On
a lathe, tool length offsets can be specified for X and Z axes, and the controlled point is either at the
tool tip or slightly outside it (where the perpendicular, axis-aligned lines touched by the “front” and
“side” of the tool intersect).
To drive a tool along a specified path, a machining center must often coordinate the motion of several
axes. We use the term “coordinated linear motion” to describe the situation in which, nominally,
each axis moves at constant speed and all axes move from their starting positions to their end
3 If the parallelism requirement is violated, the system builder will have to say how to distinguish clockwise from counter-
clockwise.
CHAPTER 7. MACHINING CENTER OVERVIEW 54
positions at the same time. If only the X, Y, and Z axes (or any one or two of them) move, this
produces motion in a straight line, hence the word “linear” in the term. In actual motions, it is
often not possible to maintain constant speed because acceleration or deceleration is required at
the beginning and/or end of the motion. It is feasible, however, to control the axes so that, at all
times, each axis has completed the same fraction of its required motion as the other axes. This
moves the tool along same path, and we also call this kind of motion coordinated linear motion.
Coordinated linear motion can be performed either at the prevailing feed rate, or at traverse rate,
or it may be synchronized to the spindle rotation. If physical limits on axis speed make the desired
rate unobtainable, all axes are slowed to maintain the desired path.
The rate at which the controlled point or the axes move is nominally a steady rate which may be set
by the user. In the Interpreter, the interpretation of the feed rate is as follows unless “inverse time
feed” or “feed per revolution” modes are being used (see Section 11.33).
1. If any of XYZ are moving, F is in units per minute in the XYZ cartesian system, and all other
axes (UVWABC) move so as to start and stop in coordinated fashion
2. Otherwise, if any of UVW are moving, F is in units per minute in the UVW cartesian system,
and all other axes (ABC) move so as to start and stop in coordinated fashion
3. Otherwise, the move is pure rotary motion and the F word is in rotary units in the ABC
“pseudo-cartesian” system.
7.2.6 Coolant
Flood coolant and mist coolant may each be turned on independently. The RS274/NGC language
turns them off together (see Section 12.4).
7.2.7 Dwell
A machining center may be commanded to dwell (i.e., keep all axes unmoving) for a specific amount
of time. The most common use of dwell is to break and clear chips, so the spindle is usually turning
during a dwell. Regardless of the Path Control Mode (see Section 7.2.15) the machine will stop
exactly at the end of the previous programmed move, as though it was in exact path mode.
7.2.8 Units
Units used for distances along the X, Y, and Z axes may be measured in millimeters or inches.
Units for all other quantities involved in machine control cannot be changed. Different quantities
use different specific units. Spindle speed is measured in revolutions per minute. The positions
of rotational axes are measured in degrees. Feed rates are expressed in current length units per
minute, or degrees per minute, or length units per spindle revolution, as described in Section 7.2.5.
The controlled point is always at some location called the “current position,” and the controller
always knows where that is. The numbers representing the current position must be adjusted in
the absence of any axis motion if any of several events take place:
CHAPTER 7. MACHINING CENTER OVERVIEW 55
There is always a “selected plane”, which must be the XY-plane, the YZ-plane, or the XZ-plane of
the machining center. The Z-axis is, of course, perpendicular to the XY-plane, the X-axis to the
YZ-plane, and the Y-axis to the XZ-plane.
The feed and speed override switches may be enabled (so they work as expected) or disabled (so they
have no effect on the feed rate or spindle speed). The RS274/NGC language has one command that
enables both switches and one command that disables both (see Section 12.5). See Section 7.3.1
for further details.
The machining center may be put into any one of three path control modes: (1) exact stop mode, (2)
exact path mode, or (3) continuous mode with optional tolerance. In exact stop mode, the machine
stops briefly at the end of each programmed move. In exact path mode, the machine follows the
programmed path as exactly as possible, slowing or stopping if necessary at sharp corners of the
path. In continuous mode, sharp corners of the path may be rounded slightly so that the feed rate
may be kept up (but by no more than the tolerance, if specified). See Section 11.18.
The Interpreter interacts with several switches. This section describes the interactions in more
detail. In no case does the Interpreter know what the setting of any of these switches is.
CHAPTER 7. MACHINING CENTER OVERVIEW 56
The Interpreter will interpret RS274/NGC commands which enable (M48) or disable (M49) the feed
and speed override switches. For certain moves, such as the traverse out of the end of a thread
during a threading cycle, the switches are disabled automatically.
EMC2 reacts to the speed and feed override settings when these switches are enabled.
If the block delete switch is on, lines of RS274/NGC code which start with a slash (the block delete
character) are not interpreted. If the switch is off, such lines are interpreted. Normally the block
delete switch should be set before starting the NGC program.
1 1 2.0 1.0
2 2 1.0 0.2
5 5 1.5 0.25 endmill
10 10 2.4 -0.3 for testing
CHAPTER 7. MACHINING CENTER OVERVIEW 57
Each line has five entries. The first four entries are required. The last entry (a comment) is optional.
It makes reading easier if the entries are arranged in columns, as shown in the table, but the only
format requirement is that there be at least one space or tab after each of the first three entries on
a line and a space, tab, or newline at the end of the fourth entry. The meanings of the columns and
the type of data to be put in each are as follows.
The “Pocket” column contains the number (unsigned integer) which represents the pocket number
(slot number) of the tool carousel slot in which the tool is placed. The entries in this column must
all be different.
The “FMS” column contains the number (unsigned integer) which represents a code number for the
tool. The user may use any code for any tool, as long as the codes are unsigned integers. This is
typically the same as the pocket number.
The “TLO” column contains a real number which represents the tool length offset. This number will
be used if tool length offsets are being used and this pocket is selected. This is normally a positive
real number, but it may be zero or any other number if it is never to be used.
The “Diameter” column contains a real number. This number is used only if tool radius compensa-
tion is turned on using this pocket. If the programmed path during compensation is the edge of the
material being cut, this should be a positive real number representing the measured diameter of the
tool. If the programmed path during compensation is the path of a tool whose diameter is nominal,
this should be a small number (positive, negative, or zero) representing the difference between the
measured diameter of the tool and the nominal diameter. If cutter radius compensation is not used
with a tool, it does not matter what number is in this column.
The “Comment” column may optionally be used to describe the tool. Any type of description is OK.
This column is for the benefit of human readers only.
The Pocket, FMS, DIA and Comment fields are as for mill format tool files. The ZOFFSET field is the
same as the TLO field of mill format tool files. The DIA is also used by the AXIS gui display.
The XOFFSET field gives an offset for the X coordinate when tool length offsets are in effect.
The ORIENTATION field gives the orientation of the lathe tool, as illustrated in 7.1. The red cross is
the controlled point. See 7.2.3.
The FRONTANGLE and BACKANGLE fields are used by some user interfaces to display a fancy
representation of the lathe tool.
CHAPTER 7. MACHINING CENTER OVERVIEW 58
7.5 Parameters
In the RS274/NGC language view, a machining center maintains an array of numerical parameters.
Many of them have specific uses. The parameter array persists over time, even if the machining
center is powered down. EMC2 uses a parameter file to ensure persistence and gives the Interpreter
the responsibility for maintaining the file. The Interpreter reads the file when it starts up, and writes
the file when it exits.
The format of a parameter file is shown in Table 7.4. The file consists of any number of header
lines, followed by one blank line, followed by any number of lines of data. The Interpreter skips over
the header lines. It is important that there be exactly one blank line (with no spaces or tabs, even)
before the data. The header line shown in Table 7.4 describes the data columns, so it is suggested
(but not required) that that line always be included in the header.
The Interpreter reads only the first two columns of the table. The third column, “Comment,” is not
read by the Interpreter.
Each line of the file contains the index number of a parameter in the first column and the value to
which that parameter should be set in the second column. The value is represented as a double-
precision floating point number inside the Interpreter, but a decimal point is not required in the
file. All of the parameters shown in Table 7.4 are required parameters and must be included in any
parameter file, except that any parameter representing a rotational axis value for an unused axis
may be omitted. An error will be signalled if any required parameter is missing. A parameter file
may include any other parameter, as long as its number is in the range 1 to 5400. The parameter
numbers must be arranged in ascending order. An error will be signalled if not. Any parameter
included in the file read by the Interpreter will be included in the file it writes as it exits. The
original file is saved as a backup file when the new file is written. Comments are not preserved
when the file is written.
In the RS274/NGC language view, a machining center has an absolute coordinate system and nine
program coordinate systems.
You can set the offsets of the nine program coordinate systems using G10 L2 Pn (n is the number
of the coordinate system) with values for the axes in terms of the absolute coordinate system. See
Section 11.6.
You can select one of the nine systems by using G54, G55, G56, G57, G58, G59, G59.1, G59.2, or
G59.3 (see Section 11.17). It is not possible to select the absolute coordinate system directly.
You can offset the current coordinate system using G92 or G92.3. This offset will then apply to all
nine program coordinate systems. This offset may be cancelled with G92.1 or G92.2. See Section
11.32.
You can make straight moves in the absolute machine coordinate system by using G53 with either
G0 or G1. See Section 11.16.
Data for coordinate systems is stored in parameters.
During initialization, the coordinate system is selected that is specified by parameter 5220. A value
of 1 means the first coordinate system (the one G54 activates), a value of 2 means the second
coordinate system (the one G55 activates), and so on. It is an error for the value of parameter 5220
to be anything but a whole number between one and nine.
Chapter 8
Language Overview
The RS274/NGC language is based on lines of code. Each line (also called a “block”) may include
commands to a machining center to do several different things. Lines of code may be collected in a
file to make a program.
A typical line of code consists of an optional line number at the beginning followed by one or more
“words.” A word consists of a letter followed by a number (or something that evaluates to a number).
A word may either give a command or provide an argument to a command. For example, “G1 X3”
is a valid line of code with two words. “G1” is a command meaning “move in a straight line at the
programmed feed rate”, and “X3” provides an argument value (the value of X should be 3 at the end
of the move). Most RS274/NGC commands start with either G or M (for General and Miscellaneous).
The words for these commands are called “G codes” and “M codes.”
The RS274/NGC language has no indicator for the start of a program. The Interpreter, however,
deals with files. A single program may be in a single file, or a program may be spread across several
files. A file may demarcated with percents in the following way. The first non-blank line of a file
may contain nothing but a percent sign, “%”, possibly surrounded by white space, and later in the
file (normally at the end of the file) there may be a similar line. Demarcating a file with percents is
optional if the file has an M2 or M30 in it, but is required if not. An error will be signalled if a file
has a percent line at the beginning but not at the end. The useful contents of a file demarcated by
percents stop after the second percent line. Anything after that is ignored.
The RS274/NGC language has two commands (M2 or M30), either of which ends a program. A
program may end before the end of a file. Lines of a file that occur after the end of a program are
not to be executed. The interpreter does not even read them.
A permissible line of input RS274/NGC code consists of the following, in order, with the restriction
that there is a maximum (currently 256) to the number of characters allowed on a line.
Any input not explicitly allowed is illegal and will cause the Interpreter to signal an error.
60
CHAPTER 8. LANGUAGE OVERVIEW 61
Spaces and tabs are allowed anywhere on a line of code and do not change the meaning of the line,
except inside comments. This makes some strange-looking input legal. The line “g0x +0. 12 34y
7” is equivalent to “g0 x+0.1234 y7”, for example.
Blank lines are allowed in the input. They are to be ignored.
Input is case insensitive, except in comments, i.e., any letter outside a comment may be in upper
or lower case without changing the meaning of a line.
8.3 Word
A word is a letter other than N followed by a real value.
Words may begin with any of the letters shown in Table 8.1. The table includes N for completeness,
even though, as defined above, line numbers are not words. Several letters (I, J, K, L, P, R) may
have different meanings in different contexts. Letters which refer to axis names are not valid on a
machine which does not have the corresponding axis.
8.3.1 Number
The following rules are used for (explicit) numbers. In these rules a digit is a single character
between 0 and 9.
• A number consists of (1) an optional plus or minus sign, followed by (2) zero to many digits,
followed, possibly, by (3) one decimal point, followed by (4) zero to many digits - provided that
there is at least one digit somewhere in the number.
• There are two kinds of numbers: integers and decimals. An integer does not have a decimal
point in it; a decimal does.
• Numbers may have any number of digits, subject to the limitation on line length. Only about
seventeen significant figures will be retained, however (enough for all known applications).
• A non-zero number with no sign as the first character is assumed to be positive.
Notice that initial (before the decimal point and the first non-zero digit) and trailing (after the decimal
point and the last non-zero digit) zeros are allowed but not required. A number written with initial
or trailing zeros will have the same value when it is read as if the extra zeros were not there.
Numbers used for specific purposes in RS274/NGC are often restricted to some finite set of values
or some to some range of values. In many uses, decimal numbers must be close to integers; this
includes the values of indexes (for parameters and carousel slot numbers, for example), M codes,
and G codes multiplied by ten. A decimal number which is supposed be close to an integer is
considered close enough if it is within 0.0001 of an integer.
A numbered parameter is the pound character # followed by an integer between 1 and 5399. The
parameter is referred to by this integer, and its value is whatever number is stored in the parameter.
A value is stored in a parameter with the = operator; for example "#3 = 15" means "set parameter
3 to 15." A parameter setting does not take effect until after all parameter values on the same line
have been found. For example, if parameter 3 has been previously set to 15 and the line “#3=6
G1 x#3” is interpreted, a straight move to a point where x equals 15 will occur and the value of
parameter 3 will be 6.
The # character takes precedence over other operations, so that, for example, “#1+2” means the
number found by adding 2 to the value of parameter 1, not the value found in parameter 3. Of
course, #[1+2] does mean the value found in parameter 3. The # character may be repeated; for
example ##2 means the value of the parameter whose index is the (integer) value of parameter 2.
Named parameters work like numbered parameters but are easier to read. All parameter names are
converted to lower case and have spaces and tabs removed. Named parameters must be enclosed
with < > marks.
#<named parameter here> is a local named parameter. By default, a named parameter is local
to the scope in which it is assigned. You can’t access a local parameter outside of its subroutine -
this is so that two subroutines can use the same parameter names without fear of one subroutine
overwriting the values in another.
#<_global named parameter here> is a global named parameter. They are accessible from within
called subroutines and may set values within subroutines that are accessible to the caller. As far
as scope is concerned, they act just like regular numeric parameters. They are not stored in files.
Examples:
CHAPTER 8. LANGUAGE OVERVIEW 63
#<_endmill_dia> = 0.049
#<_endmill_rad> = [#<_endmill_dia>/2.0]
8.3.4 Expressions
An expression is a set of characters starting with a left bracket [ and ending with a balancing right
bracket ]. In between the brackets are numbers, parameter values, mathematical operations, and
other expressions. An expression is evaluated to produce a number. The expressions on a line
are evaluated when the line is read, before anything on the line is executed. An example of an
expression is [1 + acos[0] - [#3 ** [4.0/2]]].
Binary operators only appear inside expressions. There are four basic mathematical operations:
addition (+), subtraction (-), multiplication (*), and division (/). There are three logical operations:
non-exclusive or (OR), exclusive or (XOR), and logical and (AND). The eighth operation is the modulus
operation (MOD). The ninth operation is the “power” operation (**) of raising the number on the left
of the operation to the power on the right. The relational operators are equality (EQ), inequality (NE),
strictly greater than (GT), greater than or equal to (GE), strictly less than (LT), and less than or equal
to (LE).
The binary operations are divided into several groups according to their precedence. (see table 8.2)
If operations in different precedence groups are strung together (for example in the expression [2.0
/ 3 * 1.5 - 5.5 / 11.0]), operations in a higher group are to be performed before operations in
a lower group. If an expression contains more than one operation from the same group (such as
the first / and * in the example), the operation on the left is performed first. Thus, the example is
equivalent to: [[[2.0 / 3] * 1.5] - [5.5 / 11.0]] , which is equivalent to to [1.0 - 0.5] ,
which is 0.5.
The logical operations and modulus are to be performed on any real numbers, not just on integers.
The number zero is equivalent to logical false, and any non-zero number is equivalent to logical
true.
8.3.6 Functions
A function is either “ATAN” followed by one expression divided by another expression (for example
“ATAN[2]/[1+3]”) or any other function name followed by an expression (for example “SIN[90]”).
The available functions are shown in table 8.3. Arguments to unary operations which take angle
measures (COS, SIN, and TAN) are in degrees. Values returned by unary operations which return
angle measures (ACOS, ASIN, and ATAN) are also in degrees.
The FIX operation rounds towards the left (less positive or more negative) on a number line, so that
FIX[2.8] =2 and FIX[-2.8] = -3, for example. The FUP operation rounds towards the right (more
positive or less negative) on a number line; FUP[2.8] = 3 and FUP[-2.8] = -2, for example.
8.4 Comments
Printable characters and white space inside parentheses is a comment. A left parenthesis always
starts a comment. The comment ends at the first right parenthesis found thereafter. Once a left
parenthesis is placed on a line, a matching right parenthesis must appear before the end of the
line. Comments may not be nested; it is an error if a left parenthesis is found after the start of a
comment and before the end of the comment. Here is an example of a line containing a comment:
“G80 M5 (stop motion)”. Comments do not cause a machining center to do anything.
8.5 Messages
A comment contains a message if “MSG,” appears after the left parenthesis and before any other
printing characters. Variants of “MSG,” which include white space and lower case characters are
allowed. The rest of the characters before the right parenthesis are considered to be a message.
Messages should be displayed on the message display device. Comments not containing messages
need not be displayed there.
A comment can also be used to specify a file for the results of G38.2 probing. See section 11.13.
Often, general logging is more useful than probe logging. Using general logging, the format of the
output data can be controlled.
CHAPTER 8. LANGUAGE OVERVIEW 65
Comments that look like: (debug, rest of comment) are the same as comments like (msg, rest
of comment) with the addition of special handling for parameters.
Comments that look like: (print, rest of comment) are output to stderr with special handling
for parameters.
In the DEBUG, PRINT and LOG comments, the values of parameters in the message are expanded.
For example: to print a named global variable to stderr (the default console window) add a line to
your gcode like...
Inside the above types of comments, sequences like #123 are replaced by the value of the param-
eter 123. Sequences like #<named parameter> are replaced by the value of the named param-
eter. Remember that named parameters will have whitespace removed from them. So, #<named
parameter> is the same as #<namedparameter>.
A line may have any number of G words, but two G words from the same modal group (see Section
8.12) may not appear on the same line.
A line may have zero to four M words. Two M words from the same modal group may not appear on
the same line.
For all other legal letters, a line may have only one word beginning with that letter.
If a parameter setting of the same parameter is repeated on a line, “#3=15 #3=6”, for example, only
the last setting will take effect. It is silly, but not illegal, to set the same parameter twice on the
same line.
If more than one comment appears on a line, only the last one will be used; each of the other
comments will be read and its format will be checked, but it will be ignored thereafter. It is expected
that putting more than one comment on a line will be very rare.
The three types of item whose order may vary on a line (as given at the beginning of this section)
are word, parameter setting, and comment. Imagine that these three types of item are divided into
three groups by type.
The first group (the words) may be reordered in any way without changing the meaning of the line.
If the second group (the parameter settings) is reordered, there will be no change in the meaning of
the line unless the same parameter is set more than once. In this case, only the last setting of the
parameter will take effect. For example, after the line “#3=15 #3=6” has been interpreted, the value
of parameter 3 will be 6. If the order is reversed to “#3=6 #3=15” and the line is interpreted, the
value of parameter 3 will be 15.
CHAPTER 8. LANGUAGE OVERVIEW 66
If the third group (the comments) contains more than one comment and is reordered, only the last
comment will be used.
If each group is kept in order or reordered without changing the meaning of the line, then the three
groups may be interleaved in any way without changing the meaning of the line. For example, the
line “g40 g1 #3=15 (foo) #4=-7.0” has five items and means exactly the same thing in any of
the 120 possible orders (such as “#4=-7.0 g1 #3=15 g40 (foo)”) for the five items.
In RS274/NGC, many commands cause a machining center to change from one mode to another,
and the mode stays active until some other command changes it implicitly or explicitly. Such
commands are called “modal”. For example, if coolant is turned on, it stays on until it is explicitly
turned off. The G codes for motion are also modal. If a G1 (straight move) command is given on one
line, for example, it will be executed again on the next line if one or more axis words is available on
the line, unless an explicit command is given on that next line using the axis words or cancelling
motion.
“Non-modal” codes have effect only on the lines on which they occur. For example, G4 (dwell) is
non-modal.
Modal commands are arranged in sets called “modal groups”, and only one member of a modal
group may be in force at any given time. In general, a modal group contains commands for which
it is logically impossible for two members to be in effect at the same time - like measure in inches
vs. measure in millimeters. A machining center may be in many modes at the same time, with one
mode from each modal group being in effect. The modal groups are shown in Table 8.4.
For several modal groups, when a machining center is ready to accept commands, one member of
the group must be in effect. There are default settings for these modal groups. When the machining
center is turned on or otherwise re-initialized, the default values are automatically in effect.
Group 1, the first group on the table, is a group of G codes for motion. One of these is always in
effect. That one is called the current motion mode.
It is an error to put a G-code from group 1 and a G-code from group 0 on the same line if both of
them use axis words. If an axis word-using G-code from group 1 is implicitly in effect on a line (by
having been activated on an earlier line), and a group 0 G-code that uses axis words appears on
the line, the activity of the group 1 G-code is suspended for that line. The axis word-using G-codes
from group 0 are G10, G28, G30, and G92.
It is an error to include any unrelated words on a line with O- flow control.
Chapter 9
Order of Execution
The order of execution of items on a line is critical to safe and effective machine operation. Items
are executed in the order shown below if they occur on the same line.
15. coordinate system selection (G54, G55, G56, G57, G58, G59, G59.1, G59.2, G59.3).
16. set path control mode (G61, G61.1, G64)
17. set distance mode (G90, G91).
18. set retract mode (G98, G99).
19. home (G28, G30) or change coordinate system data (G10) or set axis offsets (G92, G92.1,
G92.2, G94).
20. perform motion (G0 to G3, G33, G80 to G89), as modified (possibly) by G53.
21. stop (M0, M1, M2, M30, M60).
68
Chapter 10
Use at least 3 digits after the decimal when milling in millimeters, and at least 4 digits after the
decimal when milling in inches. In particular, arc tolerance checks are made to .001 and .0001
depending on the active units.
G-code is most legible when at least one space appears before words. While it is permitted to insert
whitespace in the middle of numbers, there is no reason to do so.
Center-format arcs (which use I- J- K- instead of R-) behave more consistently than R-format
arcs, particularly for included angles near 180 or 360 degrees.
When correct execution of your program depends on modal settings, be sure to set them at the
beginning of the part program. Modes can carry over from previous programs and from the MDI
commands.
As a good preventative measure, put a line similar to the following at the top of all your programs:
(XY plane, inch mode, cancel diameter compensation, cancel length offset, coordinate system 1,
cancel motion, non-incremental motion, feed/minute mode)
Perhaps the most critical modal setting is the distance units–If you do not include G20 or G21, then
different machines will mill the program at different scales. Other settings, such as the return mode
in canned cycles may also be important.
69
CHAPTER 10. G CODE BEST PRACTICES 70
Ignore everything in Section 9, and instead write no line of code that is the slightest bit ambiguous.
Similarly, don’t use and set a parameter on the same line, even though the semantics are well
defined. (Exception: Updating a variable to a new value, such as #1=[#1+#2])
Line numbers offer no benefits. When line numbers are reported in error messages, the numbers
refer to the line number in the file, not the N-word value.
Because the meaning of an F-word in feed-per-minute mode varies depending on which axes are
commanded to move, and because the amount of material removed does not depend only on the
feed rate, it may be easier to use G93 inverse time feed mode to achieve the desired material removal
rate.
Chapter 11
G Codes
G codes of the RS274/NGC language are shown in Table 5 and described following that.
In the command prototypes, the hypen (-) stands for a real value. As described earlier, a real value
may be (1) an explicit number, 4, for example, (2) an expression, [2+2], for example, (3) a parameter
value, #88, for example, or (4) a unary function value, acos[0], for example.
In most cases, if axis words (any or all of X-, Y-, Z-, A-, B-, C-, U-, V-, W-) are given, they specify
a destination point. Axis numbers are in the currently active coordinate system, unless explicitly
described as being in the absolute coordinate system. Where axis words are optional, any omitted
axes will have their current value. Any items in the command prototypes not explicitly described as
optional are required. It is an error if a required item is omitted. In prototypes, this will be written
as axes.
In the prototypes, the values following letters are often given as explicit numbers. Unless stated
otherwise, the explicit numbers can be real values. For example, G10 L2 could equally well be
written G[2*5] L[1+1]. If the value of parameter 100 were 2, G10 L#100 would also mean the
same. Using real values which are not explicit numbers as just shown in the examples is rarely
useful.
If L- is written in a prototype the “-” will often be referred to as the “L number”. Similarly the “-” in
H- may be called the “H number”, and so on for any other letter.
71
CHAPTER 11. G CODES 72
If cutter radius compensation is active, the motion will differ from the above; see Section 16.4. If
G53 is programmed on the same line, the motion will also differ; see Section 11.16.
If cutter radius compensation is active, the motion will differ from the above; see Section 16.4. If
G53 is programmed on the same line, the motion will also differ; see Section 11.16.
In the center format, the coordinates of the end point of the arc in the selected plane are specified
along with the offsets of the center of the arc from the current location. In this format, it is OK if
the end point of the arc is the same as the current point. It is an error if:
• When the arc is projected on the selected plane, the distance from the current point to the
center differs from the distance from the end point to the center by more than 0.0002 inch (if
inches are being used) or 0.002 millimeter (if millimeters are being used).
CHAPTER 11. G CODES 74
When the XY-plane is selected, program G2 axes I- J- (or use G3 instead of G2). The axis words
are all optional except that at least one of X and Y must be used. I and J are the offsets from
the current location (in the X and Y directions, respectively) of the center of the circle. I and J are
optional except that at least one of the two must be used. If only one is specified, the value of the
other is taken as 0. It is an error if:
When the XZ-plane is selected, program G2 axes I- K- (or use G3 instead of G2). The axis words
are all optional except that at least one of X and Z must be used. I and K are the offsets from
the current location (in the X and Z directions, respectively) of the center of the circle. I and K are
optional except that at least one of the two must be used. If only one is specified, the value of the
other is taken as 0. It is an error if:
When the YZ-plane is selected, program G2 axes J- K- (or use G3 instead of G2). The axis words
are all optional except that at least one of Y and Z must be used. J and K are the offsets from the
current location (in the Y and Z directions, respectively) of the center of the circle. J and K are
optional except that at least one of the two must be used. If only one is specified, the value of the
other is taken as 0. It is an error if:
Here is an example of a center format command to mill an arc: G17 G2 x10 y16 i3 j4 z9.
That means to make a clockwise (as viewed from the positive z-axis) circular or helical arc whose
axis is parallel to the Z-axis, ending where X=10, Y=16, and Z=9, with its center offset in the X
direction by 3 units from the current X location and offset in the Y direction by 4 units from the
current Y location. If the current location has X=7, Y=7 at the outset, the center will be at X=10,
Y=11. If the starting value of Z is 9, this is a circular arc; otherwise it is a helical arc. The radius of
this arc would be 5.
In the center format, the radius of the arc is not specified, but it may be found easily as the distance
from the center of the circle to either the current point or the end point of the arc.
In the radius format, the coordinates of the end point of the arc in the selected plane are specified
along with the radius of the arc. Program G2 axes R- (or use G3 instead of G2). R is the radius.
The axis words are all optional except that at least one of the two words for the axes in the selected
plane must be used. The R number is the radius. A positive radius indicates that the arc turns
through less than 180 degrees, while a negative radius indicates a turn of more than 180 degrees.
If the arc is helical, the value of the end point of the arc on the coordinate axis parallel to the axis
of the helix is also specified.
It is an error if:
• both of the axis words for the axes of the selected plane are omitted
• the end point of the arc is the same as the current point.
CHAPTER 11. G CODES 75
It is not good practice to program radius format arcs that are nearly full circles or nearly semicircles
because a small change in the location of the end point will produce a much larger change in the
location of the center of the circle (and, hence, the middle of the arc). The magnification effect is
large enough that rounding error in a number can produce out-of-tolerance cuts. For instance, a
1% displacement of the endpoint of a 180 degree arc produced a 7% displacement of the point 90
degrees along the arc. Nearly full circles are even worse. Other size arcs (in the range tiny to 165
degrees or 195 to 345 degrees) are OK.
Here is an example of a radius format command to mill an arc: G17 G2 x 10 y 15 r 20 z 5.
That means to make a clockwise (as viewed from the positive Z-axis) circular or helical arc whose
axis is parallel to the Z-axis, ending where X=10, Y=15, and Z=5, with a radius of 20. If the starting
value of Z is 5, this is an arc of a circle parallel to the XY-plane; otherwise it is a helical arc.
11.5 G4 Dwell
For a dwell, program G4 P- . This will keep the axes unmoving for the period of time in seconds
specified by the P number. It is an error if:
If a G92 origin offset was in effect before G10 L2, it will continue to be in effect afterwards.
The coordinate system whose origin is set by a G10 command may be active or inactive at the time
the G10 is executed. If it is currently active, the new coordinates take effect immediately.
Example: G10 L2 P1 x 3.5 y 17.2 sets the origin of the first coordinate system (the one selected
by G54) to be X=3.5 and Y=17.2. Because only X and Y are specified, the origin point is only moved
in X and Y; the other coordinates are not changed.
Program G17 to select the XY-plane. Figure(11.1) shows the orientation of the XZ plane.
Program G18 to select the XZ plane. Figure(11.2) shows the orientation of the XZ plane.
CHAPTER 11. G CODES 76
G28 and G30 do not use home switches to find the predefined position. They merely command a
rapid motion to the position defined by the parameters, assuming that the machine has already
been homed.
To return one or more axes to the predefined position by way of the programmed position, program
G28 axes (or use G30). The path is made by a traverse move from the current position to the
programmed position, followed by a traverse move of the named axes to the predefined position.
To return all axes to the predefined position without an intermediate position, program G28 or G30
without any axis words.
It is an error if :
For rigid tapping (spindle synchronized motion with return) code G33.1 X- Y- Z- K- where K-
gives the distance moved for each revolution of the spindle. A rigid tapping move consists of the
following sequence:
• A move to the specified coordinate, synchronized with the spindle at the given ratio and starting
with a spindle index pulse
• When reaching the endpoint, a command to reverse the spindle (e.g., from 300 RPM clockwise
to 300RPM counterclockwise)
• Continued synchronized motion beyond the specified end coordinate until the spindle actually
stops and reverses
• Continued synchronized motion back to the original coordinate
• When reaching the original coordinate, a command to reverse the spindle a second time (e.g.,
from 300RPM counterclockwise to 300RPM clockwise)
• Continued synchronized motion beyond the original coordinate until the spindle actually stops
and reverses
• An unsynchronized move back to the original coordinate.
All spindle-synchronized motions wait for spindle index, so multiple passes line up. G33 moves end
at the programmed endpoint; G33.1 moves end at the original coordinate.
All the axis words are optional, except that at least one must be used.
It is an error if:
In response to this command, the machine moves the controlled point (which should be at the
end of the probe tip) in a straight line at the current feed rate toward the programmed point. In
inverse time feed mode, the feed rate is such that the whole motion from the current point to the
programmed point would take the specified time. The move stops when the programmed point is
reached, or when the probe input closes1 .
After successful probing, parameters 5061 to 5069 will be set to the coordinates of the location of
the controlled point at the time the probe changed state.
A comment of the form (PROBEOPEN filename.txt) will open filename.txt and store the 9-number
coordinate of each successful straight probe in it. The file must be closed with (PROBECLOSE).
1 Actually, the movement continues beyond the “probe state changed” point due to machine acceleration constraints.
CHAPTER 11. G CODES 79
To turn cutter radius compensation off, program G40. It is OK to turn compensation off when it is
already off.
Cutter radius compensation may be performed only if the XY-plane is active.
The behavior of the machining center when cutter radius compensation is on is described in Section
16.4
To turn cutter radius compensation on left (i.e., the cutter stays to the left of the programmed path
when the tool radius is positive), program G41 D- . To turn cutter radius compensation on right
(i.e., the cutter stays to the right of the programmed path when the tool radius is positive), program
G42 D- . The D word is optional; if there is no D word, the radius of the tool currently in the spindle
will be used. If used, the D number should normally be the slot number of the tool in the spindle,
although this is not required. It is OK for the D number to be zero; a radius value of zero will be
used.
It is an error if:
• the D number is not an integer, is negative or is larger than the number of carousel slots,
• the YZ plane is active,
To turn cutter radius compensation on left, program G41.1 D- L-. To turn cutter compensation
on right, program G42.1 D- L-. The D word specifies the cutter diameter. The L word specifies the
cutter orientation, and defaults to 0 if unspecified. For more information on cutter orientation see
Section (7.1).
It is an error if:
G43 and G43.1 change subsequent motions by offsetting the Z and/or X coordinates by the length
of the tool. G43 and G43.1 do not cause any motion. The next time a compensated axis is moved,
that axis’s endpoint is the compensated location.
CHAPTER 11. G CODES 80
To use a tool length offset from the tool table, program G43 H-, where the H number is the desired
index in the tool table. The H number will typically be, but does not have to be, the same as the slot
number of the tool currently in the spindle. It is OK for the H number to be zero; an offset value of
zero will be used.
It is an error if:
• the H number is not an integer, is negative, or is larger than the number of carousel slots.
To use a tool length offset from the program, use G43.1 I- K-, where I- gives the X tool offset (for
lathes) and K- gives the Z tool offset (for lathes and mills).
It is an error if:
Program G61 to put the machining center into exact path mode, G61.1 for exact stop mode, or G64
P- for continuous mode with optional tolerance. G61 visits the programmed point exactly, even
though that means temporarily coming to a complete stop. G64 without P means to keep the best
speed possible, no matter how far away from the programmed point you end up. G64 P- means that
it should slow down as required to keep no more than P- away from the programmed endpoint. In
addition, when you activate G64 P- it turns on the "naive cam detector"; when there are a series of
linear XYZ feed moves at the same feed rate that are less than P- away from being colinear, they
are collapsed into a single linear move. On G2/3 moves in the G17 (XY) plane when the maximum
deviation of an arc from a straight line is less than the G64 P- tolerance the arc is broken into two
lines (from start of arc to midpoint, and from midpoint to end). those lines are then subject to the
naive cam algorithm for lines. Thus, line-arc, arc-arc, and arc-line cases as well as line-line benefit
from the “naive cam detector”. This improves contouring performance by simplifying the path. It is
OK to program for the mode that is already active. See also Section 7.2.15 for a discussion of these
modes.
The “drive line” is a safe line outside the thread material. The “drive line” goes from the initial
location to the Z- value specified with G76. The Z extent of the thread is the same as the drive line.
The “thread pitch”, or distance per revolution, is given by the P- value.
The “thread peak” is given by the I- value, which is an offset from the drive line. Negative I values
indicate external threads, and positive I values indicate internal threads. Generally the material
has been turned to this size before the G76 cycle.
The “initial cut depth” is given by the J- value. The first threading cut will be J beyond the “thread
peak” position. J- is positive, even when I- is negative.
The “full thread depth” is given by the K- value. The final threading cut will be K beyond the “thread
peak” position. K- is positive, even when I- is negative.
The “depth degression” is given by the R- value. R1.0 selects constant depth on successive thread-
ing passes. R2.0 selects constant area. Values between 1.0 and 2.0 select decreasing depth but
increasing area. Values above 2.0 select decreasing area. Beware that unnecessarily high degres-
sion values will cause a large number of passes to be used.
The “compound slide angle” Q- is the angle (in degrees) describing to what extent successive passes
should be offset along the drive line. This is used to cause one side of the tool to remove more
material than the other. A positive Q value causes the leading edge of the tool to cut more heavily.
Typical values are 29, 29.5 or 30.
CHAPTER 11. G CODES 82
The number of “spring passes” is given by the H- value. Spring passes are additional passes at full
thread depth. If no additional passes are desired, program H0.
Tapered entry and exit moves can be programmed using E- and L-. E- gives a distance along the
drive line used for the taper. E0.2 will give a taper for the first/last 0.2 length units along the
thread. L- is used to specify which ends of the thread get the taper. Program L0 for no taper (the
default), L1 for entry taper, L2 for exit taper, or L3 for both entry and exit tapers.
The tool will pause briefly for synchronization before each threading pass, so a relief groove will be
required at the entry unless the beginning of the thread is past the end of the material or an entry
taper is used.
Unless using an exit taper, the exit move (traverse to original X) is not synchronized to the spindle
speed. With a slow spindle, the exit move might take only a small fraction of a revolution. If the
spindle speed is increased after several passes are complete, subsequent exit moves will require a
larger portion of a revolution, resulting in a very heavy cut during the exit move. This can be avoided
by providing a relief groove at the exit, or by not changing the spindle speed while threading.
The sample program g76.ngc shows the use of the G76 canned cycle, and can be previewed and
executed on any machine using the sim/lathe.ini configuration.
• Axis words are programmed when G80 is active, unless a modal group 0 G code is programmed
which uses axis words.
The canned cycles G81 through G89 have been implemented as described in this section. Two
examples are given with the description of G81 below.
All canned cycles are performed with respect to the currently selected plane. Any of the three
planes (XY, YZ, ZX) may be selected. Throughout this section, most of the descriptions assume the
XY-plane has been selected. The behavior is always analogous if the YZ or XZ-plane is selected.
Rotational axis words are allowed in canned cycles, but it is better to omit them. If rotational
axis words are used, the numbers must be the same as the current position numbers so that the
rotational axes do not move.
CHAPTER 11. G CODES 83
All canned cycles use X, Y, R, and Z words in the NC code. These numbers are used to determine
X, Y, R, and Z positions. The R (usually meaning retract) position is along the axis perpendicular
to the currently selected plane (Z-axis for XY-plane, X-axis for YZ-plane, Y-axis for XZ-plane). Some
canned cycles use additional arguments.
For canned cycles, we will call a number “sticky” if, when the same cycle is used on several lines
of code in a row, the number must be used the first time, but is optional on the rest of the lines.
Sticky numbers keep their value on the rest of the lines if they are not explicitly programmed to be
different. The R word is always sticky.
In incremental distance mode: when the XY-plane is selected, X, Y, and R numbers are treated
as increments to the current position and Z as an increment from the Z-axis position before the
move involving Z takes place; when the YZ or XZ-plane is selected, treatment of the axis words is
analogous. In absolute distance mode, the X, Y, R, and Z numbers are absolute positions in the
current coordinate system.
The L number is optional and represents the number of repeats. L = 0 is not allowed. If the repeat
feature is used, it is normally used in incremental distance mode, so that the same sequence of
motions is repeated in several equally spaced places along a straight line. In absolute distance
mode, L > 1 means “do the same cycle in the same place several times,” Omitting the L word is
equivalent to specifying L = 1. The L number is not sticky.
When L > 1 in incremental mode with the XY-plane selected, the X and Y positions are determined
by adding the given X and Y numbers either to the current X and Y positions (on the first go-around)
or to the X and Y positions at the end of the previous go-around (on the repetitions). The R and Z
positions do not change during the repeats.
The height of the retract move at the end of each repeat (called “clear Z” in the descriptions below)
is determined by the setting of the retract mode: either to the original Z position (if that is above the
R position and the retract mode is G98, OLD_Z), or otherwise to the R position. See Section 11.35
It is an error if:
When the XY plane is active, the Z number is sticky, and it is an error if:
• the Z number is missing and the same canned cycle was not already active,
• or the R number is less than the Z number.
When the XZ plane is active, the Y number is sticky, and it is an error if:
• the Y number is missing and the same canned cycle was not already active,
• or the R number is less than the Y number.
When the YZ plane is active, the X number is sticky, and it is an error if:
• the X number is missing and the same canned cycle was not already active,
• or the R number is less than the X number.
At the very beginning of the execution of any of the canned cycles, with the XY-plane selected, if the
current Z position is below the R position, the Z-axis is traversed to the R position. This happens
only once, regardless of the value of L.
In addition, at the beginning of the first cycle and each repeat, the following one or two moves are
made
If the XZ or YZ plane is active, the preliminary and in-between motions are analogous.
Example 1. Suppose the current position is (1, 2, 3) and the XY-plane has been selected, and the
following line of NC code is interpreted.
This calls for absolute distance mode (G90) and OLD_Z retract mode (G98) and calls for the G81
drilling cycle to be performed once. The X number and X position are 4. The Y number and Y
position are 5. The Z number and Z position are 1.5. The R number and clear Z are 2.8. Old Z is 3.
The following moves take place.
CHAPTER 11. G CODES 85
Example 2. Suppose the current position is (1, 2, 3) and the XY-plane has been selected, and the
following line of NC code is interpreted.
This calls for incremental distance mode (G91) and OLD_Z retract mode (G98) and calls for the G81
drilling cycle to be repeated three times. The X number is 4, the Y number is 5, the Z number is
-0.6 and the R number is 1.8. The initial X position is 5 (=1+4), the initial Y position is 7 (=2+5), the
clear Z position is 4.8 (=1.8+3), and the Z position is 4.2 (=4.8-0.6). Old Z is 3.
The first move is a traverse along the Z-axis to (1,2,4.8), since old Z < clear Z.
The first repeat consists of 3 moves.
The second repeat consists of 3 moves. The X position is reset to 9 (=5+4) and the Y position to 12
(=7+5).
The third repeat consists of 3 moves. The X position is reset to 13 (=9+4) and the Y position to 17
(=12+5).
The G83 cycle (often called peck drilling) is intended for deep drilling or milling with chip breaking.
The retracts in this cycle clear the hole of chips and cut off any long stringers (which are common
when drilling in aluminum). This cycle takes a Q number which represents a “delta” increment
along the Z-axis. Program G83 X- Y- Z- A- B- C- R- L- Q-
It is an error if:
This code is currently unimplemented in EMC2. It is accepted, but the behavior is undefined. See
section11.12
The G85 cycle is intended for boring or reaming, but could be used for drilling or milling. Program
G85 X- Y- Z- A- B- C- R- L-
The G86 cycle is intended for boring. This cycle uses a P number for the number of seconds to dwell.
Program G86 X- Y- Z- A- B- C- R- L- P-
2. Move the Z-axis only at the current feed rate to the Z position.
3. Dwell for the P number of seconds.
4. Stop the spindle turning.
CHAPTER 11. G CODES 87
The spindle must be turning before this cycle is used. It is an error if:
This code is currently unimplemented in EMC2. It is accepted, but the behavior is undefined.
This code is currently unimplemented in EMC2. It is accepted, but the behavior is undefined.
The G89 cycle is intended for boring. This cycle uses a P number, where P specifies the number of
seconds to dwell. program G89 X- Y- Z- A- B- C- R- L- P-
2. Move the Z-axis only at the current feed rate to the Z position.
3. Dwell for the P number of seconds.
4. Retract the Z-axis at the current feed rate to clear Z.
Interpretation of RS274/NGC code can be in one of two distance modes: absolute or incremental.
To go into absolute distance mode, program G90. In absolute distance mode, axis numbers (X,
Y, Z, A, B, C) usually represent positions in terms of the currently active coordinate system. Any
exceptions to that rule are described explicitly in this Section 11.21.
To go into incremental distance mode, program G91. In incremental distance mode, axis numbers
(X, Y, Z, A, B, C) usually represent increments from the current values of the numbers.
I and J numbers always represent increments, regardless of the distance mode setting. K numbers
represent increments in all but one usage (see Section 11.28), where the meaning changes with
distance mode.
CHAPTER 11. G CODES 88
When G92 is executed, the origin of the currently active coordinate system moves. To do this, origin
offsets are calculated so that the coordinates of the current point with respect to the moved origin
are as specified on the line containing the G92. In addition, parameters 5211 to 5216 are set to the
X, Y, Z, A, B, and C-axis offsets. The offset for an axis is the amount the origin must be moved so
that the coordinate of the controlled point on the axis has the specified value.
Here is an example. Suppose the current point is at X=4 in the currently specified coordinate system
and the current X-axis offset is zero, then G92 x7 sets the X-axis offset to -3, sets parameter 5211
to -3, and causes the X-coordinate of the current point to be 7.
The axis offsets are always used when motion is specified in absolute distance mode using any of
the nine coordinate systems (those designated by G54 - G59.3). Thus all nine coordinate systems
are affected by G92.
Being in incremental distance mode has no effect on the action of G92.
Non-zero offsets may be already be in effect when the G92 is called. If this is the case, the new value
of each offset is A+B, where A is what the offset would be if the old offset were zero, and B is the old
offset. For example, after the previous example, the X-value of the current point is 7. If G92 x9 is
then programmed, the new X-axis offset is -5, which is calculated by [[7-9] + -3].
To reset axis offsets to zero, program G92.1 or G92.2. G92.1 sets parameters 5211 to 5216 to zero,
whereas G92.2 leaves their current values alone.
To set the axis offset values to the values given in parameters 5211 to 5216, program G92.3.
You can set axis offsets in one program and use the same offsets in another program. Program G92
in the first program. This will set parameters 5211 to 5216. Do not use G92.1 in the remainder
of the first program. The parameter values will be saved when the first program exits and restored
when the second one starts up. Use G92.3 near the beginning of the second program. That will
restore the offsets saved in the first program. If other programs are to run between the the program
that sets the offsets and the one that restores them, make a copy of the parameter file written by
the first program and use it as the parameter file for the second program.
Three feed rate modes are recognized: units per minute, inverse time, and units per revolution.
Program G94 to start the units per minute mode. Program G93 to start the inverse time mode.
Program G95 to start the units per revolution mode.
In units per minute feed rate mode, an F word is interpreted to mean the controlled point should
move at a certain number of inches per minute, millimeters per minute, or degrees per minute,
depending upon what length units are being used and which axis or axes are moving.
In units per revolution mode, an F word is interpreted to mean the controlled point should move a
certain number of inches per revolution of the spindle, depending on what length units are being
CHAPTER 11. G CODES 89
used and which axis or axes are moving. G95 is not suitable for threading, for threading use G33
or G76.
In inverse time feed rate mode, an F word means the move should be completed in [one divided by
the F number] minutes. For example, if the F number is 2.0, the move should be completed in half
a minute.
When the inverse time feed rate mode is active, an F word must appear on every line which has a
G1, G2, or G3 motion, and an F word on a line that does not have G1, G2, or G3 is ignored. Being
in inverse time feed rate mode does not affect G0 (rapid traverse) motions. It is an error if:
• inverse time feed rate mode is active and a line with G1, G2, or G3 (explicitly or implicitly) does
not have an F word.
• A new feed rate is not specified after switching to G94 or G95
Two spindle control modes are recognized: revolutions per minute, and constant surface speed.
Program G96 D- S- to select constant surface speed of S feet per minute (if G20 is in effect) or
meters per minute (if G21 is in effect). The maximum spindle speed is set by the D- number in
revolutions per minute.
Program G97 to select RPM mode.
It is an error if:
• A feed move is specified in G96 mode while the spindle is not turning
When the spindle retracts during canned cycles, there is a choice of how far it retracts: (1) retract
perpendicular to the selected plane to the position indicated by the R word, or (2) retract perpen-
dicular to the selected plane to the position that axis was in just before the canned cycle started
(unless that position is lower than the position indicated by the R word, in which case use the R
word position).
To use option (1), program G99. To use option (2), program G98. Remember that the R word has
different meanings in absolute distance mode and incremental distance mode.
Chapter 12
M Codes
12.1 M0, M1, M2, M30, M60 Program Stopping and Ending
To pause a running program temporarily (regardless of the setting of the optional stop switch),
program M0. EMC2 remains in Auto Mode so MDI and other manual actions are not enabled.
To pause a running program temporarily (but only if the optional stop switch is on), program M1.
EMC2 remains in Auto Mode so MDI and other manual actions are not enabled.
It is OK to program M0 and M1 in MDI mode, but the effect will probably not be noticeable, because
normal behavior in MDI mode is to stop after each line of input, anyway.
To exchange pallet shuttles and then stop a running program temporarily (regardless of the setting
of the optional stop switch), program M60.
If a program is stopped by an M0, M1, or M60, pressing the cycle start button will restart the program
at the following line.
To end a program, program M2. To exchange pallet shuttles and then end a program, program M30.
Both of these commands have the following effects.
1. Axis offsets are set to zero (like G92.2) and origin offsets are set to the default (like G54).
2. Selected plane is set to CANON_PLANE_XY (like G17).
No more lines of code in an RS274/NGC file will be executed after the M2 or M30 command is
executed. Pressing cycle start will start the program back at the beginning of the file.
90
CHAPTER 12. M CODES 91
To start the spindle turning clockwise at the currently programmed speed, program M3.
To start the spindle turning counterclockwise at the currently programmed speed, program M4.
To stop the spindle from turning, program M5.
It is OK to use M3 or M4 if the spindle speed is set to zero. If this is done (or if the speed override
switch is enabled and set to zero), the spindle will not start turning. If, later, the spindle speed is
set above zero (or the override switch is turned up), the spindle will start turning. It is OK to use M3
or M4 when the spindle is already turning or to use M5 when the spindle is already stopped.
If the hal component hal_manualtoolchange is loaded M6 will stop the spindle and prompt the user
to change the tool. For more information on hal_manualtoolchange see Section (3.8)
To change a tool in the spindle from the tool currently in the spindle to the tool most recently
selected (using a T word - see Section 14.3), program M6. When the tool change is complete:
• If the selected tool was not in the spindle before the tool change, the tool that was in the spindle
(if there was one) will be in its changer slot.
• The axis positions may be modified
• No other changes will be made. For example, coolant will continue to flow during the tool
change unless it has been turned off by an M9.
The tool change may include axis motion. It is OK (but not useful) to program a change to the tool
already in the spindle. It is OK if there is no tool in the selected slot; in that case, the spindle will
be empty after the tool change. If slot zero was last selected, there will definitely be no tool in the
spindle after a tool change.
To enable the spindle speed and feed rate override switches, program M48. To disable both switches,
program M49. See Section 7.3.1 for more details. It is OK to enable or disable the switches when
they are already enabled or disabled. These switches can also be toggled individually using M50
and M51 as described in the sections 12.6 and 12.7.
To enable the feed rate override switch, program M50 or M50 P1. To disable the switch program
M50 P0. While disabled the feed override will have no influence, and the motion will be executed at
programmed feed rate. (unless there is an adaptive feed rate override active).
To enable the spindle speed override switch, program M51 or M51 P1. To disable the switch program
M51 P0. While disabled the spindle speed override will have no influence, and the spindle speed will
have the exact program specified value (using the S-word as described in 14.2).
To use an adaptive feed, program M52 or M52 P1. To stop using adaptive feed, program M52 P0.
When adaptive feed is enabled, some external input value is used together with the user interface
feed override value and the commanded feed rate to set the actual feed rate. In EMC2, the HAL pin
motion.adaptive-feed is used for this purpose. Values on motion.adaptive-feed should range
from 0 (feed hold) to 1 (full speed).
To enable the feed stop switch, program M53 or M53 P1. To disable the switch program M53 P0.
Enabling the feed stop switch will allow motion to be interrupted by means of the feedstop control.
In EMC2, the HAL pin motion.feed-hold is used for this purpose. Values of 1 will cause the
motion to stop (if M53 is active).
To control a digital output bit, program M- P-, where the M-word ranges from 62 to 65, and the
P-word ranges from 0 to an implementation-defined maximum- currently this is 3 in EMC2. These
outputs are not changed in realtime and thus should not be used for timing-critical applications.
To control a digital input bit, program M66 P- E- L- Q- , where the P-word and the E-word ranges
from 0 to an implementation-defined maximum. Only one of the P or E words must be present. It
is an error if they are both missing.
• The Q-word specifies the timeout for the waiting. If the timeout is exceeded, the wait is inter-
rupt, and the variable #5399 will be holding the value -1.
• Mode 0 is the only one permitted for an analog input.
M66 wait on an input stops further execution of the program, until the selected event (or the pro-
grammed timeout) occurs. It is an error to program a timeout value of 0 with any mode different
than mode 0.
It is also an error to program M66 with both a P-word and an E-word (thus selecting both an analog
and a digital input).In EMC2 these inputs are not monitored in realtime and thus should not be
used for timing-critical applications.
To invoke a user-defined command, program M1nn P- Q- where P- and Q- are both optional.
The external program "M1nn" must be in the directory named in [DISPLAY]PROGRAM_PREFIX in
the ini file and is executed with the P and Q values as its two arguments. Execution of the
RS274NGC file pauses until the invoked program exits. Any valid executable file can be used.
The error "Unknown M code used" denotes one of the following
For example to open and close a collet closer that is controlled by a paraport pin using a bash script
file using M101 and M102. Create two files called M101 and M102. Set them as executable files
(typically right click/properties/permissions) before running EMC2.
M101
CHAPTER 12. M CODES 94
#!/bin/bash
# file to turn on paraport pin 14 to open the collet closer
halcmd setp parport.0.pin-14-out True
exit 0
M102
#!/bin/bash
# file to turn off paraport pin 14 to open the collet closer
halcmd setp parport.0.pin-14-out False
exit 0
Chapter 13
O Codes
O-codes provide for flow control in NC programs. Each block has an associated number, which is
the number used after O. Care must be taken to properly match the O-numbers.
The behavior is undefined if
Inside a subroutine, O- return can be executed. This immediately returns to the calling code, just
as though O- endsub was encountered.
O- call takes up to 30 optional arguments, which are passed to the subroutine as #1, #2, ..., #N.
Parameters from #N+1 to #30 have the same value as in the calling context. On return from the
subroutine, the values of parameters #1 through #30 (regardless of the number of arguments) will
be restored to the values they had before the call.
Because “1 2 3” is parsed as the number 123, the parameters must be enclosed in square brackets.
The following calls a subroutine with 3 arguments:
Subroutine bodies may not be nested. They may only be called after they are defined. They may
be called from other functions, and may call themselves recursively if it makes sense to do so. The
maximum subroutine nesting level is 10.
Subroutines do not have “return values”, but they may change the value of parameters above #30
and those changes will be visible to the calling code. Subroutines may also change the value of
global named parameters.
95
CHAPTER 13. O CODES 96
The “while loop” has two structures: while/endwhile, and do/while. In each case, the loop is exited
when the “while” condition evaluates to false.
Inside a while loop, O- break immediately exits the loop, and O- continue immediately skips to
the next evaluation of the while condition. If it is still true, the loop begins again at the top. If it is
false, it exits the loop.
The “if” conditional executes one group of statements if a condition is true and another if it is false.
13.4 Indirection
O[#101+2] call
In O-words, Parameters (section 8.3.2), Expressions (section 8.3.4), Binary Operators (section 8.3.5)
and Functions (table 8.3) are particularly useful.
Chapter 14
Other Codes
To set the feed rate, program F- . The application of the feed rate is as described in Section 7.2.5,
unless inverse time feed rate mode is in effect, in which case the feed rate is as described in Section
11.33.
To set the speed in revolutions per minute (rpm) of the spindle, program S- . The spindle will turn
at that speed when it has been programmed to start turning. It is OK to program an S word whether
the spindle is turning or not. If the speed override switch is enabled and not set at 100%, the speed
will be different from what is programmed. It is OK to program S0; the spindle will not turn if that
is done. It is an error if:
As described in Section 11.25, if a G84 (tapping) canned cycle is active and the feed and speed
override switches are enabled, the one set at the lower setting will take effect. The speed and feed
rates will still be synchronized. In this case, the speed may differ from what is programmed, even if
the speed override switch is set at 100%.
To select a tool, program T-, where the T number is the carousel slot for the tool. The tool is not
changed until an M6 is programmed (see Section 12.3). The T word may appear on the same line as
the M6 or on a previous line. It is OK, but not normally useful, if T words appear on two or more
lines with no tool change. The carousel may move a lot, but only the most recent T word will take
effect at the next tool change. It is OK to program T0; no tool will be selected. This is useful if you
want the spindle to be empty after a tool change. It is an error if:
97
CHAPTER 14. OTHER CODES 98
On some machines, the carousel will move when a T word is programmed, at the same time ma-
chining is occurring. On such machines, programming the T word several lines before a tool change
will save time. A common programming practice for such machines is to put the T word for the next
tool to be used on the line after a tool change. This maximizes the time available for the carousel to
move.
xxxx
Chapter 15
99
CHAPTER 15. DIFFERENCES BETWEEN EMC2 GCODE AND RS274NGC 100
M62 and M63 are not currently implemented, but may be added to a future release of emc2.
15.2.2 G38.2
The probe tip is not retracted after a G38.2 movement. This retraction move may be added in a
future release of emc2.
15.2.3 O-codes
The RS274NGC spec says “it is expected that” all tool lengths will be positive. However, G43 works
for negative tool lengths.
G43 tool length compensation can offset the tool in both the X and Z dimensions. This feature is
primarily useful on lathes.
EMC2 allows specification of a tool diameter and, if in lathe mode, orientation in the gcode. The
format is G41.1/G42.1 D L, where D is diameter and L (if specified) is the lathe tool orientation.
CHAPTER 15. DIFFERENCES BETWEEN EMC2 GCODE AND RS274NGC 101
In ngc, this is not allowed. In EMC2, it sets length offsets for the currently loaded tool. If no tool is
currently loaded, it is an error. This change was made so the user doesn’t have to specify the tool
number in two places for each tool change, and because it’s consistent with the way G41/G42 work
when the D word is not specified.
EMC2 allows machines with up to 9 axes by defining an additional set of 3 linear axes known as U,
V and W
Chapter 16
Tool length and diameter may come from the tool file (see section 7.4) or from a word specified when
tool compensation is enabled.
Tool compensation can cause problems for the best of nc code programmers. But it can be a
powerful aid when used to help an operator get a part to size. By setting and reseting length and
diameter of tools in a single tool table, offsets can be made durring a production run that allow for
variation in tool size, or for minor deviation from the programmed distances and size. And these
changes can be made without the operator having to search through and change numbers in a
program file.
Throughout this unit you will find ocasional references to cannonical functions where these are nec-
essary for the reader to understand how a tool offset works in a specific situation. These references
are intended to give the reader a sense of sequence rather than requiring the reader to understand
the way that cannonical functions themselves work within the EMC.
Tool length offsets are given as positive numbers in the tool table. A tool length offset is programmed
using G43 Hn, where n is the desired table index. It is expected that all entries in the tool table
will be positive. The H number is checked for being a non-negative integer when it is read. The
interpreter behaves as follows.
1. If G43 Hn is programmed, A USE_TOOL_LENGTH_OFFSET(length) function call is made (where
length is the value of the tool length offset entry in the tool table whose index is n), tool_length_offset
is reset in the machine settings model, and the value of current_z in the model is adjusted. Note
that n does not have to be the same as the slot number of the tool currently in the spindle.
2. If G49 is programmed, USE_TOOL_LENGTH_OFFSET(0.0) is called, tool_length_offset is reset to
0.0 in the machine settings model, and the value of current_z in the model is adjusted. The effect
of tool length compensation is illustrated in the screen shot below. Notice that the length of the
tool is subtracted from the z setting so that the tool tip appears at the programmed setting. You
should note that the effect of tool length compensation is immediate when you view the z position
as a relative coordinate but it does affect actual machine position until you program a z move.
102
CHAPTER 16. TOOL FILE AND COMPENSATION 103
The effect of this is that in most cases the machine will pick up the offset as a ramp during the next
xyz move after the g43 word.
The cutter radius compensation capabilities of the interpreter enable the programmer to specify that
a cutter should travel to the right or left of an open or closed contour in the XY-plane composed
of arcs of circles and straight line segments. The contour may be the outline of material not to be
machined away, or it may be a tool path to be followed by an exactly sized tool. This figure shows
two examples of the path of a tool cutting using cutter radius compensation so that it leaves a
triangle of material remaining.
Z axis motion may take place while the contour is being followed in the XY plane. Portions of the
contour may be skipped by retracting the Z axis above the part, following the contour to the next
CHAPTER 16. TOOL FILE AND COMPENSATION 104
point at which machining should be done, and re-extending the Z-axis. These skip motions may be
performed at feed rate (G1) or at traverse rate (G0). Inverse time feed rate (G93) or units per minute
feed rate (G94) may be used with cutter radius compensation. Under G94, the feed rate will apply
to the actual path of the cutter tip, not to the programmed contour.
Programming Instructions
• To start cutter radius compensation, program either G41 (for keeping the tool to the left of the
contour) or G42 (for keeping the tool to the right of the contour). In Figure 7, for example, if
G41 were programmed, the tool would stay left and move clockwise around the triangle, and
if G42 were programmed, the tool would stay right and move counterclockwise around the
triangle.
• To stop cutter radius compensation, program G40.
• If G40, G41, or G42 is programmed in the same block as tool motion, cutter compensation
will be turned on or off before the motion is made. To make the motion come first, the motion
must be programmed in a separate, previous block.
D Number
The current interpreter requires a D number on each line that has the G41 or G42 word. The value
specified with D must be a non-negative integer. It represents the slot number of the tool whose
radius (half the diameter given in the tool table) will be used, or it may be zero (which is not a slot
number). If it is zero, the value of the radius will also be zero. Any slot in the tool table may be
selected this way. The D number does not have to be the same as the slot number of the tool in the
spindle.
Tool Table
Cutter radius compensation uses data from the machining center’s tool table. For each slot in the
tool carrousel, the tool table contains the diameter of the tool in that slot (or the difference between
the actual diameter of the tool in the slot and its nominal value). The tool table is indexed by slot
number. How to put data into the table when using the stand-alone interpreter is discussed in the
tool table page.
• The contour given in the NC code is the edge of material that is not to be machined away. We
will call this type a "material edge contour".
• The contour given in the NC code is the tool path that would be followed by a tool of exactly
the correct radius. We will call this type a "tool path contour".
The interpreter does not have any setting that determines which type of contour is used, but the
description of the contour will differ (for the same part geometry) between the two types and the
values for diameters in the tool table will be different for the two types.
CHAPTER 16. TOOL FILE AND COMPENSATION 105
When the contour is the edge of the material, the outline of the edge is described in the NC program.
For a material edge contour, the value for the diameter in the tool table is the actual value of the
diameter of the tool. The value in the table must be positive. The NC code for a material edge
contour is the same regardless of the (actual or intended) diameter of the tool.
Example 1 :
Here is an NC program which cuts material away from the outside of the triangle in figure above. In
this example, the cutter compensation radius is the actual radius of the tool in use, which is 0.5,
The value for the diameter in the tool table is twice the radius, which is 1.0.
N0010 G41 G1 X2 Y2 (turn compensation on and make entry move)
N0020 Y-1 (follow right side of triangle)
N0030 X-2 (follow bottom side of triangle)
N0040 X2 Y2 (follow hypotenuse of triangle)
N0050 G40 (turn compensation off)
This will result in the tool following a path consisting of an entry move and the path shown on
the left going clockwise around the triangle. Notice that the coordinates of the triangle of material
appear in the NC code. Notice also that the tool path includes three arcs which are not explicitly
programmed; they are generated automatically.
When the contour is a tool path contour, the path is described in the NC program. It is expected
that (except for during the entry moves) the path is intended to create some part geometry. The path
may be generated manually or by a post-processor, considering the part geometry which is intended
to be made. For the interpreter to work, the tool path must be such that the tool stays in contact
with the edge of the part geometry, as shown on the left side of Figure 7. If a path of the sort shown
on the right of Figure 7 is used, in which the tool does not stay in contact with the part geometry all
the time, the interpreter will not be able to compensate properly when undersized tools are used.
For a tool path contour, the value for the cutter diameter in the tool table will be a small positive
number if the selected tool is slightly oversized and will be a small negative number if the tool is
slightly undersized. As implemented, if a cutter diameter value is negative, the interpreter compen-
sates on the other side of the contour from the one programmed and uses the absolute value of the
given diameter. If the actual tool is the correct size, the value in the table should be zero.
Tool Path Contour example
Suppose the diameter of the cutter currently in the spindle is 0.97, and the diameter assumed in
generating the tool path was 1.0. Then the value in the tool table for the diameter for this tool
should be -0.03. Here is an NC program which cuts material away from the outside of the triangle
in the figure.
N0010 G1 X1 Y4.5 (make alignment move)
N0020 G41 G1 Y3.5 (turn compensation on and make first entry move)
N0030 G3 X2 Y2.5 I1 (make second entry move)
N0040 G2 X2.5 Y2 J-0.5 (cut along arc at top of tool path)
N0050 G1 Y-1 (cut along right side of tool path)
N0060 G2 X2 Y-1.5 I-0.5 (cut along arc at bottom right of tool path)
N0070 G1 X-2 (cut along bottom side of tool path)
N0080 G2 X-2.3 Y-0.6 J0.5 (cut along arc at bottom left of tool path)
N0090 G1 X1.7 Y2.4 (cut along hypotenuse of tool path)
N0100 G2 X2 Y2.5 I0.3 J-0.4 (cut along arc at top of tool path)
N0110 G40 (turn compensation off)
CHAPTER 16. TOOL FILE AND COMPENSATION 106
This will result in the tool making an alignment move and two entry moves, and then following
a path slightly inside the path shown on the left in Figure 7 going clockwise around the triangle.
This path is to the right of the programmed path even though G41 was programmed, because the
diameter value is negative.
The interpreter will issue the following messages involving cutter radius compensation.
In particular, the interpreter treats concave corners and concave arcs into which the circle will not
fit as errors, since the circle cannot be kept tangent to the contour in these situations. This error
detection does not limit the shapes which can be cut, but it does require that the programmer
specify the actual shape to be cut (or path to be followed), not an approximation. In this respect,
the interpreter differs from interpreters used with many other controllers, which often allow these
errors silently and either gouge the part or round the corner. If cutter radius compensation has
already been turned on, it cannot be turned on again. It must be turned off first; then it can be
turned on again. It is not necessary to move the cutter between turning compensation off and back
on, but the move after turning it back on will be treated as a first move, as described below.
CHAPTER 16. TOOL FILE AND COMPENSATION 107
It is not possible to change from one cutter radius index to another while compensation is on
because of the combined effect of rules 4 and 11. It is also not possible to switch compensation
from one side to another while compensation is on. If the tool is already covering up the next XY
destination point when cutter radius compensation is turned on, the gouging message is given when
the line of NC code which gives the point is reached. In this situation, the tool is already cutting
into material it should not cut.
If a D word is programmed that is larger than the number of tool carrousel slots, an error message
is given. In the current implementation, the number of slots is 68.
The error message. "two G Codes Used from Same Modal Group," is a generic message used for
many sets of G codes. As applied to cutter radius compensation, it means that more than one of
G40, G41, and G42 appears on a line of NC code. This is not allowed.
First Move
If the first move after cutter radius compensation has been turned on is an arc, the arc which is
generated is derived from an auxiliary arc which has its center at the programmed center point,
passes through the programmed end point, and is tangent to the cutter at its current location. If
the auxiliary arc cannot be constructed, an error is signalled. The generated arc moves the tool so
that it stays tangent to the auxiliary arc throughout the move. This is shown in Figure 10.
Regardless of whether the first move is a straight line or an arc, the Z axis may also move at the same
time. It will move linearly, as it does when cutter radius compensation is not being used.Rotary axis
motions (A, B, and C axes) are allowed with cutter radius compensation, but using them would be
very unusual.
After the entry moves of cutter radius compensation, the interpreter keeps the tool tangent to the
programmed path on the appropriate side. If a convex corner is on the path, an arc is inserted to
go around the corner. The radius of the arc is half the diameter given in the tool table.
When cutter radius compensation is turned off, no special exit move takes place. The next move is
what it would have been if cutter radius compensation had never been turned on and the previous
move had placed the tool at its current position.
CHAPTER 16. TOOL FILE AND COMPENSATION 108
In general, an alignment move and two entry moves are needed to begin compensation correctly.
However, where the programmed contour is a material edge contour and there is a convex corner on
the contour, only one entry move (plus, possibly, a pre-entry move) is needed. The general method,
which will work in all situations, is described first. We assume here that the programmer knows
what the contour is already and has the job of adding entry moves.
General Method
The general method includes programming an alignment move and two entry moves. The entry
moves given above will be used as an example. Here is the relevant code again:
N0010 G1 X1 Y4.5 (make aligment move to point C)
N0020 G41 G1 Y3.5 (turn compensation on and make first entry move to point B)
N0030 G3 X2 Y2.5 I1 (make second entry move to point A)
See Figure 11. The figure shows the two entry moves but not the alignment move.
First, pick a point A on the contour where it is convenient to attach an entry arc. Specify an arc
outside the contour which begins at a point B and ends at A tangent to the contour (and going in
the same direction as it is planned to go around the contour). The radius of the arc should be larger
than half the diameter given in the tool table. Then extend a line tangent to the arc from B to some
point C, located so that the line BC is more than one radius long.
In this example, the arc AB and the line BC are fairly large, but they need not be. For a tool path
contour, the radius of arc AB need only be slightly larger than the maximum possible deviation of the
radius of the tool from the exact size. Also for a tool path contour, the side chosen for compensation
should be the one to use if the tool is oversized. As mentioned earlier, if the tool is undersized, the
interpreter will switch sides.
Simple Method
If the contour is a material edge contour and there is a convex corner somewhere on the contour, a
simpler method of making an entry is available. See Figure 12.
First, pick a convex corner, D. Decide which way you want to go along the contour from D. In our
example we are keeping the tool to the left of the contour and going next towards F. Extend the line
FD (if the next part of the contour is an arc, extend the tangent to arc FD from D) to divide the area
outside the contour near D into two regions. Make sure the center of the tool is currently in the
region on the same side of the extended line as the material inside the contour near D. If not, move
the tool into that region. In the example, point E represents the current location of the center of the
tool. Since it is on the same side of line DF as the shaded triangle, no additional move is needed.
Now write a line of NC code that turns compensation on and moves to point D
CHAPTER 16. TOOL FILE AND COMPENSATION 109
The complete set of canonical functions includes functions which turn cutter radius on and off,
so that cutter radius compensation can be performed in the controller executing the canonical
functions. In the interpreter, however, these commands are not used. Compensation is done by
the interpreter and reflected in the output commands, which continue to direct the motion of the
center of the cutter tip. This simplifies the job of the motion controller while making the job of the
interpreter a little harder.
The interpreter allows the entry and exit moves to be arcs. The behavior for the intermediate moves
is the same, except that some situations treated as errors in the interpreter are not treated as errors
in other machine controls.
Data for Cutter Radius Compensation
The interpreter machine model keeps three data items for cutter radius compensation: the setting
itself (right, left, or off), program_x, and program_y. The last two represent the X and Y positions
which are given in the NC code while compensation is on. When compensation is off, these both
are set to a very small number (10 -20 ) whose symbolic value (in a #define) is "unknown". The
interpreter machine model uses the data items current_x and current_y to represent the position of
the center of the tool tip (in the currently active coordinate system) at all times.
All further system-specific information refers to NIST’s EMC program, but much of it applies to
most modern CNC controls. My method of checking these programs is to first select tool zero, which
always has a diameter of zero, so offset commands are essentially ignored. Then, I tape a sheet of
paper to a piece of material that sits level in my vise, as a sort of platen. I install a spring-loaded pen
in the spindle. This is a standard ballpoint pen refill cartridge made of metal, in a 1/2" diameter
steel housing. It has a spring that loads the pen against the front, and a ’collet’ at the front that
allows the pen to retract against the spring, but keeps it centered within a few thousandths of an
inch. I run the program with tool zero selected, and it draws a line at the actual part’s outline. (see
figure below) Then, I select a tool with the diameter of the tool I intend to use, and run the program
again. (Note that Z coordinates in the program may need to be changed to prevent plunging the pen
through the platen.) Now, I get to see whether the G41 or G42 compensation that I specified will cut
on the desired side of the part. If it doesn’t, I then edit the opposite compensation command into
the program, and try again. Now, with the tool on the correct side of the work, you get to see if there
are any places where the tool is ’too fat’ to fit in a concave part of the surface. My old Allen-Bradley
7320 was pretty forgiving on this, but EMC is a complete stickler. If you have ANY concavity where
CHAPTER 16. TOOL FILE AND COMPENSATION 110
two lines meet at less than 180 degrees on the side that a tool of finite size cuts on, EMC will stop
with an error message there. Even if the gouge will be .0001" deep. So, I always make the approach
on the lead-in and lead-out moves such that they just nip the corner of the part a tiny bit, providing
an angle just over 180 degrees, so that EMC won’t squawk. This requires some careful adjustment
of the starting and ending points, which are not compensated by cutter radius, but must be chosen
with an approximate radius in mind.
The operative commands are :
G40 - Cancel Cutter compensation
G41 - Cutter Compensation, Tool Left of Path
G42 - Cutter Compensation, Tool Right of Path
Here is a short file that cuts one side of a part with multiple convex and concave arcs, and several
straight cuts, too. It is to clamp a high speed drilling spindle to the side of the main Bridgeport
spindle. Most of these commands are straight from Bobcad/CAM, but lines N15 and N110 were
added by me, and some of the coordinates around those lines had to be fudged a bit by me.
N10 G01 G40 X-1.3531 Y3.4
N15 F10 G17 G41 D4 X-0.7 Y3.1875 (COMP LEAD IN)
N20 X0. Y3.1875
N40 X0.5667 F10
N50 G03 X0.8225 Y3.3307 R0.3
N60 G02 X2.9728 Y4.3563 R2.1875
N70 G01 X7.212 Y3.7986
N80 G02 X8.1985 Y3.2849 R1.625
N90 G03 X8.4197 Y3.1875 R0.3
N100 G01 X9.
N110 G40 X10.1972 Y3.432 (COMP LEAD OUT
N220 M02
Line 15 contains G41 D4, which means that the diameter of the tool described as tool #4 in the tool
table will be used to offset the spindle by 1/2 the diameter, which is, of course, the tool’s radius.
Note that the line with the G41 command contains the endpoint of the move where the radius
compensation is interpolated in. What this means is that at the beginning of this move, there is
no compensation in effect, and at the end, the tool is offset by 100% of the selected tool radius.
Immediately after the G41 is D4, meaning that the offset is by the radius of tool number 4 in the
tool table. Note that tool DIAMETERS are entered in the tool table. (Jon’s tool diameter is about
0.4890)
But, note that in line 110, where the G40 ’cancel cutter compensation’ command is, that cutter
compensation will be interpolated out in this move. The way I have these set up, the moves in lines
15 and 110 are almost exactly parallel to the X axis, and the difference in Y coordinates is to line
the tool up outside the portion of the program where cutter compensation is in force.
Some other things to note are that the program starts with a G40, to turn off any compensation
that was in effect. This saves a lot of hassle when the program stops due to a concavity error, but
CHAPTER 16. TOOL FILE AND COMPENSATION 111
leaves the compensation turned on. Also note in line 15 that G17 is used to select the XY plane
for circular interpolation. I have used the radius form of arc center specification rather than the I,J
form. EMC is very picky about the radius it computes from I,J coordinates, and they must match at
the beginning and end of the move to within 10^-11 internal units, so you will have lots of problems
with arbitrary arcs. Usually, if you do an arc of 90 degrees, centered at (1.0,1.0) with a radius of
1", everything will go fine, but if it has a radius that can not be expressed exactly in just a few
significant digits, or the arc is a strange number of degrees, then there will be trouble with EMC.
The R word clears up all that mess, and is a lot easier to work with, anyway. If the arc is more than
180 degrees, R should be negative.
This unit borrows heavily from the published works of Tom Kramer and Fred Proctor at NIST and
the cutter compensation web page of Jon Elson.
Papers by Tom Kramer and Fred Proctor
http://www.isd.mel.nist.gov/personnel/kramer/publications.html
http://www.isd.mel.nist.gov/personnel/kramer/pubs/RS274NGC_22.pdf
http://www.isd.mel.nist.gov/personnel/kramer/pubs/RS274VGER_11.pdf
Pages by Jon Elson
http://artsci.wustl.edu/~jmelson/
http://206.19.206.56/diacomp.htm
http://206.19.206.56/lencomp.htm
Chapter 17
17.1 Introduction
You have seen how handy a tool length offset can be. Having this allows the programmer to ignore
the actual tool length when writing a part program. In the same way, it is really nice to be able to
find a prominent part of a casting or block of material and work a program from that point rather
than having to take account of the location at which the casting or block will be held during the
machining.
This chapter introduces you to offsets as they are used by the EMC. These include;
112
CHAPTER 17. COORDINATE SYSTEM AND G92 OFFSETS 113
5241 0.000000
5242 0.000000
5243 0.000000
5244 0.000000
5245 0.000000
5246 0.000000
In the VAR file scheme, the first variable number stores the X offset, the second the Y offset and so
on for all six axes. There are numbered sets like this for each of the fixture offsets.
Each of the graphical interfaces has a way to set values for these offsets. You can also set these
values by editing the VAR file itself and then issuing a [reset] so that the EMC reads the new values.
For our example let’s directly edit the file so that G55 takes on the following values.
5241 2.000000
5242 1.000000
5243 -2.000000
5244 0.000000
5245 0.000000
5246 0.000000
You should read this as moving the zero positions of G55 to X = 2 units, Y= 1 unit, and Z = -2 units
away from the absolute zero position.
Once there are values assigned, a call to G55 in a program block would shift the zero reference by
the values stored. The following line would then move each axis to the new zero position. Unlike
G53, G54 through G59.3 are modal commands. They will act on all blocks of code after one of
them has been set. The program that might be run using figure 17.1 would require only a single
coordinate reference for each of the locations and all of the work to be done there. The following
code is offered as an example of making a square using the G55 offsets that we set above.
G55 G0 x0 y0 z0
g1 f2 z-0.2000
x1
CHAPTER 17. COORDINATE SYSTEM AND G92 OFFSETS 114
y1
x0
y0
g0 z0
g54 x0 y0 z0
m2
“But,” you say, “why is there a G54 in there near the end.” Many programmers leave the G54
coordinate system with all zero values so that there is a modal code for the absolute machine based
axis positions. This program assumes that we have done that and use the ending command as a
command to machine zero. It would have been possible to use g53 and arrive at the same place but
that command would not have been modal and any commands issued after it would have returned
to using the G55 offsets because that coordinate system would still be in effect.
One other variable in the VAR file becomes important when we think about offset systems. This
variable is named 5220. In the default files its value is set to 1.00000. This means that when the
EMC starts up it should use the first coordinate system as its default. If you set this to 9.00000
it would use the nineth offset system as its default for startup and reset. Any value other than an
interger (decimal really) between 1 and 9 will cause the EMC to fault on startup.
In the general programming chapter we listed a G10 command word. This command can be used
to change the values of the offsets in a coordinate system. (add here)
The way that it works has changed just a bit from the early days to the current releases. It should
be thought of as a temporary offset that is applied to all other offsets.
CHAPTER 17. COORDINATE SYSTEM AND G92 OFFSETS 115
G92 This command, when used with axis names, sets values to offset variables.
G92.1 This command sets zero values to the g92 variables.
G92.2 This command suspends but does not zero out the g92 variables.
G92.3 This command applies offset values that have been suspended.
When the commands are used as described above, they will work pretty much as you would expect.
A user must understand the correct ways that the g92 values work. They are set based
upon the location of each axis when the g92 command is invoked. The NIST document
is clear that, “To make the current point have the coordinates” x0, y0, and z0 you would
use g92 x0 y0 z0. G92 does not work from absolute machine coordinates. It works from
current location.
G92 also works from current location as modified by any other offsets that are in effect
when the g92 command is invoked. While testing for differences between work offsets
and actual offsets it was found that a g54 offset could cancel out a g92 and thus give
the appearance that no offsets were in effect. However, the g92 was still in effect for all
coordinates and did produce expected work offsets for the other coordinate systems.
It is likely that the absence of home switches and proper home procedures will result in
very large errors in the application of g92 values if they exist in the var file. Many EMC
users do not have home switches in place on their machines. For them home should be
found by moving each axis to a location and issuing the home command. When each
axis is in a known location, the home command will recalculate how the g92 values are
applied and will produce consistent results. Without a home sequence, the values are
applied to the position of the machine when the EMC begins to run.
• right mouse click on position displays of tkemc will popup a window into which you can type
a value.
• the g92 command
Both of these work from the current location of the axis to which the offset is to be applied.
Issuing g92 x y z a b c does in fact set values to the g92 variables such that each axis
takes on the value associated with its name. These values are assigned to the current
position of the machine axis. These results satisfy paragraphs one and two of the NIST
document.
G92 commands work from current axis location and add and subtract correctly to give
the current axis position the value assigned by the g92 command. The effects work even
though previous offsets are in.
So if the X axis is currently showing 2.0000 as its position a G92 x0 will set an offset of -2.0000 so
that the current location of X becomes zero. A G92 X2 will set an offset of 0.0000 and the displayed
position will not change. A G92 X5.0000 will set an offset of 3.0000 so that the current displayed
position becomes 5.0000.
CHAPTER 17. COORDINATE SYSTEM AND G92 OFFSETS 116
Sometimes the values of a G92 offset will remain in the VAR file. This can happen when a file is
aborted during processing that has G92 offsets in effect. When this happens reset or a startup will
cause them to become active again. The variables are named
5211 0.000000
5212 0.000000
5213 0.000000
5214 0.000000
5215 0.000000
5216 0.000000
where 5211 is the X axis offset and so on. If you are seeing unexpected positions as the result of
a commanded move, or unexpected numbers in the position displays when you start up, issue a
G92.1 in the MDI widow the problems should go away.
With these tests we can see that reset returns g92 to the condition that it had when the
interpreter started up. The reader should note that we have established ... that no write
of these values occurs during a normal run so if no g92 was set at the startup, none will
be read in during a reset.
It may be that this is the heart of the problem that some have experienced with differences
between the old and the new interpreter. It may well be, but I leave it to others to test,
that the old interpreter and task programs immediately wrote values to the var file and
then found those values during a reset.
On the other hand, if G92 values existed in the VAR file when the EMC started up
... starting the EMC with g92 values in the var file is that it will apply the values to current
location of each axis. If this is home position and home position is set as machine zero
everything will be correct. Once home has been established using real machine switches
or moving each axis to a known home position and issuing an axis home command, g92
commands and values work as advertised.
These tests did not study the effect of re-reading the var file while they contain numbers.
This could cause problems if g92 offsets had been removed with g92.1 but the var file still
contained the previous numbers.
It is this complexity that causes us to say that G92 values must be treated as temporary. They
should be used to set global short term offsets. The G54-59.3 coordinate systems should be used
whenever long lasting and predictable offsets are needed.
We can issue a set of commands to create offsets for the four other circles like this.
Now comes the time when we might apply a set of G92 offsets to this program. You’ll see that it is
running in each case at z0. If the mill were at the zero position, a g92 z1.0000 issued at the head
of the program would shift everything down an inch. You might also shift the whole pattern around
in the XY plane by adding some x and y offsets with g92. If you do this you should add a G92.1
command just before the m2 that ends the program. If you do not, other programs that you might
run after this one will also use that g92 offset. Furthermore it would save the g92 values when you
shut down the EMC and they will be recalled when you start up again.
Chapter 18
Lathe Specifics
This chapter attempts to bring together all the lathe specific information and is currently under
construction.
18.4 Threading
118
Part III
Examples
119
Chapter 19
G-Code Examples
After you install EMC2 several sample files are placed in the /nc_files folder. Make sure the sample
file is appropriate for your machine before running.
19.1 Probing
120
CHAPTER 19. G-CODE EXAMPLES 121
Appendices
122
Appendix A
Glossary
A listing of terms and what they mean. Some terms have a general meaning and several additional
meanings for users, installers, and developers.
Acme Screw A type of lead-screw that uses an acme thread form. Acme threads have somewhat
lower friction and wear than simple triangular threads, but ball-screws are lower yet. Most
manual machine tools use acme lead-screws.
Axis One of the computer control movable parts of the machine. For a typical vertical mill, the table
is the X axis, the saddle is the Y axis, and the quill or knee is the Z axis. Additional linear axes
parallel to X, Y, and Z are called U, V, and W respectively. Angular axes like rotary tables are
referred to as A, B, and C.
Backlash The amount of "play" or lost motion that occurs when direction is reversed in a lead
screw. or other mechanical motion driving system. It can result from nuts that are loose
on leadscrews, slippage in belts, cable slack, "wind-up" in rotary couplings, and other places
where the mechanical system is not "tight". Backlash will result in inaccurate motion, or in
the case of motion caused by external forces (think cutting tool pulling on the work piece) the
result can be broken cutting tools. This can happen because of the sudden increase in chip
load on the cutter as the work piece is pulled across the backlash distance by the cutting tool.
Backlash Compensation - Any technique that attempts to reduce the effect of backlash without
actually removing it from the mechanical system. This is typically done in software in the
controller. This can correct the final resting place of the part in motion but fails to solve
problems related to direction changes while in motion (think circular interpolation) and motion
that is caused when external forces (think cutting tool pulling on the work piece) are the source
of the motion.
Ball Screw A type of lead-screw that uses small hardened steel balls between the nut and screw
to reduce friction. Ball-screws have very low friction and backlash, but are usually quite
expensive.
Ball Nut A special nut designed for use with a ball-screw. It contains an internal passage to re-
circulate the balls from one end of the screw to the other.
CNC Computer Numerical Control. The general term used to refer to computer control of machin-
ery. Instead of a human operator turning cranks to move a cutting tool, CNC uses a computer
and motors to move the tool, based on a part program.
Coordinate Measuring Machine A Coordinate Measuring Machine is used to make many accurate
measurements on parts. These machines can be used to create CAD data for parts where no
drawings can be found, when a hand-made prototype needs to be digitized for mold making,
or to check the accuracy of machined or molded parts.
123
APPENDIX A. GLOSSARY 124
Display units The linear and angular units used for onscreen display.
DRO A Digital Read Out is a device attached to the slides of a machine tool or other device which
has parts that move in a precise manner to indicate the current location of the tool with respect
to some reference position. Nearly all DRO’s use linear quadrature encoders to pick up position
information from the machine.
EDM EDM is a method of removing metal in hard or difficult to machine or tough metals, or where
rotating tools would not be able to produce the desired shape in a cost-effective manner. An
excellent example is rectangular punch dies, where sharp internal corners are desired. Milling
operations can not give sharp internal corners with finite diameter tools. A wire EDM machine
can make internal corners with a radius only slightly larger than the wire’s radius. A ’sinker’
EDM cam make corners with a radius only slightly larger than the radius on the corner of the
convex EDM electrode.
EMC The Enhanced Machine Controller. Initially a NIST project. EMC is able to run a wide range
of motion devices.
EMCIO The module within EMC that handles general purpose I/O, unrelated to the actual motion
of the axes.
EMCMOT The module within EMC that handles the actual motion of the cutting tool. It runs as a
real-time program and directly controls the motors.
Encoder A device to measure position. Usually a mechanical-optical device, which outputs a
quadrature signal. The signal can be counted by special hardware, or directly by the par-
port with EMC2.
Feed Relatively slow, controlled motion of the tool used when making a cut.
Feed rate The speed at which a motion occurs. In manual mode, jog speed can be set from the
graphical interface. In auto or mdi mode feed rate is commanded using a (f) word. F10 would
mean ten units per minute.
Feedback A method (e.g., quadrature encoder signals) by which EMC receives information about
the position of motors
Feed rate Override A manual, operator controlled change in the rate at which the tool moves while
cutting. Often used to allow the operator to adjust for tools that are a little dull, or anything
else that requires the feed rate to be “tweaked”.
G-Code The generic term used to refer to the most common part programming language. There are
several dialects of G-code, EMC uses RS274/NGC.
GUI Graphical User Interface.
General A type of interface that allows communications between a computer and human (in
most cases) via the manipulation of icons and other elements (widgets) on a computer
screen.
EMC An application that presents a graphical screen to the machine operator allowing manip-
ulation of machine and the corresponding controlling program.
Home A specific location in the machine’s work envelope that is used to make sure the computer
and the actual machine both agree on the tool position.
ini file A text file that contains most of the information that configures EMC for a particular ma-
chine
Joint Coordinates These specify the angles between the individual joints of the machine. See also
Kinematics
APPENDIX A. GLOSSARY 125
Jog Manually moving an axis of a machine. Jogging either moves the axis a fixed amount for each
key-press, or moves the axis at a constant speed as long as you hold down the key.
kernel-space See real-time.
Kinematics The position relationship between world coordinates and joint coordinates of a ma-
chine. There are two types of kinematics. Forward kinematics is used to calculate world co-
ordinates from joint coordinates. Inverse kinematics is used for exactly opposite purpose.Note
that kinematics does not take into account, the forces, moments etc. on the machine. It is for
positioning only.
Lead-screw An screw that is rotated by a motor to move a table or other part of a machine.
Lead-screws are usually either ball-screws or acme screws, although conventional triangu-
lar threaded screws may be used where accuracy and long life are not as important as low
cost.
Machine units The linear and angular units used for machine configuration. These units are used
in the ini file. HAL pins and parameters are also generally in machine units.
MDI Manual Data Input. This is a mode of operation where the controller executes single lines of
G-code as they are typed by the operator.
NIST National Institute of Standards and Technology. An agency of the Department of Commerce
in the United States.
Offsets
Part Program A description of a part, in a language that the controller can understand. For EMC,
that language is RS-274/NGC, commonly known as G-code.
Program Units The linear and angular units used for part programs.
Rapid Fast, possibly less precise motion of the tool, commonly used to move between cuts. If the
tool meets the material during a rapid, it is probably a bad thing!
Real-time Software that is intended to meet very strict timing deadlines. Under Linux, in order to
meet these requirements it is necessary to install RTAI or RTLINUX and build the software to
run in those special environments. For this reason real-time software runs in kernel-space.
RTAI Real Time Application Interface, see https://www.rtai.org/, one of two real-time exten-
sions for Linux that EMC can use to achieve real-time performance.
RTLINUX See http://www.rtlinux.org, one of two real-time extensions for Linux that EMC can
use to achieve real-time performance.
RTAPI A portable interface to real-time operating systems including RTAI and RTLINUX
RS-274/NGC The formal name for the language used by EMC part programs.
Servo Motor
Servo Loop
Spindle On a mill or drill, the spindle holds the cutting tool. On a lathe, the spindle holds the
workpiece.
Stepper Motor A type of motor that turns in fixed steps. By counting steps, it is possible to deter-
mine how far the motor has turned. If the load exceeds the torque capability of the motor, it
will skip one or more steps, causing position errors.
TASK The module within EMC that coordinates the overall execution and interprets the part pro-
gram.
APPENDIX A. GLOSSARY 126
Tcl/Tk A scripting language and graphical widget toolkit with which EMC’s most popular GUI’s
were written.
Units See “Machine Units”, “Display Units”, or “Program Units”, above.
World Coordinates This is the absolute frame of reference. It gives coordinates in terms of a fixed
reference frame that is attached to some point (generally the base) of the machine tool.
Appendix B
Legal Section
Copyright Terms
Copyright (c) 2000 LinuxCNC.org
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU Free Documentation License, Version 1.1 or any later version published by the Free Software
Foundation; with no Invariant Sections, no Front-Cover Texts, and one Back-Cover Text: "This EMC
Handbook is the product of several authors writing for linuxCNC.org. As you find it to be of value in
your work, we invite you to contribute to its revision and growth." A copy of the license is included in
the section entitled "GNU Free Documentation License". If you do not find the license you may order
a copy from Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307
127
APPENDIX B. LEGAL SECTION 128
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively
with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to
related matters) and contains nothing that could fall directly within that overall subject. (For example, if the
Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The
relationship could be a matter of historical connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant
Sections, in the notice that says that the Document is released under this License.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts,
in the notice that says that the Document is released under this License.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specifi-
cation is available to the general public, whose contents can be viewed and edited directly and straightforwardly
with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely
available drawing editor, and that is suitable for input to text formatters or for automatic translation to a vari-
ety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose
markup has been designed to thwart or discourage subsequent modification by readers is not Transparent. A
copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format,
LATEX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML
designed for human modification. Opaque formats include PostScript, PDF, proprietary formats that can be
read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools
are not generally available, and the machine-generated HTML produced by some word processors for output
purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold,
legibly, the material this License requires to appear in the title page. For works in formats which do not have
any title page as such, "Title Page" means the text near the most prominent appearance of the work’s title,
preceding the beginning of the body of the text.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided
that this License, the copyright notices, and the license notice saying this License applies to the Document
are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You
may not use technical measures to obstruct or control the reading or further copying of the copies you make
or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies of the Document numbering more than 100, and the Document’s license notice
requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also
clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with
all words of the title equally prominent and visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these
conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as
many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include
a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a
publicly-accessible computer-network location containing a complete Transparent copy of the Document, free
of added material, which the general network-using public has access to download anonymously at no charge
using public-standard network protocols. If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain
thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy
(directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any
large number of copies, to give them a chance to provide you with an updated version of the Document.
APPENDIX B. LEGAL SECTION 129
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3
above, provided that you release the Modified Version under precisely this License, with the Modified Version
filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever
possesses a copy of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those
of previous versions (which should, if there were any, be listed in the History section of the Document). You
may use the same title as a previous version if the original publisher of that version gives permission. B. List
on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications
in the Modified Version, together with at least five of the principal authors of the Document (all of its principal
authors, if it has less than five). C. State on the Title page the name of the publisher of the Modified Version, as
the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for
your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices,
a license notice giving the public permission to use the Modified Version under the terms of this License, in
the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document’s license notice. H. Include an unaltered copy of this License.
I. Preserve the section entitled "History", and its title, and add to it an item stating at least the title, year, new
authors, and publisher of the Modified Version as given on the Title Page. If there is no section entitled "History"
in the Document, create one stating the title, year, authors, and publisher of the Document as given on its
Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve
the network location, if any, given in the Document for public access to a Transparent copy of the Document,
and likewise the network locations given in the Document for previous versions it was based on. These may
be placed in the "History" section. You may omit a network location for a work that was published at least
four years before the Document itself, or if the original publisher of the version it refers to gives permission.
K. In any section entitled "Acknowledgements" or "Dedications", preserve the section’s title, and preserve in
the section all the substance and tone of each of the contributor acknowledgements and/or dedications given
therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles.
Section numbers or the equivalent are not considered part of the section titles. M. Delete any section entitled
"Endorsements". Such a section may not be included in the Modified Version. N. Do not retitle any existing
section as "Endorsements" or to conflict in title with any Invariant Section.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections
and contain no material copied from the Document, you may at your option designate some or all of these
sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s
license notice. These titles must be distinct from any other section titles.
You may add a section entitled "Endorsements", provided it contains nothing but endorsements of your Mod-
ified Version by various parties–for example, statements of peer review or that the text has been approved by
an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a
Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover
Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the
Document already includes a cover text for the same cover, previously added by you or by arrangement made
by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on
explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for
publicity for or to assert or imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms defined in
section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections
of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in
its license notice.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may
be replaced with a single copy. If there are multiple Invariant Sections with the same name but different
contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of
the original author or publisher of that section if known, or else a unique number. Make the same adjustment
to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections entitled "History" in the various original documents,
forming one section entitled "History"; likewise combine any sections entitled "Acknowledgements", and any
sections entitled "Dedications". You must delete all sections entitled "Endorsements."
APPENDIX B. LEGAL SECTION 130
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License, and
replace the individual copies of this License in the various documents with a single copy that is included in the
collection, provided that you follow the rules of this License for verbatim copying of each of the documents in
all other respects.
You may extract a single document from such a collection, and distribute it individually under this License,
provided you insert a copy of this License into the extracted document, and follow this License in all other
respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent documents or works,
in or on a volume of a storage or distribution medium, does not as a whole count as a Modified Version
of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is
called an "aggregate", and this License does not apply to the other self-contained works thus compiled with
the Document, on account of their being thus compiled, if they are not themselves derivative works of the
Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document
is less than one quarter of the entire aggregate, the Document’s Cover Texts may be placed on covers that
surround only the Document within the aggregate. Otherwise they must appear on covers around the whole
aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of the Document under
the terms of section 4. Replacing Invariant Sections with translations requires special permission from their
copyright holders, but you may include translations of some or all Invariant Sections in addition to the original
versions of these Invariant Sections. You may include a translation of this License provided that you also
include the original English version of this License. In case of a disagreement between the translation and the
original English version of this License, the original English version will prevail.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under
this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However, parties who have received copies, or rights,
from you under this License will not have their licenses terminated so long as such parties remain in full
compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License
from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns. See http:///www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular
numbered version of this License "or any later version" applies to it, you have the option of following the terms
and conditions either of that specified version or of any later version that has been published (not as a draft)
by the Free Software Foundation. If the Document does not specify a version number of this License, you may
choose any version ever published (not as a draft) by the Free Software Foundation.
ADDENDUM: How to use this License for your documents
To use this License in a document you have written, include a copy of the License in the document and put
the following copyright and license notices just after the title page:
Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the
Free Software Foundation; with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts
being LIST, and with the Back-Cover Texts being LIST. A copy of the license is included in the section entitled
"GNU Free Documentation License".
If you have no Invariant Sections, write "with no Invariant Sections" instead of saying which ones are invariant.
If you have no Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover Texts being LIST";
likewise for Back-Cover Texts.
If your document contains nontrivial examples of program code, we recommend releasing these examples in
parallel under your choice of free software license, such as the GNU General Public License, to permit their
use in free software.
Appendix C
Index
131
Index
132
INDEX 133