================================================ LonMark(R) Resource File API ReadMe File Version 2.3 - June 2003 ================================================ Copyright (c) 2002-2003 Echelon Corporation. All Rights Reserved. The archive file containing this ReadMe file contains the LonMark Resource File API. The archive includes Windows libraries for reading and writing version 1-5 type files, 1-4 functional profiles, and version 1-3 language files. The archive file also includes ANSI C source code for reading these files. The use of these files is covered by a license contained in the license.txt file included with this ReadMe file. CONTENTS ======== 1 New Features 1.1 Version 2.1 1.2 Version 2.2 1.3 Version 2.3 2 Documentation 3 Installing the LonMark Resource File API 3.1 Windows Libraries 3.2 ANSI C Source Code 1 NEW FEATURES =============== 1.1 Version 2.1 ---------------- This release of the LonMark Resource File API adds support for version 3 type files and version 3 functional profiles. The new version 3 type file format supports larger resource files and supports new invalid value and obsolete flag fields. The new version 3 functional profile format supports inherited functional profiles and network variable member numbers that are not consecutive. 1.2 Version 2.2 ---------------- This release of the LonMark Resource File API adds support for version 4 types files, version 4 functional profile templates, and version 3 language files. Version 4 type files and functional profiles add support for configuration property arrays and for permanently deleting types and profiles. Version 3 language files add support for permanently deleting language strings. 1.3 Version 2.3 ---------------- This release of the LonMark Resource File API adds support for version 5 type files. Version 5 types files adds support for new unsigned quad and double float data types. To provide backward compatibility, support for these new data types is not enabled by default in the version 2.3 API. Applications must inform the API that they can support the new types. See the LonMark Resource File API Reference Guide for details. 2 DOCUMENTATION ================ This ReadMe file includes installation instructions for both the Windows version of the resource file API as well as the ANSI C source version. If you are using a tool that used a previous version of the LonMark resource file API, you can just install the new version of the API and continue to use the tool according to its documentation. Tool developers who are developing applications that access the resource file API will require the LonMark Resource File API Reference Guide. This guide is contained in the LmResAPI.pdf file included with this archive. An Adobe Acrobat Reader is required to view the reference guide. If you do not have a reader, you can download one from www.adobe.com. 3 INSTALLING THE LONMARK RESOURCE FILE API =========================================== 3.1 Windows Libraries ---------------------- The LonMark Resource File API is used by a number of tools, including all LNS(tm) based tools, the LonMaker(R) Integration Tool, and the LNS DDE Server. Two versions of the API for Windows are provided, one that provides read/write access (lcadrf32.dll) and one that provides read-only access (ldrf32r.dll). To install the LonMark Resource File API for Windows, follow these steps: 1. Extract the contents of this archive to a temporary directory. 2. Open a Windows command window. 3. Change the current directory to your LonWorks bin directory, which is c:\LonWorks\Bin by default. 4. Enter the following command to deregister the previous version of the API: regsvr32 /u lcadrf32.dll 4. Rename the lcadrf32.dll file to lcadrf32.old. 5. Copy the contents of the archive bin directory to your LonWorks bin directory. 6. Enter the following command to register the new API: regsvr32 lcadrf32.dll (for the new one) 7. If you will be developing applications that access the LonMark Resource File API for Windows directly, copy the contents of the lib and include directories to LonWorks lib and include directories. 3.2 ANSI C Source Code ----------------------- The source directory of this archive contains ANSI C source code for functions that provide read-only access to resource files. You can use these functions to access LonMark resource files on platforms other than Windows. To use these functions, extract these files to a working directory, then port them to your target platform. The functions are documented in the LmResAPI.pdf file, and in the comments in the source files.