Echelon i.LON SmartServer Technical Information Page 286

  • Download
  • Add to my manuals
  • Print
  • Page
    / 443
  • Table of contents
  • BOOKMARKS
  • Rated. / 5. Based on customer reviews
Page view 285
i.LON SmartServer 2.0 Programmer’s Reference
17-3
Property Description
<UCPTdescription>
A user-defined description of the channel. This can be a
maximum of 201 characters long.
<UCPTuri>
The name of the file on the SmartServer flash disk containing
the configuration of the Virtual channel. This property is
always Virtual_Channel_Cfg.htm.
<UCPThandle>
The handle assigned to the Virtual channel assigned by the
SmartServer. When you use the Set function to modify the
configuration of an existing Virtual channel, you must specify
the channel’s handle. If you do not specify the handle, a new
channel is created. You cannot use the Set function to modify
the handle assigned to the channel.
<UCPTchannelType>
The channel type, which is always Virtual.
17.1.3
Using the Set Function on Virtual Channels
You can use the Set function to overwrite the configuration of a Virtual channel, or to create a new
Virtual 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 Virtual
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) Virtual channel. This set of properties is the same whether you are creating a new
Virtual channel or modifying an existing Virtual channel.
If you are creating a new Virtual channel, you only need to specify the <UCPTchannelType>
property and set it to “Virtual”; 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 Virtual
Channels, details the properties you can include in the Set function. You can create up to two
Virtual channels with a single Set message.
Request (create a new Virtual channel on the SmartServer)
<Set xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<Item xsi:type="Virtual_Channel_Cfg">
<UCPTname>Net/Virtual Channel 1</UCPTname>
<UCPTannotation>VirtualChannel</UCPTannotation>
<UCPTchannelType>Virtual</UCPTchannelType>
</Item>
</iLonItem>
</Set>
Response
<SetResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<UCPTfaultCount>0</UCPTfaultCount>
<Item xsi:type="Virtual_Channel_Cfg">
<UCPTname>Net/Virtual Channel 1</UCPTname>
</Item>
</iLonItem>
</SetResponse>
Page view 285
1 2 ... 281 282 283 284 285 286 287 288 289 290 291 ... 442 443

Comments to this Manuals

No comments