2 using the get function on a lonworks device, Using the get function on a l, Orks – Echelon i.LON SmartServer 2.0 User Manual
Page 219: Device -19, Device
i.LON SmartServer 2.0 Programmer’s Reference
14-19
14.3.2
Using the Get Function on a L
ON
W
ORKS
Device
You can use the Get function to retrieve the configuration of a L
ON
W
ORKS
device defined on the
SmartServer or in a specific LNS network database. The input parameters you supply to this function
will include one or more <Item> elements with a LON_Device_Cfg type. Each <Item> element will
include the <UCPTname> of each device whose configuration is to be returned by this function, as
shown in the example below.
Alternatively, you can specify one or more device properties in the xSelect statement to filter the items
returned by the Get function, including the <UCPTname> to filter devices based on their parent
channel; <UCPThidden> to filter devices based on whether they are hidden or shown in the
SmartServer Web interface; <UCPTlocal> to filter devices based on whether they are external or
internal to the SmartServer; <UCPTitemStatus> to filter devices based on whether they are
uncommissioned, offline, or out of sync with an LNS network database; and <UCPTprogramID> to
filter devices based on the manufacturer.
Request (return a specific device)
<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<Item
xsi:type="LON_Device_Cfg">
<UCPTname>Net/LON/DIO-1</UCPTname>
</Item>
</iLonItem>
</Get>
Request (use an xSelect statement return all the devices on a specific L
ON
W
ORKS
channel)
<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<xSelect> //Item[@xsi:type="LON_Device_Cfg"][starts-with(UCPTname,"Net/LON")]</xSelect>
</iLonItem>
</Get>
Request (use an xSelect statement return all internal devices on the SmartServer)
<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<xSelect>
//Item[@xsi:type="LON_Device_Cfg"] [UCPTlocal="1"]
</xSelect>
</iLonItem>
</Get>
Request (use an xSelect statement return all external devices that are currently shown in the
SmartServer Web interface)
<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<xSelect>
//Item[@xsi:type="LON_Device_Cfg"][UCPTlocal="0"][UCPThidden="0"]
</xSelect>
</iLonItem>
</Get>
Request (use an xSelect statement return any devices that are out of sync with an LNS network
database)
<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<xSelect>
//Item[@xsi:type="LON_Device_Cfg"] [UCPTitemStatus="IS_NOTSYNCED”]
</xSelect>
</iLonItem>
</Get>
Request (use an xSelect statement return any devices that are uncommissioned)
<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>