Version 1.0 Revision 1.01 SETUP MANUAL MODBUS/TCP Ethernet Communication Interface API for the DASTEC Corporation 457A Carlisle Drive Herndon, VA USA 20170 Tel: 1-703-709-0515 Fax: 1-703-709-0515 Web Site: www.dastec.com
NOTE The information in this document is subject to change without notice. The illustrations and specifications are not binding in detail. DASTEC Corporation shall not be held liable for any technical omissions or errors in this document, nor for any consequential or incidental damages resulting for the use of this documentation.. Copyright and Trademark notices: 2003 DASTEC Corporation, Inc. WinCE, Windows 98, Windows NT, Windows XP and Windows Explorer are registered trademarks of Microsoft Corporation. Pentium and Pentium Pro are trademarks of Intel Corporation. EDAS CE and LanPoint CE are registered trademarks of Intelligent Instrumentation, Inc.
Table of Contents.... MODBUS/TCP Ethernet Communication Interface API for the Intelligent Instrumentation WinCE Platform 1. INTRODUCTION... 1 2. PLATFORM-DEPENDENT REQUIREMENTS... 3 2.1 HARDWARE REQUIREMENTS... 3 2.1.1 WinCE Hardware Requirements... 3 2.2 SOFTWARE REQUIREMENTS... 3 2.2.1 Computer Software Requirements... 3 2.3 RECOMMENDED REFERENCE MATERIAL... 3 3. SETUP... 5 3.1 MODBUS/TCP ETHERNET COMMUNICATION INTERFACE API INSTALLATION... 5 3.1.1 API Directories and Files... 5 3.1.2 Platform-Dependent API Shortcuts... 6 3.2 WINCE PLATFORM SETUP... 6 3.2.1 IP Address Assignment... 6 3.2.2 Upload and Start FTP Server... 7 3.2.3 Modify API Communication Server Startup Shortcut... 8 3.2.4 Transfer API files to III WinCE... 9 3.2.5 Copy API Compiler Development Files... 11 4. COMMON PROBLEMS AND SOLUTIONS... 13 4.1 CLIENT API COMMON PROBLEMS AND SOLUTIONS... 13 4.2 SERVER API COMMON PROBLEMS AND SOLUTIONS... 13 MODBUS/TCP Ethernet Communication Interface API User Manual
This page is left blank intentionally.
1. INTRODUCTION The DASTEC Corporation MODBUS/TCP Ethernet Communication Interface API allows the user to implement bi-directional communications to exchange data between applications running on a Windows/WinCE-based system with other peer devices supporting the MODBUS/TCP Ethernet protocol. The peer devices can be Modicon devices, other host computers or even other system applications using the API. The MODBUS/TCP Ethernet Communication Interface API enables a system to acts as a client to other Modbus peers, initiating read and write operations on behalf of the system applications. The API also allows the system to emulate a Modicon PLC to respond to read and write requests and thus acts as a virtual PLC to other MODBUS/TCP peers. The MODBUS/TCP Ethernet Communication Interface API is available for different Windows/WinCE-based systems/platforms. This manual serves as the setup manual for only the WinCE platforms sold by Intelligent Instrumentation Inc. (III), which include the EDAS CE and the LanPoint CE. The API s operational details, installation and programming information can be found in the MODBUS/TCP Ethernet Communication Interface API User Manual. This manual provides the following information: Hardware, software and documentation requirements for the MODBUS/TCP Ethernet Communication Interface API software for the. Additional installation and setup instructions for the API software to be used on Intelligent Instrumentation WinCE Platforms. Note Throughout this manual, the term API refers to the MODBUS/TCP Ethernet Communication Interface API. MODBUS/TCP Ethernet Communication Interface API Setup Manual / 1
This page is left blank intentionally. 2 / MODBUS/TCP Ethernet Communication Interface API Setup Manual
2. PLATFORM-DEPENDENT REQUIREMENTS The following sections detail platform-dependent requirements that must be met in order to setup and develop with the MODBUS/TCP Ethernet Communication Interface API for the. 2.1 Hardware Requirements 2.1.1 WinCE Hardware Requirements The following minimum hardware items are required for the MODBUS/TCP Ethernet Communication Interface API files to be installed on the particular WinCE platform: 64 Megabytes RAM Working Ethernet port Proper interface cable to attach to the Ethernet network 2.2 Software Requirements The following software requirements must be met in order to develop with the API. 2.2.1 Computer Software Requirements Latest version of Microsoft embedded Visual C++ compiler Latest version of Intelligent Instrumentation WinCE Software Development Kit (SDK) for the particular platform 2.3 Recommended Reference Material The follow documentation and sources will provide information that will help in the setup of the MODBUS/TCP Ethernet Communication Interface API. Intelligent Instrumentation Hardware and Installation Manual for the particular WinCE platform DASTEC Corporation MODBUS/TCP Ethernet Communication Interface API User Manual DASTEC Corporation Intelligent Instrumentation WinCE Software Authorization/Un-Authorization Manual MODBUS/TCP Ethernet Communication Interface API Setup Manual / 3
This page is left blank intentionally. 4 / MODBUS/TCP Ethernet Communication Interface API Setup Manual
3. SETUP 3.1 MODBUS/TCP Ethernet Communication Interface API Installation If the API files have not already been installed on a computer, follow the installation instructions in the MODBUS/TCP Ethernet Communication Interface API User Manual. 3.1.1 API Directories and Files The installation of the API will create directories and add files to your computer s hard disk. Please verify that the following files were added to the system in the indicated directories upon completion of the software installation: Directory File Name %DESTFOLDER%\ FileInstall.lst, FTPScriptClient.exe, IIIWinCEAuthorizationMan.doc, IIIWinCEModbusTCPAPISetupMan.doc, ModbusTCPAPIMan.doc, Uninst.isu, URLLaunch.exe and WinCE_FTP_Server.exe % DESTFOLDER %\API ModbusTCPClientDemoAppl_EDASCE.zip and ModbusTCPServerDemoAppl_EDASCE.zip % DESTFOLDER %\API\include ModbusTCPClientDLL.h and ModbusTCPServerDLL.h % DESTFOLDER %\API\lib ModbusTCPClient.dll, ModbusTCPClient.lib, ModbusTCPServer.dll, ModbusTCPServer.exe and ModbusTCPServer.lib % DESTFOLDER %\Support AuthorizationForm.wds, AuthorizationInstall.wds, AuthorizationServer.exe, CommonFooter.txt, DASTEC.GIF, DASTECAuthorization.wds, DisplayCode.wds, ModbusTCPAPIAuthorization.wds, ProductDetails.wds, RunAuthorization.wds, SaveAuthorizationForm.wds and shortcut to ModbusTCPServer.lnk MODBUS/TCP Ethernet Communication Interface API Setup Manual / 5
Note In the above directory and file information, %DESTFOLDER% is the destination directory chosen during the installation of the API files. The default path/name for the directory is %WINDRIVE%\ Program Files\DASTEC Corporation\ModbusTCPAPI_IIIWinCE where %WINDRIVE% is the computer s drive on which the running Windows operating system has been installed. 3.1.2 Platform-Dependent API Shortcuts A program folder named DASTEC III WinCE MODBUS Ethernet Interface API VX.X.X was created during the installation process of the software that will contain the shortcut(s) listed below for only the Intelligent Instrumentation WinCE Platform. Install API files onto III WinCE The shortcut(s) are explained in the following sections. 3.1.2.1 Install API Files onto III WinCE Shortcut A shortcut is provided to facility the installation of the required MODBUS/TCP Ethernet Communication Interface API files onto the particular WinCE platform. See Section 3.2.4 Transfer API files to III WinCE, for more details on this setup operation. 3.2 WinCE Platform Setup If the API files have not already been installed on a computer, follow the installation instructions in the MODBUS/TCP Ethernet Communication Interface API User Manual. The following steps must be performed in order to complete the installation and setup of the MODBUS/TCP Ethernet Communication Interface API on the Intelligent Instrumentation WinCE Platforms. 1. Assign IP address for WinCE platform. 2. Upload and start FTP server on the WinCE platform. 3. Modify API Communication Server Startup Shortcut. 4. Transfer required API files to the WinCE platform. 5. Move API compiler development files. These steps are explained in the following sections. 3.2.1 IP Address Assignment The WinCE platform must be assigned a network IP address that can be accessed by the computer on which the API software was installed. Refer to the Intelligent Instrumentation Hardware and Installation Manual for the particular WinCE platform to utilize the MonitorCE program to assign an IP address and network mask. Consult your network administrator for additional information in regard to IP address assignment. 6 / MODBUS/TCP Ethernet Communication Interface API Setup Manual
3.2.2 Upload and Start FTP Server The MODBUS/TCP Ethernet Communication Interface API comes with a FTP server to allow the API files to be easily installed on the particular WinCE platform. Perform the following steps to install and start the FTP server on the WinCE platform before the API files can be transferred. 1. Start the computer s Internet browser. 2. Enter the assigned IP Address for particular WinCE platform as the URL to access or start the Remote Manager (WebDevice). 3. Refer to the Intelligent Instrumentation Hardware and Installation Manual for particular WinCE platform and to the Remote Manager Help web page for more details on the operational instructions of the Remote Manager for the next steps. 4. Click the File Manager link and enter the proper User Name and Password to access the File Manager web page. Change the current directory on the WinCE platform from / to /Storage Card/Startup by clicking on the directories in the Folder Listing. 5. Use the Upload File feature below the Folder Listing on the File Manager web page to upload the server file. Using the Browse button, select the WinCE_FTP_Server.exe file found in the root directory in which the API files were installed on the computer. The API s default install path is %WINDRIVE%\Program Files\DASTEC Corporation\ModbusTCPAPI_IIIWinCE where %WINDRIVE% is the drive the Windows OS is installed. After the FTP server file has been selected, enter /Storage Card/Startup/WinCE_FTP_Server.exe in the File name on unit field and then click the Upload link. 6. After the FTP server file has been uploaded successfully, click the green arrow in the row that the WinCE_FTP_Server.exe file is listed to start the FTP server. Then click the Run link in the Application Manager web page. 7. Click the Back link at the bottom of the File Manager web page to access the Remote Manager web page. Then click the Application Manager link and verify that the WinCE_FTP_Server.exe is shown in the Application list on the Application Manager web page. 8. Shutdown the Internet browser. Once the FTP server has been started successfully, the API files can now be transferred. Note By uploaded the FTP server file to the /Storage Card/Startup directory, the FTP server will automatically start every time upon the power up or reboot of the WinCE platform. Before deploying the WinCE platform into the field, it is recommended to stop the FTP server and either delete or move the WinCE_FTP_Server.exe file from the /Storage Card/Startup directory. MODBUS/TCP Ethernet Communication Interface API Setup Manual / 7
3.2.3 Modify API Communication Server Startup Shortcut A startup shortcut file is provided to automatically startup the communication server upon power-up or reboot of the WinCE platform. The file also contains arguments to configure the communication server s database sizes and to specify in which directory the error log file is to be created upon startup. The shortcut file is named shortcut to ModbusTCPServer.lnk and may be found in the % DESTFOLDER %\Support directory. If the API server functionality is not to be used, then this section can be disregarded. Note %DESTFOLDER% is the destination directory chosen during the installation of the API files. The default path/name for the directory is %WINDRIVE%\ Program Files\DASTEC Corporation\ModbusTCPAPI_IIIWinCE where %WINDRIVE% is the computer s drive on which the running Windows operating system has been installed. The default and explanation of the contents of the startup shortcut file are as follows: 33#"\Storage Card\ModbusTCPServer.exe" -c1000 -d1000 -h1000 -i1000 l \ The text 33#"\Storage Card\ModbusTCPServer.exe" specifies the number of characters for the directory and name of the communication server executable file. Do not change the number of characters, directory and/or name. The text proceeded by the - character are the startup arguments of the communication server and can be changed to meet the application requirements. The arguments are explained below: Arguments -c1000 configures the coil database to 1000 elements -d1000 configures the discrete input database to 1000 elements -h1000 configures the holding register database to 1000 elements -i1000 configures the input register database to 1000 elements -l \ specifies the root directory as where the error log file is to be created The database argument sizes can be any number from 0-65536. The error log file can be created in any directory within the WinCE platform. If the application requirements are not known at this time, the shortcut file can be modified at a later time and transferred to the WinCE platform. Note The root directory of the s are not in the nonvolatile storage or Compact Flash and thus the error log file will be lost upon power outage or reboot of the WinCE platform. 8 / MODBUS/TCP Ethernet Communication Interface API Setup Manual
3.2.4 Transfer API files to III WinCE The API provides a utility program to transfer the API files onto the s through an Ethernet connection. If the FTP server has not been uploaded and started on the WinCE platform, refer to Section 3.2.2, Upload and Start FTP Server before performing the following steps. 1. If transferring the files to the WinCE platform for the first time, proceed to step 7. Otherwise, if reloading the API files for any reason, start at step 2. 2. If the startup shortcut for the MODBUS/TCP communication server was installed from a previous transfer operation, the communication server must be stop first. Otherwise, proceed to step 7. 3. To stop the communication server, start the computer s Internet browser. 4. Enter the assigned IP Address of the WinCE platform as the web server IP address to access or start the Remote Manager (WebDevice). 5. Refer to the Intelligent Instrumentation Hardware and Installation Manual for the particular WinCE platform and to the Remote Manager Help web page for more details on the operational instructions of the Remote Manager for the next steps. 6. Click the Application Manager link and enter the proper User Name and Password to access the Application Manager web page. If the ModbusTCPServer.exe is shown in the Application list, click the Stop link. Once the server has been terminated, close the Internet browser window and proceed to the next step. 7. Select the Install API Files onto III WinCE shortcut in the DASTEC III WinCE MODBUS Ethernet Interface API VX.X.X program folder to start the file transfer. 8. Enter the assigned WinCE platform s IP Address or hostname as the FTP Server Address. Then enter the User Name and Password in their appropriate fields. The initial FTP server setup values are admin for both fields. Press the Start button to initiate the files transfer. The FTP Script Client program will display textual information as each file is installed on the WinCE platform. 9. The FTP Script Client program will then prompt if to install the startup shortcut for the MODBUS/TCP communication server. If the API server functionality is to be used, depress the Yes button. Otherwise depress the No button. 10. The computer s default Internet browser will appear displaying a web page indicating that the API is being setup for authorization. The DASTEC III WinCE Authorization Utility web page will then appear shortly displaying the Product Name of the installed API. 11. Follow the instructions in the DASTEC Intelligent Instrumentation WinCE Software Authorization/Un- Authorization Manual to either set the API software in the demo mode or to register and authorize the software for the particular WinCE platform. The shortcut DASTEC Software Authorization User Manual found in the DASTEC III WinCE MODBUS Ethernet Interface API VX.X.X program folder can be used to access the manual for details. If desired, the software can be authorized or placed in the demo mode at a later time. 12. Once the API software has been authorized or placed in the demo mode, click on the Exit button and close the Internet browser window. 13. Click the Exit button on the FTP Script Client program to end the API file transfer procedure. MODBUS/TCP Ethernet Communication Interface API Setup Manual / 9
The transferring of the API will create directories and add files to the WinCE platform. The following files were added to the system in the indicated directories upon completion of the software transfer: \Storage Card Directory \Storage Card\WebDevice\HTROOT\DASTEC \Storage Card\WebDevice\HTROOT\DASTEC \exe \Storage Card\WebDevice\HTROOT\DASTEC \wds File Name ModbusTCPClient.dll, ModbusTCPServer.dll and ModbusTCPServer.exe DASTECAuthorization.wds and ModbusTCPAPIAuthorization.wds AuthorizationServer.exe AuthorizationForm.wds, AuthorizationInstall.wds, CommonFooter.txt, DASTEC.GIF, DASTECAuthorization.wds, DisplayCode.wds, ModbusTCPAPIAuthorization.wds, ProductDetails.wds, RunAuthorization.wds and SaveAuthorizationForm.wds 10 / MODBUS/TCP Ethernet Communication Interface API Setup Manual
3.2.5 Copy API Compiler Development Files Once the API files have been transferred WinCE platform, the API development files need to be copied to the proper directories so they can be located by the Microsoft embedded Visual C++ compiler. The following list provides the name and source and destination directories of the API files that need to be copied. File Name Source Directory Destination Directory ModbusTCPClientDLL.h and ModbusTCPServerDLL.h ModbusTCPClient.lib and ModbusTCPServer.lib % DESTFOLDER %\API\include % DESTFOLDER %\API\lib % WinCEFOLDER %\wce300\%iii%\include % WinCEFOLDER %\wce300\%iii%\lib Note In the above directory and file information, %DESTFOLDER% is the destination directory chosen during the installation of the API files. The default path/name for the directory is %WINDRIVE%\ Program Files\DASTEC Corporation\ModbusTCPAPI_IIIWinCE where %WINDRIVE% is the computer s drive on which the running Windows operating system has been installed. %WinCEFOLDER%\wce300\%III% is the destination directory chosen during the installation of the Intelligent Instrumentation SDK files for the particular WinCE platform. MODBUS/TCP Ethernet Communication Interface API Setup Manual / 11
This page is left blank intentionally. 12 / MODBUS/TCP Ethernet Communication Interface API Setup Manual
4. COMMON PROBLEMS AND SOLUTIONS Before calling DASTEC's Customer Support, please review Problems and Solutions section in the DASTEC Corporation MODBUS/TCP Ethernet Communication Interface API User Manual and the following section to see if your problem is covered. Make sure that you have defined variables to retain the API functions return codes and have checked for any messages logged in the error file. Please look-up any error codes in API Error Codes section in the DASTEC Corporation MODBUS/TCP Ethernet Communication Interface API User Manual. 4.1 Client API Common Problems and Solutions Problem: The client API error log file ModbusTCPClient.log is lost every time the WinCE platform is rebooted or powered up. Solution: The directory specified for the creation of the error log file is not in the non-volatile storage or Compact Flash and thus the error log file will be lost upon power outage or reboot of the WinCE platform. Refer to Initialize the Client Interface section in the DASTEC Corporation MODBUS/TCP Ethernet Communication Interface API User Manual to change the directory to one that is in the non-volatile storage (ie. \Storage Card\hardware). 4.2 Server API Common Problems and Solutions Problem: The server API error log file ModbusTCPServer.log is not created when the server starts. Solution: The directory specified for the creation of the error log file is either invalid or is not within quotes characters. Refer to Start Arguments section in the DASTEC Corporation MODBUS/TCP Ethernet Communication Interface API User Manual for more details. Problem: The server API error log file ModbusTCPServer.log is lost every time the WinCE platform is rebooted or powered up. Solution: The directory specified for the creation of the error log file is not in the non-volatile storage or Compact Flash and thus the error log file will be lost upon power outage or reboot of the WinCE platform. Refer to Section 3.2.3, Modify API Communication Server Startup Shortcut to change the directory to one that is in the non-volatile storage (ie. \Storage Card\hardware). MODBUS/TCP Ethernet Communication Interface API Setup Manual / 13
This page is left blank intentionally. 14 / MODBUS/TCP Ethernet Communication Interface API Setup Manual
Index Index.... API hardware requirements, 3 program short cuts, 6 reference material, 3 software requirements, 3 A C Common Problems and Solutions, 13 Installation files installed, 5 I P Program Shortcut install API files onto III Win CE, 6 W WinCE Platform copy API compiler development files, 11 IP address assignment, 6 modify API communication server startup shortcut, 8 setup, 6 transfer API files, 9 upload and start FTP server, 7 MODBUS/TCP Ethernet Communication Interface API Setup Manual
Index This page is left blank intentionally. MODBUS/TCP Ethernet Communication Interface API Setup Manual