3 using the set function on a lonworks channel, 4 using the delete function on a lonworks channel, Using the set function on a l – Echelon i.LON SmartServer 2.0 User Manual

Page 216: Orks, Channel -16, Using the delete function on a l

Advertising
background image

i.LON SmartServer 2.0 Programmer’s Reference

14-16

Property Description

Web service should be set to DDT_DYNAMIC. You cannot
use the Set function to modify this property

14.2.3

Using the Set Function on a L

ON

W

ORKS

Channel

You can use the Set function to overwrite the configuration of a channel, or to create a new channel.
The input parameters you supply to the function will include one or more <Item> elements. Each
<Item> element includes a <UCPTname> property that specifies a unique channel to be created or
modified.

Each <Item> element may also include a series of properties that define the configuration of the new
(or modified) channel. This set of properties is the same whether you are creating a new channel or
modifying an existing channel.

• If you are creating a new channel, you only need to specify the <UCPTtransceiverId> property; all

other properties are optional.

• If you are modifying an existing channel, you must specify the channel’s <UCPThandle>. If you

do not specify the handle, a new channel is created. All other properties must be filled; otherwise
the values stored in them are erased. The previous section, Using the Get Function on a
L

ON

W

ORKS

Channel, details the properties you can include in the Set function.

You can set multiple channels with a single Set message. However, you should not attempt to create or
write to more than 100 channels with a single call to the Set function.

Request (create a new L

ON

W

ORKS

channel on the SmartServer)

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

xsi:type="LON_Channel_Cfg">

<UCPTname>MyNewNetwork/myNewChannel</UCPTname>
<UCPTannotation>TP</UCPTannotation>
<UCPTtransceiverId

LonFormat="UCPTtransceiverId">TP_FT_10</UCPTtransceiverId>

</Item>
</iLonItem>
</Set>

Response

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

<Item>

<UCPTname>MyNewNetwork/myNewChannel</UCPTname>

</Item>

</iLonItem>
</SetResponse>

14.2.4

Using the Delete Function on a L

ON

W

ORKS

Channel

You can use the Delete function to delete a L

ON

W

ORKS

channel on the SmartServer or a channel in an

LNS network database via the LNS Proxy Web service. The Delete function takes an <Item> element
with a LON_Channel_Cfg type as its input. The <Item> element only needs to include the channel’s
<UCPTname> property in the Delete Request as demonstrated in the following code sample:

Request

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

xsi:type="LON_Channel_Cfg">

<UCPTname>MyOldNetwork/MyOldChannel</UCPTname>

</Item>

</iLonItem>

Advertising