docs: update gmoccapy docs regarding INI values

hansu · Nov 27, 2024 · 6482552 · 6482552
1 parent 86cdee2
commit 6482552
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/configs/sim/gmoccapy/gmoccapy.ini b/configs/sim/gmoccapy/gmoccapy.ini
@@ -30,6 +30,19 @@ MAX_LINEAR_VELOCITY     = 166
 DEFAULT_LINEAR_VELOCITY = 100
 MAX_ANGULAR_VELOCITY    = 234
 DEFAULT_SPINDLE_SPEED   = 450
+# Initial value for spindle speed
+DEFAULT_SPINDLE_SPEED = 500
+
+# The following are not used, added here to suppress warnings (from qt_istat/logger).
+MIN_LINEAR_VELOCITY     = 0
+DEFAULT_SPINDLE_0_SPEED = 500
+MIN_SPINDLE_0_SPEED     = 0
+MAX_SPINDLE_0_SPEED     = 3000
+MAX_SPINDLE_0_OVERRIDE = 1.2
+MIN_SPINDLE_0_OVERRIDE = 0.5
+# The following are not relevant for this machine, added here to suppress warinings.
+MIN_ANGULAR_VELOCITY = 0.1
+DEFAULT_ANGULAR_VELOCITY = 360
 
 # Prefix to be used
 PROGRAM_PREFIX = ../../nc_files/

diff --git a/docs/src/gui/gmoccapy.adoc b/docs/src/gui/gmoccapy.adoc
@@ -115,6 +115,7 @@ PREFERENCE_FILE_PATH = gmoccapy_preferences
 MAX_FEED_OVERRIDE = 1.5
 MAX_SPINDLE_OVERRIDE = 1.2
 MIN_SPINDLE_OVERRIDE = 0.5
+DEFAULT_SPINDLE_SPEED = 500
 LATHE = 1
 BACK_TOOL_LATHE = 1
 PROGRAM_PREFIX = ../../nc_files/
@@ -156,6 +157,11 @@ See also the <<gmoccapy:lathe-section,Lathe Specific Section>>.
 If not specified, GMOCCAPY will look in the following order for NGC files:
 First `linuxcnc/nc_files` and then the users home directory.
 
+- _DEFAULT_SPINDLE_SPEED_ - Start value for <<gmoccapy-settings-spindle,"Starting RPM">> if value not present in preferences file or file is not present. Will have no effect with valid preferences file.
+
+- _MIN_ANGULAR_VELOCITY_ - Sets the minimal jog velocity of the machine for rotary axes.
+- _MAX_ANGULAR_VELOCITY_ - Sets the maximal jog velocity of the machine for rotary axes.
+- _DEFAULT_ANGULAR_VELOCITY_ - Sets the default jog velocity of the machine for rotary axes.
 
 [[gmoccapy:traj-section]]
 === The TRAJ Section
@@ -166,8 +172,8 @@ First `linuxcnc/nc_files` and then the users home directory.
 If not set, half of 'MAX_LINEAR_VELOCITY' will be used.
 If that value is also not given, it will default to 180.
 
-// max. jog velocity?
 - _MAX_LINEAR_VELOCITY = 230.0_ - Sets the maximal velocity of the machine.
+This value will also be the maximum linear jog velocity.
 +
 [NOTE]
 Defaults to 600 if not set.
@@ -1291,7 +1297,7 @@ By default all scales are set using the calculation:
 (MAX - MIN)/100
 ----
 
-
+[[gmoccapy-settings-spindle]]
 .Spindle
 * _Starting RPM_ - Sets the rpm to be used if the spindle is started and no S value has been set.
 +