System information
Table Of Contents
- Table of Contents
- 1 Introduction to the SmartServer SOAP/XML Interface
- 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.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.3 SmartServer Resource Files
- 3.3.1 Standard Network Variable Type (SNVT) Device Resource Files
- 3.3.2 Standard Configuration Property Type (SCPT) Device Resource Files
- 3.3.3 User Defined Network Variable Type (UNVT) Device Resource Files
- 3.3.4 User Defined Configuration Property Type (UCPT) Device Resource Files
- 3.3.5 Data Point Templates
- 3.3.6 Data Formatting
- 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.3.1 Using the List Function on the Data Server
- 4.3.2 Using the Get Function on the Data Server
- 4.3.3 Using the Set Function on the Data Server
- 4.3.4 Using the Read Function on the Data Server
- 4.3.5 Using the Write Function on the Data Server
- 4.3.6 Using the Invoke Function to Reset Data Point Priorities
- 4.3.7 Data Point Values and Priority Levels
- 4.3.8 Using the Delete Function on the Data Server
- 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
- 7.3.1 Using the List Function on an Alarm Notifier
- 7.3.2 Using the Get Function on an Alarm Notifier
- 7.3.3 Using the Set Function on an Alarm Notifier
- 7.3.4 Using the Read Function on an Alarm Notifier
- 7.3.5 Using the Write Function on an Alarm Notifier Log File
- 7.3.6 Using the Clear Function on an Alarm Notifier Log File
- 7.3.7 Using the Delete Function on an Alarm Notifier
- 8 Analog Function Block
- 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
- 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
- 12.3.1 Using the List Function on a Type Translator
- 12.3.2 Using the Get Function on a Type Translator
- 12.3.3 Using the Set Function on a Type Translator
- 12.3.4 Pre Defined Type Translator Rules
- 12.3.4.1 16xSNVT_switch_TO_SNVT_state
- 12.3.4.2 SNVT_lev_disc_TO_SNVT_occupancy
- 12.3.4.3 SNVT_lev_disc_TO_SNVT_switch
- 12.3.4.4 SNVT_occupancy_TO_SNVT_setting
- 12.3.4.5 SNVT_scene_TO_SNVT_setting
- 12.3.4.6 SNVT_scene_TO_SNVT_switch
- 12.3.4.7 SNVT_setting_TO_SNVT_switch
- 12.3.4.8 SNVT_state_TO_16xSNVT_switch
- 12.3.4.9 SNVT_switch_TO_SNVT_lev_disc
- 13 Type Translator Rules
- 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
- 16 M Bus Driver
- 17 Virtual Driver
- 18 File System Data
- 19 System Information Methods
- 20 Using the SOAP Interface as a Web Service
- 21 Programming Examples
- 21.1 Visual C#.NET Examples
- 21.1.1 Reading and Writing Data Point Values in Visual C# .NET
- 21.1.2 Creating and Reading a Data Logger in Visual C# .NET
- 21.1.3 Creating a Scheduler and Calendar in Visual C# .NET
- 21.1.4 Creating and Installing a LonWorks Device in Visual C# .NET
- 21.1.5 Commissioning External Devices in Visual C# .NET
- 21.1.6 Discovering and Installing External Devices in Visual C# .NET
- 21.1.7 Configuring the SmartServer in Visual C# .NET
- 21.2 Visual Basic.NET Examples
- 21.2.1 Reading and Writing Data Point Values in Visual Basic.NET
- 21.2.2 Creating and Reading a Data Logger in Visual Basic. NET
- 21.2.3 Creating a Scheduler and Calendar in Visual Basic.NET
- 21.2.4 Creating and Installing a LonWorks Device in Visual Basic.NET
- 21.2.5 Commissioning External Devices in Visual Basic.NET
- 21.2.6 Discovering and Installing External Devices in Visual Basic.NET
- 21.2.7 Configuring the SmartServer in Visual Basic.NET
- 21.1 Visual C#.NET Examples
- 22 Programming the SmartServer with Java
- Appendix A: SOAP Tester Example

i.LON SmartServer 2.0 Programmer’s Reference
1-2
Echelon strongly recommends that you use the SOAP interface to configure the applications of
your SmartServer. The SmartServer performs error-checking on all data written in a SOAP message,
so that invalid data will not be written to any of the XML files. The SmartServer will not perform
error-checking on any XML files downloaded to it via FTP, and so manually editing the XML files
may cause errors during the boot process. Additionally, you can send SOAP messages to the
SmartServer while it is operating, and the SmartServer will update the XML files affected by the
SOAP messages without requiring a reboot.
You may find the information in this document that pertains to manually creating and managing XML
files useful if you are using several SmartServers, and would like to use the same configuration on
each one. In that case, you could configure one of the SmartServers, copy its XML files, and
download them to the appropriate directories of the other SmartServers to obtain the same
configuration in all of them.
1.2
Programming Samples
Chapter 21 of this document includes programming samples written in
Visual C# .NET, Visual Basic
.NET, and Java
to illustrate concepts described in this manual. To make these samples more easily
understood, they have been simplified. Error checking has been removed, and in some cases, the
examples are only fragments that may not compile without errors or warnings.
1.3
Getting Started
You should review Chapters 2 and 3 before proceeding to the rest of this document and learning about
the functions and applications of the SOAP/XML interface. Chapter 2,
SOAP Messages and the
SmartServer WSDL, describes the WSDL file which defines the SOAP/XML interface. Chapter 3,
SmartServer Applications and the SOAP/XML Interface, provides an overview of the SmartServer
applications and includes a roadmap to follow when configuring those applications with a SOAP
application.
You can begin to learn how to program the SmartServer using SOAP/XML using the iLON SOAP
Tester (version 2.0.3994). The SOAP Tester is an unsupported engineering-level tool provided by
Echelon that lets you perform functional testing of the SmartServer’s pre-defined SOAP functions and
your user-defined SOAP functions. You can download the SOAP Tester from the i.LON SmartServer
Community Web site at
http://ilonsmartserver.com/files. If you have a SmartServer 2.0 (Release
4.03), the SOAP Tester is also included on the i.LON SmartServer 2.0 DVD in the
iLon100\iLon100\unsupported\SoapTester folder. For more information on using the SOAP Tester,
see
Appendix A: SOAP Tester Example.
You can also learn how to program the SmartServer using SOAP/XML by installing an HTTP
debugging proxy program like Charles on your computer. The Charles proxy records all SOAP and
other HTTP traffic to and from your computer. You can use Internet Explorer to perform normal
operations with the SmartServer Web interface and record the SOAP messages that are being sent to
the SmartServer. You can download a free trial version of the Charles proxy from the Charles Web
site. For more information on using and downloading the Charles proxy, go to the Charles Web site at
www.charlesproxy.com.
1.4
SmartServer SOAP/XML Interface Upgrades
The format and contents of the SOAP messages you can send to a SmartServer are defined by the
SOAP namespace that the SmartServer is using. The SOAP/XML interface used for the SmartServer
(software version 4.0) is new. It uses a common set of generic methods (list, get, set, delete, read,
write, clear, and invoke) for retrieving and configuring the data of the various SmartServer
applications. This differs from the SOAP/XML interface that was used for e3 (software version 3.0)
release, in which each application had its own specialized set of messages and structures.
There have been three different SOAP namespaces introduced during the four releases of the i.LON
servers. The version 1.0 namespace was introduced for Release 1.0, the version 1.1 namespace was