Yt_GP_MachineStruct
Yt_GP_MachineStruct: STRUCT
| Element |
Data Type |
Description |
Usage |
|
Version
|
UDINT
|
Version code to identify the structure to GroupComm.DLL for compatibility confirmation
|
MyMachine.Version
|
|
MachineType
|
Yt_GP_MachineType
|
|
MyMachine.MachineType
|
|
Variant
|
Yt_GP_Variant
|
|
MyMachine.Variant
|
|
Emulation
|
Yt_GP_Emulation
|
|
MyMachine.Emulation
|
|
Feature
|
DWORD
|
FR 1698
|
MyMachine.Feature
|
|
Control
|
Yt_GP_ControlData
|
|
MyMachine.Control
|
|
Origin
|
MC_COORD_REF
|
|
MyMachine.Origin
|
|
Home
|
Yt_GP_HomePresetStruct
|
FR 1648 / DCR 3927
|
MyMachine.Home
|
|
LocalZeroOffset
|
VECTOR
|
DCR 3286
|
MyMachine.LocalZeroOffset
|
|
LocalZeroInhibit
|
BOOL
|
DCR 5963
|
MyMachine.LocalZeroInhibit
|
|
G92RotationInhibit
|
BOOL
|
DCR 6642
|
MyMachine.G92RotationInhibit
|
|
CoordinateSystem
|
Yt_GP_OffsetStruct
|
|
MyMachine.CoordinateSystem
|
|
Prms
|
Yt_GP_MotionParameters
|
|
MyMachine.Prms
|
|
Printer
|
Yt_GP_PrinterStruct
|
|
MyMachine.Printer
|
|
Spindle
|
Yt_GP_SpindleArray
|
|
MyMachine.Spindle[x]
|
|
SelectedSpindle
|
INT
|
Added here instead of making better SpindleStruct to maintain PLCi Compatibility for Compass
|
MyMachine.SelectedSpindle
|
|
Tangent
|
Yt_GP_TangentStruct
|
|
MyMachine.Tangent
|
|
Laser
|
Yt_GP_LaserStruct
|
DCR 6672
|
MyMachine.Laser
|
|
UserStatus
|
WORD
|
General Purpose command bits for customization
|
MyMachine.UserStatus
|
|
ToolChanger
|
Yt_GP_ToolChangerStruct
|
For operating a tool changer system external to the group via M06
|
MyMachine.ToolChanger
|
|
Shared
|
Yt_GP_GCodeSharedStruct
|
Connector struct to map info from one structure to another for FBs that don't have access to requried info
|
MyMachine.Shared
|
Yt_GP_MachineType: ENUM
| ENUM Type |
#INT Value |
ENUM String |
Description |
Usage |
|
Yt_GP_MachineType
|
Some applications use the same code for different meanings based on the intended machine type
|
|
0
|
Milling
|
|
Yt_GP_MachineType#Milling
|
|
1
|
Lathe
|
|
Yt_GP_MachineType#Lathe
|
|
2
|
Printer
|
|
Yt_GP_MachineType#Printer
|
Yt_GP_Variant: ENUM
| ENUM Type |
#INT Value |
ENUM String |
Description |
Usage |
|
Yt_GP_Variant
|
To distinguish special characteristics of the mechanism and do certain things differently, like MoveOptions.VelocityScaler
|
|
0
|
na
|
|
|
|
1
|
PrinterXD
|
|
Yt_GP_Variant#PrinterXD
|
|
2
|
PrinterRobot
|
|
Yt_GP_Variant#PrinterRobot
|
|
3
|
SimultaneousExtruder
|
|
Yt_GP_Variant#SimultaneousExtruder
|
Yt_GP_Emulation: ENUM
| ENUM Type |
#INT Value |
ENUM String |
Description |
Usage |
|
Yt_GP_Emulation
|
DCR To recognize certian G code commands in a special, non standard way.
|
|
0
|
na
|
|
|
|
1
|
Mode1
|
|
Yt_GP_Emulation#Mode1
|
|
2
|
Mode2
|
|
Yt_GP_Emulation#Mode2
|
Yt_GP_ControlData: STRUCT
| Element |
Data Type |
Description |
Usage |
|
CycleStart
|
BOOL
|
Optional flag coming from GroupCommManager to allow the host PC to signal that auto run should start
|
MyControl.CycleStart
|
|
CycleStop
|
BOOL
|
Flag coming from GroupCommManager to allow the host PC to signal that an auto run should stop
|
MyControl.CycleStop
|
|
Cancel
|
BOOL
|
Flag coming from GroupCommManager to allow the host PC to signal that the current job should cancel
|
MyControl.Cancel
|
|
BlockSkip
|
BOOL
|
GCodes with leading '/' on line will not be executed when this bit is set.
|
MyControl.BlockSkip
|
|
ProgramStop
|
BOOL
|
Used in conjunction with M0 and M1. When ProgramStop is in effect, MC_MovePath will remain Busy, and the Execute input must be triggered to resume
|
MyControl.ProgramStop
|
|
SingleStep
|
BOOL
|
DCR 3196
|
MyControl.SingleStep
|
|
SingleStepStart
|
BOOL
|
|
MyControl.SingleStepStart
|
|
MDIMode
|
BOOL
|
|
MyControl.MDIMode
|
|
GUICommand
|
BOOL
|
DCR 3587 - GUI sets this BOOL when a G Code command has been tied to a button press, Template will clear the status bit when executed
|
MyControl.GUICommand
|
|
VelocityScaler
|
REAL
|
User can optionally map this value from MachineStruct to MC_MovePath.VelocityScaler if prefer to change via host PC
|
MyControl.VelocityScaler
|
|
UserCommand
|
WORD
|
General Purpose command bits for customization
|
MyControl.UserCommand
|
|
SetLZRequest
|
BOOL
|
DCR , bandaid to get LocalZeroOffsets back to what they were before a part was run, CAMaster request.
|
MyControl.SetLZRequest
|
|
RetainProgramFlow
|
BOOL
|
DCR 5929
|
MyControl.RetainProgramFlow
|
Yt_GP_HomePresetStruct: STRUCT
Yt_GP_HomePresetArray: ARRAY
| Array Name |
Data Type |
Range |
Description |
Usage |
|
Yt_GP_HomePresetArray
|
Yt_GP_PresetStruct
|
0..29
|
For emulation mode 2, see FR 1648
|
|
Yt_GP_PresetStruct: STRUCT
| Element |
Data Type |
Description |
Usage |
|
Location
|
MC_COORD_REF
|
|
|
|
Description
|
Yt_String32
|
|
|
|
AxesFlags
|
WORD
|
To indicate the positions the user actually provided positions for
|
|
Yt_GP_OffsetStruct: STRUCT
Yt_GP_OffsetArray: ARRAY
| Array Name |
Data Type |
Range |
Description |
Usage |
|
Yt_GP_OffsetArray
|
MC_COORD_REF
|
1..9
|
For G53 - G59 support, including 59.1, 59.2 and 59.3
|
|
Yt_GP_MotionParameters: STRUCT
| Element |
Data Type |
Description |
Usage |
|
MaxVelocity
|
LREAL
|
The maximum velocity the mechanism can handle. Units are mm or in / sec
|
|
|
MaxDirectVelocity
|
LREAL
|
The maximum velocity the mechanism can handle. Units are mm or in / sec
|
|
|
MaxRotationalVelocity
|
LREAL
|
The maximum velocity the mechanism can handle. Units are deg or rev / sec
|
|
|
MinAcceleration
|
LREAL
|
The maximum Acceleration the mechanism can handle. Units are mm or in / sec2
|
|
|
MinDeceleration
|
LREAL
|
The maximum Deceleration the mechanism can handle. Units are mm or in / sec2
|
|
|
Acceleration
|
LREAL
|
Acceleration of the interpolated motion path. Cannot be negative or 0.
|
|
|
Deceleration
|
LREAL
|
Deceleration of the interpolated motion path. Cannot be negative or 0.
|
|
|
MaxAcceleration
|
LREAL
|
The maximum Acceleration the mechanism can handle. Units are mm or in / sec2
|
|
|
MaxDeceleration
|
LREAL
|
The maximum Deceleration the mechanism can handle. Units are mm or in / sec2
|
|
|
Jerk
|
LREAL
|
Jerk of the interpolated motion path. Cannot be negative or 0.
|
|
|
DirectAcceleration
|
LREAL
|
Acceleration of the interpolated motion path. Cannot be negative or 0.
|
|
|
DirectDeceleration
|
LREAL
|
Deceleration of the interpolated motion path. Cannot be negative or 0.
|
|
|
DirectJerk
|
LREAL
|
Jerk of the interpolated motion path. Cannot be negative or 0.
|
|
|
ZMaxVelocity
|
LREAL
|
DCR 3181, for use when only Z is commanded. Requires emulation mode 2. The velocity the Z axis when only Z is commanded and Feedrate is not explicit. If zero, system will use MaxVelocity. Units are mm or in / sec
|
|
|
ZMaxAcceleration
|
LREAL
|
DCR 3181, for use when only Z is commanded. Requires emulation mode 2. The maximum Acceleration the Z axis can handle. If zero, system will use MaxAcceleration. Units are mm or in / sec2
|
|
|
ZAcceleration
|
LREAL
|
DCR 3181, for use when only Z is commanded. Requires emulation mode 2. Acceleration used when only Z is commanded. If zero, system will use Acceleration.
|
|
|
RotationalVelocity
|
LREAL
|
For use with Tangent or Theta axes
|
|
|
RotationalAcceleration
|
LREAL
|
For use with Tangent or Theta axes
|
|
|
MaxSegmentsPerScan
|
INT
|
Maximum amount of segments MC_MovePath can add to the firmware motion queue from
MC_PATH_DATA_REF
in one application task interval
|
|
|
TransitionMode
|
INT
|
Transition mode for buffered interpolation. See PLCopen Part4 documentation for more info.
|
|
|
TransitionParameter
|
VECTOR
|
Transition Parameters for buffered interpolation. See PLCopenPart4 documentation for more info.
|
|
Yt_GP_PrinterStruct: STRUCT
| Element |
Data Type |
Description |
Usage |
|
BedTempActual
|
Yt_RealArray32
|
M140 - Set Bed Temperature. http://reprap.org/wiki/G-code#M140:_Set_Bed_Temperature_.28Fast.29
|
|
|
BedTempSetting
|
Yt_RealArray32
|
M140 - Set Bed Temperature. http://reprap.org/wiki/G-code#M140:_Set_Bed_Temperature_.28Fast.29
|
|
|
BedTempTolerance
|
REAL
|
|
|
|
BedTempSensors
|
INT
|
Added v360, specify the number of extruder temp sensors physically in use.
|
|
|
EnclosureTempActual
|
REAL
|
|
|
|
EnclosureTempSetting
|
REAL
|
|
|
|
EnclosureTempTolerance
|
REAL
|
M191 S parameter
|
|
|
BedTempReady
|
BOOL
|
If M190 is used, user application code can be added to let MC_MovePath know when processing can continue
|
|
|
EnclosureTempReady
|
BOOL
|
If M191 is used, user application code can be added to let MC_MovePath know when processing can continue
|
|
|
Fan
|
BOOL
|
Enable / Disable
|
|
|
FanSpeed
|
BYTE
|
|
|
|
Extruder
|
Yt_GP_ExtruderArray
|
|
|
|
ExtruderScalerEffective
|
BOOL
|
Used by MC_MovePath to indicate when a change in scaler values has propagated through the system (motion buffer), and is in effect at the machine
|
|
|
ExtruderOffsetValid
|
BOOL
|
|
|
|
ActiveExtruder
|
INT
|
Tool ID for the extruder currently in use by the MC_MovePath
|
|
Yt_GP_ExtruderArray: ARRAY
Yt_GP_ExtruderData: STRUCT
| Element |
Data Type |
Description |
Usage |
|
Axis
|
AXIS_REF
|
To operate an axis which is synced to the group, possibly MC_SyncTangentAxisToGroup
|
|
|
XOffset
|
LREAL
|
In the case of multiple extruders, these values indicate the cartesian offset to the primary extruder
|
|
|
YOffset
|
LREAL
|
In the case of multiple extruders, these values indicate the cartesian offset to the primary extruder
|
|
|
ZOffset
|
LREAL
|
In the case of multiple extruders, these values indicate the cartesian offset to the primary extruder
|
|
|
EOffset
|
LREAL
|
Necessary in case the extruder is moved during a Pause scenario - and user must set a new offset to resume the path
|
|
|
ScaleFactor
|
LREAL
|
To override the E values manually. Range is 0.5 to 1.5
|
|
|
CmdPos
|
LREAL
|
Scaled extruder command
|
|
|
CmdVel
|
REAL
|
|
|
|
TempSetting
|
Yt_RealArray4
|
M104 - http://reprap.org/wiki/G-code#M104:_Set_Extruder_Temperature
|
|
|
MinWarmTemp
|
Yt_RealArray4
|
M109 - http://reprap.org/wiki/G-code#M104:_Set_Extruder_Temperature
|
|
|
TempTolerance
|
Yt_RealArray4
|
M109 - http://reprap.org/wiki/G-code#M104:_Set_Extruder_Temperature
|
|
|
TempActual
|
Yt_RealArray4
|
M105 - http://reprap.org/wiki/G-code#M104:_Get_Extruder_Temperature
|
|
|
TempOffset
|
REAL
|
So the operator can adjust the temperature from what was set in the G Code data
|
|
|
TempSensors
|
INT
|
Added v360, specify the number of extruder temp sensors physically in use.
|
|
|
TempReady
|
BOOL
|
If M109 is used, user application code can be added to let MC_MovePath know when processing can continue
|
|
|
RetractLength
|
LREAL
|
From S register. reprap says this is always in mm
|
|
|
UnRetractLength
|
LREAL
|
From R register. reprap says this is always in mm
|
|
|
RetractFeedrate
|
LREAL
|
From F register. reprap says this is always in mm
|
|
|
UnRetractFeedrate
|
LREAL
|
From T register. reprap says this is always in mm
|
|
|
ZLift
|
LREAL
|
From Z register
|
|
|
AirPressure
|
BOOL
|
User customizable to report to host PC
|
|
|
VacuumPressure
|
BOOL
|
User customizable to report to host PC
|
|
|
LowTorque
|
BOOL
|
User customizable to report to host PC
|
|
|
HighTorque
|
BOOL
|
User customizable to report to host PC
|
|
|
PressAdv
|
REAL
|
K Value for Extruder Pressure Advance
|
|
Yt_GP_SpindleArray: ARRAY
| Array Name |
Data Type |
Range |
Description |
Usage |
|
Yt_GP_SpindleArray
|
Yt_GP_SpindleStruct
|
0..2
|
DCR 3261
|
|
Yt_GP_SpindleStruct: STRUCT
| Element |
Data Type |
Description |
Usage |
|
RPM
|
REAL
|
Holds value of S Register when G96 / G97 decoded
|
|
|
Bypass
|
REAL
|
Available for the user when customizing, not used by the Group Toolbox.
|
|
|
Accel
|
REAL
|
Available for the user when customizing, not used by the Group Toolbox.
|
|
|
MaxRPM
|
REAL
|
Value to be used if there would be a divide by zero in surface speed calculations
|
|
|
SurfaceSpeed
|
REAL
|
|
|
|
UnitCode
|
INT
|
96 = Constant Surface Speed / 97 = FPM
|
|
|
Direction
|
INT
|
Same as M03 = +1, M04 = -1, M05 = 0
|
|
|
Axis
|
AXIS_REF
|
|
|
|
OrientationPosition
|
LREAL
|
Could come from an M19, or other method to move the spindle to a specific angle
|
|
|
OrientationExe
|
BOOL
|
Set by MC_MovePath when an M19 is encountered.
|
|
|
OrientationDone
|
BOOL
|
To be populated by the the template layer project code if the user wants to show this information on a GUI via the MachineStruct.
|
|
|
OrientationBusy
|
BOOL
|
To be populated by the the template layer project code if the user wants to show this information on a GUI via the MachineStruct.
|
|
|
OrientationAborted
|
BOOL
|
To be populated by the the template layer project code if the user wants to show this information on a GUI via the MachineStruct.
|
|
|
OrientationError
|
BOOL
|
To be populated by the the template layer project code if the user wants to show this information on a GUI via the MachineStruct.
|
|
|
OrientationErrorID
|
UINT
|
To be populated by the the template layer project code if the user wants to show this information on a GUI via the MachineStruct.
|
|
|
ToolPresent
|
BOOL
|
Connect a BOOL to this structure item if there is a sensor mounted to detect a tool in the chuck.
|
|
|
AtSpeed
|
BOOL
|
Indicates when the spindle motor is within a target speed so MC_MovePath can pause and wait for the spindle to get up to speed
|
|
|
FeedbackSpeed
|
REAL
|
To be populated by the the template layer project code if the user wants to show this information on a GUI via the MachineStruct.
|
|
|
FeedbackTorque
|
REAL
|
To be populated by the the template layer project code if the user wants to show this information on a GUI via the MachineStruct.
|
|
Yt_GP_ToolChangerStruct: STRUCT
Holds information to link with an externally programmed sequence based on uesr specific tool changer device. Related to G Code M06
| Element |
Data Type |
Description |
Usage |
|
RequestedTool
|
INT
|
Tool requested such as from M06 command. Links to ToolDataStruct
|
|
|
Execute
|
BOOL
|
MC_MovePath will SET this bit high when an M06 is encountered to signal the external process. External Process must CLEAR.
|
|
|
Done
|
BOOL
|
The External Process will SET this bit high when change is completed, MC_MovePath will CLEAR when acknowledged.
|
|
|
Busy
|
BOOL
|
External Process will manage this BOOL.
|
|
|
CommandAborted
|
BOOL
|
External Process will manage this BOOL. If set, MC_MovePath will also report CommandAborted.
|
|
|
Error
|
BOOL
|
External Process will manage this BOOL. If set, MC_MovePath will also report this Error.
|
|
|
ErrorID
|
UINT
|
External Process will manage this BOOL. If set, MC_MovePath will also report this ErrorID.
|
|
Yt_GP_ToolChangerStruct: STRUCT
New struct - DCR , moved ExternalTangent from MachineStruct to organize with other required features for emulation mode2 tanget support.
| Element |
Data Type |
Description |
Usage |
|
Axis
|
AXIS_REF
|
To use with
MC_MoveAbsolute
to align, and
Y_SyncTangentAxisToGroup. Was ExternalTanget and in the MachineStruct before v361. DCR 3668
|
|
|
MaxAngle
|
LREAL
|
Colinearity checked between each linear segment, if MaxAngle execeeded, knife will be raised out of the material.
|
|
|
RaisedPosition
|
LREAL
|
Z position when knife is out of the material
|
|
|
CutPosition
|
LREAL
|
Z position when knife is cutting
|
|
|
CutVelocity
|
REAL
|
Speed at which Z must move when going to Cut position. (Should be same as GCodeRegister._Fz but the code for preparing Z is in MC_MovePath, which does not have access to G Code Registers
|
|
|
MaxRotationalVelocity
|
LREAL
|
DCR 6570. Lookahead checks calculated rotation in deg/sec, and limits the TCP velocity if this MaxRotationalVelocity would be exceeded
|
|
Yt_GP_GCodeSharedStruct: STRUCT
| Element |
Data Type |
Description |
Usage |
|
SharingValid
|
BOOL
|
Need this to know if the GroupCommManager / Pendant_Driver is an active part of the project and updating Shared data
|
|
|
GGroupStatus1
|
DWORD
|
4778 - For porting data into GroupCommManager for feedrate override management during G0 rapid moves
|
|
|
SegmentFeedrate
|
REAL
|
DCR 4823
|
|
|
CurrentOverride
|
LREAL
|
|
|
|
GroupHandle
|
UINT
|
To provide the possibility that functions under Read_GCode_Stream can access some group parameters (no
AXES_GROUP_REF
VAR_IN_OUT)
|
|
|
MCSConfig
|
Yt_GP_DOF_Struct
|
|
|
Yt_GP_DOF_Struct: STRUCT
Yt_GP_DOF_Array: ARRAY
| Array Name |
Data Type |
Range |
Description |
Usage |
|
Yt_GP_DOF_Array
|
BOOL
|
0..12
|
Flags to indicate which MCS degrees of freedom the group, as configured in the HC, can support.
|
|
Yt_GP_LaserStruct: STRUCT
FR 1734
| Element |
Data Type |
Description |
Usage |
|
Enable
|
BOOL
|
|
|
|
Enabled
|
BOOL
|
Status report - will be delayed by the Compensation value if set, otherwise same as Enable
|
|
|
DynamicPowerEnable
|
BOOL
|
Not supported by the toolbox
|
|
|
Compensation
|
LREAL
|
In Seconds. Use to adjust the laser power values later for system timing delays not accounted for elsewhere
|
|
|
Register
|
DWORD
|
Specify the register letter used to provide the laser value. A=bit0, B=bit1, C=bit2, etc.
|
|