System information

ManualsBrandsEchelon ManualsComputer equipmenti.LON SmartServer

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

4-3

• The data points on the SmartServer’s internal automated systems device (i.LON App), which

contains the functional blocks representing the SmartServer’s built-in applications, are stored in a

Dp.xml file in the root/config/network/Net/LON/iLONApp directory on the SmartServer flash

disk by default.

• The data points for an external L

ONWORKS digital input/output device connected to the

SmartServer might be stored in a Dp.xml file in the root/config/network/Net/LON/DIO-2

directory on the SmartServer flash disk.

• The data points on the SmartServer’s internal systems device (i.LON System), which contains

Interoperable Self-Installation (ISI) data points and data points containing connection manager and

LonTalk statistics, are stored in a Dp.xml file in the root/config/network/Net/VirtCh/iLONSystem

directory on the SmartServer flash disk.

• Note: The directories containing the Data Server’s Dp.xml files also contain separate

<driver>_Dp.xml files in which the data points’ driver properties are stored. The properties in

these files relate to a specific bus—L

ONWORKS, Modbus, M-Bus, Virtual, or FPM—and not the

Data Server. These driver-specific properties and how to use the List, Get, Set, and Delete

functions on them are described in Chapters 14–17.

You can manage the Dp.xml files manually using an XML text editor, and download them to the

root/config/network/<network>/<channel>/<device> directory of the SmartServer

via FTP. Echelon does not recommend this, as the SmartServer will require a reboot to read the

configuration of the downloaded XML files. Additionally, the SmartServer performs error checking

on all SOAP messages it receives before writing to the XML files. It will not perform error checking

on any XML files you download via FTP, and so the application may not boot properly.

However, if you plan to create or modify any XML files manually, you should review the rest of this

chapter first. This chapter describes the elements and properties in the Data Server configuration files

that define each data point’s configuration.

4.2

Overview of the Data Point XML File

The Dp.xml files on the SmartServer store the configurations of the data points that you have added to

the SmartServer under their respective parent network/channel/device directories. Each data point is

signified by an <Item> element of a Dp_Cfg type in the XML file. The configuration properties

contained in each <Item> element define the configuration of a data point, and are described later in

this chapter.

You can create new data points using the Set function, or by manually editing the Dp.xml file. You

can read the current value and status of a data point using the Read function, and you can write updated

values to data point using the Write function.

The following code represents a snippet of a sample Dp.xml file with one data point of an external

ONWORKS digital input/output device connected to the SmartServer:

<UCPTname>Net/LON/DIO-3/Digital Output[0]/DO_Digital_1</UCPTname>

<UCPTdescription>Digital value to output</UCPTdescription>

<UCPTformatDescription>#0000000000000000[0].SNVT_switch</UCPTformatDescription>

<UCPTunit field="value">% of full level</UCPTunit>

<UCPTunit field="state">state code</UCPTunit>

<UCPTbaseType LonFormat="UCPTbaseType">BT_STRUCT</UCPTbaseType>