Echelon LonWorks Network XML Manuel d'utilisateur

LonWorks® Network XML Programmer's Guide LonMaker®User’s Guidewww.echelon.com078-0333-01ALM-UG1 6/19/06 9:30 AM Page 1

2 Using the LonMaker XML Plug-in Introduction You can speed up your network design and ensure your devices are configured correctly by creating a cu

LONWORKS Network XML Programmer’s Guide 3 Tip: You can download an assembly provided by Echelon, named PlugInWrapper.dll, to expedite the developmen

4 Using the LonMaker XML Plug-in Defining Export Automation Properties You can define standard LNS Plug-in properties and the following export autom

LONWORKS Network XML Programmer’s Guide 5 Property Name Type Description exported data. TemplateExport Long Specifies which device templates are t

6 Using the LonMaker XML Plug-in // *Insert export automation properties before invoking send command* // Option to export N

LONWORKS Network XML Programmer’s Guide 7 Defining Import Automation Properties You can define standard LNS Plug-in properties and the following imp

8 Using the LonMaker XML Plug-in // Option to suppress status and options dialog m_lmXml.XmlOptions = 0x01 | 0x02;

LONWORKS Network XML Programmer’s Guide 9 Tip: You can import two or more individual XML files to overcome order dependencies in your XML data that

10 Using the LonMaker XML Plug-in

LONWORKS Network XML Programmer’s Guide 11 2 Using the XML Schema This chapter provides an overview of the XML schema that defines the structure an

Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo are trademarks of Echelon Corporation registered

12 Using the XML Schema XML Schema Overview The LonMaker XML plug-in includes an XML schema that defines the structure and content of a LonMaker net

LONWORKS Network XML Programmer’s Guide 13 The applicable Action attributes and properties for each object element are detailed in the next section,

14 Using the XML Schema • Configuration properties • Targets • Extensions • Channels • Connection descriptions • Device templates • Component

LONWORKS Network XML Programmer’s Guide 15 RootSubsystem Y Y The LNS Subsystem that contains all of the objects reported in the XML file. If the

16 Using the XML Schema NV/message tag target definitions. See Targets for more information on using subsystem references. Properties Supported by

LONWORKS Network XML Programmer’s Guide 17 Example <Subsystem Handle="6" Action=”CREATE”> <Name>Sub

18 Using the XML Schema The possible values are as follows: 0 ConfiguredRouter 1 LearningRouter 2 RepeaterRouter 3 BridgeRouter 4 PermanentRepeater

LONWORKS Network XML Programmer’s Guide 19 PingClass Y Y An enumerated value indicating the expected movement of the router, which determines the f

20 Using the XML Schema <Location>800600000000</Location> <Description/>

LONWORKS Network XML Programmer’s Guide 21 image search path. If an application image is specified, the file exists, and the Commission attribute i

LonWorks Network XML Programmer’s Guide iii Table of Contents Preface ...

22 Using the XML Schema NeuronId Y Y On export, this property is only reported if the value is non-empty. On import, the value of this property

LONWORKS Network XML Programmer’s Guide 23 is non-empty. Priority Y Y On export, the current value (specified manually or selected automatically) i

24 Using the XML Schema is to be assigned. Subnet/Name Y Y If you specify a subnet name or ID that differs from the current subnet, the import op

LONWORKS Network XML Programmer’s Guide 25 </Extensions> </FunctionalBlocks> </AppDevice&

26 Using the XML Schema 3 Manf 4 ManfDevClass 5 ManfDevClassSubClass 6 ManfDevType Virtual functional blocks do not contain this property. IsDy

LONWORKS Network XML Programmer’s Guide 27 information. Example <FunctionalBlock Handle="1"> <Name>AI- 1</Name> <I

28 Using the XML Schema Example <FunctionalBlock Handle="2"> <Name>Analog Input[1]</Name> <IsVirtualFb ID="

LONWORKS Network XML Programmer’s Guide 29 approved functional profile, or by the user (in the case of a network variable not specified in those gui

30 Using the XML Schema Selector Y N Specifies the selector used for the NV alias. Value Y N To report NV values, you must specify the Export NV v

LONWORKS Network XML Programmer’s Guide 31 Properties within Device Template Object Elements Supported by Function? Property Export Import Descripti

iv Preface Properties within Application Device Object Elements...28 Example...

32 Using the XML Schema definitions. See Targets for more information. Properties within Application Device Object Elements Supported by Function?

LONWORKS Network XML Programmer’s Guide 33 <IsDynamic ID="0">False</IsDynamic> </MessageTag> Properties within Device Te

34 Using the XML Schema Dimension Y N The number of elements in the CP are reported. A value of 1 indicates a single element. A value greater t

LONWORKS Network XML Programmer’s Guide 35 Properties within Device Template Object Elements Supported by Function? Property Export Import Descript

36 Using the XML Schema or override components of the referenced object. SubsystemName Y Y On export, the subsystem name is reported relative to

LONWORKS Network XML Programmer’s Guide 37 <ReferenceName>TargetSub</ReferenceName> <DeviceName>AO- 1</DeviceName>

38 Using the XML Schema 4 R4 Floating point 5 R8 Floating point 6 CY Signed decimal: Unsigned decimal (high order 32 bits: l

LONWORKS Network XML Programmer’s Guide 39 assumed. Value/ Dimension/ NumberElements Y Y Applies to array values. Specifies the number of element

40 Using the XML Schema 11 TP/RS485-1250 27 DC-78 28 DC-625 29 DC-1250 24 FO-20S 16 PL-20C-LOW 17 PL-20N-LOW 15 PL-20A 15

LONWORKS Network XML Programmer’s Guide 41 reported. UseAuthenticationFlag Y Y An enumerated value indicating whether the NV/MT connection uses

LonWorks Network XML Programmer’s Guide v Preface This guide describes how to create and modify a LonMaker network using the LonMaker XML Plug-in.

42 Using the XML Schema of “None” is reported on export. ReceiverTimer Y Y An encoded integer. If you have not overridden the default receiver tim

LONWORKS Network XML Programmer’s Guide 43 <PropertyOptions ID="64">ReceiveTimer</PropertyOptions> <PropertyOptions I

44 Using the XML Schema Classification/ ModelNo Y N Only reported if Format is 8 or 9. DeviceValidation Y Y An enumerated value indicating the le

LONWORKS Network XML Programmer’s Guide 45 </DeviceTemplate> Component Applications (Plug-Ins) Component Application objects are reported on

46 Using the XML Schema 4 Systems 5 Subsystem 6 Subsystems 7 AppDevice 8 AppDevices 9 Router 10 Routers 1

LONWORKS Network XML Programmer’s Guide 47 69 PingIntervals 70 Application 71 TestInfo 72 DataPoint 73 FormatSpec 74 Monitor

48 Using the XML Schema 41 Replace 50 Register 51 Unregister 60 Recover 61 MonitorRecovery VersionNumber Y Y Specifi

LONWORKS Network XML Programmer’s Guide 49 //create Directory for XML file DirectoryInfo di = Directory.CreateDirectory(&qu

50 Using the XML Schema writer.WriteStartElement("IsVirtualFb"); writer.WriteAttributeString("ID&quo

LONWORKS Network XML Programmer’s Guide 51 writer.WriteEndElement(); // End NetworkVariable Element

vi Preface Purpose This guide explains how to programmatically interface with the LonMaker XML Plug-in to update and create a LonMaker network. Audi

52 Using the XML Schema // End NetworkVariable Element writer.WriteEndElement(); // End NetworkVar

LONWORKS Network XML Programmer’s Guide 53 //Option to create and specify location of import log m_lmXml.LogFileName = "

54 Using the XML Schema

LONWORKS Network XML Programmer’s Guide 55 Appendix A LonWorks Network XML Schema This appendix presents the XML schema that defines the structure

56 LONWORKS XML Schema LONWORKS XML Schema The XML schema used for LonWorks network is as follows: <?xml version="1.0" encoding="ut

LONWORKS Network XML Programmer’s Guide 57 <xs:element name="ElementSize" type="xs:integer" maxOccurs="1" minOccu

58 LONWORKS XML Schema <xs:element name="ProgramId" type="xs:string" maxOccurs="1" minOccurs="0" />

LONWORKS Network XML Programmer’s Guide 59 <xs:sequence> <xs:element name="Name" type="xs:string" maxOccurs=&quo

60 LONWORKS XML Schema <xs:element name="NetworkVariables" type="nvCollection" maxOccurs="1" minOccurs="0&q

LONWORKS Network XML Programmer’s Guide 61 <xs:element name="Name" type="xs:string" maxOccurs="1" minOccurs=&qu

LonWorks Network XML Programmer’s Guide vii You can also view free online training or enroll in training classes at Echelon or an Echelon training

62 LONWORKS XML Schema <xs:complexType name="deviceCollection"> <xs:sequence> <xs:element name="AppDevice" typ

LONWORKS Network XML Programmer’s Guide 63 <xs:complexContent> <xs:extension base="objectType"> <xs:sequence>

64 LONWORKS XML Schema <xs:extension base="objectType"> <xs:sequence> <xs:element name="Name" type="

LONWORKS Network XML Programmer’s Guide 65 <xs:element name="ReceiveTimer" type="xs:integer" maxOccurs="1" minO

LonMaker®User’s GuideLonMaker®User’s Guidewww.echelon.com078-0466-01ALM-UG1 6/19/06 9:30 AM Page 1

LONWORKS Network XML Programmer’s Guide 1 1 Using the LonMaker XML Plug-in This chapter explains how to write a director application that invokes t