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
13-8
input data point is not equal to that of the
compare data point.
FN_NUL
Null. Returns True for all values of the
input. Use this if you want the case rules
for a structure to be used each time there is
a translation.
The value of the input data point, or input data point field,
selected for the case structure will be compared to the
compare value using the selected comparison function. If
the result of this comparison is True, the case rules defined
for the case structure will be used.
For more information on case rules, see
Case Rules.
<UCPTcompValue>
Specify a value to be compared against the value of the
selected data point or data point field. This property is not
used if
<UCPTcompFunction> is FN_NUL.
13.3.2.2 Case Rules
You can use case rules to determine the value(s) to be assigned to the output data point(s) when a Type
Translator Rule is used. If the output data point is a structure, you can create case rules to determine
the value that will be assigned to each field in the structure.
For each rule, you will specify an input data point (and a field name if the input data point is a
structure) to determine the input value. You will also specify a compare value and a comparison
function. The input value will be compared to the compare value using the specified comparison
function. If the result of the comparison is True, the operation defined by the case rule will be
performed. If the result of the comparison is False, the operation will not be performed, and the value
of the output data point (or field) will not change.
For example, consider a Type Translator Rule that converts a SNVT_scene data point (nviScene) to a
SNVT_switch data point (nvoSwitch). You could create a case rule to assign the value or state fields
of the SNVT_switch data point a value based on scene_number of the SNVT_scene data point. For
example, you could assign the SNVT_switch data point the value 100.0 1 if the scene_number is less
than 2, or 0.0 if it is greater than 2. You can create as many case rules as you want per case structure,
so you can plan on as many contingencies as you like.
<Case>
<UCPTindex>0</UCPTindex>
<UCPTinputPath>DataPointFormat[UCPTnickName="nviScene"]</UCPTinputPath>
<UCPTinputFieldName>scene_number</UCPTinputFieldName>
<UCPTcompFunction LonFormat="UCPTcompFunction">FN_GT</UCPTcompFunction>
<UCPTcompValue LonFormat="">2</UCPTcompValue>
<Rule>
<UCPTindex>0</UCPTindex>
<UCPTinputPath>DataPointFormat[UCPTnickName="nviScene"]</UCPTinputPath>
<UCPTinputFieldName>scene_number</UCPTinputFieldName>
<UCPToutputPath>DataPointFormat[UCPTnickName="nvoSwitch"]</UCPToutputPath
<UCPTcompFunction LonFormat="UCPTcompFunction">FN_NE</UCPTcompFunction>
<UCPTcompValue LonFormat="">SC_RESET</UCPTcompValue>
<UCPTmultiplier>0</UCPTmultiplier>
<UCPTconstant LonFormat="">0.0 0</UCPTconstant>
</Rule>
</Case>
<Case>
<UCPTindex>1</UCPTindex>
<UCPTinputPath>DataPointFormat[UCPTnickName="nviScene"]</UCPTinputPath>
<UCPTinputFieldName>scene_number</UCPTinputFieldName>
<UCPTcompFunction LonFormat="UCPTcompFunction">FN_LT</UCPTcompFunction>