Windows Registry Reference Manual for ServoWorks CNC Products and SMP Series General Motion Control Products

Transcription

1 Windows Registry Reference Manual for ServoWorks CNC Products and SMP Series General Motion Control Products Revision Soft Servo Systems, Inc.

2 Warning / Important Notice Warning The product described herein has the potential through misuse, inattention, or lack of understanding to create conditions that could result in personal injury, damage to equipment, or damage to the product(s) described herein. Machinery in motion and high-power, high-current servo drives can be dangerous; potentially hazardous situations such as runaway motors could result in death; burning or other serious personal injury to personnel; damage to equipment or machinery; or economic loss if procedures aren t followed properly. Soft Servo Systems, Inc. assumes no liability for any personal injury, property damage, losses or claims arising from misapplication of its products. In no event shall Soft Servo Systems, Inc. or its suppliers be liable to you or any other person for any incidental collateral, special or consequential damages to machines or products, including without limitation, property damage, damages for loss of profits, loss of customers, loss of goodwill, work stoppage, data loss, computer failure or malfunction claims by any party other than you, or any and all similar damages or loss even if Soft Servo Systems, Inc., its suppliers, or its agent has been advised of the possibility of such damages. It is therefore necessary for any and all personnel involved in the installation, maintenance, or use of these products to thoroughly read this pamphlet and related manuals and understand their contents. Soft Servo Systems, Inc. stands ready to answer any questions or clarify any confusion related to these products in as timely a manner as possible. The selection and application of Soft Servo Systems, Inc. s products remain the responsibility of the equipment designer or end user. Soft Servo Systems, Inc. accepts no responsibility for the way its controls are incorporated into a machine tool or factory automation setting. Any documentation and warnings provided by Soft Servo Systems, Inc. must be promptly provided to any end users. This document is based on information that was available at the time of publication. All efforts have been made to ensure that this document is accurate and complete. However, due to the widely varying uses of this product, and the variety of software and hardware configurations possible in connection with these uses, the information contained in this manual does not purport to cover every possible situation, contingency or variation in hardware or software configuration that could possibly arise in connection with the installation, maintenance, and use of the products described herein. Soft Servo Systems, Inc. assumes no obligations of notice to holders of this document with respect to changes subsequently made. Under no circumstances will Soft Servo Systems, Inc. be liable for any damages or injuries resulting from any defect or omission in this manual. Soft Servo Systems, Inc. makes no representation or warranty, expressed, implied, or statutory with respect to, and assumes no responsibility for the accuracy, completeness, sufficiency, or usefulness of the information contained herein. NO IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS OF PURPOSE SHALL APPLY. i

3 Warning / Important Notice Important Notice The information contained in this manual is intended to be used only for the purposes agreed upon in the related contract with Soft Servo Systems, Inc. All material contained herein is subject to restricted rights and restrictions set forth in the contract between the parties. These manuals contain confidential and proprietary information that is not to be shared with, nor distributed to, third parties by any means without the prior express, written permission of Soft Servo Systems, Inc. No materials contained herein are to be duplicated or reproduced in whole or in part without the express, written permission of Soft Servo Systems, Inc. Although every effort and precaution has been taken in preparing this manual, the information contained herein is subject to change without notice. This is because Soft Servo Systems, Inc. is constantly striving to improve its products. Soft Servo Systems, Inc. assumes no responsibility for errors or omissions. All rights reserved. Any violations of contractual agreements pertaining to the materials herein will be prosecuted to the full extent of the law. ii

4 Contents Table of Contents Warning... i Important Notice... ii Table of Contents... iii List of Tables... iv List of Figures... iv Chapter 1: Windows Registry and Registry Editor What is the Windows Registry? What is the Registry Editor? Chapter 2: ServoWorks CNC and SMP Registry Data Overview Default Registry Paths Registry Data in the HKEY_CLASSES_ROOT\ServoWorks Key Folder Structure of the HKEY_CLASSES_ROOT\ServoWorks Key Summary of Relevant Registry Information in the HKEY_CLASSES_ROOT Folder, ServoWorks Key Registry Data in the HKEY_CLASSES_ROOT\SNK Key Overview of the HKEY_CLASSES_ROOT\SNK Key The PLC Control Screen Utility Counters for PLC D Data for PLC Keep Relays for PLC Timers for PLC Summary of Relevant Registry Information in the HKEY_CLASSES_ROOT Folder, SNK Key Registry Data in the HKEY_CURRENT_USER\SNK\SNK_PLC Key Overview of the HKEY_CURRENT_USER\SNK\SNK_PLC Key The PLC Diagnose Utility LadderWorks Console Summary of Relevant Registry Information in the HKEY_CURRENT_USER\SNK Folder, SNK_PLC Key Chapter 3: APIs for Interacting with the Registry Chapter 4: Backing Up and Restoring Registry Data Uses for Backing Up and Restoring Registry Data Exporting Current Parameter Settings to Windows Files Importing Registry Settings to a PC from Windows Files Chapter 5: Setting All Parameter Settings Back to the Default Settings Index... I iii

5 Contents List of Tables Table 2-1: HKEY_CLASSES_ROOT\ServoWorks\GMC Subkey, System Settings Parameters (1 of 4) Table 2-2: HKEY_CLASSES_ROOT\ServoWorks\GMC Subkey, System Settings Parameters (2 of 4) Table 2-3: HKEY_CLASSES_ROOT\ServoWorks\GMC Subkey, System Settings Parameters (3 of 4) Table 2-4: HKEY_CLASSES_ROOT\ServoWorks\GMC Subkey, System Settings Parameters (4 of 4) Table 2-5: HKEY_CLASSES_ROOT\ServoWorks Key Summary of Registry Information for all ServoWorks CNC and SMP Products (1 of 2) Table 2-6: HKEY_CLASSES_ROOT\ServoWorks Key Summary of Registry Information for all ServoWorks CNC and SMP Products (2 of 2) Table 2-7: Summary of SNK Key Registry Information for all ServoWorks CNC and SMP Products Table 2-8: Summary of HKEY_CURRENT_USER\SNK Folder, SNK_PLC Key Registry Information for LadderWorks PLC List of Figures Figure 2-1: Registry Editor Window Showing HKEY_CLASSES_ROOT\ServoWorks Subkeys Figure 2-2: Registry Editor Window Showing SNK Subkeys Figure 2-3: PLC Control Screen Window for RUN Status Figure 2-4: PLC Control Screen Window for STOP Status Figure 2-5: Edit Counter Window Figure 2-6: PLC Edit Data Table Screen Figure 2-7: Edit Keep Relay Window Figure 2-8: Edit Timer Window Figure 2-9: Registry Editor Window Showing HKEY_CURRENT_USER\SNK\SNK_PLC Subkeys Figure 4-1: Start Menu Selection Showing Run Figure 4-2: Run Window Figure 4-3: Main Registry Editor Window Figure 4-4: Registry Editor Window with ServoWorks Selected Figure 4-5: Registry Editor Window with GMC Selected Figure 4-6: Registry Editor Window File Pull Down Menu Figure 4-7: Export Registry File Window (1 of 2) Figure 4-8: Registry Editor Window with SMP Selected Figure 4-9: Export Registry File Window (2 of 2) Figure 4-10: Registry Editor Window File Pull Down Menu Figure 4-11: Import Registry File Window Figure 4-12: Registry Editor Dialog Box Importing Success Message Figure 5-1: Start Menu Selection Showing Run Figure 5-2: Run Window Figure 5-3: Main Registry Editor Window Figure 5-4: Registry Editor Window with ServoWorks Selected Figure 5-5: Registry Editor Window with GMC Selected Figure 5-6: Registry Editor Window Edit Pull Down Menu Figure 5-7: Confirm Delete Key Dialog Box Figure 5-8: Registry Editor Window with SMP Selected iv

6 Chapter 1: Windows Registry and Registry Editor Chapter 1: Windows Registry and Registry Editor 1.1 What is the Windows Registry? The Windows registry is a database repository for information about a computer s configuration. The registry contains information that Windows continually references during operation, such as: Profiles for each user. The programs installed on the computer and the types of documents each can create. Property settings for folders and program icons. What hardware exists on the system. Which ports are being used. The registry is organized hierarchically as a tree and is made up of keys and their subkeys, hives, and value entries. 1.2 What is the Registry Editor? The Registry Editor is an advanced tool (included with your Windows operating system) for viewing, changing, inspecting and modifying settings in your system registry. You may use the Registry Editor to export registry settings, import registry settings, or to set all ServoWorks CNC or SMP parameters back to their default settings, as described in subsequent chapters of this manual.! CAUTION Do not use the Registry Editor to make any changes to Windows registry entries. Only use the Registry Editor to import or export registry folders. Follow the procedures in this manual very carefully. INCORRECTLY EDITING THE REGISTRY MAY SEVERELY DAMAGE YOUR SYSTEM. 1-1

7 Chapter 2: ServoWorks CNC and SMP Registry Data 2.1 Overview Chapter 2: ServoWorks CNC and SMP Registry Data This information is only provided for SDK (ServoWorks Development Kit) and MDK (Motion Development Kit) users, who will need to use the Windows registry for their customized programs. Many registry entries are in binary and hexadecimal format, and their values are not readily apparent when viewed in the Windows Registry Editor.! CAUTION UNDER NO CIRCUMSTANCES SHOULD REGISTRY ENTRIES BE MODIFIED DIRECTLY. All parameters should be modified by using a ServoWorks CNC or SMP application (Configure Mode or Configuration Mode in ServoWorks CNC products, and the Parameters window in the SMP Console and ServoWorks MotionLite) to change parameter values, which in turn updates the registry automatically. If you are not developing a customized ServoWorks CNC or SMP application, you should skip this chapter. 2.2 Default Registry Paths Data for ServoWorks CNC and SMP products, including LadderWorks PLC, is stored in two different predefined keys: the HKEY_CLASSES_ROOT folder and the HKEY_CURRENT_USER folder. Within the HKEY_CLASSES_ROOT folder, there are two different keys: the ServoWorks key and the SNK key. The default registry path for all ServoWorks CNC and SMP products is: My Computer\HKEY_CLASSES_ROOT\ServoWorks The default registry paths for all LadderWorks PLC parameters are: My Computer\HKEY_CLASSES_ROOT\SNK My Computer\HKEY_CURRENT_USER\SNK\SNK_PLC 2.3 Registry Data in the HKEY_CLASSES_ROOT\ServoWorks Key Folder Structure of the HKEY_CLASSES_ROOT\ServoWorks Key The structure of the ServoWorks key in the registry varies somewhat depending upon which ServoWorks CNC or SMP product is installed. For customized ServoWorks CNC or SMP products created with the ServoWorks Development Kit (SDK) or the Motion Development Kit (MDK), the application developer determines some of the structure. For off-the-shelf ServoWorks CNC or SMP products, there are three types of folders for registry entries for ServoWorks CNC and SMP Products: 2-1

8 Chapter 2: ServoWorks CNC and SMP Registry Data 1) GMC This folder is used to store all system parameters, including those created and updated by SDK or MDK APIs (SWAPI or MAPI) through the SwDll.dll file (a dynamic link library containing code and data for ServoWorks CNC and SMP products it provides the interface between the ServoWorks CNC/SMP applications in the Win32 subspace and the CNC Engine or SMP Motion Engine in the real-time subspace). System parameters included in this folder are divided into four subfolders: a) ABS_Encoder b) NC_Param c) Servo_Control_Param d) Servo_Drive_Param! CAUTION The format of this GMC folder is predetermined and SHOULD NOT BE CHANGED. We strongly caution against manually modifying this folder in any way. 2) Windows HMI Applications These folders store program data (such as Windows HMI-related data or user-defined program parameters) for ServoWorks CNC and SMP applications. These registry entries are created and updated by Windows APIs in HMI or Windows applications. Each folder is named for the Windows HMI application it was created by (i.e. S100M, S120M or S140M, for the ServoWorks S-100M series; MC_QUAD for ServoWorks MC-Quad; Lathe for ServoWorks S-100T; or SMP for the SMP Console). NOTE: SDK and MDK users must create the path, the format and the data to be saved for each customized ServoWorks CNC or SMP application they create. For example, ServoWorks S-100M creates and maintains an S100M folder, for example, in My Computer\HKEY_CLASSES_ROOT\ServoWorks\S100M sub folders include: a) ATC b) AxisName c) Color d) Display e) MacroVar f) PitchErr g) Plot h) ToolOffset i) WorkpieceOffset 2-2

9 Chapter 2: ServoWorks CNC and SMP Registry Data 3) Products This folder is used to store the product version and the license code, and is created and updated by the ServoWorks CNC or SMP installer. A screen shot of the ServoWorks key in the HKEY_CLASSES_ROOT folder (showing multiple ServoWorks CNC and SMP installations) follows: Figure 2-1: Registry Editor Window Showing HKEY_CLASSES_ROOT\ServoWorks Subkeys 2-3

10 Chapter 2: ServoWorks CNC and SMP Registry Data Summary of Relevant Registry Information in the HKEY_CLASSES_ROOT Folder, ServoWorks Key Sub Folder ABS_Encoder NC_Param Value Entry Name Corresponding Parameter Name* Corresponding Variable Name in SDK AbsEnc_Home_Value AbsEncHomeValue AbsEnc_Home_Done AbsEncHomeDone Always_Search_Home Always Search for Home AlwaysSearchHome Axis_Type Axis Type AxisType Backlash Backlash Value Backlash Circle_Error_Limit Default_Cutting_Lead Default_Program_Unit Unit / Default Program Unit DefaultProgramUnit DryRun_Feedrate Dry Run Feedrate DryRunFeedrate FeedDn_EDM FeedUp_EDM Accumulate HandWheel Pulse HandWheel_Pulse_Accum (HandWheel Pulse HandwheelPulseAccumulation Accumulation) HandWheel_Type Enable HandWheel / HandWheel Type HandwheelType Home_Direction Home Direction HomeDirection Home_Reverse_Distance Home Reverse Distance HomeReverseDistance Home_Reverse_Dwell_Time Home Reverse Dwell Time HomeReverseDwellTime Home_Shift Home Shift HomeShift Home_Speed Grid Search Speed HomeSpeed Home_Switch_Search_Speed Home Switch Search Speed HomeSwitchSearchSpeed Home_Switch_Type Home Switch Type HomeSwitchType Home_Timeout Home_Type Home Type HomeType Int_Prog_Enable Enable Integer Programming with Machine Unit IntProgEnable Jog_Feedrate Jog Feedrate JogFeedrate LengthDn_EDM LengthUp_EDM Linear_Scale_On Max_AccDec_Rate Maximum Acceleration/ Deceleration Rate MaxAccDecRate Minus_Stroke Minus Stroke MinusStroke No_Of_DC120 Number of DC Modules NoOfDC_Modules No_Of_IM200 Number of IM Modules NoOfIM_Modules Table 2-1: HKEY_CLASSES_ROOT\ServoWorks\GMC Subkey, System Settings Parameters (1 of 4) 2-4

11 Chapter 2: ServoWorks CNC and SMP Registry Data Sub Folder Servo_Control_Param Value Entry Name Corresponding Parameter Name* Corresponding Variable Name in SDK OverPosErrSynLimit_Rpd Over Position Error Sync Limit Moving OverPosErrSynLimit_Rpd OverPosErrSynLimit_Stp Over Position Error Sync Limit Stopped OverPosErrSynLimit_Stp Pitch_Interval Pitch Interval PitchInterval Pitch_Origin Pitch Origin PitchOrigin Plus_Stroke Plus Stroke PlusStroke PowerCntl_EDM Product_Version Rapid_Feed_Type G00 Perform Linear Interpolation (Rapid Feed Type) RapidFeedType Rapid_Feedrate Rapid Feedrate RapidFeedrate Rapid_Feedrate_Zero Ref_Point_2 Reference Position #2 RefPoint_2 Ref_Point_3 Reference Position #3 RefPoint_3 Ref_Point_4 Reference Position #4 RefPoint_4 Retract_Vector Retract Vector RetractVector Rpd_Linear_Feed Rpd_Linear_Feed_Zero Set_Point Shift_Direction Shift Direction ShiftDirection SynAssociatedToAxis Sync Master Axis SynAssociatedToAxis SynControlRes1 SynControlRes2 SynSlaveCompGain TimeOver_EDM Z_Dir_EDM Sync Slave Axis Compensation Gain SynSlaveCompGain Z_Spd_EDM Dis_Enc_Rev Distance Per Encoder Revolution DisPerEncRev EStop_Type E-STOP Type EStopType In_Position_Val In Position Width InPositionWidth Limit_Switch_Action Hard Limit Switch Action LimitSwitchAction Limit_Switch_Type Limit Switch Type LimitSwitchType Machine_Unit Machine Unit (Minimum Resolution) MachineUnit Notch_Filter1_d1 Notch_Filter1_d2 Table 2-2: HKEY_CLASSES_ROOT\ServoWorks\GMC Subkey, System Settings Parameters (2 of 4) 2-5

12 Sub Folder Servo_Control_Param (continued) REFERENCE MANUAL FOR SERVOWORKS CNC PARAMETERS AND FUNCTIONS Chapter 2: ServoWorks CNC and SMP Registry Data Value Entry Name Corresponding Parameter Name* Corresponding Variable Name in SDK Notch_Filter1_Enable Notch_Filter1_n1 Notch_Filter1_n2 Notch_Filter2_d1 Notch_Filter2_d2 Notch_Filter2_Enable Notch_Filter2_n1 Notch_Filter2_n2 Notch_Filter3_d1 Notch_Filter3_d2 Notch_Filter3_Enable Notch_Filter3_n1 Notch_Filter3_n2 Notch_Filter4_d1 Notch_Filter4_d2 Notch_Filter4_Enable Notch_Filter4_n1 Notch_Filter4_n2 Over_PosErr_Limit_Moving Over Position Error Protection OverPosErrServoOffLimit_Mo Limit Moving ving Over_PosErr_Limit_Stopped Over Position Error Protection OverPosErrServoOffLimit_Sto Limit Stopped pped Pos_iEnable Position Loop Integral Control Enable PosLoopIntEnable Pos_iSaturation Position Loop Integral Saturation PosLoopIntSaturation Pos_iTimeConst Position Loop Integral Time Constant PosLoopIntTimeConst Pos_pGain Position Loop Gain PosLoopGain Smoothing_Mode_Cutting Smoothing Mode Cutting SmoothingMode_Cutting Smoothing_Mode_Manual Smoothing Mode Manual SmoothingMode_Manual Smoothing_Mode_Rapid Smoothing Mode Rapid SmoothingMode_Rapid Smoothing_Time_Cutting Smoothing Time Cutting SmoothingTime_Regular_Cutt ing Smoothing_Time_Look_Ahead Look Ahead Smoothing Time SmoothingTime_LookAhead Smoothing_Time_Manual Smoothing Time Manual SmoothingTime_Regular_Ma nual Smoothing_Time_Rapid Smoothing Time Rapid SmoothingTime_Regular_Rap id VelocityFF_Enable Velocity Feedforward Enable VelocityFFEnable VelocityFF_Pct Velocity Feedforward Percentage VelocityFFpct Table 2-3: HKEY_CLASSES_ROOT\ServoWorks\GMC Subkey, System Settings Parameters (3 of 4) 2-6

13 Chapter 2: ServoWorks CNC and SMP Registry Data Sub Folder Servo_Drive_Param Value Entry Name Corresponding Parameter Name* Corresponding Variable Name in SDK Drive_Vel_Sensitivity Servo Drive Velocity Sensitivity DriveVelSensitivity Encoder_Polarity Encoder Polarity EncoderPolarity Encoder_Resolution Encoder Resolution EncoderResolution Encoder_Type Encoder Type EncoderType Motor_Polarity Motor Polarity MotorPolarity Motor_Type Peak_Velocity Peak Velocity PeakVelocity Rated_Velocity Rated Velocity RatedVelocity Stepper_Resolution Table 2-4: HKEY_CLASSES_ROOT\ServoWorks\GMC Subkey, System Settings Parameters (4 of 4) * System parameters are discussed in detail in the Reference Manual for ServoWorks CNC Parameters and Functions, the ServoWorks S-100T Parameters Manual and the Reference Manual for SMP Parameters and Functions. 2-7

14 Chapter 2: ServoWorks CNC and SMP Registry Data Subkey Parameter Type Sub Folders Sub Subfolders GMC System Settings See tables, previous pages Lathe MC_QUAD Products Program Settings Program Settings Version/License COLOR DISPLAY FEEDRATE HANDWHEEL HOME MACHINEERROR MCODE Password PICTURE PROGRAM SAFEZONE SERVOCONTROL SMOOTHFILTER SPINDLE_GENERAL TOOLOFFSET WORKCOORDINATE Color Display Home MacroVar Plot ToolOffset WorkpieceOffset PermanentMacroVar Table 2-5: HKEY_CLASSES_ROOT\ServoWorks Key Summary of Registry Information for all ServoWorks CNC and SMP Products (1 of 2) 2-8

15 Chapter 2: ServoWorks CNC and SMP Registry Data Subkey Parameter Type Sub Folders Sub Subfolders S100M Program Settings ATC AxisName Color Display MacroVar PermanentMacroVar Plot ToolOffset S120M Program Settings WorkpieceOffset ATC AxisName Color Display MacroVar PermanentMacroVar Plot ToolOffset S140M Program Settings WorkpieceOffset ATC AxisName Color Display MacroVar PermanentMacroVar Plot ToolOffset SMP Program Settings WorkpieceOffset CylIntAxis Display GapSensor Messenger WORKCOORDINATE Table 2-6: HKEY_CLASSES_ROOT\ServoWorks Key Summary of Registry Information for all ServoWorks CNC and SMP Products (2 of 2) 2-9

16 Chapter 2: ServoWorks CNC and SMP Registry Data 2.4 Registry Data in the HKEY_CLASSES_ROOT\SNK Key Overview of the HKEY_CLASSES_ROOT\SNK Key Registry data in the HKEY_CLASSES_ROOT\SNK key is used to store information relevant to the PLC Control Screen Utility included with LadderWorks PLC. A typical screen shot of the SNK key in HKEY_CLASSES_ROOT follows: Figure 2-2: Registry Editor Window Showing SNK Subkeys Four of the subkeys in the SNK_PLC folder relate directly to values set with the PLC Control Screen Utility The PLC Control Screen Utility To access the PLC Control Screen Utility, double click on the file in C:\SwPLC\Utility. If the status of ladder logic is RUN, you will see the PLC Control Screen window shown in the following figure: 2-10

17 Chapter 2: ServoWorks CNC and SMP Registry Data Figure 2-3: PLC Control Screen Window for RUN Status If the status of ladder logic is STOP, you will see the PLC Control Screen window shown in the following figure: Figure 2-4: PLC Control Screen Window for STOP Status The first time you run the PLC Control Screen utility, the K edit, T edit and C edit buttons may be disabled. If these three buttons are disabled, you can enable them by compiling the SwPLC table see Section 6.2: PLC Tables for Input/Output Declaration of the LadderWorks PLC User s Manual, and follow the procedure described in this section. To exit the PLC Control Screen utility at any time, click on the button in the upper right hand corner. 2-11

18 Chapter 2: ServoWorks CNC and SMP Registry Data Counters for PLC The data in the CTR registry sub folder relates to the counter values used by the CTR counter functional command (SUB5) and the CTRC counter functional command (SUB55) for LadderWorks PLC. There are five pages of counter data in the Edit Counter window, corresponding to the PAGE01 to PAGE05 folders in the CTR registry folder. To view the Edit Counter window, click the C edit button in the PLC Control Screen utility, and the following window will appear: Figure 2-5: Edit Counter Window D Data for PLC The data in the DATA registry sub folder relates to D data for LadderWorks PLC. There are two pages of D data in the Edit Data Table window, corresponding to the PAGE01 and PAGE02 folders in the DATA registry folder. To view the Edit Data Table window, click the D edit button in the PLC Control Screen utility, and the following window will appear: Figure 2-6: PLC Edit Data Table Screen 2-12

19 2.4.5 Keep Relays for PLC REFERENCE MANUAL FOR SERVOWORKS CNC PARAMETERS AND FUNCTIONS Chapter 2: ServoWorks CNC and SMP Registry Data The data in the KEEP registry sub folder relates to the keep relay values used by LadderWorks PLC. There are 100 pages of keep relay data in the Edit Keep Relay window, corresponding to the PAGE01 to PAGE100 folders in the KEEP registry folder. To view the Edit Keep Relay window, click the K edit button in the PLC Control Screen utility, and the following window will appear: Figure 2-7: Edit Keep Relay Window Timers for PLC The data in the TMR registry sub folder relates to the timers for LadderWorks PLC. There are ten pages of counter data in the Edit Timer window, corresponding to the PAGE01 to PAGE10 folders in the TMR registry folder. To view the Edit Timer window, click the T edit button in the PLC Control Screen utility, and the following window will appear: Figure 2-8: Edit Timer Window 2-13

20 Chapter 2: ServoWorks CNC and SMP Registry Data Summary of Relevant Registry Information in the HKEY_CLASSES_ROOT Folder, SNK Key Subkey Parameter Type Sub Folders Sub Subfolders Notes AXIS PLC Settings n/a Not used MESSAGE PLC Settings TABLE Not used SNK_PLC PLC Settings CTR DATA I/O KEEP DATA PAGE01 PAGE02 PAGE03 PAGE04 PAGE05 DATA PAGE01 PAGE02 PAGE01 PAGE02 PAGE03 PAGE04 DATA PAGE01.. See Figure 2-5 See Figure 2-6 See Figure 2-7 RELAY SLINKT TMR PAGE100 PAGE01.. PAGE39 DATA PAGE01.. PAGE17 DATA PAGE01.. PAGE10 Not used See Figure 2-8 Table 2-7: Summary of SNK Key Registry Information for all ServoWorks CNC and SMP Products 2-14

21 Chapter 2: ServoWorks CNC and SMP Registry Data 2.5 Registry Data in the HKEY_CURRENT_USER\SNK\SNK_PLC Key Overview of the HKEY_CURRENT_USER\SNK\SNK_PLC Key Registry data in the HKEY_CURRENT_USER\SNK\SNK_PLC key is used to store information relevant to the PLC Diagnose Utility and the LadderWorks Console application included with LadderWorks PLC. A typical screen shot of the SNK_PLC key in the HKEY_CURRENT_USER\SNK folder follows: Figure 2-9: Registry Editor Window Showing HKEY_CURRENT_USER\SNK\SNK_PLC Subkeys The PLC Diagnose Utility The PLC Diagnose Utility is a utility for verifying sequence programs with ladder diagrams (viewing ladder diagrams only you cannot edit in the ladder diagram format with this utility). [NOTE: This is a LadderWorks PLC legacy product that will be discontinued in the future.] LadderWorks Console LadderWorks Console is a Win32 application for creating, editing, monitoring, debugging and compiling PLC ladder diagram (LD) sequence programs Summary of Relevant Registry Information in the HKEY_CURRENT_USER\SNK Folder, SNK_PLC Key Subkey Parameter Type Sub Folders SNK_PLC_DIAGNOSE SW_PLC_EDITOR PLC Diagnose Utility Settings LadderWorks Console Settings COLOR SEARCH WINDOW INSATLL_PATH Table 2-8: Summary of HKEY_CURRENT_USER\SNK Folder, SNK_PLC Key Registry Information for LadderWorks PLC 2-15

22 Chapter 3: APIs for Interacting with the Registry Chapter 3: APIs for Interacting with the Registry Please refer to our API manuals (either the ServoWorks API (SWAPI) Reference Manual for C/C++ and Visual Basic or the SMP Motion and Logic API (MAPI) Reference Manual for C/C++ and Visual Basic) for the details of the following registry-related APIs: sssloadparameters (loads parameter settings from registry or the initialization files and feeds the data into parameter structures) ssssaveparameters (saves parameter settings to the system registry or initialization files from the structures) sssloadabsencparameters (loads absolute encoder parameters from file or Windows registry and sends it to the Real-Time Engines. These parameters include information on whether the absolute encoder homing has ever been performed, and the absolute encoder home location.) ssssaveabsencparameters (Gets the absolute encoder parameters from the Real-Time Engines, and saves them to file or to the Windows registry. These parameters include information on whether the absolute encoder homing has ever been performed, and the absolute encoder home location.) 3-1

23 Chapter 4: Backing Up and Restoring Registry Data Chapter 4: Backing Up and Restoring Registry Data 4.1 Uses for Backing Up and Restoring Registry Data All current software settings are contained in the Windows registry. Therefore, when you have completed your installation, setup and integration for any ServoWorks CNC or SMP product (especially the important process of tuning your system), we highly recommend that you back up the GMC and Windows application folders in the HKEY_CLASSES_ROOT\ServoWorks key of the Windows registry. This will save you time and money if you need to recreate your optimized software environment for any reason. This is also useful for creating an identical control system with a new PC. To back up your current parameter settings, you must export two folders to two Windows files (as explained in Section 4.2: Exporting Current Parameter Settings to Windows Files). [We recommend saving these files somewhere other than your PC.] To restore a set of parameters, you can import your desired parameter settings from these two Windows files (as explained in Section 4.3: Importing Registry Settings to a PC from Windows Files). You can also use your registry data files for quickly accessing parameter information, such as your password to access Configure Mode (or Configuration Mode). Open a saved.reg file with any text editor (such as Notepad), and you can search for "password" to get your password setting. 4.2 Exporting Current Parameter Settings to Windows Files The following steps will guide you in saving your current parameter settings to two files: 1) From the Windows Start menu, go to Run as shown: Figure 4-1: Start Menu Selection Showing Run 2) You will see the Run window appear, as shown: 4-1

24 Chapter 4: Backing Up and Restoring Registry Data Figure 4-2: Run Window 3) Type in regedit as shown, and then click the OK button. You will see the Registry Editor application appear, as shown: Figure 4-3: Main Registry Editor Window 4) Click on the symbol next to "HKEY_CLASSES_ROOT"to see the drop-down list under HKEY_CLASSES_ROOT. Then, with "HKEY_CLASSES_ROOT" selected, scroll all the way down to the key named "ServoWorks" (as shown in the following window): Figure 4-4: Registry Editor Window with ServoWorks Selected 4-2

25 Chapter 4: Backing Up and Restoring Registry Data 5) Click on the symbol next to "ServoWorks" to see the drop-down list under ServoWorks. Then click on the GMC key (as shown in the following window): Figure 4-5: Registry Editor Window with GMC Selected 6) Select "Export" from the "File" pull-down menu, as shown in the following figure: Figure 4-6: Registry Editor Window File Pull Down Menu 7) You will see an Export Registry File window appear, as shown in the following figure: 4-3

26 Chapter 4: Backing Up and Restoring Registry Data Figure 4-7: Export Registry File Window (1 of 2) 8) Note that the export range for the selected branch shows HKEY_CLASSES_ROOT\ServoWorks\GMC your location in the registry before you selected Export. Browse to the folder where you want to save this registry settings file, set an arbitrary name for this file (or click on an existing file to overwrite), and click the "OK" button. This.reg file will contain the current GMC parameter settings. 9) Now click on the relevant Windows application folder in the ServoWorks key: If you are using ServoWorks S-100M, select the S100M folder. If you are using ServoWorks S-120M, select the S120M folder. If you are using ServoWorks S-140M, select the S140M folder. If you are using ServoWorks MC-Quad, select the MC_QUAD folder. If you are using ServoWorks S-100T, select the Lathe folder. If you are using an SMP product, select the SMP folder, as shown in the following window: 4-4

27 Chapter 4: Backing Up and Restoring Registry Data Figure 4-8: Registry Editor Window with SMP Selected 10) Select "Export" from the "File" pull-down menu, as shown in Figure ) You will see an Export Registry File window appear, as shown in the following figure: Figure 4-9: Export Registry File Window (2 of 2) 4-5

28 Chapter 4: Backing Up and Restoring Registry Data 12) Note that the export range for the selected branch shows HKEY_CLASSES_ROOT\ServoWorks\SMP in this example your location in the registry before you selected Export. Browse to the folder where you want to save this registry settings file, set an arbitrary name for this file (or click on an existing file to overwrite), and click the "OK" button. This.reg file will contain the current Windows application parameter settings. Your registry settings are now backed up. NOTE: In addition to backing up individual sub-keys such as the GMC and Windows application keys, you can back up the entire ServoWorks key. However, this is not recommended if you are planning to import those settings to another computer, because your ServoWorks CNC or SMP license information (contained in the Products key) will be overwritten, and you will have to reregister your ServoWorks CNC or SMP product. 4.3 Importing Registry Settings to a PC from Windows Files The following steps will guide you in importing a set of registry settings to a PC (either the same PC from which the registry settings were backed up, or a different PC). You must first have saved your desired parameter settings to one or more files, as shown in the previous section, Section 4.2 Exporting Current Parameter Settings to Windows Files. NOTE: If you are backing up the entire ServoWorks key from HKEY_CLASSES_ROOT (not recommended), make a note of your ServoWorks CNC or SMP license code before beginning this procedure, as your license code for your ServoWorks CNC or SMP product will be overwritten, and you will be required to reregister your ServoWorks CNC or SMP product. 1) Copy the.reg file(s) with the desired registry settings to the target PC, in a location of your choice. 2) From the Windows Start menu, go to Run as shown in Figure ) You will see the Run window appear, as shown in Figure ) Type in regedit as shown, and then click the OK button. You will see the Registry Editor application appear, as shown in Figure ) Click on the symbol next to"hkey_classes_root" to see the drop-down list under HKEY_CLASSES_ROOT. Then, with "HKEY_CLASSES_ROOT" selected, scroll all the way down and select (click on) the key you are importing (i.e. GMC, SMP, ServoWorks, etc). 6) Select "Import" from the "File" pull-down menu, as shown in the following figure: 4-6

29 Chapter 4: Backing Up and Restoring Registry Data Figure 4-10: Registry Editor Window File Pull Down Menu 7) You will see an Import Registry File window appear, as shown in the following figure: Figure 4-11: Import Registry File Window 8) Select the file with your parameter settings (you can only select one file at a time), then click the "OK" button. You will see a window similar to the following appear: Figure 4-12: Registry Editor Dialog Box Importing Success Message 4-7

30 Chapter 4: Backing Up and Restoring Registry Data 9) To import a second registry file, select "Import" from the "File" pull-down menu again, as shown in Figure You will see the Import Registry File window appear again, as shown in Figure ) Select the second file with your parameter settings (you can only select one file at a time), then click the "OK" button. You should see a message telling you the file was successfully entered into the registry, similar to Figure To back up more than two registry files, keep repeating steps 9 and 10. NOTE: If you are trying to create an identical control system with the same PC environment, you should first install and register your ServoWorks CNC or SMP product, then import registry settings to overwrite the default settings. If you import a registry file containing settings for the entire ServoWorks key, you will need to reregister your product, as your license code will be overwritten. [Click on the "Registration" button in the ServoWorks CNC or SMP installer and input your license code again.] To avoid this problem, instead of importing a registry file containing settings for the entire ServoWorks key, import separate registry files for GMC and the relevant Windows application folder under the ServoWorks key. 4-8

31 Chapter 5: Setting All Parameter Settings Back to the Default Settings Chapter 5: Setting All Parameter Settings Back to the Default Settings You can change the current parameter settings for a ServoWorks CNC or SMP product back to the default parameter settings with the following steps: 1) From the Windows Start menu, go to Run as shown: Figure 5-1: Start Menu Selection Showing Run 2) You will see the Run window appear, as shown: Figure 5-2: Run Window 3) Type in regedit as shown, and then click the OK button. You will see the Registry Editor application appear, as shown: 5-1

32 Chapter 5: Setting All Parameter Settings Back to the Default Settings Figure 5-3: Main Registry Editor Window 4) Click on the symbol next to "HKEY_CLASSES_ROOT" to see the drop-down list under HKEY_CLASSES_ROOT. Then, with "HKEY_CLASSES_ROOT" selected, scroll all the way down to the key named "ServoWorks" (as shown in the following window): Figure 5-4: Registry Editor Window with ServoWorks Selected 5) Click on the symbol next to "ServoWorks" to see the drop-down list under ServoWorks. Then, select (click on) the key named "GMC" (as shown in the following window): 5-2

33 Chapter 5: Setting All Parameter Settings Back to the Default Settings Figure 5-5: Registry Editor Window with GMC Selected 6) Delete the "GMC" key by pressing the delete key on your keyboard, or by selecting Delete from the Edit pull-down menu, as shown: Figure 5-6: Registry Editor Window Edit Pull Down Menu 7) You will see the following Confirm Key Delete button appear. Figure 5-7: Confirm Delete Key Dialog Box 8) Click the Yes button to finalize the deletion of the GMC registry key. 9) Now click on the relevant Windows application folder: 5-3

34 Chapter 5: Setting All Parameter Settings Back to the Default Settings If you are using ServoWorks S-100M, select the S100M folder. If you are using ServoWorks S-120M, select the S120M folder. If you are using ServoWorks S-140M, select the S140M folder. If you are using ServoWorks MC-Quad, select the MC_QUAD folder. If you are using ServoWorks S-100T, select the Lathe folder. If you are using an SMP product, select the SMP folder, as shown in the following window: Figure 5-8: Registry Editor Window with SMP Selected 10) Delete the selected key by pressing the delete key on your keyboard, or by selecting Delete from the Edit pull-down menu, as shown in Figure 5-6. You will see the Confirm Key Delete button appear as shown in Figure 5-7. Click the Yes button to finalize the deletion of the selected registry key. 11) The next time when you run your ServoWorks CNC or SMP application, the default settings will be restored automatically. NOTE: In addition to deleting the GMC and Windows application folder subkeys, you can delete the entire ServoWorks key. You will, however, need to reregister your ServoWorks CNC or SMP application, as you will be deleting the Products key with your license code. 5-4

35 Index Index CTR registry sub folder DATA registry sub folder KEEP registry sub folder Run window SNK_PLC SNK Key TMR registry sub folder A ABS_Encoder folder , 2-4 AbsEnc_Home_Done AbsEnc_Home_Value AbsEncHomeDone AbsEncHomeValue absolute encoder parameters accessing parameter information accumulate handwheel pulse always search for home Always_Search_Home AlwaysSearchHome APIs for interacting with the registry ATC AXIS axis type Axis_Type AxisName AxisType B backing up registry data Backlash backlash value C C edit button , 2-12 Circle_Error_Limit Color , 2-9 COLOR , 2-15 Confirm Key Delete , 5-4 Control Screen UtilitySee PLC Control Screen Utility counters for PLC creating an identical control system CTR CTR counter functional command CTRC counter functional command CylIntAxis D D data for PLC D edit button DATA default program unit default registry paths default settings , 5-1 Default_Cutting_Lead Default_Program_Unit DefaultProgramUnit Diagnose Utility...See PLC Diagnose Utility Dis_Enc_Rev DisPerEncRev Display , 2-9 DISPLAY distance per encoder revolution Drive_Vel_Sensitivity DriveVelSensitivity dry run feedrate DryRun_Feedrate DryRunFeedrate duplicating a control system E Edit Counter Window Edit Data Table Screen Edit Keep Relay Window Edit Timer Window enable handwheel enable integer programming with machine unit encoder polarity encoder resolution encoder type Encoder_Polarity Encoder_Resolution Encoder_Type EncoderPolarity EncoderResolution EncoderType E-STOP type EStop_Type EstopType exporting current parameter settings to Windows Files exporting registry data exporting settings in your system registry F FeedDn_EDM I

36 Index FEEDRATE FeedUp_EDM G G00 perform linear interpolation GapSensor GMC GMC folder , 2-8 grid search speed H HANDWHEEL handwheel pulse accumulation handwheel type HandWheel_Pulse_Accum HandWheel_Type HandwheelPulseAccumulation HandwheelType hard limit switch action HKEY_CLASSES_ROOT HKEY_CLASSES_ROOT folder HKEY_CURRENT_USER HKEY_CURRENT_USER folder HKEY_CURRENT_USER\SNK Home HOME home direction home reverse distance home reverse dwell Time home shift home speed home switch search speed home switch type home type Home_Direction Home_Reverse_Distance Home_Reverse_Dwell_Time Home_Shift Home_Speed Home_Switch_Search_Speed Home_Switch_Type Home_Timeout Home_Type HomeDirection HomeReverseDistance HomeReverseDwellTime HomeShift HomeSpeed HomeSwitchSearchSpeed HomeSwitchType HomeType I I/O identical control system importing registry data importing registry settings to a PC from Windows files importing settings in your system registry in position width In_Position_Val InPositionWidth INSATLL_PATH installer Int_Prog_Enable integer programming with machine unit enable IntProgEnable J jog feedrate Jog_Feedrate JogFeedrate K K edit button , 2-13 KEEP keep relays for PLC keys L LadderWorks Console LadderWorks PLC , 2-15 Lathe folder legacy software products LengthDn_EDM LengthUp_EDM license code limit switch type Limit_Switch_Action Limit_Switch_Type LimitSwitchAction LimitSwitchType Linear_Scale_On look ahead smoothing time M machine unit Machine_Unit MACHINEERROR MachineUnit MacroVar , 2-9 Max_AccDec_Rate MaxAccDecRate maximum acceleration/deceleration rate MC_QUAD folder MCODE MDK MESSAGE II

37 Index Messenger minimum resolution minus stroke Minus_Stroke MinusStroke modifying settings in your system registry motor polarity Motor_Polarity Motor_Type MotorPolarity N NC_Param folder , 2-4 No_Of_DC No_Of_IM NoOfDC_Modules NoOfIM_Modules Notch_Filter1_d Notch_Filter1_d Notch_Filter1_Enable Notch_Filter1_n Notch_Filter1_n Notch_Filter2_d Notch_Filter2_d Notch_Filter2_Enable Notch_Filter2_n Notch_Filter2_n Notch_Filter3_d Notch_Filter3_d Notch_Filter3_Enable Notch_Filter3_n Notch_Filter3_n Notch_Filter4_d Notch_Filter4_d Notch_Filter4_Enable Notch_Filter4_n Notch_Filter4_n number of DC modules number of IM modules O over position error protection limit moving over position error protection limit stopped over position error sync limit moving over position error sync limit stopped Over_PosErr_Limit_Moving Over_PosErr_Limit_Stopped OverPosErrServoOffLimit_Moving OverPosErrServoOffLimit_Stopped OverPosErrSynLimit_Rpd OverPosErrSynLimit_Stp overwriting registry settings P PAGE parameter default settings parameters program parameters, absolute encoder Password paths peak velocity Peak_Velocity PeakVelocity PermanentMacroVar , 2-9 PICTURE pitch interval pitch origin Pitch_Interval Pitch_Origin PitchInterval PitchOrigin PLC , 2-15 PLC Control Screen utility PLC Control Screen Utility PLC Diagnose Utility PLC Diagnose Utility PLC Edit Data Table Screen Plot , 2-9 plus stroke Plus_Stroke PlusStroke Pos_iEnable Pos_iSaturation Pos_iTimeConst Pos_pGain position loop gain position loop integral control enable position loop integral saturation position loop integral time constant PosLoopGain PosLoopIntEnable PosLoopIntSaturation PosLoopIntTimeConst PowerCntl_EDM product version Product_Version Products folder , 2-8 PROGRAM program data program parameters R rapid feed type rapid feedrate Rapid_Feed_Type Rapid_Feedrate Rapid_Feedrate_Zero III

38 Index RapidFeedrate RapidFeedType rated velocity Rated_Velocity RatedVelocity Ref_Point_ Ref_Point_ Ref_Point_ reference position # reference position # reference position # RefPoint_ RefPoint_ RefPoint_ regedit...4-2, 4-6, 5-1 registry APIs registry default settings Registry Editor Registry Editor, definition registry paths registry, definition regular smoothing time RELAY , 2-6, 2-7 restoring registry data retract vector Retract_Vector RetractVector Rpd_Linear_Feed Rpd_Linear_Feed_Zero RUN status S S100M folder S120M folder S140M folder SAFEZONE saving current parameter settings to Windows Files 4-1 saving registry data SDK SEARCH servo drive velocity sensitivity Servo_Control_Param folder...2-2, 2-5, 2-6 Servo_Drive_Param folder , 2-7 SERVOCONTROL ServoWorks ServoWorks key Set_Point setting all parameter settings back to the default settings shift direction Shift_Direction ShiftDirection SLINKT SMOOTHFILTER smoothing mode cutting smoothing mode manual smoothing mode rapid smoothing time cutting smoothing time manual smoothing time rapid Smoothing_Mode_Cutting Smoothing_Mode_Manual Smoothing_Mode_Rapid Smoothing_Time_Cutting Smoothing_Time_Look_Ahead Smoothing_Time_Manual Smoothing_Time_Rapid SmoothingMode_Cutting SmoothingMode_Manual SmoothingMode_Rapid SmoothingTime_LookAhead SmoothingTime_Regular_Cutting SmoothingTime_Regular_Manual SmoothingTime_Regular_Rapid SMP folder SNK key SNK_PLC folder SNK_PLC_DIAGNOSE SPINDLE_GENERAL sssloadabsencparameters sssloadparameters ssssaveabsencparameters ssssaveparameters Stepper_Resolution STOP status subkeys SW_PLC_EDITOR SwDll.dll SynAssociatedToAxis sync master axis sync slave axis associated to axis sync slave axis compensation gain SynControlRes SynControlRes SynSlaveCompGain T T edit button , 2-13 TABLE TimeOver_EDM timers for PLC TMR ToolOffset , 2-9 TOOLOFFSET tree U unit IV

39 Index V velocity feedforward enable velocity feedforward percentage VelocityFF_Enable VelocityFF_Pct VelocityFFEnable VelocityFFPct version, product viewing settings in your system registry W warning regarding registry editing WINDOW Windows Registry, definition WORKCOORDINATE , 2-9 WorkpieceOffset , 2-9 Z Z_Dir_EDM Z_Spd_EDM V