LONMARK® Resource Files ReadMe File

Version 14.00, December 2012
Self-Installer


Copyright © 1991–2012 Echelon Corporation & LONMARK International
All Rights Reserved

 
Introduction

Welcome to Version 14.00 LONMARK Resource Files for LONWORKS® software products and other software and devices compliant to the ISO/IEC 14908-1 controls-networking protocol.  These files contain all previously released standard network-variable types (SNVTs), standard configuration-property types (SCPTs), standard functional-profile templates (SFPTs), and enumeration definitions, plus new SNVTs, SCPTs, enumerations, and profile templates, that were added since the version 13.00 release.  It also contains all of the header files needed to use the new types.  The last beta release was 13.20.

NOTE: The version 14.00 files require version 2.41 or newer of the LONMARK resource file API to read the new type and functional profile files.  The version 2.41 API is installed by this Resource Files Installation Program for Windows® OS platforms as part of the installation procedure (see Installation for details).

 
Contents

  1. Introduction
  2. Contents
  3. New Features
  4. Documentation
  5. Installation
  6. Packaging the Installer
  7. Trademark Attributions

 
New Features

Version 14.00 includes the following SFPTs (Profiles) that were not included in the v13.00 release:

Version 14.00 includes the following SCPTs that were not included in the v13.00 release:

Version 14.00 includes the following SNVTs that were not included in the v13.00 release:

Version 14.00 includes the following Enumerations that were not included in the v13.00 release and includes additions to previously existing Enumerations, not shown here (please see Documentation):

There are two sets of resource files:  The first set contains the standard.typ, standard.fpt, standard.enu, standard.eng, and standard.fmt files.  This set is for use with tools that are compatible with LONMARK resource files including Echelon Corporation’s OpenLNS™ or LNS® tools such as the LonMaker® Integration Tool and LNS DDE Server.  These files include standard functional-profile templates (SFPTs), standard network-variable types (SNVTs), standard configuration-property types (SCPTs), and standard enumeration types (appended with “_t”).

The standard.fmt format file conforms to the version 3 specification for format files.  The version 3 specification added improved support for language localization.

The second set contains the snvt.typ, snvt.enm, and snvt.fmt files.  This set is for use with legacy tools based on Echelon Corporation’s LonManager® API such as LonMaker for DOS.  These files only define SNVTs—they do not define SCPTs or SFPTs. Additionally, these files have not been updated since 2003-03 (except to be given common file dates for organizational purposes).

Back to top

 
Documentation

The version 14.00 files include several ISO 32000-1 Portable Document Format (PDF) files that detail the LONMARK standard types.  These files will be placed into your LONWORKS Bin directory (c:\LonWorks\bin by default, or into one of the “Program Files” directories) by this Resource Files Installation Program for Windows OS platforms.  The snvt.pdf file details the standard network-variable types.  The scpt.pdf file details the standard configuration-property types.  The enum.pdf file details the standard enumerated types.  The snvtscpt.pdf file is a master document with common definitions and links to the first three documents.  Online, XML-transformed documentation is available for Internet Explorer users at types.lonmark.org.  See the LONMARK Web site for functional profile documentation at www.lonmark.org/profiles

An ISO 32000-1 -compliant reader/viewer is required to view the PDF files.  Free-of-charge PDF readers/viewers are available from many different sources—and for many different platforms—and can be found through a search of the Internet.

Back to top

 
Installation

NOTE: The version 14.00 files require version 2.41 or newer of the LONMARK resource file API to read the new type and functional profile files.  The version 2.41 DRF API is installed by this Resource Files Installation Program as part of the normal installation procedure. The API is also available as ANSI C source files (read-only access) for porting to platforms other than Microsoft Windows.

WARNING:  If you install any products that include LONMARK Resource files but do not use our installers, the installation of those products may overwrite your updated, 14.00 resource files.  If this happens, reinstall the resource files (this would be a good time for you to check the LONMARK Web site at www.lonmark.org/LMRF to see if you have the latest version of the LONMARK Resource Files).  Only older (earlier) files are overwritten by the LonMarkResourceFiles1400.exe and later installer programs.

WARNING:  It is possible that the format files in this release could cause some tools to report a “Symbol table full” error.  You will not see this problem if you are using Echelon Corporation’s LonMaker 3.1 Integration Tool (or newer).  If you are using the LonMaker 3 Integration Tool or other tool based on LNS 3, you can fix this problem by installing the latest service pack.  Otherwise, this problem can be addressed by removing the formatting of one or more unused SNVTs from these files to reduce the symbol table size.  E.g., two large SNVT formats that you may not be using are the formats for SNVT_time_zone and SNVT_earth_pos.  These are complex and therefore use a lot of symbol table space.  It is possible that you may need to remove several formats in order to work around this problem.  If you have already modified your FMT files, the installer will give you the option of preserving these files so that you can use them in manually modifying the newly installed versions.

WARNING:  The standard.fmt format file conforms to the version 3 specification for format files.  The version 3 specification added improved support for language localization.  Some tools do not recognize the localized format extensions in version 3 format files such as standard.fmt.  If you are using Echelon Corporation’s LonMaker 3 (or later) Integration Tool or other tool based on Echelon’s OpenLNS or LNS 3 (or later), you should not have any problems using the version 3 standard.fmt file.  If you are using a tool that does not support the version 3 specification for format files, you can convert version 3 files to version 2 using the FMTconv.exe Format-File Conversion Utility, available for free download from http://www.lonmark.org/LMRF.  Files converted down to version 2 will not be up-convertible back to version 3 files.

WARNING:  No formal testing has been done with the installer nor with the files on Windows OSes prior to XP™.  Likewise no formal testing has been done on Windows 8 OS at the time of this release.

 
Installation Procedure:

  1. Read these steps completely, first; then run the LonMarkResourceFiles1400.exe installation program, choosing the options you prefer when prompted.  If you have modified any pre-existing standard format (.fmt) files, allow the installation program to backup/save your FMT files for you.
     
  2. The installer will place the latest versions of snvtscpt.pdf, svnt.pdf, scpt.pdf, and enum.pdf documentation files into your LONWORKS Bin directory (C:\LonWorks\Bin or C:\[Program Files]\LonWorks\Bin by default, where some installations use one of the “Program Files” directories instead).  These files document the standard network-variable and configuration-property types.  It will also install the v2.41 API files: lcadrf32.dll, ldrf32r.dll, lcadrf32.inf, and lmresapi.pdf.  For convenience, an Internet shortcut is also included in the \bin directory: to the LONMARK Resource Report.
     
  3. If a Complete installation is chosen, or if “LonMark Device Developer Files” are chosen in the Custom setup, then the installer will place the latest versions of Neuron® C header files into your LONWORKS Neuron C Include folder (C:\LonWorks\NeuronC\Include by default, or into one of the “Program Files” directories).  The complete set of Include (.h) files, even the ones that have not changed for the last few releases, are included to ensure that you have all the latest LONMARK Include files in your system.  All file times reflect the present version of resource files in 24-hour time: 14:00 (version 14.00).
     
  4. The installer will place standard.eng, standard.enu, standard.fmt, standard.fpt, standard.typ, standard.ver, snvt.enm, snvt.fmt, snvt.tvb, snvt.typ, nb_snvt.fmt, snvtver.exe, mkcat.exe, readme.htm, and spiddata.xml, into the LONWORKS Types folder (C:\LonWorks\Types by default, or into one of the “Program Files” directories).  It will also use mkcat.exe to update the ldrf.cat file (or create ldrf.cat, if it does not exist).  It will also add an “include” directory to “types” containing lcadrf.h and lcadrfw.h header files.  For convenience, two Internet shortcuts are also included in the \types directory: to the LONMARK Standard Program Identifier (SPID) Master List and to the LONMARK Certification Tool (LCT).
     
  5. If a Complete installation is chosen, or if “LonMark Start Menu Shortcuts” are chosen in the Custom setup, then the installer will place a “LonMark” program menu in the “All Programs” menu and populate it with links to the Internet shortcuts and PDF documentation.
     
  6. Registry changes include setting the “LonWorks Path” in “HKEY_LOCAL_MACHINE\SOFTWARE\LonWorks”; setting “Install Status” in “HKEY_LOCAL_MACHINE\SOFTWARE\LonMark\LonMarkResourceFiles 14.00”, and clearing any older installation of LONMARK Resource Files.
     
  7. Other installation actions ensure that there are no LONMARK files misplaced into the System or System32 directories (a common issue with very old tools from a variety of vendors).
     
  8. Upon completion of the installation, if you have any modified .fmt format files that you saved at the beginning of the installation (saved with the installation tool or manually), you can now manually merge your changes into the newly installed .fmt files.  The installation-tool-saved files will have a sequentially increasing numeric extension and are located in the “types” directory (e.g., “snvt.fmt.1”).
     
  9. The installation can be uninstalled using Windows Control Panel “Add or Remove Programs” under a Windows XP OS installation, or “Programs  |  Programs and Features” under a Vista™ OS or Windows 7 OS installation.  Later versions of the Resource Files will install over earlier versions; however, to install an earlier version over a later version, the later version must be uninstalled using the “Add or Remove Programs” or “Programs  |  Programs and Features” control panel application.  Additionally, any options above that were not selected at the time of installation can be installed from the “Add or Remove Programs” or “Programs  |  Programs and Features” control panel at a later time.

Back to top

 
Packaging the Installer

For those companies interested in providing this installer as part of their own installation package, a command-line interface is available to invoke the installer invisibly (not seen by the end user) or with the user interface (as seen when run normally).

Invoke the LonMarkResourceFiles1400.exe with the following switches for the desired installation options.

NOTE: The spaces before and after “ /s ”, “ /v" ” and “ /qn are significant and are required.

 
To install with the Developer’s Kit feature:

 
To install with the Start Menu Shortcuts feature:

 
To install both the Developer’s Kit and Start Menu Shortcuts features:

Back to top


Echelon, LONWORKS, LonMaker, LonManager, LNS, LON, Neuron, & OpenLNS are either registered trademarks or trademarks of Echelon Corporation in the United States and other countries.
Microsoft, DOS, MS-DOS, Internet Explorer, Windows, XP, Vista, Windows 7, & Windows 8 are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
LONMARK and the LONMARK Logo are registered trademarks of LONMARK INTERNATIONAL in the U.S. and other jurisdictions.  All other trademarks are the property of their respective owners.