Instruction Manual

vi Preface
Purpose
This guide explains how to programmatically interface with the LonMaker XML Plug-in to update and
create a LonMaker network.
Audience
This guide is intended for software developers creating applications interfacing with the LonMaker
XML Plug-in. The applications may be written in any language that supports COM components or
ActiveX controls, including Microsoft
® Visual C# and Microsoft Visual Basic. Readers of this guide
should have programming experience in such a language, and familiarity with L
ONWORKS technology,
LNS Plug-ins, COM/ActiveX control concepts, and XML.
Related Reading
Introduction to the LONWORKS Platform—Introduces the basics of the LONWORKS platform.
LNS Plug-in Programmer’s Guide—Describes how to write LNS plug-ins.
LNS Programmer’s Guide—Describes the standards and development methodology for creating
interoperable LNS director and plug-in applications.
LonMaker User’s Guide— Describes how to use the LonMaker Integration Tool to design,
commission, monitor and control, maintain, and manage a network.
Go to the LonMaker Web site at
www.echelon.com/lonmaker for the latest versions of documentation
and any available updates for your software. Go to
types.lonmark.org for updated resource file
documentation.
Content
This guide includes the following content:
• Using the LonMaker XML Plug-in. Explains how to write a director application that invokes the
export and import functions of the LonMaker XML Plug-in. Describes the export and import
automation properties you can set. Provides code samples that demonstrate how to invoke the
export and import commands and how to define automation properties. Describes how to create a
trace log in order to help troubleshoot your director application
• Using the XML Schema. Provides an overview of the XML schema that defines the structure and
content of a LonMaker network XML file. Explains the elements in the header of the XML file.
Describes the various object elements that may be included in the XML file and the actions that
can be performed on them during import. Lists the attributes and properties you can set for each
object element in a LonMaker network XML file. Provides examples of how each object element
appears in a LonMaker network XML file. Describes how to define target object references.
Includes a programming example that demonstrates how to export, modify, and import a
LonMaker network XML file.
• Appendix A—LonWorks Network XML Schema. Presents the XML schema that defines the
structure and content of a LonMaker network XML file.
For More Information and Technical Support
If you have technical questions that are not answered by this document, you can contact technical
support. Free e-mail support is available or you can purchase phone support from Echelon or an
Echelon support partner. See
www.echelon.com/support for more information on Echelon support and
training services.