System information

ManualsBrandsEchelon ManualsComputer equipmenti.LON SmartServer

131

132

133

134

135

136

137

138

139

140

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

9-4

Note: Section 21.1.3, Creating a Scheduler and Calendar in Visual C# .NET, includes a C#

programming example demonstrating how to use the Scheduler SOAP interface to create and read a

data logger.

Section 21.2.3, Creating a Scheduler and Calendar in Visual Basic.NET, includes a

Visual Basic example demonstrating how to do this.

9.3.1

Using the List Function on a Scheduler

You can use the List function to retrieve a list of the Schedulers that you have added to the

SmartServer. The List function takes an <iLonItem> element that includes an xSelect statement

querying items of a UFPTscheduler_Cfg type as its input, as shown in the example below. The List

function returns an <Item> element for each Scheduler that you have added to the SmartServer. The

next section describes the properties included in each of these elements.

You could use the list of <Item> elements returned by this function as input for the Get function. The

Get function would then return the configuration of each Scheduler included in the list.

Request

<xSelect>//Item[@xsi:type=" UFPTscheduler_Cfg"]</xSelect>

</iLonItem>

</List>

Response

<Item>

<UCPTname>Net/LON/iLON App/Scheduler[0]</UCPTname>

<UCPTannotation>#8000010128000000[4].UFPTscheduler;xsi:type="LON_Fb_Cfg”;

</UCPTannotation>

</Item>

</iLonItem>

</ListResponse>

9.3.2

Using the Get Function a Scheduler

You can use the Get function to retrieve the configuration of any Scheduler that you have added to the

SmartServer. You must reference the Scheduler whose configuration is to be returned by its

<UCPTname> in the input you supply to the function, as shown in the example below.

Request

<Item>

<UCPTname>Net/LON/iLON App/Scheduler[0]</UCPTname>

</Item>

</iLonItem>

</Get>

Response

<UCPTname>Net/LON/iLON App/Scheduler[0]</UCPTname>

<UCPTannotation>8000010128000000[4].UFPTscheduler</UCPTannotation>

<UCPTuri>#8000010128000000[4].UFPTscheduler_Cfg.htm</UCPTuri>

<UCPTname>Net/LON/iLON App/Digital Output 1/nviClaValue_1</UCPTname>

</DataPoint>