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-3

3.3

SmartServer Resource Files

There are many configuration properties you can configure with the SOAP functions described in this

document. This document provides a general description of each property, and other information you

will need when configuring each one, such as minimum and maximum values for scalar properties, and

maximum string lengths for string properties. This information is also contained in the SmartServer

resource files. In order to successfully send a SOAP message to the SmartServer, all data in the

message must be formatted as described in this document and in the resource files.

The SmartServer resource files are added to the LNS resource file catalog by the SmartServer software

installation utility, but they also exist locally on the SmartServer. In fact, like LNS, the SmartServer

maintains a catalog of resource files to use when formatting data in SOAP messages, network variable

updates, and web tag data from the SmartServer web server.

You can use the Node Builder Resource Editor, which is included on the SmartServer software

installation CD, to create new resource files for your own custom data point types and formats. Note

that when creating custom resource files on a PC, it is common to organize the files into subdirectories

such as:

C:\LonWorks\Types\User\YourCompany\YourResourceFiles.*

When adding these files to the SmartServer, it is the best practice to FTP them to a location on the

SmartServer flash disk matching the path on your computer:

/root/lonworks/types/User/YourCompnay/YourResourceFiles.*

You only need to FTP your own custom resource files to the SmartServer. If the name of your file set

is "MyResourceFiles", then you must copy every file which starts with the name "MyResourceFiles".

After you have copied these files to the SmartServer you must reboot to be able to use the new type

definitions and formats. During boot the SmartServer reads the resource files in this directory and

updates its local catalog accordingly.

3.3.1

Standard Network Variable Type (SNVT) Device Resource Files

SNVT device resource files describe the data structures within LonMark

SNVTs, and the formats

used to display SNVT data. On the SmartServer, you can find these files in the

/root/lonworks/types directory. They are named STANDARD.ENU, STANDARD.TYP,

STANDARD.FMT, and STANDARD.FPT.

The default format for a SNVT is its native format, as described in STANDARD.FMT. When you

add a data point to the SmartServer, you will assign that data point a format type. If a specific SNVT

format is desired for a particular data point, the <UCPTformatDescription> of that data point must be

set to the name of that SNVT format.

You can browse the entire SNVT device resource files online at

http://types.lonmark.org.

3.3.2

Standard Configuration Property Type (SCPT) Device Resource Files

This is a set of files that describes the data structures within SCPTs, and also describes the formats

used to display SCPT data. On the SmartServer, these files can be found in the directory

/root/lonworks/types directory. These files are named STANDARD.ENU,

STANDARD.TYP, STANDARD.FMT and STANDARD.FPT.

Many configuration properties that are used by the SmartServer applications are based on the SCPTs

defined in these files. The information provided in this document, and in the SCPT resource files, will

help you determine what values to assign to the SCPTs referenced by the SmartServer.

You can browse the entire SCPT device resource files online at

http://types.lonmark.org.