System information

ManualsBrandsEchelon ManualsComputer equipmenti.LON SmartServer

161

162

163

164

165

166

167

168

169

170

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

10-12

<UCPTyearMask>DW_WILDCARD</UCPTyearMask>

<UCPTmonthMask>DW_WILDCARD</UCPTmonthMask>

<UCPTdayMask>DW_WILDCARD </UCPTdayMask>

</StartDate>

<UCPTyearMask>DW_WILDCARD</UCPTyearMask>

<UCPTmonthMask>DW_WILDCARD</UCPTmonthMask>

<UCPTdayMask> DW_WILDCARD</UCPTdayMask>

</EndDate>

<UCPTschedDay LonFormat="UCPTschedDay">DM_FOURTH_SUN </UCPTschedDay>

Now consider a case where you need to create an exception to apply to every fourth Sunday of every

month, for the next 10 years. You could do so by setting the <UCPTyearMask> to DW_NUL, the

<UCPTmonthMask> to DW_WILDCARD and the <UCPTdayMask> to DW_NUL. You would also

set the <UCPTschedDay> property to DM_FOURTH_SUN, and the <UCPTschedMonth> property to

MN_NUL.

<UCPTmonthMask>DW_WILDCARD</UCPTmonthMask>

</StartDate>

<UCPTmonthMask>DW_WILDCARD</UCPTmonthMask>

</EndDate>

<UCPTschedDay LonFormat="UCPTschedDay">DM_FOURTH_SUN </UCPTschedDay>

10.3.3

Using the Set Function on a Calendar

You can use the Set function to create new Calendars, or to overwrite the configuration of existing

Calendars. The Calendars to be created or written to are signified by a list of <Item> elements in the

input you supply to the function. The properties you must define within each <Item

> element are the

same, whether you are creating a new Calendar or modifying an existing Calendar. The previous

section,

Using the Get Function on a Calendar, describes these properties.

Note: If you specify a Calendar with the <UCPTname> element, the Set function deletes the specified

Calendar before the specified parameters are set. If the <UCPTname> element is not specified, a new

Calendar is created.

The first invocation of the Set function will generate the #8000010128000000[4].UFPTcalendar.xml

file in the root/config/network/<network>/<channel>/iLONApp ||<device> directory of the

SmartServer, if the file does not already exist.

When modifying an existing Calendar, any optional properties omitted from the input will be erased.

Old values will not be preserved, so you should fill in every property when writing to a Calendar, even

if you are not changing all of the values.

When creating or modifying a Calendar with this function, you may want to use output from the Get

function as the basis for your input. You would then only need to modify the values of each property

to match the new configuration you want, as opposed to re-creating an entire string like the one shown

below, to generate your input.

The following example creates a Calendar with one exception that recurs every weekday day of every

month, year after year.

Request