LON Smartserver Programming Tools Versions the I.LON Smartserver DVD Includes a Demo Version of the I.LON Smartserver Programming Tools
Total Page:16
File Type:pdf, Size:1020Kb
.LON® SmartServer Programming Tools i User’s Guide ® 078-0349-01C Echelon, i.LON, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo are trademarks of Echelon Corporation registered in the United States and other countries. LonPoint and LonSupport are trademarks of Echelon Corporation. Other brand and product names are trademarks or registered trademarks of their respective holders. Neuron Chips, LonPoint Modules, and other OEM Products were not designed for use in equipment or systems which involve danger to human health or safety or a risk of property damage and Echelon assumes no responsibility or liability for use of the Neuron Chips or LonPoint Modules in such applications. Parts manufactured by vendors other than Echelon and referenced in this document have been described for illustrative purposes only, and may not have been tested by Echelon. It is the responsibility of the customer to determine the suitability of these parts for each application. ECHELON MAKES NO REPRESENTATION, WARRANTY, OR CONDITION OF ANY KIND, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE OR IN ANY COMMUNICATION WITH YOU, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR ANY PARTICULAR PURPOSE, NONINFRINGEMENT, AND THEIR EQUIVALENTS. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Echelon Corporation. Printed in the United States of America. Copyright ©1997–2008 by Echelon Corporation. Echelon Corporation www.echelon.com ii Preface Preface You can use i.LON SmartServer Programming Tools to create custom embedded applications and drivers, which are referred to as freely programmable modules (FPMs), for your SmartServer. FPMs let you customize the embedded software of the SmartServer to meet your specific needs. Using i.LON SmartServer Programming Tools, you can write FPMs in C or C++, compile them, and then upload them to your SmartServer. You can then deploy your FPMs on SmartServers that have an FPM programming license installed on them. You can also create FPM application licenses and use them to protect your FPM applications and make them available to customers for order. i.LON SmartServer Programming Tools User’s Guide iii Welcome The SmartServer includes i.LON SmartServer Programming Tools for creating custom C/C++ applications and drivers (called freely programmable modules [FPMs]) that you can use to customize the functionally of the SmartServer. You can use your FPMs for a number of applications, including energy optimization, data analysis, lighting control, and room control. You can also use the i.LON SmartServer Programming Tools to translate the SmartServer Web interface into a number of different languages (language localization). Purpose This guide describes how to create and use FPMs on your SmartServer, and how to localize the language of the SmartServer Web interface. Audience This guide is intended for system designers and integrators with an understanding of control networks and the ability to program in C or C++, and for language localization developers. Models This guide is intended for FT-10 and PL-20 models of the SmartServer hardware on which FPM Programming is licensed. This includes models of the SmartServer on which the FPM programming license is pre-installed (model numbers 72101R-409, 72101R-410, 72102R-409, 72102R-410, 72103R-409, and 72103R-410), and all other models of the SmartServer hardware for which the FPM programming license (Echelon part number 72161) has been ordered and installed. i.LON SmartServer Programming Tools Versions The i.LON SmartServer DVD includes a demo version of the i.LON SmartServer Programming Tools. You can use the demo version to write an unlimited number of FPMs. To compile your FPMs and deploy them on your SmartServer, you must order an i.LON SmartServer Programming Tools DVD. To order the i.LON SmartServer Programming Tools DVD (Echelon part number 72111-409), contact your Echelon sales representative. i.LON SmartServer Programming Tools Applications Installing the demo or full version of the i.LON SmartServer Programming Tools adds the following programs to your computer: • i.LON SmartServer Programming Tool. A pre-configured Eclipse Development Kit that includes FPM template files, the FPM library, a tool for creating the C structures of user-defined UNVTs, a C++ compiler, and a CYGWIN environment. You must have the full version of the i.LON SmartServer Programming Tools to compile and upload FPMs to your SmartServer with the i.LON SmartServer Programming Tool. • i.LON SmartServer LonWorks Interface Developer tool. A command line interface that converts a model file (.nc extension) to a device interface (XIF) file. You must create a XIF for your FPM in order to deploy it on your SmartServer. See Chapter 4 for more information on creating XIFs with this tool. • i.LON License Generator. A tool for creating licenses that help protect your FPM application from piracy or unauthorized use. The i.LON License Generator includes the following three components: ○ The main executable (iLONLicenseGen.exe) that provides a user interface for entering the values used to generate an FPM license. iv Preface ○ A sample license generator configuration file (an XML file named iLONLicenseGenValuesSample.xml) that demonstrates the structure of the i.LON License Generator user interface and provides sample pre-defined values. ○ A sample security DLL file (LicenseSecurityHMACMD5.dll) that takes the values entered in the i.LON License Generator user interface and creates an FPM license. See Chapter 7 for more information on creating FPM application licenses. Requirements The following sections list the hardware and software requirements for running the i.LON SmartServer Programming Tools, and requirements for deploying and running FPMs on an i.LON SmartServer. Hardware Requirements The following are minimum requirements for the computer running the i.LON SmartServer Programming Tool and the SmartServer Web pages: • Pentium II 600 MHz or faster • 500 MB RAM minimum • 100 MB free hard disk space • DVD-ROM drive • Super VGA (1024 × 768) or higher-resolution display with 256 colors • Mouse or compatible pointing device • RS-232 null modem cable. You use this cable to physically connect the computer running the i.LON SmartServer Programming Tool to the SmartServer console port. This enables you to use the SmartServer console port to debug your FPMs during runtime. Software Requirements The following are minimum software requirements for computers running the i.LON SmartServer Programming Tool and the SmartServer Web pages: • Microsoft Windows Vista™ or Microsoft Windows XP. Echelon recommends that you install the latest service pack available from Microsoft for your version of Windows XP. Screen resolution 1024 x 768 with large or small fonts; 800x600 with small fonts only. • Microsoft Internet Explorer 6 or higher. The SmartServer Web pages support Internet Explorer 6; however, there may be a significant delay when loading the SmartServer Web pages if the navigation pane contains more than 2,000 icons. It is strongly recommended that you install Internet Explorer 7 to optimize the performance of the SmartServer Web pages. You can install Internet Explorer 7 from the i.LON SmartServer DVD. • Terminal emulator such as Windows HyperTerminal. If you are using Windows Vista, you need to install a terminal emulation application on your computer (Windows HyperTerminal is not included with Windows Vista). You can license Windows HyperTerminal from Hilgraeve; install puTTy, which is included on the root directory of the i.LON SmartServer DVD and the i.LON SmartServer Programming Tools DVD; or download another free terminal emulator to your computer. i.LON SmartServer Requirements You can run FPMs on the SmartServer hardware (they cannot be run on i.LON 100 e3 server hardware). The i.LON SmartServer embedded image and an FPM programming license must be installed on the SmartServer hardware. To run your FPMs on your SmartServer, your SmartServer must have an FPM programming license installed on it. If you do not have a SmartServer model 7210xR-409 or 7210xR-410, on which the i.LON SmartServer Programming Tools User’s Guide v FPM programming license is pre-installed, you can order a FPM programming license from the i.LON SmartServer Web site at www.echelon.com/products/cis/activate. To run Echelon first-party FPMs or third-party FPMs on your SmartServer, your SmartServer must also have a separate FPM application license from Echelon or the third-party FPM vendor. Creating FPM Application Licenses You can create FPM application licenses for your FPMs to protect your FPMs from unauthorized use and piracy, and to make your FPMs available to customers for order. The i.LON SmartServer Programming Tools includes the components required to create a FPM licensing tool. Once you create your FPM licensing tool, you can use it to create FPM application licenses that must be installed on a SmartServer in order for it to run your FPMs. Customers who want to implement your licensed FPMs on their SmartServersmust order your FPM application license and install it on their SmartServers. Related Reading The documentation related to the SmartServer is provided as Adobe Acrobat PDF files and online help files. The PDF files are installed in the in the Echelon i.LON SmartServer Software program folder when you install the i.LON SmartServer software. You can download the latest SmartServer documentation, including the latest version of this guide, from Echelon’s website at www.echelon.com/support/documentation/manuals/cis. • i.LON SmartServer User’s Guide. Describes how to configure the SmartServer and use its applications to manage control networks • i.LON SmartServer Power Line Repeating Network Management Guide. Describes how to install a PL-20 repeating network and how to use the SmartServer to prepare, maintain, monitor and control, and connect the network.