beautypg.com

3 real time clock soap interface, 1 using the list function on a real time clock, 2 using the get function on a real time clock – Echelon i.LON SmartServer 2.0 User Manual

Page 168: Real-time clock soap interface -2, Using the list function on a real-time clock -2, Using the get function on a real-time clock -2, Real-time clock soap interface

background image

i.LON SmartServer 2.0 Programmer’s Reference

11-2

Alternatively, you can create and manage the #8000010128000000[4].UFPTrealTimeClock.xml file
manually with an XML editor and download it to the SmartServer via FTP. Echelon does not
recommend this, as the SmartServer will require a reboot to read the configuration of the downloaded
file. Additionally, the SmartServer performs error checking on all SOAP messages it receives before
writing to the XML file. It will not perform error checking on any XML files you download via FTP,
and thus the application may not boot properly.

If you plan to create the XML file manually, you should review the rest of this chapter first, as it
describes the elements and properties in the XML file that define each real-time clock’s configuration.

11.3

Real-Time Clock SOAP Interface

You can use the SOAP interface to perform the following functions on the real-time clock:

Function Description

List

Generate a list of the real-time clocks on the SmartServer.

Get

Retrieve the configuration of the real-time clocks on the SmartServer.

Set

Create a new real-time clock, or overwrite the configuration of an
existing real-time clock.

Delete

Delete a real-time clock.

11.3.1

Using the List Function on a Real-Time Clock

You can use the List function to retrieve a list of the real-time clocks that you have added to the
SmartServer. The List function takes an element that includes an xSelect statement
querying items with a UFPTrealTimeClock_Cfg type as its input, as shown in the example below. The
List function returns an element for each real-time clock that you have added to the
SmartServer. The next section describes the properties included in each of these elements.

You could use the list of elements returned by this function as input for the Get function. The
Get function would then return the configuration of each real-time clock included in the list.

Request



//Item[@xsi:type="

UFPTrealTimeClock_Cfg"]



Response



0
4.0

Net/LON/iLON

App/RealTimeClock

#8000010128000000[4].UFPTrealTimeClock;xsi:type=”LON_Fb_Cfg”
0

11.3.2

Using the Get Function on a Real-Time Clock

You can use the Get function to retrieve the configuration of any real-time clock that you have added
to the SmartServer. You must reference the real-time clock whose configuration is to be returned by
its in the input you supply to the function, as shown in the example below.