Differences

This shows you the differences between two versions of the page.

--- mycnc:global_variables [2019/08/26 15:59] – ivan
+++ mycnc:global_variables [2019/08/30 11:47] – ivan
@@ Line 12: / Line 12: @@
 |GVAR_MODAL_G54_G59 | 4014 | Modal state of G54-G59 |
 |GVAR_MODAL_G17_G19 | 4016 | Modal state of G17-G19 |
-|GVAR_TOOL_1_X_CORRECTION | 4600 | +98 |
+|GVAR_TOOL_1_X_CORRECTION | 4600 | (+98) Tool correction (small value corrections in the x direction) |
-|GVAR_TOOL_1_Z_CORRECTION | 4700 | +98 |
+|GVAR_TOOL_1_Z_CORRECTION | 4700 | (+98) Tool correction (small value corrections) in the z direction) |
 |<del>GVAR_RUNNING_STOP</del> | 4800 | |
 |<del>GVAR_CURRENT_BLOCK_END_POSITION</del> | 5001 | (+8) program position at the end of current block |
@@ Line 63: / Line 63: @@
 | GVAR_SURFACE_SENSOR_TYPE | 5495 | Specifies sensor type - open or closed |
 | GVAR_SHEET_THICKNESS | 5496 | Specifies the thickness of the working material |
-| GVAR_OFFSET_G283 | 5501 | Similar to 5541 G282, stores the position.  |
+| GVAR_OFFSET_G283 | 5501 | Similar to 5441 (G282), stores the position.  |
-| GVAR_OFFSET_G284 | 5511 | +9 |
+| GVAR_OFFSET_G284 | 5511 | +9. See 5441 (G282) for description.|
 | [[mycnc:global_variables_description#5521|GVAR_END_SENSORS_IGNORE]] | [[mycnc:global_variables_description#5521|5521]] | Writing "1" to this register will turn off Hardware Limit Sensors control temporarily. |
 | GVAR_JOG_STEP_SIZE | 5522 | Specifies the jog step size. This variable can be written to (and is what the user should be interacting with rather than the 7381/7382/etc variables) |
@@ Line 74: / Line 74: @@
 | GVAR_SIMULATION_MODE | 5528 | Indicates that the machine will be in drawing mode to be able to draw/etch on the working material |
 | GVAR_SHOCK_SENSOR_IGNORE | 5529 | Ignores shock sensor data (useful when utilizing the sensors for procedures other than shock information gathering) |
-| GVAR_STEP_PER_UNIT | 5530 | +6 |
+| GVAR_STEP_PER_UNIT | 5530 | (+6) Specifies the steps per unit value |
 | <del>GVAR_PARKING1</del> | 5541 | (+8) Registers are obsolete since another address space is reserved to ge up to 20 parking coordinates |
 | <del>GVAR_PARKING2</del> | 5551 | (+8) Registers are obsolete since another address space is reserved to ge up to 20 parking coordinates  |
@@ Line 82: / Line 82: @@
 | <del>GVAR_PARKING6</del> | 5591 | (+8) Registers are obsolete since another address space is reserved to ge up to 20 parking coordinates  |
 | GVAR_CURRENT_TOOLCHANGER_TYPE | 5600 | Allows to select the toolchanger type (whether it is off/linear/rotary/manual tool change) |
-| GVAR_TOOLCHANGER_UNLOAD_OFFSET | 5601 | +8 |
+| GVAR_TOOLCHANGER_UNLOAD_OFFSET | 5601 | +8 | Specifies the offset for machine to position itself before unloading the current working tool. Typically done so that the tool is not in danger of breaking due to being pushed into the tool changer)
-| GVAR_TOOLCHANGER_BLOW_OFF_OFFSET | 5610 | +8 |
+| GVAR_TOOLCHANGER_BLOW_OFF_OFFSET | 5610 | (+8) The offset for the machine to position itself if the tool will be blown out by the compressed air, done for safety reasons |
-| GVAR_MYDEV_MSG_COUNTER |5630 | +64 till 5694 |
+| GVAR_MYDEV_MSG_COUNTER |5630 | +64 till 5694. Allows for a quick display of the number of messages in the UDP message counter field in the Network tab |
 | GVAR_TECHNOLOGY_CFG | 5701 |
 - flexible;
@@ Line 104: / Line 104: @@
 | <del>GVAR_ET5_SLOW_PID_ENABLE</del> | 5705 | ET5 SLOW PID: 0- disable; 1- enable |
 | GVAR_CV_MODE | 5710 | Enables or disables the Constant Velocity mode (0 - disable, 1 - enable) |
-| GVAR_CV_TOLERANCE | 5711 | This stores the constant velocity tolerance, as described in [[mycnc:constant_velocity_mode_cv|MyCNC Constant Velocity Mode (CV)]] manual |
+| GVAR_CV_TOLERANCE | 5711 | This stores the constant velocity tolerance, as described in the [[mycnc:constant_velocity_mode_cv|Constant Velocity Mode (CV)]] manual |
-| GVAR_SOFT_LIMITS_CHECKER | 5714 | Enable/disable the limits checker |
+| GVAR_SOFT_LIMITS_CHECKER | 5714 | Checks whether the machine is within or outside the software limits |
-| GVAR_LATHE_GEARS | 5715 | Gear ratios can be used on lathe machines. In order to allow for constant surface speed while changing gears, the gear ratio is used. |
+| GVAR_LATHE_GEARS | 5715 | Gear ratios can be used on lathe machines. In order to allow for constant surface speed while changing gears, the gear ratio is used. This global variable stores the value of the gear ratio to be used to calculate CSS |
-| GVAR_MODE_SINGLE_BLOCK | 5720 | Writing "1" into this register will make the program run in single blocks (single lines). In this mode, the program runs through a single next line of code before stopping again. Useful for safety evaluations. |
+| GVAR_MODE_SINGLE_BLOCK | 5720 | Writing "1" into this register will make the program run in single blocks (single lines). In this mode, the program runs through a single next line of code before stopping again. Useful for safety evaluations when running through the entire program can be dangerous. |
-| GVAR_POSITION_STORED | 5900 | Stores a position |
+| GVAR_POSITION_STORED | 5900 | This register stores the flag (0 or 1) for whether the current position has been saved in flash memory. This is done every few seconds after the movement has been stopped in order to conserve the number of write operations onto flash memory. The variable flag visualization can be seen in the Diagnostics window in the bottom-right corner next to the stop button (grey for not saved - 0, red for saved - 1) |
 | GVAR_CURRENT_MOTION_CODE | 6060 | Specifies the current motion code (useful to wait until motion has finished, for example). |
 | GVAR_CURRENT_MOTION_WORK_PTR | 6061 | Motion controller work command pointer |
-| GVAR_CURRENT_MOTION_LAST_PTR | 6062 | Motion controller work command pointer |
+| GVAR_CURRENT_MOTION_LAST_PTR | 6062 | Motion controller work command pointer (last) |
 | GVAR_CURRENT_NC_LINE | 6063 | Current line number within the control program |
 | GVAR_TOTAL_NC_LINES | 6064 | Stores the total number of lines of the control program |
@@ Line 117: / Line 117: @@
 | GVAR_JOB_PROGRESS | 6067 | Denotes the current job progress in percentage of total lines done from the control program (useful for time estimation) |
 | GVAR_OIL_LENGTH_COUNTER | 6080 | Oil system counter which stores the distance that the lathe has travelled. |
-| GVAR_OIL_REVERSE_COUNTER | 6081 | Oil system counter which stores the number of direction changes for the lathe system (as those require more frequent lubrication). |
+| GVAR_OIL_REVERSE_COUNTER | 6081 | Oil system counter which stores the number of direction changes for the machine system (as those require more frequent lubrication). Both the length and the reverse counter are used in the lubrication process |
 | GVAR_SOFT_LIMITS_CONTROL | 6083 | Enables or disables software limits (this can otherwise be set through the check mark in Settings > Config > Inputs/Outputs/Sensors > Limits) |
 | GVAR_OIL_SERVICE_COUNTER_X |  6090 | Mileage/oil change X-direction trips counter  |
 | GVAR_OIL_SERVICE_COUNTER_Y |  6091 | Mileage/oil change Y-direction trips counter  |
 | GVAR_OIL_SERVICE_COUNTER_Z |  6092 | Mileage/oil change Z-direction trips counter  |
-| GVAR_TOOLCHANGER_POSITION | 6101 | Specifies the tool changer position (+8 axes) |
+| GVAR_TOOLCHANGER_POSITION | 6101 | Specifies the tool changer position on the machine (+8 axes) |
 | GVAR_TOOLCHANGER_NEXT_POSITION | 6111 | +6 |
-| GVAR_TOOLPOT_1_POSITION | 6121 | +6 |
+| GVAR_TOOLPOT_1_POSITION | 6121 | +6. Registers 6121-6271 specify the positions for the tool pots |
 | GVAR_TOOLPOT_2_POSITION | 6131 | +6 |
 | GVAR_TOOLPOT_3_POSITION | 6141 | +6 |
@@ Line 158: / Line 158: @@
 | GVAR_FEED_SPEED | 7030 | Feed Speed for the machine (+9) |
 | GVAR_FEED_SPEED_X | 7030 | Feed Speed for the X axis |
-| GVAR_RAPID_SPEED | 7040 | +9 |
+| GVAR_RAPID_SPEED | 7040 | +9. Specifies the rapid speed for the machine (all axes) |
 | GVAR_RAPID_SPEED_X | 7041 | Rapid Speed for the X axis |
-| GVAR_JOG_SPEED | 7050 | +9. Specifies the machine jog speed. |
+| GVAR_JOG_SPEED | 7050 | +9. Specifies the machine jog speed (all axes). |
 | GVAR_JOG_SPEED_X | 7050 | Jog Speed for the X axis |
 | GVAR_MARKING_SPEED | 7060 | Specifies the marking speed for the machine. |
@@ Line 211: / Line 211: @@
 | GVAR_HW_ADC7 | 7203 | |
 | GVAR_HW_INP_TCOUNT0 | 7206 | Only for ET10, special purpose global variables. On the ET10 controller, there are two ports which allow to count impulse signals sent on these ports and which can then be used as a timer. These timer values are set in to the myCNC program on the host computer with a period of 32 ms |
-| GVAR_HW_INP_TCOUNT1 | 7207 | |
+| GVAR_HW_INP_TCOUNT1 | 7207 | Only the first two registers  (7207 and 7208) are currently used on the existing ET10 controller. Registers 7208 and 7209 have been reserved for future development. |
-| GVAR_HW_INP_TCOUNT2 | 7208 | Only the first two registers are currently used on the existing ET10 controller. Registers 7208 and 7209 have been reserved for future development. |
+| GVAR_HW_INP_TCOUNT2 | 7208 | Reserved for future development |
-| GVAR_HW_INP_TCOUNT3 | 7209 | |
+| GVAR_HW_INP_TCOUNT3 | 7209 | Reserved for future development |
-| GVAR_PARKING_LAST | 7210 | Data for the last parking location is stored in this register |
+| GVAR_PARKING_LAST | 7210 | Data for the last machine parking location is stored in this register |
 | GVAR_RTCP_DEBUG_X | 7211 | RTCP correction data for X axis is stored in this register for debug purpose. This register is read-only |
 | GVAR_RTCP_DEBUG_Y | 7212 | RTCP correction data for Y axis is stored in this register for debug purpose. This register is read-only  |
 | GVAR_RTCP_DEBUG_Z | 7213 | RTCP correction data for Z axis is stored in this register for debug purpose. This register is read-only  |
-| GVAR_RTCP_SHOULDER | 7215 | Shoulder Length (in units) for RTCP correction calculation. |
+| GVAR_RTCP_SHOULDER | 7215 | Shoulder Length (in units) for RTCP correction calculations (calculating the correction value for the rotation). Note that the shoulder length is measured from the pivot to the end of the shoulder, and not for the entire shoulder length should it extend past the pivot point. |
-| GVAR_HCONTROL2_VREF | 7228 | System-reserved global variable |
+| GVAR_HCONTROL2_VREF | 7228 | System-reserved global variable for reference voltage. |
-| GVAR_HCONTROL_VREF | 7229 | A global variable reserved for system usage (specifies the reference voltage). For user-facing THC interactions, the 7011 global variable should be used. |
+| GVAR_HCONTROL_VREF | 7229 | A global variable reserved for system usage (specifies the reference voltage). For user-facing THC interactions, the 7011 global variable should be used instead of 7228 and 7229. |
-| GVAR_PLC_USER_DATA | 7230 | (+32) |
+| GVAR_PLC_USER_DATA | 7230 | (+32) Allows to specify the PLC user data not through var00/etc, but through global variables. This is an older PLC implementation which can still be used by the controller. |
-| GVAR_PLC_USER_DATA_LAST | 7261 |
+| GVAR_PLC_USER_DATA_LAST | 7261 | Stores the last PLC user global variable data for easy retrieval. |
 | GVAR_HW_DAC0 | 7270 | Stores the DAC 0 value to be read |
 | GVAR_HW_DAC1 | 7271 | Stores the DAC 1 value to be read |
@@ Line 239: / Line 239: @@
 | GVAR_HW_PWM6 | 7284 | Stores the PWM 6 value to be read |
 | GVAR_HW_PWM7 | 7285 | Stores the PWM 7 value to be read |
-| GVAR_GOTO_PROGRAMMING | 7290 | Specifies absolute/incremental programming modes. Reserved for certain custom myCNC profiles, and should not be used by most default profile configurations. The mode will specify how the machine will move to the GOTO_POSITION described below. |
+| GVAR_GOTO_PROGRAMMING | 7290 | Specifies absolute/incremental programming modes. Reserved for certain custom myCNC profiles, and should not be used by most default profile configurations. The selected mode will specify how the machine will move to the GOTO_POSITION described in register 7291 below. |
 | GVAR_GOTO_POSITION | 7291 | +16. These describe the position to which the machine will be moving. Not used on most default profile configurations.  |
-| GVAR_REFERENCE_POSITION | 7311 | +16. Specifies a reference position on some custom myCNC profiles (to be used separately from the zero position). This allows to set a reference work location somewhere on the machine (for example, at the point where the multiple axes of the machine are all at zero, etc). |
+| GVAR_REFERENCE_POSITION | 7311 | +16. Specifies a reference position on some custom myCNC profiles (to be used separately from the zero position). This allows to set a reference work location somewhere on the machine (for example, at the point where the multiple axes of the machine are all at zero, etc) and to refer to that position during the work process. |
 | GVAR_PRG_RECT_P | 7330 | +16. P=plus (positive direction). Allows to draw a rectangle to specify certain sizes in the visualization window, etc by specifying one of the three-dimensional points to be used as a corner. |
 | GVAR_PRG_RECT_M | 7350 | +16. M=minus (negative direction). Allows to draw a rectangle by specifying the second of the three-dimensional points to be used. |
@@ Line 278: / Line 278: @@
 | GVAR_HT_PUMP_CONTROL | 7470 | Hypertherm register for storing the pump control value |
 | GVAR_HT_FIRMWARE_VERSION | 7471 | Hypertherm firmware version register |
-| GVAR_HT_TEST_CUTFLOW_GASES | 7472 | |
+| GVAR_HT_TEST_CUTFLOW_GASES | 7472 | Cutflow test gases variable for Hypertherm consoles |
-| GVAR_HT_TEST_PREFLOW_GASES | 7473 | |
+| GVAR_HT_TEST_PREFLOW_GASES | 7473 | Preflow test gases variable for Hypertherm consoles |
 | GVAR_HT_LINE_VOLTAGE | 7474 | Line voltage value (Hypertherm) |
 | GVAR_HT_CHOPPER_CURRENT | 7475 | Chopper current value (Hypertherm) |
-| GVAR_HT_WORK_LEAD_CURRENT | 7476 | |
+| GVAR_HT_WORK_LEAD_CURRENT | 7476 | Lead current |
 | GVAR_HT_CHOPPER_TEMPERATURE | 7477 | Chopper temperature value (Hypertherm) |
-| GVAR_HT_TRANS_TEMPERATURE | 7478 | |
+| GVAR_HT_TRANS_TEMPERATURE | 7478 | Hypertherm temperature value |
 | GVAR_HT_GAS_PRESSURE | 7479 | Gas pressure value for Hypertherm machines is stored in this register |
 | GVAR_HT_COOLANT_FLOW_RATE | 7480 | Coolant flow rate (Hypertherm) |
 | GVAR_HT_CURRENT_ACTUAL | 7481 | The real current value for a Hypertherm machine is stored in this register |
-| GVAR_OXYFUEL_PREHEAT_COUNTDOUN | 7490 | |
+| GVAR_OXYFUEL_PREHEAT_COUNTDOUN | 7490 | Oxyfuel preheat countdown value |
 | GVAR_OXYFUEL_PREHEAT_COUNTDOUN_V2 | 7491 | The preheat countdown which is set by default (the preheat can then be turned off by the operator if they consider the process to be complete prior to the countdown end) |
 | GVAR_PROBE_SENSOR_CORRECTION_XMINUS | 7501 | Edge sensing correction values for the probe: this register specifies the negative-x correction value |
@@ Line 350: / Line 350: @@
 | GVAR_CUTPROCESS_MATERIAL_THICKNESS | 7602 | Specifies the material thickness |
 | GVAR_CUTPROCESS_TIME_PREHEAT | 7603 | Preheat time for the cut process |
-| GVAR_CUTPROCESS_TIME_SOFT_OXY_START | 7604 | |
+| GVAR_CUTPROCESS_TIME_SOFT_OXY_START | 7604 | Cutchart - time value for the oxyfuel cutting start |
 | GVAR_CUTPROCESS_CUTSPEED | 7605 | Specifies the cutting speed |
 ^ Oxy Fuel cutting, Automatic Gas Console ^^^
@@ Line 386: / Line 386: @@
 | GVAR_CUTPROCESS_CREEP_SPEED | 7651 | Creep speed for the plasma cutting process |
 ^  ^^^
-| GVAR_CUTPROCESS_MIX_GAS1 | 7652 |  |
+| GVAR_CUTPROCESS_MIX_GAS1 | 7652 | Register stores the mix gas data for Hypertherm consoles (gas #1) |
-| GVAR_CUTPROCESS_MIX_GAS2 | 7653 |  |
+| GVAR_CUTPROCESS_MIX_GAS2 | 7653 | Register stores the mix gas data for Hypertherm consoles (gas #2) |
 ^ Plasma Cutting, Automatic Gas Console ^^^
 | GVAR_CUTPROCESS_AGC_PLASMA_PREFLOW | 7660 | Automatic gas console preflow value |
@@ Line 433: / Line 433: @@
 | GVAR_CORRECTIONY_OFFSET | 8152 | Register reserved for future development - y-axis |
 | GVAR_CORRECTIONZ_OFFSET | 8153 | Flatbed correction (z-axis). This value will impact the program (work) coordinate. It is a read-only value which will be retrieved from the flatbed correction table in myCNC software. Writing to this register directly by setting it through a command is not recommended. |
-| GVAR_CURRENT_XMACHINE_POSITION | 8221 | +8 |
+| GVAR_CURRENT_XMACHINE_POSITION | 8221 | (+8) Stores the current machine position for the 8 axes |
-| GVAR_CURRENT_XWORK_POSITION | 8231 | +8 |
+| GVAR_CURRENT_XWORK_POSITION | 8231 | (+8) Stores the current work position for the 8 axes |
-| GVAR_CURRENT_XMACHINE_CORRECTION | 8241 | +8 |
+| GVAR_CURRENT_XMACHINE_CORRECTION | 8241 | (+8) Stores the current machine correction for the 8 axes|
 ^ Encoders ^^^
 | GVAR_ET5_ENCODER | 9000  | (+16) Registers represent Encoder values. Writing to this registers does not affect anything. Selected channel Current Encoder value will be returned when reading these registers. \\ Reading these registers from the controller Hardware PLC will return actual Encoder value. \\ Encoder values in the software are updated about every 128ms. This delay should be counted when using Encoder values from the Software PLC. \\ 9000 - Encoder #0 value \\ 9001 - Encoder #1 value \\ 9002 - Encoder #2 value \\ 9003 - Encoder #3 value \\ 9004 - Encoder #4 value \\ 9005 - Encoder #5 value \\ 9006 - Encoder #6 value \\ 9007 - Encoder #7 value |