KingStar Motion 2.1 SDK and Runtime Installation Guide

Transcription

1 KingStar Motion 2.1 SDK and Runtime Installation Guide This guide describes system requirements and provides installation and setup instructions for the KingStar Motion SDK and Runtime. KS-DOC-X R6

2 Copyright 2015 by IntervalZero, Inc. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means, graphic, electronic, or mechanical, including photocopying, and recording or by any information storage or retrieval system without the prior written permission of IntervalZero, Inc. unless such copying is expressly permitted by federal copyright law. While every effort has been made to ensure the accuracy and completeness of all information in this document, IntervalZero, Inc. assumes no liability to any party for any loss or damage caused by errors or omissions or by statements of any kind in this document, its updates, supplements, or special editions, whether such errors, omissions, or statements result from negligence, accident, or any other cause. IntervalZero, Inc. further assumes no liability arising out of the application or use of any product or system described herein; nor any liability for incidental or consequential damages arising from the use of this document. IntervalZero, Inc. disclaims all warranties regarding the information contained herein, whether expressed; implied or statutory, including implied warranties of merchantability or fitness for a particular purpose. IntervalZero, Inc. reserves the right to make changes to this document or to the products described herein without further notice. All other companies and product names may be trademarks or registered trademarks of their respective holders. KingStar Motion SDK & Runtime Install Guide KingStar 2015 IntervalZero, Inc. 1 KS-DOC-X R6

3 Contents Product Editions... 3 Hardware Requirements... 3 Drives and IO... 3 Network Interface Card (NIC)... 3 Hardware Considerations... 3 Software Requirements... 4 Operating System Requirements... 4 Microsoft Visual Studio... 4 Microsoft.NET Framework... 4 Real-Time Subsystem... 4 Administrator Privileges... 4 Install KingStar Motion... 5 Activation and Processor Configuration Connected to the Internet No Internet Connection Manual System Configurations Install RTX64 SDK for use with KingStar Install RTX64 Runtime for use with KingStar Associate a NIC Configure the RT-TCP/IP Stack Start the RTX64 Subsystem Uninstall KingStar Motion Get Support Third-Party Support Before Calling Technical Support KingStar Web Site Contacting Technical Support KingStar 2015 IntervalZero, Inc. 2 KS-DOC-X R6

4 Product Editions KingStar Motion provides two different Runtime editions. Edition Entry Professional Supports 1 millisecond timer, and 1 core dedicated to real-time motion control 125 microsecond timer, and up to 3 cores dedicated to real-time motion control Hardware Requirements Drives and IO KingStar Motion supports a number of servo drives, stepper drives, and EtherCAT IO, for the most up-todate list see the KingStar Supported Hardware PDF at Network Interface Card (NIC) KingStar Motion requires a dedicated NIC. The NIC is configured when the Install Wizard is run. For the most up-to-date list see the KingStar Supported Network Interface Cards PDF file at Hardware Considerations KingStar Motion requires a multiprocessor platform that supports 64-bit Windows 7 with Service Pack 1 or Windows 8. Uniprocessor systems are not supported because at least one core must be dedicated to Windows and one to KingStar Motion. Multiprocessor systems can have as many as 64 cores and as few as 2 cores. If your system is hyper-threaded, it is recommended that you assign an even number of processors between Windows and KingStar real-time components. The Windows logical processor and real-time logical processor must not share the same physical processor. Some hardware configurations are not supported by the KingStar Motion. Although KingStar Motion runs on most x64 platforms, unique attributes of some processors require special consideration before selecting them for a target system. For a comprehensive list of approved and supported hardware, see the Microsoft Windows Logo Program web page: For a comprehensive list of system requirements for Windows 8, see the Windows 8 System Requirements web page: KingStar 2015 IntervalZero, Inc. 3 KS-DOC-X R6

5 Software Requirements This section lists software requirements for the KingStar Motion SDK and Runtime. Operating System Requirements KingStar Motion is supported on 64-bit multi-processor configurations for the following operating systems: Windows 8, without Service Pack 1 Windows 7, with Service Pack 1 Microsoft Visual Studio KingStar Motion requires Microsoft Visual Studio 2013 to develop KingStar Motion applications. Microsoft.NET Framework KingStar Motion requires Microsoft.NET Framework 4.5 Client. If not detected on the machine, the product installer installs the.net Client for you. Real-Time Subsystem KingStar Motion requires RTX64 Real-time Subsystem and RT-TCP/IP Stack. KingStar Motion requires, at minimum, RTX Runtime with Service Pack 1. By default, the KingStar Motion Install Wizard installs RTX64 Runtime and RTX64 SDK. If you already have these components installed, you can choose to not reinstall them when you run the Install Wizard. Note: Downloading KingStar Motion SDK and Runtime software from the Intervalzero KingStar website requires a network connection. Administrator Privileges Administrator privileges are required for installing and uninstalling the RTX64 product. RTX64 provides local Windows Groups to control user access to RTX64 features. By default, all users are members. Modify groups to have only those users that you want assigned as members. Note: For access to evaluation kits, go to the URL: In the form that appears, select KingStar Motion from the product choices, fill out the contact information, and click Submit. KingStar 2015 IntervalZero, Inc. 4 KS-DOC-X R6

6 Install KingStar Motion After purchasing KingStar Motion, you will receive an confirmation that includes a link to the KingStar product download page. Complete the steps that follow to install KingStar Motion. Note: You must have Administrator permissions to run the KingStar Motion installer. 1. From the KingStar product download page, download the KingStar Motion self-extracting installer KingStarMotion zip file for KingStar Motion 2.1, unzip the download to the destination of your choice. 2. To start the product installation wizard, double- click Setup.exe from the destination you previously chose. 3. On the KingStar Motion installer Welcome page, click Next to begin the installation. KingStar 2015 IntervalZero, Inc. 5 KS-DOC-X R6

7 4. Read the End User License Agreement, select I accept the terms in the license agreement, and then click Next. KingStar 2015 IntervalZero, Inc. 6 KS-DOC-X R6

8 5. On the Choose Destination Location screen, choose the location where you want KingStar Motion files to be installed, and then click Next. You can accept the KingStar default file location, or you can click Browse to browse for a different location. The default location is C:\Program Files\IntervalZero\. KingStar 2015 IntervalZero, Inc. 7 KS-DOC-X R6

9 6. On the Select Features screen, select the KingStar Motion features to install, and then click Next: Runtime o KingStar Motion Runtime includes all components required to run KingStar Motion applications. o Interval Zero RTX6 Subsystem and RT-TCP/IP Stack this is the real-time Subsystem and network stack used by KingStar Motion; required for KingStar Motion Runtime. You can clear the checkbox if a supported version of RTX64 is already installed on the system. SDK o KingStar Motion Software Development Kit (SDK) includes the Headers and Libraries required to develop and build KingStar Motion applications. o IntervalZero RTX64 Software Development Kit includes additional Headers and Libraries that allow for developing and building real-time applications. You can clear the checkbox if a supported version of RTX64 is already installed on the system. Note: If you already have features installed, or if you want to install features at a later time, clear the checkbox next to that feature. KingStar 2015 IntervalZero, Inc. 8 KS-DOC-X R6

10 7. On the KingStar Motion Network Interface Setup page, select a network controller for KingStar to use, and then click Next: None Do not associate a network controller with KingStar Motion now. You will be required to manually configure a controller and interface before you can use KingStar Motion. <Controllers> Select which controller to associate with KingStar Motion, and configure an interface to use this device for KingStar Motion network communication. KingStar 2015 IntervalZero, Inc. 9 KS-DOC-X R6

11 8. On the Ready to Install KingStar Motion Program screen, click Install to begin the installation. Note: During the installation, one or more Windows Security screens may display prompting you to choose to install IntervalZero software. Click Install to continue the installation. KingStar 2015 IntervalZero, Inc. 10 KS-DOC-X R6

12 9. The Setup Status screens display the progress of the installation. 10. After successfully completing the installation, click Finish on the KingStar Install Wizard Complete screen, to close the wizard. KingStar 2015 IntervalZero, Inc. 11 KS-DOC-X R6

13 11. From the Windows Start menu, select IntervalZero RTX Runtime>Activation and Configuration. The RTX64 Activation and Configuration utility appears. See Activate and Processor Configuration for more information on activating your KingStar Motion components. KingStar 2015 IntervalZero, Inc. 12 KS-DOC-X R6

14 Activation and Processor Configuration You must activate your KingStar Motion and RTX64 products and configure the system s boot configuration through this dialog before you can run any KingStar Motion applications. You should have received an Activation key with your copy of KingStar Motions. If you did not, contact the sales person from whom you purchased the KingStar software. If you received a sticker you should have a key. Stickers are always accompanied by an Activation key or they are invalid. Connected to the Internet Follow the steps below if you can access the IntervalZero license server. If you do not have Internet access, skip to No Internet Connection below. 1. Open the Activation and Configuration dialog from the Start menu: Start > All Programs > IntervalZero RTX Runtime > Activation and Configuration. The Activation and Configuration dialog appears. Note: You must have Administrator permissions to launch this utility. KingStar 2015 IntervalZero, Inc. 13 KS-DOC-X R6

15 2. Make sure your machine is connected to the Internet with access to the IntervalZero License Server. If a connection is available you will see in the right hand corner of the utility. If no network connection is found, make sure all network cables are plugged in and click the Network image to refresh. If a network connection still is not found, you may need to configure a Proxy Server. To configure a Proxy Server. a. Click the Configure Proxy button b. Provide the requested settings and click Ok. This information should be available from your IT department. Note:The proxy server must be able to proxy HTTP connections. SOCKS proxies are not supported. If no network connection can be established, go to No Internet Connection. KingStar 2015 IntervalZero, Inc. 14 KS-DOC-X R6

16 3. Enter your activation key and then click Activate. Note: You can find your activation key in the you received from Sales when you purchased KingStar Motion. The product components activated by your key are listed in the Components box. You should see the following components: KingStar Motion for 64-bit KingStar IO for 64-bit RTX64 Subsystem (this component will show up with a warning image until you configure the system) RTX64 RT-TCP/IP Stack If you purchased KingStar Entry edition you will have a Solo RTX64 Subsystem edition. If you purchased a KingStar Professional edition you will see a Basic RTX64 Subsystem edition listed. 4. Click Configure to configure the system processors. Note: You must configure before you can use KingStar Motion. 5. Assign processors between Windows and RTX64. There must be at least one Windows processor (indicated by the lock). If you have purchased the KingStar Motion Entry edition, select one processor for RTX64. If you have purchased the KingStar Motion Professional edition, select up to three processors for RTX Click Done to complete the configuration. 7. When you are prompted, click Yes to reboot your computer. 8. Choose the RTX64 boot configuration at system startup: Note: If you boot into a non-rtx64 configuration, KingStar Motion will not work. Windows 8: Windows 8 - RTX64 Windows 7: Windows 7 - RTX64 KingStar 2015 IntervalZero, Inc. 15 KS-DOC-X R6

17 No Internet Connection Follow the steps below if you cannot access the IntervalZero license server. 1. Open the Activation and Configuration dialog from the Start menu: Start > All Programs > IntervalZero RTX Runtime > Activation and Configuration. The Activation and Configuration dialog appears Note: You must have Administrator permissions to launch this utility. 2. Make sure your machine is not connected to the Internet with access to the IntervalZero License Server. If a network connection is available see Connected to a Network. 3. Enter your activation key and then click Activate. Note: You can find your activation key in the you received from Sales when you purchased KingStar Motion. In the dialog that appears, click Yes to create a fingerprint file. KingStar 2015 IntervalZero, Inc. 16 KS-DOC-X R6

18 4. In the Save As dialog, name the file fingerprint.rfp and click Save. By default, the file will be saved to the desktop. 5. Navigate to the desktop, and then copy and paste the file fingerprint.rfp to an external device. 6. Connect the device to a machine with Internet connectivity. 7. Launch a web browser, and navigate to 8. Click Choose File, browse to and open the file fingerprint.rfp. 9. Click Activate to generate a license (.Lic) file. 10. Download the license.lic. Depending on your Browser you may be asked to save the file. 11. Copy the file License.lic to the external device, and transfer it to the machine on which RTX64 is installed. 12. In the Product Activation dialog, click Import License. KingStar 2015 IntervalZero, Inc. 17 KS-DOC-X R6

19 13. Browse for and open the file License.lic. The product components activated by your key are listed in the Components box. You should see the following components: KingStar Motion for 64-bit RTX64 Subsystem (this component will show up with a warning image until you configure the system) RTX64 RT-TCP/IP Stack Note: If you purchased KingStar Entry edition you will have a Solo RTX64 Subsystem edition. If you purchased a KingStar Professional edition you will see a Basic RTX64 Subsystem edition listed. 14. Click Configure to configure system processors. Note: You must configure the RTX64 Subsystem before you can use KingStar Motion. 15. Assign processors between Windows and RTX64. There must be at least one Windows processor (indicated by the lock). If you have purchased the Entry edition, select one processor for RTX64 If you have purchased the Professional edition, select up to three processors for RTX Click Done to complete configuration. 17. When you are prompted, click Yes to reboot your computer. Choose the RTX64 boot configuration at system startup: Note: If you boot into a non-rtx64 configuration, KingStar Motion will not work. Windows 8: Windows 8 - RTX64 Windows 7: Windows 7 - RTX64 KingStar 2015 IntervalZero, Inc. 18 KS-DOC-X R6

20 Manual System Configurations For KingStar Motion to function properly, some RTX64 subsystem settings need to be modified, including associating a Network Interface Card with KingStar. KingStar installs and configures RTX^$ for you. However, you can also manually modify settings from the RTX64 Control Panel. Install RTX64 SDK for use with KingStar The product installer installs the RTX64 SDK. If you prefer to install RTX64 SDK manually on your system, install it before installing Motion, and then complete the steps that follow. 1. Check to be sure Visual Studio is installed on the system, if you want to develop KingStar Motion applications. 2. Locate, and then double-click the product Setup.exe file. The default location is C:\Program Files\IntervalZero\. You must have administrator permissions to run the RTX64 installation. Note: If Microsoft.NET 4.5 is not already installed on your machine, it will now be installed for you. 3. Click Next in the IntervalZero RTX64 SDK installation Welcome window. 4. Read the End User License Agreement, select I accept the terms in the license agreement and then click Next. Optionally, on the Destination Folder screen, change the destination location. The default is: C:\Program Files\IntervalZero\RTX64 SDK\ Click Next in the Destination Folder screen. 6. In the Custom Setup screen, select the features you want to install, and then click Next. Note: You must install at least the KingStar Real-time Headers and Libraries if you wish to build KingStar Motion applications. 7. In the Ready to Install the Program screen, click Install. 8. Click Finish in the installation completed screen. The Activation and Configuration dialog displays after the RTX64 SDK installs successfully. 9. If you are going to install the RTX64 Runtime, click Close. The program is restarted at the end of the Runtime installation. If not, see Activate and Processor Configuration for more information on activating your KingStar Motion components. KingStar 2015 IntervalZero, Inc. 19 KS-DOC-X R6

21 Install RTX64 Runtime for use with KingStar The product installer installs the RTX64 Runtime. If you want to install it manually, complete the steps that follow. 1. Double-click the Setup.exe. You must have administrator permissions to run the RTX64 installation. Note: If Microsoft.NET 4.5 is not already installed on your machine, it will now be installed for you. 2. Click Next in the IntervalZero RTX64 Runtime installation Welcome window. 3. Read the End User License Agreement, select I accept the terms in the license agreement and then click Next. 4. Optionally, on the Destination Folder screen, change the destination location. The default is: C:\Program Files\IntervalZero\RTX64. Click Next in the Destination Folder screen. 5. In the Custom Setup screen, select the features you want to install. Click Next in the Custom Setup screen. Note: You must install at least the RTX64 Real-time Subsystem and the RT-TCP/IP stack if you wish to use KingStar Motion. You do not need to install the Virtual Network sub component of RT-TCP/IP stack. 6. In the Ready to Install program screen, click Install. Note: You may receive a pop-up message asking if you want to allow the installation of the IntervalZero Plug and Play driver. If this occurs, click Install to install the RTX64 Plug and Play driver. 7. Click Finish in the installation Completed screen. 8. The Activation and Configuration dialog appears once the RTX64 Runtime has been successfully installed. See Activate and Processor Configuration for more information on activating your components. Associate a NIC KingStar Motion requires a dedicated NIC. Follow the steps below to associate a NIC with KingStar. 1. Open the RTX64 Control Panel, on the taskbar click start, click All Programs, click IntervalZero RTX , and click RTX64 Control Panel. KingStar 2015 IntervalZero, Inc. 20 KS-DOC-X R6

22 2. Click Manage RTX64 devices, this will launch the Windows Device Manager. 3. Expand the Network adapters, right click on the device you wish to associate with KingStar and click Update Driver Software. You must choose a device that is supported by RTX64 and KingStar Motion. KingStar 2015 IntervalZero, Inc. 21 KS-DOC-X R6

23 4. From the Driver Wizard, Click Browse my computer for driver software. 5. Click, Let me pick from a list of device drivers on my computer. KingStar 2015 IntervalZero, Inc. 22 KS-DOC-X R6

24 6. If your Network Adapter shows up in the provided Adapter list with (RTX64) in the name, select this adapter and click Next. If your Network Adapter does not show up in the provided list click Have Disk KingStar 2015 IntervalZero, Inc. 23 KS-DOC-X R6

25 a. Browse to the RTX64 inf location <RTX64Dir>\inf. If you installed RTX64 in the default location, this should be C:\program files\intervalzero\rtx64\inf. b. Click OK. c. Select the Network Adapter for your device with (RTX64), and then click Next. KingStar 2015 IntervalZero, Inc. 24 KS-DOC-X R6

26 7. A Windows Security dialog may be displayed to ask if you would like to install the drive click Install. 8. The RTX64 driver will be installed for the NIC. Click Close once the installation is complete. The device is now available for use with KingStar Motion. KingStar 2015 IntervalZero, Inc. 25 KS-DOC-X R6

27 Configure the RT-TCP/IP Stack KingStar sets up the RTX64 RT-TCP/IP stack to use the dedicated NIC for KingStar Motion. To do this manually: 1. Open the RTX64 Control Panel, on the taskbar click start, click All Programs, click IntervalZero RTX , and click RTX64 Control Panel. 2. Click Configure the RT-TCP/IP Stack. 3. Click Manage Interfaces and filters. 4. Add a new interface by clicking. 5. In the new interface dialog select your NIC from the device name pull-down list. 6. Provide a Friendly name, IP address and Netmask to use with the selected device. Click OK. 7. Associate the KingStar Motion filter with the interface. From the Filter name field, Browse ( ) to the file ksio64filter.rtdll, which should be found in the <KSMDir>\bin. <KSMDir> is the location where KingStar Motion was extracted. KingStar 2015 IntervalZero, Inc. 26 KS-DOC-X R6

28 Start the RTX64 Subsystem After the RTX64 Subsystem and RT-TCP/IP stack are configured, you can start the subsystem and stack so that they are available for use by KingStar Motion. 1. Open the RTX64 Control Panel, on the taskbar click start, click All Programs, click IntervalZero RTX , and click RTX64 Control Panel. 2. Under the Subsystem section click to start the subsystem, this should also start the RT-RTP/IP stack. KingStar 2015 IntervalZero, Inc. 27 KS-DOC-X R6

29 Uninstall KingStar Motion Use the KingStar Uninstall utility to uninstall KingStar components and product software. Consider the following when removing RTX64 from your system: When RTX64 Runtime is uninstalled from a system, any devices given to RTX64 will no longer have an associated driver and should be returned to Windows by using the Windows Device Manager. RTX64 Control Panel must be closed. KingStar Motion applications must not be running. If the RTX64 boot configuration is the only boot configuration present on uninstall, it will be retained so that you can boot your system. Get Support IntervalZero offers a number of support options for KingStar Motion users, including technical support and the KingStar Web site. Third-Party Support If you are a customer who purchased a KingStar product through a third-party reseller, contact the reseller for support. Before Calling Technical Support Before contacting technical support, determine the version of KingStar Motion installed on your system. KingStar Web Site The KingStar Support Web page is located at: Contacting Technical Support For technical support related to installing and using KingStar Motion, you can support at support@kingstar.com. KingStar 2015 IntervalZero, Inc. 28 KS-DOC-X R6