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
3-5
Precision – Single floats always use 7 digits of precision, including digits before and after the decimal
point. Double floats always use 14 digits of precision. For the rest of the base types, precision is
determined by the type definition
Digit Grouping Symbol – Always comma ","
Digit Grouping – Always in the form "123,456,789"
Negative Sign Symbol – Always the minus sign "-"
Negative Number Format – Always "-1.1"; negative symbol in front, and no space between the
symbol and the number
List Separators – If the format uses the localized list separator symbol vertical bar "|", the i.LON
SmartServer will replace it with comma ",". However, if you define a new type in the NodeBuilder
Resource Editor which is a structure, array or union, the default list separator is space " ". The
localized list separator must be explicitly specified in the format.
Measurement System – The SmartServer does not use localization settings for measurement system.
The measurement system used to display a formatted value is determined by the
UCPTformatDescription property of the data point. For example, if you have a data point whose
format is defined as SNVT_temp_f#US, then the UCPTvalue written to a data point Read function will
be in Fahrenheit.
If that data point is an input to the Alarm Generator, then the format of a property which specifies a
comparison value, a delta, or an offset like UCPThighLimit2Offset will also be in US units when you
read it with a Get function. Furthermore, you would have to use US units when setting the property
with a Set function.
You should note that the value stored in the XML file will always be in SI units so that XML files may
be shared between SmartServers. The rule used by the applications is that the format of the primary
data point for the application instance determines the format of measurement system dependent
properties, like offsets, comparison values and deltas.
3.4
SOAP Functions
The SOAP interface includes a generic set of List, Get, Set, and Delete functions that can be used by
the SmartServer applications. Together, these functions make up a symmetric interface. You can use
the response from the List function as the input to the Get function. You can use the response from the
Get function as the input to the Set function.
The SOAP interface also includes Read and Write methods that can be use to read and write values to
the data points on the Data Server, read entries in a data log, alarm log, or scheduler or calendar event
log, and update entries in an alarm log. The Read and Write functions also provide a symmetric
interface. You can use the output from the Read function as the basis for your input to the Write
function.
This section provides an overview of the functions in the SOAP interface, and it briefly describes how
you can use them.
3.4.1
List Functions
Use the List function to retrieve the names of the application instances or items of a specific type on
the SmartServer. For example, the List function can return a list containing the names of the Alarm
Generators, Data Loggers, Schedulers, or other functional blocks representing the SmartServer’s
embedded applications that have been instantiated. Similarly, you can use the List function to return a
list of the data points on the Data Server (Dp_Cfg), or retrieve a list of the channels (Channel_Cfg), the
L
ONWORKS application devices (LON_Device_Cfg), the Modbus devices (MOD_Device_Cfg), and
other network items on the SmartServer.