Mach Modules Documentation
Lua Module API Documentation
Loading...
Searching...
No Matches
GrinderCenterlessFixedBladeGUIModuleV02.lua File Reference

Go to the source code of this file.

Functions

GrinderCenterlessFixedBladeGUIModuleV02 FeedHoldBtn ()
 Handle the Feed Hold button press by triggering an emergency retract if one is configured.
GrinderCenterlessFixedBladeGUIModuleV02 IsMSTAndDryRunActive ()
 Check whether MST (Setup Run) lock and/or Dry Run modes are active and prompt the operator to confirm cycle start.
GrinderCenterlessFixedBladeGUIModuleV02 MSTLockToggleBtn ()
 Toggle the MST (Setup Run) lock state on or off.

Function Documentation

◆ FeedHoldBtn()

GrinderCenterlessFixedBladeGUIModuleV02 FeedHoldBtn ( )

Handle the Feed Hold button press by triggering an emergency retract if one is configured.

Calls m.screen.EmergencyRetract() if the function exists on the current screen module. If no EmergencyRetract function is defined on the screen, the button press has no effect.

Note
Documentation generated by AI on 2026-03-03

◆ IsMSTAndDryRunActive()

GrinderCenterlessFixedBladeGUIModuleV02 IsMSTAndDryRunActive ( )

Check whether MST (Setup Run) lock and/or Dry Run modes are active and prompt the operator to confirm cycle start.

Reads the ConfirmationDialogs OEM parameter to determine if confirmation prompts are enabled. If enabled, it reads the MSTLock and DryRun OEM registers to determine which modes are active. A combined warning message is built from whichever modes are active (e.g. "Setup Run and Dry Run Active! Continue?") and presented to the operator via m.CycleStartDialog(). If neither mode is active, or if ConfirmationDialogs is not "Yes", the function returns true immediately without prompting.

Returns
(boolean|nil) True if the operator confirmed or no confirmation was needed, false if the operator declined, or nil on error reading OEM parameters
(boolean) Success flag - true if operation completed without error
(string) Status message describing the outcome, from w.FunctionError() on error or a descriptive string indicating the result
Note
Documentation generated by AI on 2026-03-03

◆ MSTLockToggleBtn()

GrinderCenterlessFixedBladeGUIModuleV02 MSTLockToggleBtn ( )

Toggle the MST (Setup Run) lock state on or off.

Logs the button press via w.OperatorLog(), then reads the current MSTLock register value. If MSTLock is currently "Yes", it is set to "No" unconditionally. If MSTLock is currently "No", it is only set to "Yes" if the machine is in IDLE state. If the machine is not idle, the toggle is canceled and the cancellation is logged via w.OperatorLog().

Returns
(nil) No meaningful primary return value
(boolean) Success flag - true if operation completed successfully
(string) Status message from w.FunctionCompleted() or w.FunctionError()
Warning
MSTLock can only be activated when the machine is in MC_STATE_IDLE. Attempting to enable Setup Run while the machine is running will silently cancel the operation.
Note
Documentation generated by AI on 2026-03-03