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-15
• If <UCPTmaxAge> is set to 0, the Data Server returns polls the data point and returns the updated
value regardless how current the data point is.
• If <UCPTmaxAge> is disabled, the Data Server returns cached values regardless how old the data
point values are. This is the default.
4.3.5
Using the Write Function on the Data Server
A data point's value and priority level are initially set when the data point is added to the Data Server.
The value is set to the value established for the <UCPTdefOutput> property for the data point, and the
priority defaults to the lowest priority level (255).
You can write to a data point’s current value and priority level with the Write function. The input
parameters you supply to this function will include one or more <Item> elements that have a
<UCPTname> property, specifying the unique name of the data point to be written to with the Write
function. You should not attempt to write to more than 100 data points with a single call to the Write
function.
You can specify the value to be written to the data point with the <UCPTvalue> property. You can
also write an updated value to the data point using a formatted value, a preset, or raw hex. You can
also write values to the individual fields of structured data points.
4.3.5.1 Writing Formatted Values to a Data Point
You can use a formatted value to write to a data point. To do this, you must include a LonFormat
attribute in the <UCPTvalue> property and set it to the format description of the data point. This
attribute indicates how the <UCPTvalue> property should be unformatted by the SmartServer. If the
UCPTformatDescription of the data point being written to is SNVT_temp_f#SI, and the Write function
includes a LonFormat attribute with the value SNVT_temp_f#US, the specified value will be first
unformatted using Fahrenheit, before being written to the Data Point, even though the format of the
Data Point is normally in Celsius. For example, you could write a value of 32 to a SNVT_temp data
point in Fahrenheit by specifying the data type’s customary units (#US) format, and the value will
automatically be converted to 0.0° Celsius.
• <UCPTvalue LonFormat="#0000000000000000[0].SNVT_temp#US">32.0</UCPTvalue>
4.3.5.2 Writing Presets to a Data Point
You can use a preset to write to a data point. To do this, you must include a LonFormat attribute and
set it to the <UCPTvalueDef> property. For example, you could write a value of 100.0 1 to a
SNVT_switch data point by writing the ON preset to the data point.
• <UCPTvalue LonFormat="UCPTvalueDef">ON</UCPTvalue>
Note: If you pass in both the <UCPTvalue> property and a <UCPTvalue> property with a
<UCPTvalueDef> LonFormat attribute in a single Write function, the <UCPTvalueDef> property will
be used to determine the value to assign to the data point, unless it references an invalid value, in
which case the <UCPTvalue> property will be used to determine the value to assign to the data point.
4.3.5.3 Writing Raw Values to a Data Point
You can write a raw value to a data point. To do this, you must include a LonFormat attribute and set
it to "RAW_HEX".
<UCPTvalue LonFormat="RAW_HEX">10</UCPTvalue>
4.3.5.4 Writing Values to Structured Data Points
You can write to the individual fields of structured data points. To do this, you must include a
LonFormat attribute and set it to the field of the specific data type using the following format:
datatype.field. For example, to write to the setting field of a SNVT_scene data point, you would set
the LonFormat attribute to “SNVT_scene.setting” and then specify the value to be written to the field.