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

3-1

3 SmartServer Applications and the SOAP/XML

Interface

This chapter provides an overview of the applications supported by the SmartServer, and of how you

can use the SOAP/XML interface to configure these applications and use the data they generate. This

chapter includes the following major sections:

•

Overview of SmartServer Applications. This section provides a description of each of the

applications that the SmartServer supports.

•

SmartServer XML Configuration Files. The configuration of each SmartServer application is

stored in an XML file. This section lists those XML files, and it indicates where they are stored

on the SmartServer.

•

SmartServer Resource Files. The SmartServer resource files contain information you will need

when using the SOAP functions. This section describes how to use the resource files.

•

SOAP Functions. The SmartServer’s SOAP interface includes a generic set of List, Get, Set,

Read, Write, and Delete functions that can be used by the SmartServer applications. Together,

these functions make up a symmetric interface. This section provides an overview of how to use

these functions.

•

Performance Issues. This section lists performance issues you should consider when using the

SOAP/XML interface.

3.1

Overview of SmartServer Applications

You can use the SOAP/XML interface to configure the following SmartServer applications:

•

Data Server. The SmartServer’s internal Data Server is a software component that abstracts any

data element of any bus into a data point. This enables the SmartServer’s built-in applications and

your custom SmartServer Web pages to operate on these abstractions without regard of the device

driver (e.g., L

ONWORKS, Modbus, M-Bus, Virtual, and Freely Programmable Module [FPM]).

•

Web Binding. You can use the Web Binder application to create Web connections that allow

direct data exchange over a TCP/IP network between a SmartServer and another host device such

as a remote SmartServer, LNS Server, or a WebBinder Target Server (a Web server that can

process SOAP requests such as Apache or IIS).

•

Data Logging. You can configure the SmartServer to record updates to the data points on your

network by creating Data Loggers. Each Data Logger will have its own log file, which will

contain log entries for each of the updates to the data points it is monitoring. These logs can be

downloaded and read with the Internet File Transfer Protocol (FTP), or retrieved with the Read

function.

•

Alarming. You can configure the SmartServer to trigger alarms based on the values and statuses

of the data points in your control network. The SmartServer can be configured to update any data

point in the L

ONWORKS network, log the conditions to one or more data logs, or send out emails

notifying recipients of the alarms and the conditions that triggered them. Alarms can be

configured to shut off automatically when certain conditions are met, or they can be configured to

require manual clearance. You will create Alarm Generators and Alarm Notifiers to manage these

alarming tasks.

•

Analog Functional Blocks. You can use the Analog Functional Block application to perform

statistical operations on the values of any of the data points in your network.

•

Scheduling. You can use the SmartServer to create daily and weekly schedules, as well as

exception schedules and override schedules. These schedules can drive the inputs to data points

bound to any L

ONWORKS, M-Bus or Modbus device. You can create Schedulers and Calendars to