Using the list function on a l, Orks, Functional block -35 – Echelon i.LON SmartServer 2.0 User Manual

Page 235: Functional block

Advertising

i.LON SmartServer 2.0 Programmer’s Reference

14-35

14.6.1

Using the List Function on a L

ORKS

Functional Block

You can use the List function to retrieve a list of functional blocks on the SmartServer or to retrieve a
list of functional blocks in a specific LNS network database via the LNS Proxy Web service. The List
function takes an <iLonItem> element that has an xSelect statement with a LON_Fb_Cfg type as its
input, as shown in the example below.

Request (return all the functional blocks of all the devices on the SmartServer or in an LNS
network database)

</iLonItem>
</List>

Alternatively, you can filter the functional blocks returned by the List function to those on a specific
device by including the <UCPTname>of the parent device in the xSelect statement, or you can filter
functional blocks returned by using the <UCPTname>, <UCPTlastUpdate>, or the <UCPThidden>
properties of the functional block.

Request (return all the functional blocks of a specific device that were updated after a specific
time)

<xSelect>//Item[@xsi:type="LON_Fb_Cfg"][starts-with(UCPTname,"Building 2/Channel 1/DIO-5")]
[UCPTlastUpdate>"2008-03-31T00:00:00"]
</xSelect>

</iLonItem>
</List>

Request (return all the functional blocks of a specific type on all devices based on name)

<List xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<xSelect>//Item[@xsi:type="LON_Fb_Cfg"][contains(UCPTname,"Digital

Output")]</xSelect>

</iLonItem>
</List>

Request (use an xSelect statement return all functional blocks on a specific device that are
currently hidden in the SmartServer Web interface)

<xSelect> //Item[@xsi:type="LON_Fb_Cfg"][starts-with(UCPTname,"Building 2/Channel 1/iLON

App")][UCPThidden="1"]

</xSelect>
</iLonItem>
</Get>

Request (return all the functional blocks of a specific type based on name)

<xSelect>//Item[@xsi:type="LON_Fb_Cfg"][starts-with(UCPTname,"Building 2/Channel 1/DIO-5/Digital
Output")]</xSelect>

</iLonItem>
</List>

Response

<UCPTname>Building 2/Channel 1/DIO-5/Digital Output[0]</UCPTname>

<UCPTannotation>#8000010000000000[3].UFPTDigitalOutput;xsi:type="LON_Fb_Cfg"</UCPTannotation>
<UCPThidden>0</UCPThidden>
</Item>

Advertising