1 using the list function on an alarm generator, 2 using the get function on an alarm generator, Using the list function on an alarm generator -3 – Echelon i.LON SmartServer 2.0 User Manual
Page 81: Using the get function on an alarm generator -3, Using the list function on an alarm generator, Using the get function on an alarm generator
i.LON SmartServer 2.0 Programmer’s Reference
6-3
Get
Retrieve the configuration of any Alarm Generator that you have
added to the SmartServer.
Set
Create a new Alarm Generator, or overwrite the configuration of an
existing Alarm Generator.
Delete
Delete an Alarm Generator.
6.3.1
Using the List Function on an Alarm Generator
Use the List function to retrieve a list of the Alarm Generators that you have added to the SmartServer.
The List function takes an <iLonItem> element that includes an xSelect statement querying items of a
UFPTalarmGenerator_Cfg type as its input, as shown in the example below. The List function returns
an <Item> element for each Alarm Generator 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 <Item> elements returned by this function as input for the Get function. The
Get function would then return the configuration of each Alarm Generator included in the list.
Request
<List xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<xSelect>//Item[@xsi:type="UFPTalarmGenerator_Cfg"]</xSelect>
</iLonItem>
</List>
Response
<ListResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<Item>
<UCPTname>Net/LON/iLON
App/Alarm
Generator[0]</UCPTname>
<UCPTannotation>#8000010128000000[4].UFPTalarmGenerator;xsi:type=“LON_Fb_Cfg”
</UCPTannotation>
<UCPThidden>0</UCPThidden>
</Item>
</iLonItem>
</ListResponse>
6.3.2
Using the Get Function on an Alarm Generator
You can use the Get function to retrieve the configuration of any Alarm Generator that you have added
to the SmartServer. You must reference the Alarm Generator whose configuration is to be returned by
its <UCPTname> in the input you supply to the function, as shown in the example below.
Request
<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<Item>
<UCPTname>Net/LON/iLON
App/Alarm
Generator[0]</UCPTname>
</Item>
</iLonItem>
</Get>
Response
<GetResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem >
<UCPTfaultCount>0</UCPTfaultCount>
<Item xsi:type="UFPTalarmGenerator_Cfg" >
<UCPTname>Net/LON/iLON
App/Alarm
Generator[0]</UCPTname>
<UCPTannotation>8000010128000000[4].UFPTalarmGenerator</UCPTannotation>
<UCPThidden>0</UCPThidden>