System information

ManualsBrandsEchelon ManualsComputer equipmenti.LON SmartServer

371

372

373

374

375

376

377

378

379

380

Table Of Contents

Table of Contents
1 Introduction to the SmartServer SOAP/XML Interface
- 1.1 About This Document
- 1.2 Programming Samples
- 1.3 Getting Started
- 1.4 SmartServer SOAP/XML Interface Upgrades
  - 1.4.1 Version 4.0 SOAP Message Name Schema
    - 1.4.1.1 Version 3.0 Message Name Schema
    - 1.4.1.2 Version 4.0 Message Name Schema
2 SOAP Messages and the SmartServer WSDL File
- 2.1 SmartServer Naming Structure
- 2.2 SmartServer WSDL File
- 2.3 Security
- 2.4 SOAP Request and Response Message Structure
  - 2.4.1 SOAP Request
  - 2.4.2 SOAP Response
- 2.5 SOAP Messages Formats
- 2.6 Data Point References
- 2.7 UCPTcurrentConfig
- 2.8 Fault Structure
- 2.9 LonString type
- 2.10 SOAP Message Examples
3 SmartServer Applications and the SOAP/XML Interface
- 3.1 Overview of SmartServer Applications
- 3.2 SmartServer XML Configuration Files
  - 3.2.1 Modifying the XML Configuration Files
- 3.3 SmartServer Resource Files
- 3.4 SOAP Functions
- 3.5 Performance Issues
4 Using the SmartServer Data Server
- 4.1 Creating and Modifying the Data Point XML Files
- 4.2 Overview of the Data Point XML File
- 4.3 Data Server SOAP Interface
- 4.4 Using the Web Binder Application
5 Data Loggers
- 5.1 Overview of the Data Logger XML File
- 5.2 Creating and Modifying the Data Logger XML File
- 5.3 Data Logger SOAP Interface
6 Alarm Generator
- 6.1 Overview of the Alarm Generator XML File
- 6.2 Creating and Modifying the Alarm Generator XML File
- 6.3 Alarm Generator SOAP Interface
7 Alarm Notifier
- 7.1 Overview of the AlarmNotifier XML File
- 7.2 Creating and Modifying the Alarm Notifier XML File
- 7.3 Alarm Notifier SOAP Interface
8 Analog Function Block
- 8.1 Overview of the AnalogFB XML File
- 8.2 Creating and Modifying the Analog Functional Block XML File
- 8.3 Analog Functional Block SOAP Interface
9 Scheduler
- 9.1 Overview of the Scheduler XML File
- 9.2 Creating and Modifying the Scheduler XML File
- 9.3 Scheduler SOAP Interface
10 Calendar
- 10.1 Overview of the Calendar XML File
- 10.2 Creating and Modifying the Calendar XML File
- 10.3 Calendar SOAP Interface
11 Real Time Clock
- 11.1 Overview of the Real Time Clock XML File
- 11.2 Creating and Modifying the Real Time Clock XML File
- 11.3 Real Time Clock SOAP Interface
12 Type Translator
- 12.1 Overview of the Type Translator XML File
- 12.2 Creating and Modifying the Type Translator XML File
- 12.3 Type Translator SOAP Interface
13 Type Translator Rules
- 13.1 Type Translator Rule XML Files
- 13.2 Creating and Modifying the Type Translator Rule XML Files
- 13.3 Type Translator Rule SOAP Interface
14 LonWorks Driver
- 14.1 LonWorks Networks
- 14.2 LonWorks Channels
- 14.3 LonWorks Devices
- 14.4 Routers
- 14.5 Remote Network Interface
- 14.6 LonWorks Functional Blocks
- 14.7 Network Variables (LonWorks Data Points)
- 14.8 Configuration Properties (LonWorks Data Points)
- 14.9 LonWorks Connections
15 Modbus Driver
- 15.1 Modbus Channels
- 15.2 Modbus Devices
- 15.3 Modbus Virtual Functional Blocks
- 15.4 Modbus Data Points
16 M Bus Driver
- 16.1 M Bus Channels
- 16.2 M Bus Devices
- 16.3 M Bus Virtual Functional Blocks
- 16.4 M Bus Data Points
17 Virtual Driver
- 17.1 Virtual Channels
- 17.2 Virtual Devices
- 17.3 Virtual Functional Blocks
- 17.4 Virtual Data Points
18 File System Data
- 18.1 Using the List Function on File System Data
- 18.2 Using the Read Function on File System Data
- 18.3 Using the Write Function on File System Data
- 18.4 Using the Delete Function on File System Data
19 System Information Methods
- 19.1 System Service Methods
- 19.2 System Test Methods
20 Using the SOAP Interface as a Web Service
- 20.1 Referencing and Inheriting from the WSDL
  - 20.1.1 Referencing and Inheriting from the WSDL Using .NET 3.5 Framework
  - 20.1.2 Referencing and Inheriting from the WSDL Using .NET 2.0 Framework
- 20.2 Instantiating and Initializing the Web Service Client
- 20.3 Calling Web Services Methods
- 20.4 Accepting a Web Binding From a SmartServer
21 Programming Examples
- 21.1 Visual C#.NET Examples
- 21.2 Visual Basic.NET Examples
22 Programming the SmartServer with Java
- 22.1 Setting up the Java Programming Environment
- 22.2 Creating a JAX-WS Client
- 22.3 Java Programming Examples
Appendix A: SOAP Tester Example

i.LON SmartServer 2.0 Programmer’s Reference

21-24

Console.WriteLine("Neuron ID = " + NID);

String PID = NID_PID.Substring(13, 16);

Console.WriteLine("Program ID = " + PID);

//set Neuron ID, which is a byte[]

my_LON_Device.UCPTuniqueId = (HexStringToArray(NID));

//set Program ID, which is a byte[]

my_LON_Device.UCPTprogramId = (HexStringToArray(PID));

//set template

iLON_SmartServer.E_xSelect xSelect = new iLON_SmartServer.E_xSelect();

xSelect.xSelect = "//Item[@xsi:type=\"TemplateManager_Cfg\"]

[UCPTfileType=\"TEMPLATE_OR_XIF\"]

[UCPTprogramId=\"" + PID + "\"]";

itemColl = SmartServer.List(xSelect);

iLON_SmartServer.TemplateManager_Surrogate_Cfg template =

(iLON_SmartServer.TemplateManager_Surrogate_Cfg)itemColl.Item[0];

String templateName = template.UCPTname;

Console.WriteLine("Device Template = " + templateName);

my_LON_Device.UCPTurlTemplate = templateName;

//set the device name

//1. get the name of the channel ("Net/LON")

xSelect.xSelect = "//Item[@xsi:type=\"LON_Channel_Cfg\"][UCPThidden=0]";

itemColl = SmartServer.List(xSelect);

iLON_SmartServer.Item channel = itemColl.Item[0];

//2. get the name of the xif

string[] separator = new string[] { "/" };

String[] templateName_justxif = templateName.Split(separator, 0);

int templateNameLength = templateName_justxif.Length;

String xifName = templateName_justxif[templateNameLength - 1];

Console.WriteLine("XIF Name = " + xifName);

//3. name device using channel name, /device [index], and xif name

// ("Net/LON/Device 1 (ai-10v3.xif)")

String deviceName = channel.UCPTname + "/" + "Device " + i + " (" + xifName + ")";

Console.WriteLine("Device Name = " + deviceName);

Console.WriteLine("===========================================================");

my_LON_Device.UCPTname = deviceName;

//set Commission status

iLON_SmartServer.E_LonString commissionStatus_LonString =

new iLON_SmartServer.E_LonString();

commissionStatus_LonString.Value = "COMMISSIONED";

my_LON_Device.UCPTcommissionStatus = commissionStatus_LonString;

//set Application status

iLON_SmartServer.E_LonString applicationStatus_LonString =

new iLON_SmartServer.E_LonString();

applicationStatus_LonString.Value = "APP_RUNNING";

my_LON_Device.UCPTapplicationStatus = applicationStatus_LonString;

//set tree and app icon; based on program ID

my_LON_Device.UCPTannotation = PID;

//++++send device commands++++++

//commission device

//create a command array to store device commands to be sent

my_LON_Device.Command = new iLON_SmartServer.LON_Device_CfgCommand[3];

//commission device

my_LON_Device.Command[0] = new iLON_SmartServer.LON_Device_CfgCommand();

my_LON_Device.Command[0].UCPTcommand =

new iLON_SmartServer.LON_Device_eCommand();

my_LON_Device.Command[0].UCPTcommand =