Lon Xml Tool:
The Lon Xml Tool lets you make your own Lon Xml (.lnml) file for a device, using the source .xif file
and (if necessary) other resource files, as available from the device’s manufacturer.
The tool’s dialog (Figure A-2) provides the necessary input fields.
Need for custom Lon Xml files:
Although Workbench installs with many lon<Vendor> modules, where each one contains numerous lnml
files for specific devices, in some cases you may need an lnml file for a device not included. Typically, this
need arises because:
• The device includes one or more manufacturer-defined nvs (otherwise, you could simply use a DynamicDevice
to represent it, then perform a Learn Nv action).
• The device is newer or otherwise different than the one represented by the closest “standard” lnml
file, or Tridium has not yet released a standard lnml version for this device.
Note: Starting in builds 3.0.100 and 3.1.7, Lon Xml support was added for “default” (init) values for a device’s
ncis and cps, providing that the source .xif file is version 4.0 or later, and “init” data values other than all
zeros exist. Therefore, you may want to build lnml files for various devices, even if they previously had
“standard” lnml files in various lon<Vendor> modules. In other words, lnml files that already existed in
those modules were not regenerated with this feature—only devices that had lnml files added in
lon<Vendor> modules after those builds.
In general, using the Lon Xml Tool allows you to independently integrate Lonworks devices without
depending on Tridium to issue updated lon<Vendor> modules.
Lon Xml file overview:
Lon Xml (lnml) files are used to describe specific Lonworks devices to NiagaraAX. This includes data to
describe the device itself (typically derived from an xif file), as well as manufacturer-specific datatypes
for nvs, ncis, and cps (typically derived from resource files). For specific low-level details about Lon Xml,
see the “Lon Markup Language” section in the Developer Guide.
Note: By convention, any device’s lnml file is named identically as its xif file (except for extension). Meaning, a
device that has a “T7350Cs.xif” file will have a “T7350Cs.lnml” file.
By default, Workbench installs with many “standard” lnml files for various Lon devices, all of which are
distributed among various lon<Vendor> module jars (for example, lonHoneywell). During a Lon Device
Manager “Discover”, these lnml files are automatically searched and defaulted, according to the Program
Id returned by each device.
Or, if the needed lon<Vendor> modules are installed on the host JACE platform, a “Quik Learn” automatically
uses the matching lnml file to create Lon devices, in much the same manner.
Note: Lon Xml file source data is required to make lnml files.
Lon Xml file source data:
Xif and resource files for any Lonworks device are provided by the manufacturer. To create an lnml file
for any Lonworks device, you must have its xif file. If the device contains manufacturer-defined datatypes,
and you want this data for any LonComponents, you must also supply related resource files.
Resource files typically include the following types:
• vendor.ENU — Language resource file (in this case, English).
• vendor.FMT — Format selector file.
• vendor.FPT — Functional profile file.
• vendor.TYP —Type and enum file.
Before using this tool, place all related resource files in a single directory.
Lon Xml creation:
When using the Lon Xml Tool tool to make an lnml file, you specify the following, by clicking the folder
icon beside each input field (see Figure A-2):
• Working Dir — where the device lnml file is to be made (Directory Chooser appears).
• Xif File — the manufacturer’s xif for that device (File Chooser appears).
• Resource Dir (if applicable) — the directory that contains associated resource files (as listed in the
previous section, “Lon Xml file source data”) (Directory Chooser appears).
In the Directory Chooser or File Chooser dialogs, you can specify the complete path (inclusive
of drive letter) for the working directory, *.xif file, and resource files directory. Or, use the “Sys Home”
(“!”) path if you are working under the Niagara-3.n.n installation directory.
When you click Compile, the xif file for that device is parsed, along with the resource files (if applicable),
and an *.lnml file for the device is created in the working directory. If using resource files, a “datatypes”
sub-directory is also created under that working directory, with a child lnml file.