microlok configuration tool - hitachi rail · 2019. 3. 25. · 1. launch the microlok ii...

SM 1E1.0002 1000 Technology Drive, Pittsburgh, PA 15219

645 Russell Street, Batesburg, SC 29006

MICROLOK® II

Configuration Tool

STS USA Part No. N8001130200

MICROLOK® II Configuration Tool

Copyright 2019 SM 1E1.0002 Rev. 2, March 2019


Copyright 2019 SM 1E1.0002 Rev. 2, March 2019 i

Proprietary Notice This document and its contents are the property of Hitachi Rail STS USA, Inc. (formerly known as Union Switch & Signal Inc., and hereinafter referred to as "STS USA"). This document is furnished to you on the following conditions: 1.) That no proprietary or intellectual property right or interest of STS USA is given or waived in supplying this document and its contents to you; and, 2.) That this document and its contents are not to be used or treated in any manner inconsistent with the rights of STS USA, or to its detriment, and are not to be copied, reproduced, disclosed or transferred to others, or improperly disposed of without the prior written consent of STS USA.

Important Notice STS USA constantly strives to improve our products and keep our customers apprised of changes in technology. Following the recommendations contained in the attached service manual will provide our customers with optimum operational reliability. The data contained herein purports solely to describe the product, and does not create any warranties.

Within the scope of the attached manual, it is impossible to take into account every eventuality that may arise with technical equipment in service. Please consult an STS USA local sales representative in the event of any irregularities with our product.

STS USA expressly disclaims liability resulting from any improper handling or use of our equipment, even if these instructions contain no specific indication in this respect. We strongly recommend that only approved STS USA spare parts are used as replacements.


Copyright 2019 SM 1E1.0002 Rev. 2, March 2019 ii

Revision History

REV. DATE NATURE OF REVISION

1 September 2011 Initial Release 2 March 2019 Hitachi Rail STS Branding

Copyright© 2019, Hitachi Rail STS USA, Inc.

1000 Technology Drive, Pittsburgh, PA USA 15219-3120 645 Russell Street, Batesburg, SC 29006

sts.hitachirail.com All rights reserved.


Copyright 2019 SM 1E1.0002 Rev. 2, March 2019 iii

Table of Contents 1. GENERAL INFORMATION ............................................................................................................... 1-1

1.1. 8BAbbreviations and Acronyms (typical) .................................................................................. 1-1 2. GENERAL DESCRIPTION ................................................................................................................ 2-1

2.1. Limitation................................................................................................................................... 2-1 3. OPERATION ...................................................................................................................................... 3-1

3.1. Required Equipment ................................................................................................................. 3-1 3.2. Upgrade Procedure .................................................................................................................. 3-1

4. RAIL TEAM AND TECHNICAL SUPPORT ...................................................................................... 4-1

List of Figures Figure 3-1. VitalNet CPU Programming Jumpers .............................................................................. 3-5


Copyright 2019 SM 1E1.0002 Rev. 2, March 2019 1-1

1. GENERAL INFORMATION

1.1. 8BAbbreviations and Acronyms (typical)

The following are abbreviations and acronyms used in this manual along with their associated meanings.

STS USA Hitachi Rail STS USA, Inc. (formerly known as Union Switch & Signal Inc.)

Com Communication

CPS Conditional Power Supply

CRC Cyclic Redundancy Check

CPU Central Processing Unit

EEPROM Electrically Erasable Programmable Read Only Memory

MCT Microlok Configuration Tool

USB Universal Serial Bus

PC Personal Computer

PTC Positive Train Control



2. GENERAL DESCRIPTION

The MICROLOK® II Configuration Tool (MCT) is used when a MICROLOK II CPU is being replaced with a MICROLOK II VitalNet CPU. The MCT copies the application software and configuration information from the existing Microlok II CPU and uploads it to the MICROLOK II VitalNet CPU. The MCT does not provide any application software for the VitalNet PTC daughter card.

The MICROLOK II Development Tool can be used to perform the upgrade. However, it requires significant manual input and increases the chance of user error during the upgrade process. This could result in a longer than expected system outage while the configuration is checked, changed, and retested. The potential for errors is greatly reduced when using the MCT.

The MCT automates the following processes:

• Retrieving the application software that is currently loaded on the existing CPU

• Retrieving the configuration information that is stored in the EEPROM of the existing CPU

• Saving a text file of the current configuration information

• Uploading the existing application software and executive software version 8.6 to the new VitalNet CPU

• Uploading the configuration information for the existing location

• Setting the system real time clock

• Detecting CPS down operation and performing a Clear CPS if required

• Clearing of all logs for the new VitalNet CPU

2.1. Limitation

The MCT will upgrade any version 8.x MICROLOK II executive to version 8.6. The tool has support for future versions of the MICROLOK II executive. The current executive (as of the published date of this manual) is version 8.6. The MCT does not work with older MICROLOK II executives or GENISYS® II executives. The tool automatically deals with common problems that may occur during the upgrade process.

The user must be familiar with and qualified to perform system configurations on the MICROLOK II system. This ensures that the upgraded MICROLOK II unit is properly inspected and tested to verify that the upgrade was properly completed. If an unrecoverable error occurs during the upgrade process, the user must manually restore the system to operation.

MICROLOK® is a registered trademark of Hitachi Rail STS USA, Inc. GENISYS® is a registered trademark of Hitachi Rail STS USA, Inc.



The MCT is a non-vital program and the use of this program does not guarantee that the system is properly upgraded. The MCT program and the MICROLOK II executive perform the following multiple integrity checks during the upgrade:

• Each message sent to or from the MICROLOK II unit contains an integrity value for serial error checking.

• Application and Executive software have associated integrity values checked by MCT, validated by the user and the MICROLOK II CPU.

• EEPROM stored configuration data is retrieved and stored with multiple messages. Each message includes an integrity value that is checked by MCT and the Microlok II CPU

• EEPROM stored data has multiple integrity values associated with the entire configuration image that are checked by the MICROLOK II CPU and MCT.



3. OPERATION

3.1. Required Equipment

The following equipment is required:

• A Laptop or PC running Microsoft Windows 98 SE or newer with a serial port or USB to serial converter and a null modem 9-pin serial cable.

NOTE

USB to Serial converters sometimes fail to dynamically change baud as required for software upload. If you experience trouble uploading software, ensure that the USB serial port is assigned to port 9 or less. Ports 1-4 are recommended. Double digit port numbers sometimes cause this problem. Some USB serial ports will not work at speeds greater than 9600 baud. This is a hardware limitation of the device. A different USB device must be used in this case.

• MICROLOK II Development Tool 8.6 installed

• MICROLOK II Configuration Tool installed

• MICROLOK II 8.6 Executive File, CRC and Checksum documented

• Location-specific Microlok II Application file, CRC and Checksum documented

• Spare cardfile or CPU cable if the in-service EEPROM fails to store configuration data. The user will need to replace the device that provides access to the EEPROM. In some configurations the EEPROM is mounted on the main motherboard of the system card file. In other cases the EEPROM is mounted on the CPU cable.

• New MICROLOK II VitalNet CPU

• Signal plan that documents the relevant MICROLOK II configuration information

3.2. Upgrade Procedure

Proceed as follows to use the MCT to upgrade a MICROLOK II unit:

1. Launch the Microlok II Configuration Tool (MCT) by clicking the "Start". Select All Programs/Hitachi Rail STS/Microlok II Configuration Tool.

2. A dialog box will display the Notice of User Qualification. Read and be sure that you thoroughly understand the notice.

3. Click Yes to accept the notice of user qualification or Click No to exit the program. If No is selected, no further action is required to return the existing Microlok II system to operation.



4. If Yes was selected, the Configuration Tool Checklist dialog box will display. Review the checklist and click in the square next to each item to verify that you have the proper material and software. You can also click Auto Check All to check all of the boxes.

5. Click Next to continue or click Quit to exit the program. If Quit is selected, no further action is required to return the existing MICROLOK II system to operation.

6. If Next was selected, a dialog box will display informing you to connect a 9-pin serial cable to the in-service CPU and the (PC) laptop.

7. Connect the serial cable to the MICROLOK II CPU and the Laptop or PC serial port. Click Ok.

8. A dialog box will display asking for the Com Port and Baud. Select the Com Port and Baud that MCT will use to communicate with the MICROLOK II CPU from the drop-down menus. Click Next to continue or click Quit to exit the program.

If the baud is not known, take the MICROLOK II unit off line and place it in PC Link Mode.

NOTE

Train movements should be protected before taking the CPU off line.

Proceed as follows to enter the PC Link Mode:

a. Press and release the RESET pushbutton on the CPU board front panel.

b. Quickly operate any one of the four front panel toggle switches. Hold the switch in the toggled position.

c. Release the toggle switch that was operated in Step b after the CPU board 4-character displays shows RES|MENU.

d. Toggle the MENU UP-DOWN switch to the down position. The CPU board 4-character displays will show VIEW|SLOG.

e. Toggle the Menu L-R switch to R to access the PC LINK option (3 selections from the VIEW|SLOG mode). The CPU board 4-character displays will show PC LINK. Toggle the action ACCEPT-REJECT switch to the accept position. After the PC LINK mode is activated, the display will show LINK on the upper display and the maintenance port baud on the lower display. If, for example, the baud is 9600 BPS, "9600" will appear on the lower display.



f. On the laptop or PC, select the Com Port and Baud that MCT will use to communicate with the MICROLOK II CPU. Click Next.

9. A dialog box will display listing the following:

• Application Name

• Application CRC

• Compiler Version

• Executive Version

• Executive CRC

10. Review the information. If the information is correct, click Next to continue. If you do not want to continue, remove the serial cable from the unit, click Next, and then click Quit on the next dialog window. Quitting the program will exit the upgrade and return the existing MICROLOK II system to operation. If the MICROLOK II was in PC Link mode, it will need to be reset before it can be returned to operation.

11. The MCT retrieves the loaded application program and the configuration information. Progress is shown on the display as each item is retrieved. MICROLOK II configuration data verification information is retrieved and the MCT validates that the data retrieved matches these check values.

12. The MCT looks for saved configuration data and takes one of the following actions:

a. If the configuration has never been changed by the user, the MCT will display a dialog box that states "Connected unit does not have saved configuration information". Click Ok. The MCT will report that the retrieval failed or the unit does not have saved configuration data and therefore the MCT is not required to upgrade the location. To upgrade this type of location, use the standard MICROLOK II Development Tool and upload the correct application to the new VitalNet CPU.

b. If the configuration data has been saved to the EEPROM and the image check values as calculated by the MCT match the reported values from the MICROLOK II CPU, the MCT will display "Configuration image load successfully". Click Ok.

c. If the configuration data image checking fails, the MCT will display "Configuration image load fail!". Click Ok. The MCT will report that the retrieval failed or the MICROLOK II unit does not have saved configuration data (therefore the MCT is not required to upgrade the location). Check the serial connections and try again from Step 1. If several attempts fail, try a different PC or Laptop. Contact the RAIL Team (Section 4) if you are unable to correct the problem.



13. The MCT will display a dialog box that states "The configuration information for the in-service unit will now be displayed...". Click Ok.

14. A dialog box will display listing the following system configuration:



• Application CRC


• Executive CRC

15. Click Save Configuration Information and Continue (it is recommended that you save this information) to begin the process of installing the VitalNet CPU. Click Quit to exit the program and to return the existing MICROLOK II system to operation.

16. A dialog box will display prompting you to pick a folder and filename for the configuration information to be saved. Click Save. If you click cancel (not recommended by STS USA), the MCT will continue to Step 17. When you exit the program, MCT will prompt you to save the information again. If the MCT does not exit the program normally (such as a PC or Laptop failure) and configuration data was not saved, the configuration data cannot be recovered.

17. Upgrade activity from this point on could interrupt normal train movements. A dialog box will display informing you to "Obtain track foul time and to protect train movements". Obtain track foul time and protect train movements then click Yes to continue.

Clicking No will display a warning stating that it may not be safe to return the system to service. It is safe to quit at this point if the operating CPU has not been removed from the cardfile and no attempt has been made to save any configuration information. Click Yes to Quit or No to start the upgrade over.

18. A dialog box will display informing you to power off the MICROLOK II system and to remove the existing CPU to protect it from damage. This will ensure that the system can be returned to operation with the old CPU if the upgrade process fails to complete. Power off the MICROLOK II system, remove the CPU, and then Click Ok

19. You will be prompted to set the programming jumpers on the VitalNet CPU to the program position. Set the program jumpers 20, 21, 22, 23, and 30 to position 2-3 (Figure 3-1).



Figure 3-1. VitalNet CPU Programming Jumpers

20. Install the new CPU into the cardfile, connect the serial cable, and then Click Ok.

21. The MCT has all the data it needs to upgrade a VitalNet CPU as shipped from Hitachi Rail STS. You can reduce the time spent in the field by pre-loading the correct application (by using the standard MICROLOK II Development Tool) on the new CPU before beginning the upgrade process at the field location.

A dialog box will display giving you two options for the upgrade process.

a. Option #1 is the recommended option. It allows the MCT to exam the installed CPU to determine what items need to be upgraded. It will check the application information and ensure the loaded executive is 8.6 or higher. Proceed to Step 22 to use upgrade option #1.



b. Option #2 assumes the CPU is completely blank or has none of the required programming (no executive file) and will require the user to upload all information. This option ensures that the MCT can upgrade a unit that has failed an upgrade in the past or was corrupted in some manner. This option skips the steps of checking the loaded programming on the CPU. It is safe to quit at this point if no attempt has been made to save any configuration information. Click Quit to exit the MCT. A warning will display stating that the system may not be safe for return to service. Click Yes to quit or No to display the upgrade choices again. Proceed to Step 24 to use upgrade option #2.

22. Select Option #1

You will proceed through a series of steps that instruct you to place the VitalNet CPU in PC Link Mode. Proceed as follows to place the VitalNet CPU in PC Link Mode:

a. Hold the MENU UP-DOWN switch in the down position and apply power to the MICROLOK II unit. Hold the switch in the down position until the Vital Net CPU the displays shows RES|MENU.

b. Toggle the MENU UP-DOWN switch to the down position. The CPU board 4-character displays will show VIEW|SLOG.

c. Toggle the Menu L-R switch to R to access the PC LINK option (3 selections from the VIEW|SLOG mode). The CPU board 4-character displays will show PC LINK. Toggle the action ACCEPT-REJECT switch to the accept position. After the PC LINK mode is activated, the display will show "LINK" on the upper display and the maintenance port data-rate on the lower display.

d. A dialog box will display stating that the VitalNet CPU board 4-character displays should show “LINK” “9600”. If not, the baud must be changed to be able to connect. Click OK.

e. A dialog box will display asking you to confirm that the unit is Link Mode by displaying LINK on the top display and the baud on the lower display. Click Yes to begin query of unit. If not in Link Mode, Click No and the query will be skipped and the upgrade will return to the dialog box in Step 18 to provide another opportunity to get into Link Mode. Select Option #2 this time.

f. A dialog box will display asking if you want to change the baud and com port. Click Yes to change the settings (continue to Step g) or No (continue to Step 23).



g. If yes was selected, a dialog box will display asking for the Com Port and Baud. Select the Com Port and Baud that MCT will use to communicate with the MICROLOK II CPU from the drop-down menus. Set the baud and Com Port and then Click Next.



• Application CRC



• Executive CRC

Verify the data. Click Next to continue. It is safe to quit if no attempt has been made to configure the new VitalNet CPU. The old CPU must be re-installed.

The MCT uses the basic information to detect if the executive is at least 8.6. If it is not 8.6 or higher, you will be prompted to load a new executive file. If it is 8.6 or higher, select No and continue to Step 24b The MCT compares the loaded application program to the program previously downloaded. If they match, you will be given the option to skip the upload of the application. If both the executive and the application are of correct versions, the MCT will display a dialog box that gives you the option to skip all software uploading. If any software is uploaded, continue to Step 24. Otherwise, the upgrade continues at Step 25.

24. Select Option #2.

If the loaded executive is detected as less than 8.6 or if you selected Upgrade Option #2, a valid MICROLOK II executive file must be specified before continuing. If an executive is not specified, a warning will display stating that the system may not be safe for return to service. It is safe to quit if the in-service PC has not been removed from the cardfile and no attempt has been made to save any configuration information. The old CPU must be re-installed.

a. A dialog box will display asking if you want to use this executive file. Click Yes to continue or No to select another executive program. If No is selected, you will be asked to specify a location and filename for the executive program to be uploaded.

b. A dialog box will display informing you to reset or turn on the Microlok ii CPU. Reset or turn on the Microlok ii CPU.

c. The software upload will start when communication is established. The MCT will upload based on collected information and user input. This step may upload both an executive and an application file, or just one of the two.



d. The upgrade continues at Step 25.

25. You will be prompted via a series of dialog boxes to place the new VitalNet CPU in PC Link mode.

Proceed as follows to enter the PC Link Mode:

a. Press and release the RESET pushbutton on the CPU board front panel.

b. Quickly operate any one of the four front panel toggle switches. Hold the switch in the toggled position.

c. Release the toggle switch that was operated in Step b after the CPU board 4-character displays shows RES|MENU.

d. Toggle the MENU UP-DOWN switch to the down position. The CPU board 4-character displays will show VIEW|SLOG.

e. Toggle the Menu L-R switch to R to access the PC LINK option (3 selections from the VIEW|SLOG mode). The CPU board 4-character displays will show PC LINK. Toggle the action ACCEPT-REJECT switch to the accept position. After the PC LINK mode is activated, the display will show "LINK" on the upper display and the baud on the lower display.

26. You will be asked to confirm the unit is in PC Link Mode. A dialog box will display stating that the CPU board 4-character displays show “LINK” “9600”. If not, the baud must be changed to be able to connect. Click OK.

27. A dialog box will display asking if you want to change the baud or serial port. Click Yes to change or No to continue. Continue to Step 29.

28. If Yes was selected, a drop down menu will display allowing you to change the baud and serial port. Change the settings and then click Next.



• Application CRC



• Executive CRC

It is safe to quit if no attempt has been made to configure the new VitalNet CPU. The old CPU must be re-installed. Click Next to continue.

30. A dialog box will display indicating the retrieval status.



The MCT verifies program imagining information to ensure that the correct software is now loaded on the VitalNet CPU. If the correct software is not installed a dialog will display that indicates the source of the problem. Configuration is re-started at Step 18. You should inspect the hardware, including the serial cable and the laptop to determine what may have been the cause of the upload failure. If the MCT does not detect any problems, no dialog boxes are displayed and the upgrade continues at Step 31.

The MCT downloads the configuration information from the VitalNet CPU. The MCT performs numerous checks to ensure that the connected CPU does require modification to the configuration data. If no modifications are required, the MCT will display a dialog box that indicates no modifications are required and will exit. This gives the user an opportunity to start over. This ensures that someone has physically swapped the MICROLOK II CPU with a MICROLOK II VitalNet CPU. If the MCT were used remotely and the CPU was not swapped out when instructed, the execution would continue to this point if Upgrade Option #1 was selected. Without this check, a remote user could use this tool to take a MICROLOK II CPU off line.

31. When the retrieval is complete, a dialog box will display indicating that the retrieval status is complete. Click Ok.

32. A dialog box will display to set the date and time. Use the drop-down menus to set the date and time.

33. Click Ok to set the date and time to the selected values or click Use PC Time to set the time to the PC's time.

34. A dialog box will display for the password. Enter the password (default password on new VitalNet CPU is microlokii) and then click Ok.

35. A dialog box will display indicating the saving configuration status.

The CPU reset command is sent. A dialog display will prompt you to manually reset the CPU if not already reset. Configuration data is uploaded to the VitalNet CPU. Numerous messages are sent and verified by the MCT and the MICROLOK II to ensure configuration data integrity. If the MICROLOK II CPU passes all required checks on the configuration data, the changes will be stored in the EEPROM.

After the configuration password is entered and accepted, it may not be safe to quit and reinstall the old CPU without manually reentering any changes to the configuration data. The MCT will make multiple attempts to send and store configuration data and the user is given opportunities to restart the configuration process. The MCT stores configuration data and the downloaded application file from the original CPU in PC memory. All data is lost when the MCT is closed. For this reason, the MCT provides an opportunity to save a readable form of the configuration data.



The MICROLOK II Unit re-boots and the MCT links up with The MICROLOK II Unit.

If the MICROLOK II Unit has re-booted in CPS Down mode, the MCT informs you and makes one attempt to perform a Clear CPS.

36. When the configuration save is completed, a dialog box will display to clear the logs. Click Yes to clear the logs or click No to not clear the logs.

37. A dialog box will display stating that the new CPU is ready for testing. Click Ok to exit.

38. Configuration is complete.



4. RAIL TEAM AND TECHNICAL SUPPORT

The Rapid Action Information Link Team (RAIL Team) is a group of experienced product and application engineers ready to assist you to resolve any technical issues concerning this product. Contact the RAIL Team in the United States at 1-800-652-7276 or by e-mail at [email protected].



End of Manual

microlok configuration tool - hitachi rail · 2019. 3. 25. · 1. launch the microlok ii...

Documents