System information

ManualsBrandsEchelon ManualsComputer equipmenti.LON SmartServer

391

392

393

394

395

396

397

398

399

400

Table Of Contents

Table of Contents
1 Introduction to the SmartServer SOAP/XML Interface
- 1.1 About This Document
- 1.2 Programming Samples
- 1.3 Getting Started
- 1.4 SmartServer SOAP/XML Interface Upgrades
  - 1.4.1 Version 4.0 SOAP Message Name Schema
    - 1.4.1.1 Version 3.0 Message Name Schema
    - 1.4.1.2 Version 4.0 Message Name Schema
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.4.1 SOAP Request
  - 2.4.2 SOAP Response
- 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.2.1 Modifying the XML Configuration Files
- 3.3 SmartServer Resource Files
- 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.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
8 Analog Function Block
- 8.1 Overview of the AnalogFB XML File
- 8.2 Creating and Modifying the Analog Functional Block XML File
- 8.3 Analog Functional Block SOAP Interface
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
- 11.1 Overview of the Real Time Clock XML File
- 11.2 Creating and Modifying the Real Time Clock XML File
- 11.3 Real Time Clock SOAP Interface
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
13 Type Translator Rules
- 13.1 Type Translator Rule XML Files
- 13.2 Creating and Modifying the Type Translator Rule XML Files
- 13.3 Type Translator Rule SOAP Interface
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
- 15.1 Modbus Channels
- 15.2 Modbus Devices
- 15.3 Modbus Virtual Functional Blocks
- 15.4 Modbus Data Points
16 M Bus Driver
- 16.1 M Bus Channels
- 16.2 M Bus Devices
- 16.3 M Bus Virtual Functional Blocks
- 16.4 M Bus Data Points
17 Virtual Driver
- 17.1 Virtual Channels
- 17.2 Virtual Devices
- 17.3 Virtual Functional Blocks
- 17.4 Virtual Data Points
18 File System Data
- 18.1 Using the List Function on File System Data
- 18.2 Using the Read Function on File System Data
- 18.3 Using the Write Function on File System Data
- 18.4 Using the Delete Function on File System Data
19 System Information Methods
- 19.1 System Service Methods
- 19.2 System Test Methods
20 Using the SOAP Interface as a Web Service
- 20.1 Referencing and Inheriting from the WSDL
  - 20.1.1 Referencing and Inheriting from the WSDL Using .NET 3.5 Framework
  - 20.1.2 Referencing and Inheriting from the WSDL Using .NET 2.0 Framework
- 20.2 Instantiating and Initializing the Web Service Client
- 20.3 Calling Web Services Methods
- 20.4 Accepting a Web Binding From a SmartServer
21 Programming Examples
- 21.1 Visual C#.NET Examples
- 21.2 Visual Basic.NET Examples
22 Programming the SmartServer with Java
- 22.1 Setting up the Java Programming Environment
- 22.2 Creating a JAX-WS Client
- 22.3 Java Programming Examples
Appendix A: SOAP Tester Example

i.LON SmartServer 2.0 Programmer’s Reference

21-40

Dim newScheduler As iLON_SmartServer.Item = ItemColl_Set_Scheduler_Return.Item(0)

Console.WriteLine("New Scheduler = " & newScheduler.UCPTname)

End If

' -------------- CREATING A CALENDAR --------------

Create a new UFPTcalendar_Cfg item

Dim myCalendar As New iLON_SmartServer.UFPTcalendar_Cfg()

myCalendar.UCPTname = "Net/LON/iLON App/myCalendar"

myCalendar.UCPTannotation = "#8000010128000000[4].UFPTcalendar"

End Try

'Configure the Calendar

Dim effectivePeriod_calendar As New iLON_SmartServer.UFPTscheduler_CfgEffectivePeriod()

effectivePeriod_calendar.StartDate = New DateTime(2009, 6, 8)

effectivePeriod_calendar.EndDate = New DateTime(2020, 12, 31)

effectivePeriod_calendar.StartDateSpecified = True

effectivePeriod_calendar.EndDateSpecified = True

myCalendar.ScheduleEffectivePeriod = effectivePeriod_calendar

'create an exception

myCalendar.Exception = New iLON_SmartServer.UFPTcalendar_CfgException(0) {}

myCalendar.Exception(0) = New iLON_SmartServer.UFPTcalendar_CfgException()

myCalendar.Exception(0).UCPTexceptionName = "Holidays"

myCalendar.Exception(0).UCPTaliasName = "Holidays"

myCalendar.Exception(0).UCPTindex = 0

myCalendar.Exception(0).UCPTindexSpecified = True

myCalendar.Exception(0).UCPTtemporary = 0

myCalendar.Exception(0).UCPTtemporarySpecified = True

myCalendar.Exception(0).UCPTmaxClient = 1

myCalendar.Exception(0).UCPTmaxClientSpecified = True

myCalendar.Exception(0).Client = New iLON_SmartServer.UFPTcalendar_CfgExceptionClient(0) {}

myCalendar.Exception(0).Client(0) = New iLON_SmartServer.UFPTcalendar_CfgExceptionClient()

myCalendar.Exception(0).Client(0).UCPTname = "Net/LON/iLON App/myScheduler"

myCalendar.Exception(0).Client(0).UCPTservicePath = New iLON_SmartServer.E_Path()

myCalendar.Exception(0).Client(0).UCPTservicePath.Value = ""

'create exception dates

myCalendar.Exception(0).Schedule = New iLON_SmartServer.UFPTcalendar_CfgExceptionSchedule(3) {}

myCalendar.Exception(0).Schedule(0) = New iLON_SmartServer.UFPTcalendar_CfgExceptionSchedule()

myCalendar.Exception(0).Schedule(1) = New iLON_SmartServer.UFPTcalendar_CfgExceptionSchedule()

myCalendar.Exception(0).Schedule(2) = New

iLON_SmartServer.UFPTcalendar_CfgExceptionSchedule()

myCalendar.Exception(0).Schedule(3) = New iLON_SmartServer.UFPTcalendar_CfgExceptionSchedule()

'create 4th of July exception

'==========================

myCalendar.Exception(0).Schedule(0).UCPTschedMonth = New iLON_SmartServer.E_LonString()

myCalendar.Exception(0).Schedule(0).UCPTschedMonth.LonFormat = "UCPTschedMonth"

myCalendar.Exception(0).Schedule(0).UCPTschedMonth.Value = "MN_JUL"

myCalendar.Exception(0).Schedule(0).UCPTschedDay = New iLON_SmartServer.E_LonString()

myCalendar.Exception(0).Schedule(0).UCPTschedDay.LonFormat = "UCPTschedDay"

myCalendar.Exception(0).Schedule(0).UCPTschedDay.Value = "DM_DAY_4"

'set start date

myCalendar.Exception(0).Schedule(0).StartDate = New iLON_SmartServer.UFPTcalendar_CfgESDate()

myCalendar.Exception(0).Schedule(0).StartDate.UCPTdate = New DateTime(2009, 6, 8)

'set end date

myCalendar.Exception(0).Schedule(0).EndDate = New iLON_SmartServer.UFPTcalendar_CfgESDate()

myCalendar.Exception(0).Schedule(0).EndDate.UCPTdate = New DateTime(2020, 12, 31)

'create Labor Day exception

'==========================