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
4-1
4 Using the SmartServer 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]).
Data points provide the SmartServer applications and Web server with a generic, open way to handle
any piece of information in any type of network, such as the current value of a network variable in an
LNS-managed network, or an explicit message in a closed L
ONWORKS system. The Data Server
handles all the details of these data point that are required by the various applications of the
SmartServer, such as how often a data point should be polled, its default value, its heartbeat, its current
status, and its current value.
At the Data Server layer, all data points have the same set of properties, regardless of the network or
device to which each data point is local. This is made possible by the drivers that exist for each data
point type, which handle communication between the Data Server and the physical network to which
each data point is local.
You can use a standard network management tool for the particular data point type to configure each
driver on the SmartServer. For example, you could use an LNS-based network management tool to
configure the data points on the SmartServer’s internal automated systems device (i.LON App). This
layer of abstraction between the drivers and the Data Server provides a mechanism for all SmartServer
applications to use data points of all types in the same way. The Data Server also ensures that the
configuration, status and value of each data point recognized by the tools you can use to configure the
SmartServer remain synchronized with each other, and within the device to which the data point is
local. The tools you can use to configure the SmartServer include custom SOAP applications, the
LonMaker tool, built-in SmartServer Web pages, and custom SmartServer Web pages.
The data elements that that can be abstracted by the Data Server include the following:
• The network variables and configuration properties on the SmartServer’s LON driver, which
include the following:
o The network variables and configuration properties on the SmartServer’s internal automated
systems device (Net/LON/i.LON App). The i.LON App device contains functional blocks
representing the SmartServer’s built-in applications. These data points were referred to as
NVLs in Version 3.0.
o The network variables and configuration properties of the L
ONWORKS devices connected to
the SmartServer. These data points were referred to as NVEs in Version 3.0.
o The system network variables on the SmartServer that maintain constant values for the
SmartServer’s built-in applications (e.g., Net/LON/iLON App/Alarm
Generator[0]/CompareDP). These data points were referred to as NVCs in Version 3.0.
• The registers of M-Bus and Modbus devices on the SmartServer’s M-Bus and Modbus drivers.
• The network variables on the SmartServer’s Virtual driver. This includes the network variables of
the SmartServer’s internal systems device (Net/VirtCh/i.LON System), which contain connection
manager and LonTalk statistics, and the network variables on Interoperable Self-Installation (ISI)
devices connected to the SmartServer. These data points were referred to as NVVs in Version 3.0.
• The network variables and configuration properties on custom FPM drivers created with the
i.LON SmartServer Programming Tools. You can use FPM drivers as gateways to legacy
systems or nonnative networks such as BACnet and CAN (requires an external interface, sold
separately)
. For more information on creating FPM drivers, see the i.LON SmartServer
Programming Tools User’s Guide.
The following figure shows the relationship between the buses supported by the SmartServer, the Data
Server, and the SmartServer’s built-in applications.