2 using the get function on a lonworks channel, Using the get function on a l, Orks – Echelon i.LON SmartServer 2.0 User Manual

Page 212: Channel -12, Channel

Advertising
background image

i.LON SmartServer 2.0 Programmer’s Reference

14-12

<Item>
<UCPTname>Net/LON

IP</UCPTname>

<UCPTannotation>IP;xsi:type="LON_Channel_Cfg"</UCPTannotation>
<UCPThidden>1</UCPThidden>
</Item>
</iLonItem>
</List>

The List function returns a list of <Item> elements for each L

ON

W

ORKS

channel defined on the

SmartServer or each L

ON

W

ORKS

channel defined in a specific LNS network database.

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 channel included in the list. The next section
describes the properties included in each of these elements.

14.2.2

Using the Get Function on a L

ON

W

ORKS

Channel

You can use the Get function to retrieve the configuration of a L

ON

W

ORKS

channel defined on the

SmartServer or a L

ON

W

ORKS

channel in a specific LNS network database. The input parameters you

supply to this function will include one or more <Item> elements with a LON_Channel_Cfg type.
Each <Item> element will include the <UCPTname> of each channel whose configuration is to be
returned by this function, as shown in the example below.

Request

<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<Item

xsi:type="LON_Channel_Cfg">

<UCPTname>Net/LON</UCPTname>
</Item>
</iLonItem>
</Get>

Response

<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<UCPTfaultCount>0</UCPTfaultCount>
<Item

xsi:type="LON_Channel_Cfg">

<UCPTname>Net/LON</UCPTname>
<UCPTannotation>TP;xsi:type="LON_Channel_Cfg"</UCPTannotation>
<UCPThidden>0</UCPThidden>
<UCPTlastUpdate>2008-03-20T17:42:54.903-07:00</UCPTlastUpdate>
<UCPTuri>LON_Channel_Cfg.htm</UCPTuri>
<UCPThandle>0</UCPThandle>
<UCPTchannelType

LonFormat="UCPTchannelType">CT_LON</UCPTchannelType>

<UCPTtransceiverId

LonFormat="UCPTtransceiverId">TP_FT_10</UCPTtransceiverId>

<UCPTtransmitTimer

LonFormat="UCPTtransmitTimer">TT_96</UCPTtransmitTimer>

<UCPTretryCount>3</UCPTretryCount>
<UCPTmaxPriority>4</UCPTmaxPriority>
<UCPTchannelMode

LonFormat="UCPTchannelMode">AM_ONLINE</UCPTchannelMode>

<UCPTdynamic

LonFormat="UCPTdynamic">DDT_STATIC</UCPTdynamic>

</Item>
</iLonItem>
</Get>

The Get function returns an <Item> element for each channel referenced in the input parameters you
supplied to the function. The properties included within each <Item> element are initially defined
when the channel is added to the SmartServer or LNS network database. You can write to these
channel properties with the Set function. The following table describes these properties.

Property Description

<UCPTname>

The name of the channel in the following format:
<network/channel>. You can rename a L

ON

W

ORKS

channel by

providing its <UCPThandle> and specifying the new

Advertising