ini_config.lyx

CNC 的开放码,EMC2 V2.2.8版

#LyX 1.3 created this file. For more info see http://www.lyx.org/
\lyxformat 221
\textclass book
\begin_preamble
\usepackage[plainpages=false,pdfpagelabels,colorlinks=true,linkcolor=blue]{hyperref}
\end_preamble
\language english
\inputencoding default
\fontscheme bookman
\graphics default
\float_placement !!h
\paperfontsize 10
\spacing single 
\papersize Custom
\paperpackage a4
\use_geometry 1
\use_amsmath 0
\use_natbib 0
\use_numerical_citations 0
\paperorientation portrait
\paperwidth 8.5in
\paperheight 11in
\leftmargin 1.2in
\topmargin 1in
\rightmargin 0.6in
\bottommargin 0.6in
\secnumdepth 5
\tocdepth 5
\paragraph_separation skip
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 2
\paperpagestyle default

\layout Chapter

Config Files
\layout Section

Files Used for Configuration
\layout Standard

The EMC is configured with human readable text files.
 All of these files can be read and edited in any of the common text file
 editors available with most any Linux distribution.
\begin_inset Foot
collapsed false

\layout Standard

Don't confuse a text editor with a word processor.
 A text editor like gedit or kwrite produce files that are plain text.
 They also produce lines of text that are separated from each other.
 A word processor like Open Office produce files with paragraphs and word
 wrapping and lots of embedded codes that control font size and such.
 A text editor does none of this.
\end_inset 

 You'll need to be a bit careful when you edit these files.
 Some mistakes will cause the start up to fail.
 These files are read whenever the software starts up.
 Some of them are read repeatedly while the CNC is running.
 
\layout Standard

Configuration files include
\layout Description

INI
\begin_inset LatexCommand \index{INI}

\end_inset 

 The ini file overrides defaults that are compiled into the EMC code.
 It also provides sections that are read directly by the Hardware Abstraction
 Layer.
\layout Description

HAL
\begin_inset LatexCommand \index{HAL}

\end_inset 

 The hal files start up process modules and provide linkages between EMC
 signals and specific hardware pins.
\layout Description

VAR
\begin_inset LatexCommand \index{VAR}

\end_inset 

 The var file is a way for the interpreter to save some values from one
 run to the next.
 These values are saved from one run to another but not always saved immediately.
 See the Parameters section of the G Code Manual for information on what
 each parameter is.
\layout Description

TBL
\begin_inset LatexCommand \index{TBL}

\end_inset 

 The tbl file saves tool information.
 See Tool File section of the G Code Manual.
\layout Description

NML
\begin_inset LatexCommand \index{NML}

\end_inset 

 The nml file configures the communication channels used by the EMC.
 It is normally setup to run all of the communication within a single computer
 but can be modified to communicate between several computers.
\layout Description

.emcrc
\begin_inset LatexCommand \index{.emcrc}

\end_inset 

 This file saves user specific information and is created to save the name
 of the directory when the user first selects an EMC configuration.
\begin_inset Foot
collapsed false

\layout Standard

Usually this file is in the users home directory (e.g.
 /home/user/ )
\end_inset 


\layout Standard

Items marked 
\series bold 
\noun on 
(hal)
\series default 
\noun default 
 are used only by the sample HAL files and are suggested as a good convention.
 Other items are used by EMC directly, and must always have the section
 and item names given.
\layout Chapter

INI File
\layout Section

File Layout
\layout Standard

A typical INI file follows a rather simple layout that includes;
\layout Itemize

comments.
\layout Itemize

sections, 
\layout Itemize

variables.
\layout Standard

Each of these elements is separated on single lines.
 Each end of line or newline character creates a new element.
 
\layout Subsection

Comments
\begin_inset LatexCommand \index{comments}

\end_inset 


\layout Standard

A comment line is started with a ; or a # mark.
 When the ini reader sees either of these marks at the start a line, the
 rest of the line is ignored by the software.
 Comments can be used to describe what some INI element will do.
 
\layout LyX-Code

; This is my little mill configuration file.
\newline 
; I set it up on January 12, 2006
\layout Standard

Comments can also be used to select between several values of a single variable.
 
\layout LyX-Code

# DISPLAY = tkemc
\begin_inset LatexCommand \index{tkemc}

\end_inset 


\newline 
DISPLAY = axis
\begin_inset LatexCommand \index{AXIS}

\end_inset 


\newline 
# DISPLAY = mini
\begin_inset LatexCommand \index{mini}

\end_inset 


\newline 
# DISPLAY = keystick
\begin_inset LatexCommand \index{keystick}

\end_inset 


\layout Standard

In this list, the DISPLAY
\begin_inset LatexCommand \index{DISPLAY}

\end_inset 

 variable will be set to axis because all of the others are commented out.
 If someone carelessly edits a list like this and leaves two of the lines
 uncommented, the first one encountered will be used.
\layout Standard

Note that inside a variable, the 
\begin_inset Quotes eld
\end_inset 

#
\begin_inset Quotes erd
\end_inset 

 and 
\begin_inset Quotes eld
\end_inset 

;
\begin_inset Quotes erd
\end_inset 

 characters do not denote comments:
\layout LyX-Code

INCORRECT = value     # and a comment
\layout Subsection

Sections
\layout Standard

Related parts of an ini file are separated into sections.
 A section line looks like [THIS_SECTION].
 The name of the section is enclosed in brackets.
 The order of sections is unimportant.
 The following sections are used by EMC:
\layout Itemize

[EMC] general information (
\begin_inset LatexCommand \ref{sub:[EMC]-Section}

\end_inset 

)
\layout Itemize

[DISPLAY] settings related to the graphical user interface (
\begin_inset LatexCommand \ref{sub:[DISPLAY]-Section}

\end_inset 

)
\layout Itemize

[FILTER] settings input filter programs (
\begin_inset LatexCommand \ref{sub:[FILTER]-Section}

\end_inset 

)
\layout Itemize

[RS274NGC] settings used by the g-code interpreter ()
\layout Itemize

[EMCMOT] settings used by the real time motion controller (
\begin_inset LatexCommand \ref{sub:[EMCMOT]-Section}

\end_inset 

)
\layout Itemize

[HAL] specifies .hal files (
\begin_inset LatexCommand \ref{sub:[HAL]-section}

\end_inset 

)
\layout Itemize

[TASK] settings used by the task controller (
\begin_inset LatexCommand \ref{sub:[TASK]-Section}

\end_inset 

)
\layout Itemize

[TRAJ] additional settings used by the real time motion controller (
\begin_inset LatexCommand \ref{sub:[TRAJ]-Section}

\end_inset 

)
\layout Itemize

[AXIS_0] ...
 [AXIS_n] individual axis variables (
\begin_inset LatexCommand \ref{sub:[AXIS]-Section}

\end_inset 

)
\layout Itemize

[EMCIO] settings used by the I/O Controller (
\begin_inset LatexCommand \ref{sub:[EMCIO]-Section}

\end_inset 

)
\layout Subsection

Variables
\layout Standard

A variable line is made up of a variable name, an equals sign(=), and a
 value.
 
\color black
Everything from the first non-white space character after the = up to the
 end of the line is passed as the value, so you can embed spaces in string
 symbols if you want to or need to.
 A variable name is often called a keyword.
\layout Standard


\color black
The following sections detail each section of the configuration file, using
 sample values for the configuration lines.
\layout Standard

Some of the variables are used by EMC, and must always use the section names
 and variable names shown.
 Other variables are used only by HAL, and the section names and variable
 names shown are those used in the sample configuration files.
\layout Subsection

Definitions
\layout Description

Machine\SpecialChar ~
Units The units (of length or angle) specified in the ini file for
 a particular axis
\layout Section


\begin_inset LatexCommand \label{sub:INI-Detail}

\end_inset 

Section Variables
\layout Subsection

[EMC] Section
\color black
 
\begin_inset LatexCommand \label{sub:[EMC]-Section}

\end_inset 


\begin_inset LatexCommand \index{ini [EMC] Section}

\end_inset 


\layout Description


\color black
VERSION\SpecialChar ~

\series bold 
=
\series default 
\SpecialChar ~

\series bold 
$Revision:
\series default 
\SpecialChar ~

\series bold 
1.3
\series default 
\SpecialChar ~

\series bold 
$
\series default 
 The version number for the INI file.
 The value shown here looks odd because it is automatically updated when
 using the Revision Control System.
 It's a good idea to change this number each time you revise your file.
 If you want to edit this manually just change the number and leave the
 other tags alone.
 
\layout Description


\color black
MACHINE\SpecialChar ~

\series bold 
=
\series default 
\SpecialChar ~

\series bold 
My
\series default 
\SpecialChar ~

\series bold 
Controller
\series default 
 This is the name of the controller, which is printed out at the top of
 most graphical interfaces.
 You can put whatever you want here as long as you make it a single line
 long.
\layout Subsection

[DISPLAY] Section
\color black
 
\begin_inset LatexCommand \label{sub:[DISPLAY]-Section}

\end_inset 


\begin_inset LatexCommand \index{ini [DISPLAY] Section}

\end_inset 


\layout Standard

Different user interface programs use different options, and not every option
 is supported by every user interface.
\layout Standard


\series bold 
\color black
DISPLAY\SpecialChar ~
=\SpecialChar ~
tkemc
\series default 
 The name of the user interface to use.
 Valid options may include:
\layout Itemize

axis
\layout Itemize


\color black
keystick
\layout Itemize

mini
\layout Itemize


\color black
tkemc
\layout Itemize


\color black
xemc
\layout Description

POSITION_OFFSET\SpecialChar ~
=\SpecialChar ~
RELATIVE The coordinate system (RELATIVE or MACHINE) to
 show when the user interface starts.
 The RELATIVE coordinate system reflects the G92 and G5x coordinate offsets
 currently in effect.
\layout Description

POSITION_FEEDBACK\SpecialChar ~
=\SpecialChar ~
ACTUAL The coordinate value (COMMANDED or ACTUAL) to show
 when the user interface starts.
 The COMMANDED position is the ideal position requested by EMC.
 The ACTUAL position is the feedback position of the motors.
\layout Description

MAX_FEED_OVERRIDE\SpecialChar ~
=\SpecialChar ~
1.2 The maximum feed override the user may select.
 1.2 means 120% of the programmed feed rate
\layout Description

MIN_SPINDLE_OVERRIDE\SpecialChar ~
=\SpecialChar ~
0.5 The minimum spindle override the user may select.
 0.5 means 50% of the programmed spindle speed.
 (This is useful as it's dangerous to run a program with a too low spindle
 speed).
\layout Description

MAX_SPINDLE_OVERRIDE\SpecialChar ~
=\SpecialChar ~
1.0 The maximum spindle override the user may select.
 1.0 means 100% of the programmed spindle speed
\layout Description

PROGRAM_PREFIX\SpecialChar ~
=\SpecialChar ~
~/emc2/nc_files The default location for g-code files and
 the location for user-defined M-codes
\layout Description

INTRO_GRAPHIC\SpecialChar ~
=\SpecialChar ~
emc2.gif The image shown on the splash screen
\layout Description

INTRO_TIME\SpecialChar ~
=\SpecialChar ~
5 The maximum time to show the splash screen
\layout Subsubsection

AXIS Interface
\layout Standard

If your using the Axis interface the following can be used with it only.
\layout Description

DEFAULT_LINEAR_VELOCITY\SpecialChar ~
=\SpecialChar ~
.25 The default velocity for linear jogs, in machine
 units per second.
 
\layout Description

MAX_LINEAR_VELOCITY\SpecialChar ~
=\SpecialChar ~
1.0 The maximum velocity for linear jogs, in machine
 units per second.
 
\layout Description

DEFAULT_ANGULAR_VELOCITY\SpecialChar ~
=\SpecialChar ~
.25 The default velocity for angular jogs, in machine
 units per second.
 
\layout Description