LonMark^® Resource Files ReadMe File, (build 04)

Version 13.10 beta, July 2011

Self-Installer

Copyright © 1991–2011 Echelon Corporation
All Rights Reserved

 
1   Introduction

Welcome to Version 13.10 beta LonMark Resource Files for LonWorks® software products.  These files contain all previously released, version 13.00 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, as described in this document that may also have been present in the version 13.04 beta release.  It also contains all of the header files needed to use the new types.

NOTE: The version 13.10 beta files require version 2.3 or newer of the LonMark resource file API to read the new type and functional profile files. This API is installed by the Resource Files Installation Program as part of the installation procedure (see Installation for details).

 
2   Contents

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

 
3   New Features

Version 13.10 beta includes the following Standard Functional Profile Templates (SFPTs) that are not included in the v13.00 RELEASE.  Users of these profiles from the 13.01, 13.02, 13.03, or 13.04 alpha or beta sets are encouraged to upgrade to this version (13.10 beta).  Further, two new profiles are present in this 13.10 beta, as noted:

• SFPTisiLampActuator
• SFPTisiKeypad
• SFPTisiMonitorPoint
• SFPTchannelMonitor
• SFPTchannelContinuityMonitor
• SFPTdeviceMonitor
• SFPTisiSunblindActuator
• SFPTisiOccupancySensor
• SFPTdataLogger
• SFPToutdoorLuminairController
• SFPTglobalSolarRadiation - 13.10
• SFPTstaticProgrammable - 13.10

Version 13.10 beta includes the following SCPTs that are not included in the v13.00 RELEASE, with new and experimental SCPTs, as noted:

• SCPTdefInput
• SCPTname1
• SCPTscene
• SCPTsceneTiming
• SCPTname2
• SCPTname3
• SCPTbuttonPressAction
• SCPTbuttonColor
• SCPTbuttonRepeatInterval
• SCPTbuttonHoldAction
• SCPTpwrSendOnDelta
• SCPTsceneName
• SCPTmaxPower
• SCPTifaceDesc
• SCPTmonInterval
• SCPTlinkPowerDetectEnable
• SCPTscanTime
• SCPTdevListDesc
• SCPTdevListEntry
• SCPTlogCapacity
• SCPTlogNotificationThreshold
• SCPTlogSize
• SCPTlogType
• SCPTfanInEnable
• SCPTlogTimestampEnable
• SCPTlogHighLimit
• SCPTlogLowLimit
• SCPTmaxFanIn
• SCPTlogMinDeltaTime
• SCPTlogMinDeltaValue
• SCPTpollRate
• SCPTsourceAddress
• SCPTlogRecord
• SCPTlogFileHeader
• SCPTlogAlarmThreshold
• SCPTlogRequest
• SCPTlogResponse
• SCPTlightingGroupEnable
• SCPTsceneColor
• SCPTbkupSchedule
• SCPTdeviceOutSelection
• SCPTenableStatusMsg
• SCPTgeoLocation
• SCPTlampPower
• SCPTOLCLimits
• SCPTmaxLevelVolt
• SCPTprogName - 13.10
• SCPTprogRevision - 13.10
• SCPTprogSelect - 13.10
• SCPTprogSourceLocation - 13.10
• SCPTprogFileIndexes - 13.10
• SCPTprogCmdHistory - 13.10
• SCPTprogStateHistory - 13.10
• SCPTprogErrorHistory - 13.10
• SCPTnsdsFbIndex - 13.10
• SCPTnvUsage - 13.10
• SCPTcurrentSenseEnable - under test in 13.10
• SCPTmeasurementInterval - under test in 13.10
• SCPTlightingGroupMembership - under test in 13.10
• SCPTloadControlOffset - under test in 13.10

Version 13.10 beta includes the following SNVTs that are not included in the v13.00 RELEASE, with new and experimental SNVTs, as noted:

• SNVT_multiplier_s
• SNVT_switch_2
• SNVT_color_2
• SNVT_log_status
• SNVT_time_stamp_p
• SNVT_log_fx_request
• SNVT_log_fx_status
• SNVT_log_request
• SNVT_amp_ac_mil
• SNVT_environment
• SNVT_geo_loc
• SNVT_lamp_status
• SNVT_time_hour_p
• SNVT_program_status - 13.10
• SNVT_Wm2_p - 13.10
• SNVT_load_offsets - under test in 13.10

Version 13.10 beta includes the following Enumerations that are not included in the v13.00 RELEASE, with new Enumerations, as noted. Some existing Enumerations may have been enhanced with additional enumerated values. They are not shown in this list:

• button_action_t
• char_encoding_t
• switch_state_t
• color_encoding_t
• log_status_t
• log_type_t
• timestamp_t
• log_record_t
• point_status_t
• message_code_t
• log_access_req_t
• log_response_code_t
• address_type_t
• olc_select_t
• program_state_t - 13.10
• program_status_error_t - 13.10
• file_type_t -13.10

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 LNS® tools such as the LonMaker® Integration Tool and LNS DDE Server.  These files define SFPTs, SNVTs, SCPTs, and standard Enumeration types.  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 the 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.

 
4   Documentation

The version 13.10 beta files include several Adobe® Acrobat® -style PDF files that document the LonMark standard types.  These files are contained in the Bin folder within the archive file, and will be placed into your LonWorks Bin directory (c:\LonWorks\bin by default but will locate the proper directory if existing files are elsewhere).  The snvt.pdf file documents standard network-variable types.  The scpt.pdf file documents standard configuration-property types.  The enum.pdf file documents standard enumeration types.  The snvtscpt.pdf file is a master document with common definitions and links to the first three documents.  See the LonMark website for functional-profile documentation (http://www.lonmark.org/profiles).  Please note that the included PDF files are v13.00 files; they do not include the additions listed above (new Profiles, SNVTs, SCPTs, and Enumerations).  Please see the web-based version for up-to-date beta documentation: types.lonmark.org

A PDF reader is required to view the PDF files.  If you do not have a reader, you can download one from from several sources on the Internet.

Back to top.

 
5   Installation

NOTE: As with version 12.00 and 13.00, the version 13.10 beta files likewise require version 2.3 or newer of the LonMark resource file API to read the new type and functional profile files.  This 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 reinstall any of the upgraded products at a later time, the reinstallation may overwrite your updated resource files.  If this happens, reinstall the updated resource files (this would be a good time for you to check the LonMark website at www.lonmark.org/lmrf to see if you have the latest version of the LonMark resource files).  Only older files are overwritten by the LonMarkResourceFiles1310.exe installer program.

WARNING: It is possible that the format files (e.g., standard.fmt) in this upgrade could cause some tools to report a “Symbol table full” error.  You will not see this problem if you are using the 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 possible 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 modifying the newly installed versions.

WARNING: The standard.fmt format file conforms with 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 the LonMaker 3 or 3.1 Integration Tool or other tool based on LNS 3, 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 Format File Converter (FmtConv.zip) utility, available for free download from http://www.lonmark.org/lmrf.

Installation Procedure:

1. Read these steps completely, first; then run the LonMarkResourceFiles1310.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 by default but will locate the proper directory if existing files are elsewhere).  These files document the standard network-variable and configuration-property types.  It will also install the API files: lcadrf32.dll, ldrf32r.dll, lcadrf32.inf, and lmresapi.pdf.  For convenience, an Internet shortcut to the LonMark Resource Report is also included in the \Bin directory.
    
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 NeuronC Include folder (C:\LonWorks\NeuronC\Include by default but will locate the proper directory if existing files are elsewhere).  The complete set of include 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: 13:10 (version 13.10) but may show in your system as 1:10 PM, based on your system settings.
    
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 but will locate the proper directory if existing files are elsewhere).  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 to the LonMark Standard Program ID Master List and to the LonMark Certification Tool are also included in the \types directory.
    
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 13.10”, 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.
    
8. Upon completion of the installation, if you have any modified .fmt format files that you saved at the beginning of the installation, you can now manually merge your changes into the newly installed .fmt files.  The saved files will have a sequentially increasing numeric extension and are located in the types directory (e.g., “snvt.fmt.1”).  LonMark International does not provide a tool for merging the old and new files.
    
9. The installation can be removed using Windows Control Panel “Add or Remove Programs” under an XP™ or earlier OS installation, or can be uninstalled under “Programs and Features” under a Vista™ or 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 first be removed/uninstalled using the “Add or Remove Programs” or “Programs and Features” control panel.
    
10. Alternatively, any options above that were not selected at the time of installation can be installed later from the “Add or Remove Programs” or “Programs and Features” control panel.
     

Back to top.

 
6   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 with the user interface (as seen when run normally) or invisibly (not seen by the end user).

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

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

To install with the Developer’s Kit feature:

• invisibly:
  • LonMarkResourceFiles1304.exe /s /v" /qn DEVELOPER=1"
• with the user interface:
  • LonMarkResourceFiles1304.exe /v" DEVELOPER=1"

To install with the Start Menu Shortcuts feature:

• invisibly:
  • LonMarkResourceFiles1304.exe /s /v" /qn SHORTCUTS=1"
• with the user interface:
  • LonMarkResourceFiles1304.exe /v" SHORTCUTS=1"

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

• invisibly:
  • LonMarkResourceFiles1304.exe /s /v" /qn DEVELOPER=1 SHORTCUTS=1"
• with the user interface:
  • LonMarkResourceFiles1304.exe /v" DEVELOPER=1 SHORTCUTS=1"

Back to top.

Echelon, LonMark, LonWorks, LonBuilder, LonMaker, LonPoint, LonManager, LNS, LON, NodeBuilder, and Neuron are either registered trademarks or trademarks of Echelon Corporation in the United States and/or other countries.
Adobe and Acrobat are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Microsoft, DOS, MS-DOS, Windows, XP, Vista, and Windows 7 are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.