Echelon i.LON SmartServer Technical Information

078-0347-01D®i.LON®SmartServer 2.0 Programmer's Reference

i.LON SmartServer 2.0 Programmer’s Reference x

i.LON SmartServer 2.0 Programmer’s Reference 7-8 Property Description <DataPoint> An alarm notification will occur each time any of the input

i.LON SmartServer 2.0 Programmer’s Reference 7-9 Property Description <AlarmDest> Each <AlarmDest> element defines a group of active an

i.LON SmartServer 2.0 Programmer’s Reference 7-10 Property Description sub-property in the element are described below: <UCPTlogEnable>: When

i.LON SmartServer 2.0 Programmer’s Reference 7-11 Property Description <UCPTalarmPriority2> The priority level to be assigned to the data poi

i.LON SmartServer 2.0 Programmer’s Reference 7-12 Property Description <UCPTemailAttachment> The path of the attachment file that will be sen

i.LON SmartServer 2.0 Programmer’s Reference 7-13 Variable Substitution Description {alarm_hour_12} Alarm Time Hour (12 hour). The time the alar

i.LON SmartServer 2.0 Programmer’s Reference 7-14 Variable Substitution Description {dp_value_alias} Data Point Value (by Alias Name). The <U

i.LON SmartServer 2.0 Programmer’s Reference 7-15 Property Description assigned level 126-255 would use the second destination. NOTE: If you use th

i.LON SmartServer 2.0 Programmer’s Reference 7-16 <UCPTdataPointPath>DataPoint[@dpType=“Output” and UCPTnickName=“Net/LON/iLON App/Data Logge

i.LON SmartServer 2.0 Programmer’s Reference 7-17 Property Description <UCPTnackDelay> The delay, in minutes, to wait for an alarm to be ackn

i.LON SmartServer 2.0 Programmer’s Reference 1-1 1 Introduction to the SmartServer SOAP/XML Interface The SmartServer contains a powerful micropr

i.LON SmartServer 2.0 Programmer’s Reference 7-18 <UCPTdescription /> </DataPoint> <DataPoint xsi:type="UFPTalarmNotifie

i.LON SmartServer 2.0 Programmer’s Reference 7-19 created. An Alarm Notifier will not generate a log file until it has generated an alarm notifica

i.LON SmartServer 2.0 Programmer’s Reference 7-20 made. <UCPTalarmLog> The type of log requested (either HISTORICAL or SUMMARY). <UCPTst

i.LON SmartServer 2.0 Programmer’s Reference 7-21 Property Description <UCPTpriority> The priority level currently assigned to the data point

i.LON SmartServer 2.0 Programmer’s Reference 7-22 7.3.5 Using the Write Function on an Alarm Notifier Log File You can use the Write function to a

i.LON SmartServer 2.0 Programmer’s Reference 7-23 Property Description <UCPTackRequired> property, see Input Data Points. • AUTO_CLEAR:

i.LON SmartServer 2.0 Programmer’s Reference 7-24 Response <ClearResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/messa

i.LON SmartServer 2.0 Programmer’s Reference 7-25 </iLonItem> </Delete> Response <DeleteResponse xmlns="http://wsdl.echelon.co

i.LON SmartServer 2.0 Programmer’s Reference 7-26

i.LON SmartServer 2.0 Programmer’s Reference 8-1 8 Analog Function Block You can use Analog Function Blocks to perform a variety of statistical op

i.LON SmartServer 2.0 Programmer’s Reference 1-2 Echelon strongly recommends that you use the SOAP interface to configure the applications of your

i.LON SmartServer 2.0 Programmer’s Reference 8-2 </DataPoint> <DataPoint xsi:type="UFPTanalogFunctionBlock_DpRef" dpType=&quo

i.LON SmartServer 2.0 Programmer’s Reference 8-3 querying items of a UFPTanalogFunctionBlock_Cfg type as its input, as shown in the example below.

i.LON SmartServer 2.0 Programmer’s Reference 8-4 <UCPTname>Net/LON/iLON App/Digital Input 1/nvoClsValue_1</UCPTname> <UCPTfiel

i.LON SmartServer 2.0 Programmer’s Reference 8-5 Property Description Input Analog Function Block. The input data points for an Analog Function Bl

i.LON SmartServer 2.0 Programmer’s Reference 8-6 Property Description <UCPTtrueThreshold> property is defined. <DataPoint> Output This

i.LON SmartServer 2.0 Programmer’s Reference 8-7 Property Description select a compare data point by filling in the <CompareDataPoint> elemen

i.LON SmartServer 2.0 Programmer’s Reference 8-8 Property Description <SCPTovrValue> The value the output data point will be assigned when it

i.LON SmartServer 2.0 Programmer’s Reference 8-9 Identifier Value Assigned To The Output Data Point the analog function block are True. For an ex

i.LON SmartServer 2.0 Programmer’s Reference 8-10 8.3.2.2 Comparison Functions The following table lists and describes the comparison functions yo

i.LON SmartServer 2.0 Programmer’s Reference 8-11 20 30 40 50 35 EMPTY 0.0 0 70 80 40 50 35 EMPTY 100.0 1 8.3.2.2.2 FN_OR Example In this exam

i.LON SmartServer 2.0 Programmer’s Reference 1-3 introduced for the e2 release, and the version 3.0 namespace was introduced for the e3 release.

i.LON SmartServer 2.0 Programmer’s Reference 8-12 8.3.3 Using the Set Function on an Analog Functional Block Use the Set function to create new An

i.LON SmartServer 2.0 Programmer’s Reference 8-13 </Item> </iLonItem> </Set> 8.3.4 Using the Delete Function on an An

i.LON SmartServer 2.0 Programmer’s Reference 9-1 9 Scheduler You can use the Scheduler application to schedule periodic updates to the data points

i.LON SmartServer 2.0 Programmer’s Reference 9-2 comes from the local Calendar object via an internal binding between the nvoEcDateEvent output of

i.LON SmartServer 2.0 Programmer’s Reference 9-3 <UCPTwednesday>1</UCPTwednesday> <UCPTthursday>1</UCPTthursday>

i.LON SmartServer 2.0 Programmer’s Reference 9-4 Note: Section 21.1.3, Creating a Scheduler and Calendar in Visual C# .NET, includes a C# programm

i.LON SmartServer 2.0 Programmer’s Reference 9-5 <UCPTname>Net/LON/iLON App/Digital Output 2/nviClaValue_2</UCPTname> <SCPTdel

i.LON SmartServer 2.0 Programmer’s Reference 9-6 </GetResponse> The function returns an <Item> element for each Scheduler referenced in

i.LON SmartServer 2.0 Programmer’s Reference 9-7 Property Description will be decreased with every heartbeat. <ScheduleEffectivePeriod> The &

i.LON SmartServer 2.0 Programmer’s Reference 9-8 <Event> <UCPTindex>2</UCPTindex> <UCPTtime>10:00:00</UCPTtime>

i.LON SmartServer 2.0 Programmer’s Reference 1-4

i.LON SmartServer 2.0 Programmer’s Reference 9-9 exception that occurs over a specific range of dates. The actual date or range of dates in which

i.LON SmartServer 2.0 Programmer’s Reference 9-10 Property Description <Exception> The exceptions for the date-based schedule specify the dat

i.LON SmartServer 2.0 Programmer’s Reference 9-11 Property Description SNVT_switch data point using either of the following statements: <UCPTval

i.LON SmartServer 2.0 Programmer’s Reference 9-12 9.3.3 Using the Read Function on a Scheduler You can use the Read function to retrieve the event

i.LON SmartServer 2.0 Programmer’s Reference 9-13 <Item xsi:type="UFPTscheduler_Meta_Data" > <UCPTname>Net/LON/iLON App/S

i.LON SmartServer 2.0 Programmer’s Reference 9-14 <EventType> This element may have one of the following values: • ET_LOCK: A #LOCK event.

i.LON SmartServer 2.0 Programmer’s Reference 9-15 When creating or modifying a Scheduler with this function, you may want to use output from the Ge

i.LON SmartServer 2.0 Programmer’s Reference 9-16 </Event> <Weekdays> <UCPTsunday>0</UCPTsunday> <UCPTmonda

i.LON SmartServer 2.0 Programmer’s Reference 9-17 <UCPTfaultCount>0</UCPTfaultCount> <Item> <UCPTname>Net/LON/iLO

i.LON SmartServer 2.0 Programmer’s Reference 9-18

i.LON SmartServer 2.0 Programmer’s Reference 2-1 2 SOAP Messages and the SmartServer WSDL File This chapter contains general information about the

i.LON SmartServer 2.0 Programmer’s Reference 10-1 10 Calendar You can use the Calendar application to define the exceptions that you will referenc

i.LON SmartServer 2.0 Programmer’s Reference 10-2 <UCPTaliasName>Holiday</UCPTaliasName> <UCPTtemporary>0</UCPTtemporary

i.LON SmartServer 2.0 Programmer’s Reference 10-2 SmartServer. Get Retrieve the configuration of the Calendar that you have added to the SmartSe

i.LON SmartServer 2.0 Programmer’s Reference 10-3 Response <GetResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message

i.LON SmartServer 2.0 Programmer’s Reference 10-4 Property Description Calendar. This property is always 8000010128000000[4].UFPTcalendar <UCPT

i.LON SmartServer 2.0 Programmer’s Reference 10-5 Property Description <Exception> You can specify the dates that the Event Calendar applies

i.LON SmartServer 2.0 Programmer’s Reference 10-6 Property Description <Schedule> The <Schedule> element contains a series of child ele

i.LON SmartServer 2.0 Programmer’s Reference 10-7 WILDCARD means that the starting date is the 1st. • Setting the <EndDate> of <UCPTday

i.LON SmartServer 2.0 Programmer’s Reference 10-8 Identifier Description DM_SECOND_MON Second Monday of each month DM_SECOND_TUE Second Tuesday of

i.LON SmartServer 2.0 Programmer’s Reference 10-9 Identifier Description DM_FIFTH_FRI Fifth Friday of each month DM_FIFTH_SAT Fifth Saturday of eac

i.LON SmartServer 2.0 Programmer’s Reference 2-2 2.2 SmartServer WSDL File Each SmartServer includes two WSDL (Web Service Description Language) f

i.LON SmartServer 2.0 Programmer’s Reference 10-10 Identifier Description MN_JAN January MN_FEB February MN_MAR March MN_APR April MN_MAY May MN_J

i.LON SmartServer 2.0 Programmer’s Reference 10-11 Identifier Description active. MN_EVERY_11_MONTH Every eleventh month during the interval the C

i.LON SmartServer 2.0 Programmer’s Reference 10-12 <UCPTyearMask>DW_WILDCARD</UCPTyearMask> <UCPTmonthMask>DW_WILDCARD</UCPT

i.LON SmartServer 2.0 Programmer’s Reference 10-13 <UCPTname>Net/LON/iLON App/Calendar</UCPTname> <UCPTdescription>enter an

i.LON SmartServer 2.0 Programmer’s Reference 10-14 position() Position of the events in previously selected list. You can use this filter to limi

i.LON SmartServer 2.0 Programmer’s Reference 10-15 events within the timeframe from <UCPTstart> to <UCPTstop>. The first <DateEve

i.LON SmartServer 2.0 Programmer’s Reference 10-16

i.LON SmartServer 2.0 Programmer’s Reference 11-1 11 Real-Time Clock You can use the real-time clock on the SmartServer to schedule events to star

i.LON SmartServer 2.0 Programmer’s Reference 11-2 Alternatively, you can create and manage the #8000010128000000[4].UFPTrealTimeClock.xml file manu

i.LON SmartServer 2.0 Programmer’s Reference 11-3 Request <Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/"&g

i.LON SmartServer 2.0 Programmer’s Reference 2-3 2.4.1 SOAP Request <?xml version="1.0" encoding="utf-8" ?> <soap:En

i.LON SmartServer 2.0 Programmer’s Reference 11-4 Property Description <UCPTannotation> The program ID and functional profile template used b

i.LON SmartServer 2.0 Programmer’s Reference 11-5 The first invocation of the Set function will generate the #8000010128000000[4].UFPTrealTimeClock

i.LON SmartServer 2.0 Programmer’s Reference 11-6 Response <DeleteResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/mess

i.LON SmartServer 2.0 Programmer’s Reference 12-1 12 Type Translator You can use Type Translators to convert data points from one network variable

i.LON SmartServer 2.0 Programmer’s Reference 12-2 12.2 Creating and Modifying the Type Translator XML File You can create and manage the #8000010

i.LON SmartServer 2.0 Programmer’s Reference 12-3 </iLonItem> </ListResponse> 12.3.2 Using the Get Function on a Type Translator Y

i.LON SmartServer 2.0 Programmer’s Reference 12-4 Property Description 1 – hidden <UCPTitemStatus> This property only appears if the data log

i.LON SmartServer 2.0 Programmer’s Reference 12-5 Property Description enumeration). In this case, the value of the output data point will be upda

i.LON SmartServer 2.0 Programmer’s Reference 12-6 When modifying an existing type translator, any optional properties omitted from the input will b

i.LON SmartServer 2.0 Programmer’s Reference 12-7 • The 16 SNVT_switch data points to be translated are defined by a list of <DataPoint> ele

i.LON SmartServer 2.0 Programmer’s Reference 2-4 2.4.2 SOAP Response <?xml version="1.0" encoding="utf-8" ?> <SOAP-E

i.LON SmartServer 2.0 Programmer’s Reference 12-8 Each time a type translation is made, the SNVT_occupancy output data point is assigned a value ba

i.LON SmartServer 2.0 Programmer’s Reference 12-9 ST_HIGH value: 75.0 state: 1 (ON) ST_MED value: 50.0 state: 1 (ON) ST_LOW value: 25.0 state: 1 (O

i.LON SmartServer 2.0 Programmer’s Reference 12-10 OC_BYPASS function: SET_STATE setting: 100 rotation: 80.24 OC_STANDBY function: SET_STATE settin

i.LON SmartServer 2.0 Programmer’s Reference 12-11 The following code demonstrates how to use the Set function to create a type translator that use

i.LON SmartServer 2.0 Programmer’s Reference 12-12 <Set xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/"> &

i.LON SmartServer 2.0 Programmer’s Reference 12-13 <UCPTtranslatorRule>SNVT_setting_TO_SNVT_switch</UCPTtranslatorRule> <SCPTdel

i.LON SmartServer 2.0 Programmer’s Reference 12-14 • The SNVT_switch input data point is defined by a <DataPointFormat> element that has a “

i.LON SmartServer 2.0 Programmer’s Reference 12-15 Request <Delete xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/&quo

i.LON SmartServer 2.0 Programmer’s Reference 12-16

i.LON SmartServer 2.0 Programmer’s Reference 13-1 13 Type Translator Rules You can use the Type Translator Rule SOAP functions to create additiona

i.LON SmartServer 2.0 Programmer’s Reference 2-5 2.5.1 SOAP Envelope The SOAP envelope is the highest level in a SOAP message. The SOAP envelope

i.LON SmartServer 2.0 Programmer’s Reference 13-2 <UCPTformatDescription>#0000000000000000[0].SNVT_switch</UCPTformatDescription> &l

i.LON SmartServer 2.0 Programmer’s Reference 13-3 Delete Delete a type translator rule. 13.3.1 Using the List Function on a Type Translator Rule

i.LON SmartServer 2.0 Programmer’s Reference 13-4 <UCPTdescription>Translates the state and value fields from two SNVT_switch input DPs t

i.LON SmartServer 2.0 Programmer’s Reference 13-5 Property Description 0 – shown 1 – hidden <UCPTlastUpdate> A timestamp indicating the last

i.LON SmartServer 2.0 Programmer’s Reference 13-6 13.3.2.1 Creating a Case Structure You can create case structures for each Type Translator Rule

i.LON SmartServer 2.0 Programmer’s Reference 13-7 Property Description <UCPTindex> The index number of the case structure. <UCPTinputPath

i.LON SmartServer 2.0 Programmer’s Reference 13-8 input data point is not equal to that of the compare data point. FN_NUL Null. Returns True for a

i.LON SmartServer 2.0 Programmer’s Reference 13-9 <UCPTcompValue LonFormat="">2</UCPTcompValue> <Rule> <UCPTinde

i.LON SmartServer 2.0 Programmer’s Reference 13-10 Property Description as the input data point or field selected for the case rule. The following

i.LON SmartServer 2.0 Programmer’s Reference 13-11 Property Description <UCPTconstant> If the output data point or field takes an enumeration

ii Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo are trademarks of Echelon Corporation regist

i.LON SmartServer 2.0 Programmer’s Reference 2-6 <UCPTtimeStamp> A time stamp indicating when the message was sent. Per the ISO 8601 standar

i.LON SmartServer 2.0 Programmer’s Reference 13-12 <Rule> <UCPTindex>0</UCPTindex> <UCPTinputPath>DataPointForma

i.LON SmartServer 2.0 Programmer’s Reference 14-1 14 LONWORKS Driver The following chapter describes how to manage the networks, channels, devices

i.LON SmartServer 2.0 Programmer’s Reference 14-2 </Get> Response <Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/m

i.LON SmartServer 2.0 Programmer’s Reference 14-3 Property Description interface. This property may have the following values: 0 – shown 1 – hidde

i.LON SmartServer 2.0 Programmer’s Reference 14-4 Property Description <UCPTlnsSync> Specifies the network management service used to manage

i.LON SmartServer 2.0 Programmer’s Reference 14-5 Property Description <UCPTmgmtMode> Specifies when network configuration changes are propag

i.LON SmartServer 2.0 Programmer’s Reference 14-6 SmartServer and get its <UCPThandle> property. If you don’t specify the <UCPThandle>

i.LON SmartServer 2.0 Programmer’s Reference 14-7 synchronization), you can perform a manual synchronization to update the LNS network database wit

i.LON SmartServer 2.0 Programmer’s Reference 14-8 </InvokeCmd> • The following example demonstrates how to synchronize the two devices on th

i.LON SmartServer 2.0 Programmer’s Reference 14-9 14.1.3.2 Issuing Network Scan Commands to Discover Devices You can use the InvokeCmd function to

i.LON SmartServer 2.0 Programmer’s Reference 2-7 <soap:Body> <MessageName xmlns="http://wsdl.echelon.com/web_services_ns/ilon100

i.LON SmartServer 2.0 Programmer’s Reference 14-10 Option Description STATUS_CANCEL STATUS_PENDING STATUS_DONE STATUS_FAIL STATUS_INVOKE When this

i.LON SmartServer 2.0 Programmer’s Reference 14-11 Read response and store it in the <UCPTlastUpdate> property of the subsequent Read request

i.LON SmartServer 2.0 Programmer’s Reference 14-12 <Item> <UCPTname>Net/LON IP</UCPTname> <UCPTannotation>IP;xsi:type=

i.LON SmartServer 2.0 Programmer’s Reference 14-13 Property Description <UCPTname> property to which the channel is to be renamed. <UCPTan

i.LON SmartServer 2.0 Programmer’s Reference 14-14 Property Description is a power line channel that uses the Enhanced LonTalk® Proxy Protocol to t

i.LON SmartServer 2.0 Programmer’s Reference 14-15 Property Description is accomplished by assigning each priority device a time (priority) slot wh

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

i.LON SmartServer 2.0 Programmer’s Reference 14-17 </Delete> Response <DeleteResponse xmlns="http://wsdl.echelon.com/web_services_ns

i.LON SmartServer 2.0 Programmer’s Reference 14-18 Response <List xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/"

i.LON SmartServer 2.0 Programmer’s Reference 14-19 14.3.2 Using the Get Function on a LONWORKS Device You can use the Get function to retrieve the

i.LON SmartServer 2.0 Programmer’s Reference 2-8 <fault> <faultcode faultType="_error">6</faultcode> <faults

i.LON SmartServer 2.0 Programmer’s Reference 14-20 <xSelect> //Item[@xsi:type="LON_Device_Cfg"] [UCPTitemStatus="IS_UNCON

i.LON SmartServer 2.0 Programmer’s Reference 14-21 </iLonItem> </Get> The Get function returns an <Item> element for each devic

i.LON SmartServer 2.0 Programmer’s Reference 14-22 Property Description represents the time of day the configuration of the Data Point was last upd

i.LON SmartServer 2.0 Programmer’s Reference 14-23 Property Description pre-loaded on a device. Devices that support dynamic functional blocks inc

i.LON SmartServer 2.0 Programmer’s Reference 14-24 Property Description • APP_RUNNING. Online. • APP_STOPPED. Offline. <UCPTcommissionStat

i.LON SmartServer 2.0 Programmer’s Reference 14-25 Property Description <Command> Lists the network management and debugging commands issued

i.LON SmartServer 2.0 Programmer’s Reference 14-26 14.3.3 Using the Set Function on a LONWORKS Device You can use the Set function to overwrite the

i.LON SmartServer 2.0 Programmer’s Reference 14-27 To issue a network management command, you need to provide one or more <Item> elements with

i.LON SmartServer 2.0 Programmer’s Reference 14-28 <UCPTstatus LonFormat="UCPTstatus">STATUS_REQUEST</UCPTstatus> </Co

i.LON SmartServer 2.0 Programmer’s Reference 14-29 Reset You can use the Reset command to stop a device application, terminate all incoming and outg

i.LON SmartServer 2.0 Programmer’s Reference 2-9 Error Code Error Description Comment 15 No Data 2.5.4 Namespace The namespace uniquely identi

i.LON SmartServer 2.0 Programmer’s Reference 14-30 14.3.3.2 Issuing Debugging Commands You can use the InvokeCmd function to issue debugging comman

i.LON SmartServer 2.0 Programmer’s Reference 14-31 <UCPTtransactionTimeouts> Transaction timeouts occur when an acknowledged message times out

i.LON SmartServer 2.0 Programmer’s Reference 14-32 You can use the ClearStatus debugging command to clear the device statistics returned by the Quer

i.LON SmartServer 2.0 Programmer’s Reference 14-33 • The <UCPTannotation> property is Router. • The <UCPTuri> property is LON_Device_R

i.LON SmartServer 2.0 Programmer’s Reference 14-34 bridges. You can use permanent bridges to preserve subnet IDs. • LCA_NUL. The SmartServer auto

i.LON SmartServer 2.0 Programmer’s Reference 14-35 14.6.1 Using the List Function on a LONWORKS Functional Block You can use the List function to r

i.LON SmartServer 2.0 Programmer’s Reference 14-36 <Item> <UCPTname>Building 2/Channel 1/DIO-5/Digital Output[1]</UCPTname>

i.LON SmartServer 2.0 Programmer’s Reference 14-37 <UCPThidden>0</UCPThidden> <UCPTlastUpdate>2008-03-31T12:33:54.133-07:00<

i.LON SmartServer 2.0 Programmer’s Reference 14-38 Property Description was last updated, in UTC (Coordinated Universal Time). UTC is the current te

i.LON SmartServer 2.0 Programmer’s Reference 14-39 Property Description values: • 0. Standard functional profile defined in the standard resource

i.LON SmartServer 2.0 Programmer’s Reference 2-10 Because Item is the base class for all types passed in the Get /Set /Delete, Read /Write, and In

i.LON SmartServer 2.0 Programmer’s Reference 14-40 <iLonItem> <UCPTfaultCount>0</UCPTfaultCount> <Item> <UCPTn

i.LON SmartServer 2.0 Programmer’s Reference 14-41 <xSelect>//Item[@xsi:type="LON_Dp_Cfg"][starts-with(UCPTname,"Building 2/Cha

i.LON SmartServer 2.0 Programmer’s Reference 14-42 </iLonItem> </Get> Response <Get xmlns="http://wsdl.echelon.com/web_service

i.LON SmartServer 2.0 Programmer’s Reference 14-43 Property Description was last updated, in UTC (Coordinated Universal Time). UTC is the current te

i.LON SmartServer 2.0 Programmer’s Reference 14-44 Property Description <UCPTdefOutput> property. <UCPTunit> This property is a string u

i.LON SmartServer 2.0 Programmer’s Reference 14-45 Property Description <UCPTpollRate> The frequency in which the SmartServer’s internal data

i.LON SmartServer 2.0 Programmer’s Reference 14-46 a LON_Dp_Cfg type as its input. The <Item> element only needs to include the network varia

i.LON SmartServer 2.0 Programmer’s Reference 14-47 <UCPTobjDisableFlag> The device must be disabled for the configuration property value to be

i.LON SmartServer 2.0 Programmer’s Reference 14-48 o ST_LON_UNACK (Unacknowledged). The sending device sends out the network variable update only

i.LON SmartServer 2.0 Programmer’s Reference 14-49 Transaction Timer Calculated based on topology and service type. Broadcast Options Broadcast a

i.LON SmartServer 2.0 Programmer’s Reference 2-11 You can cast an item to a more specialized type using meta data (the xsi:type attribute) that is

i.LON SmartServer 2.0 Programmer’s Reference 15-1 15 Modbus Driver The following chapter describes how to manage Modbus channels, devices, and data

i.LON SmartServer 2.0 Programmer’s Reference 15-2 <UCPTannotation>RS232</UCPTannotation> <UCPThidden>0</UCPThidden> &l

i.LON SmartServer 2.0 Programmer’s Reference 15-3 Property Description 10:13:13 AM on August 15, 2002. If it is not UTC, time shift has to be define

i.LON SmartServer 2.0 Programmer’s Reference 15-4 Property Description <InterfaceOptions> This element contains the following options for Mod

i.LON SmartServer 2.0 Programmer’s Reference 15-5 Property Description <UCPTserialMode> The transmission mode used by the SmartServer for comm

i.LON SmartServer 2.0 Programmer’s Reference 15-6 • If you are creating a new Modbus channel, you only need to specify the <UCPTchannelType>

i.LON SmartServer 2.0 Programmer’s Reference 15-7 15.2 Modbus Devices The following section describes how to use the List, Get, Set, and Delete fu

i.LON SmartServer 2.0 Programmer’s Reference 15-8 </Item> </iLonItem> </Get> The Get function returns an <Item> element fo

i.LON SmartServer 2.0 Programmer’s Reference 15-9 Property Description <UCPTuri> The name of the file on the SmartServer flash disk containin

i.LON SmartServer 2.0 Programmer’s Reference 15-10 </SetResponse> 15.2.4 Using the Delete Function on Modbus Devices You can use the Delete

i.LON SmartServer 2.0 Programmer’s Reference 2-12 The following code samples demonstrate supported xSelect statements. Example 1 – List or Get a

i.LON SmartServer 2.0 Programmer’s Reference 15-11 15.4.1 Using the List Function on Modbus Data Points You can use the List function to retrieve

i.LON SmartServer 2.0 Programmer’s Reference 15-12 15.4.2 Using the Get Function on Modbus Data Points You can use the Get function to retrieve th

i.LON SmartServer 2.0 Programmer’s Reference 15-13 Property Description rename a Modbus data point by providing its <UCPThandle> and specifyi

i.LON SmartServer 2.0 Programmer’s Reference 15-14 Property Description including the type of values it takes and its base type. If you do not set

i.LON SmartServer 2.0 Programmer’s Reference 15-15 Property Description states (on/off). • MTT_C_MO [Coil Functions (Functions 1 & 15 multi-wr

i.LON SmartServer 2.0 Programmer’s Reference 15-16 Property Description • DO_WORD_SWAP. Data is first arranged from highest to lowest order, but

i.LON SmartServer 2.0 Programmer’s Reference 15-17 You can set multiple Modbus data points with a single Set message. However, you should not atte

i.LON SmartServer 2.0 Programmer’s Reference 15-18

i.LON SmartServer 2.0 Programmer’s Reference 16-1 16 M-Bus Driver The following chapter describes how to manage M-Bus channels, devices, and data

i.LON SmartServer 2.0 Programmer’s Reference 16-2 <UCPThidden>0</UCPThidden> <UCPTlastUpdate>2008-04-02T13:06:24.430-07:00<

i.LON SmartServer 2.0 Programmer’s Reference 2-13 Example 9 – Select a formatter report: xSelect = "//Item[@xsi:type=”TemplateManager_NVT_Cfg

i.LON SmartServer 2.0 Programmer’s Reference 16-3 Property Description If it is not UTC, time shift has to be defined: 2008-02-28T09:59:53.660+01:0

i.LON SmartServer 2.0 Programmer’s Reference 16-4 Property Description the M-Bus network. A parity bit is an extra bit used to check for errors in

i.LON SmartServer 2.0 Programmer’s Reference 16-5 • If you are creating a new M-Bus channel, you only need to specify the <UCPTchannelType>

i.LON SmartServer 2.0 Programmer’s Reference 16-6 16.2 M-Bus Devices The following section describes how to use the List, Get, Set, and Delete fun

i.LON SmartServer 2.0 Programmer’s Reference 16-7 <UCPTmbusMedId>MED_NUL</UCPTmbusMedId> <UCPTmbusManId /> <UCPTmbusGenI

i.LON SmartServer 2.0 Programmer’s Reference 16-8 Property Description 10:13:13 AM on August 15, 2002. If it is not UTC, time shift has to be defin

i.LON SmartServer 2.0 Programmer’s Reference 16-9 Property Description received from the device. The device answers to a REQ_UD-request with toggl

i.LON SmartServer 2.0 Programmer’s Reference 16-10 Property Description (AT_SECONDARY) addressing. Primary addressing is preferred because it make

i.LON SmartServer 2.0 Programmer’s Reference 16-11 16.2.4 Using the Delete Function on M-Bus Devices You can use the Delete function to delete an

i.LON SmartServer 2.0 Programmer’s Reference 16-12 16.4.1 Using the List Function on M-Bus Data Points You can use the List function to retrieve a

i.LON SmartServer 2.0 Programmer’s Reference 2-14 Driver Item xsi type Type Translator UFPTtypeTranslator_Cfg Type Translator Rule

i.LON SmartServer 2.0 Programmer’s Reference 16-13 </iLonItem> </Get> Alternatively, you can specify one or more M-Bus data point pro

i.LON SmartServer 2.0 Programmer’s Reference 16-14 Property Description YYYY-MM-DDTHH:MM:SS.sssZPhh:mm The first segment of the time stamp (YYYY-MM

i.LON SmartServer 2.0 Programmer’s Reference 16-15 Property Description <UCPTpollRate> The frequency in which the SmartServer’s internal data

i.LON SmartServer 2.0 Programmer’s Reference 16-16 16.4.4 Using the Delete Function on M-Bus Data Points You can use the Delete function to delete

i.LON SmartServer 2.0 Programmer’s Reference 17-1 17 Virtual Driver The virtual channel is the SmartServer's internal channel. It is used as

i.LON SmartServer 2.0 Programmer’s Reference 17-2 <UCPTfaultCount>0</UCPTfaultCount> <Item xsi:type="Virtual_Channel_Cfg&quo

i.LON SmartServer 2.0 Programmer’s Reference 17-3 Property Description <UCPTdescription> A user-defined description of the channel. This can

i.LON SmartServer 2.0 Programmer’s Reference 17-4 17.1.4 Using the Delete Function on a Virtual Channel You can use the Delete function to delete

i.LON SmartServer 2.0 Programmer’s Reference 17-5 elements with a Virtual_Device_Cfg type. Each <Item> element will include the <UCPTname

i.LON SmartServer 2.0 Programmer’s Reference 17-6 Property Description represents the time of day the configuration of the Data Point was last upda

i.LON SmartServer 2.0 Programmer’s Reference 2-15 <DataPoint dpType="nvoLevelAlarm" discrim="dir_out"> <UCPTname>

i.LON SmartServer 2.0 Programmer’s Reference 17-7 <UCPTname>Net/Virtual Channel/Virtual Device</UCPTname> </Item> </iLonI

i.LON SmartServer 2.0 Programmer’s Reference 17-8 </iLonItem> </SetResponse> 17.4 Virtual Data Points The following section descri

i.LON SmartServer 2.0 Programmer’s Reference 17-9 </Item> <Item> <UCPTname>Net/VirtCh/iLON System/VirtFb/CMdialInIp</UCPTn

i.LON SmartServer 2.0 Programmer’s Reference 17-10 Property Description <network/channel/device/functionalblock/data point>. You can rename

i.LON SmartServer 2.0 Programmer’s Reference 17-11 Property Description #<manufacturer ID>[scope selector].<type name>[#format] . This

i.LON SmartServer 2.0 Programmer’s Reference 17-12 <UCPTannotation>Dp_Out</UCPTannotation> <UCPTformatDescription>#0000000000

i.LON SmartServer 2.0 Programmer’s Reference 18-1 18 File System Data You can use the List, Read, Write, and Delete functions to download, upload,

i.LON SmartServer 2.0 Programmer’s Reference 18-2 <xSelect>//*[@xsi:type="FileSystem"][UCPTname="/eventlog.txt"][UCPTfi

i.LON SmartServer 2.0 Programmer’s Reference 18-3 returns the following data: Hello World ! 18.3 Using the Write Function on File System Data Y

i.LON SmartServer 2.0 Programmer’s Reference 18-4 ilonWebRef.Item_Coll wrteResp = ilon.Write(itemDataColl); 18.4 Using the Delete Function on File

i.LON SmartServer 2.0 Programmer’s Reference iii Table of Contents 1 Introduction to the SmartServer SOAP/XML Interface ... 1-1 1.1 A

i.LON SmartServer 2.0 Programmer’s Reference 2-16 2.10.1 Configuration Data The following example demonstrates how to use a Get function to obtain

i.LON SmartServer 2.0 Programmer’s Reference 18-5

i.LON SmartServer 2.0 Programmer’s Reference 19-1 19 System Information Methods You can use the SystemService_Read_Info and SystemService_Write_In

i.LON SmartServer 2.0 Programmer’s Reference 19-2 • Time of last refresh. SI_MAIL E-mail (SMTP) server settings. SI_RTR IP-852 router settin

i.LON SmartServer 2.0 Programmer’s Reference 19-3 <UCPTethernetMode>Auto</UCPTethernetMode> <UCPTSoftwareDisabledByDownRevHardwa

i.LON SmartServer 2.0 Programmer’s Reference 19-4 Property Description R/W address prior to a reboot. <UCPTcurrentIpMask> The SmartServer’

i.LON SmartServer 2.0 Programmer’s Reference 19-5 </iLONSystemService> </SystemService_Read_Info> Response <SystemService_Read_I

i.LON SmartServer 2.0 Programmer’s Reference 19-6 Response <SystemService_Read_Info xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/

i.LON SmartServer 2.0 Programmer’s Reference 19-7 Property Description R/W <UCPTftpPassword The password used to access the SmartServer via FTP

i.LON SmartServer 2.0 Programmer’s Reference 19-8 <UCPTmodemPresent>true</UCPTmodemPresent> <UCPTip852RouterPresent>true</

i.LON SmartServer 2.0 Programmer’s Reference 19-9 Property Description R/W used to accommodate block failures. <UCPTdiskSpareBlocksMinRec>

i.LON SmartServer 2.0 Programmer’s Reference 2-17 </ValueDef> <ValueDef> <UCPTindex>1</UCPTindex> <UCPTnam

i.LON SmartServer 2.0 Programmer’s Reference 19-10 <UCPTdpMessageFailures>1440 0</UCPTdpMessageFailures> </AoUCPTdpMessageFailu

i.LON SmartServer 2.0 Programmer’s Reference 19-11 Property Description R/W <UCPTnumBlocksFree> The number of free blocks of RAM on the Smar

i.LON SmartServer 2.0 Programmer’s Reference 19-12 Property Description R/W <UCPTmailLogin> The user name for logging in to an SMTP serve

i.LON SmartServer 2.0 Programmer’s Reference 19-13 Property Description R/W on which devices are attached to be determined automatically. Configu

i.LON SmartServer 2.0 Programmer’s Reference 19-14 Property Description R/W <UCPTrouterLONWORKSAddr_LT> The domain, subnet, node address of

i.LON SmartServer 2.0 Programmer’s Reference 19-15 Property Description R/W IP-852 Configuration Server on the IP-852 channel. <UCPTcfgPacketsR

i.LON SmartServer 2.0 Programmer’s Reference 19-16 Property Description R/W <UCPTlspaCaptureAllPackets> This property enables packets direct

i.LON SmartServer 2.0 Programmer’s Reference 19-17 <UCPTstate> This property specifies whether to start a test or get the current status of t

i.LON SmartServer 2.0 Programmer’s Reference 19-18 Response <SystemService_TestResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon

i.LON SmartServer 2.0 Programmer’s Reference 19-19 • SS_SENDING_MAIL • SS_BUSY <UCPTerror> A flag indicating whether there was an error wit

i.LON SmartServer 2.0 Programmer’s Reference 2-18 <p:UCPTprocessingTime>20</p:UCPTprocessingTime> </p:messageProperties> <

i.LON SmartServer 2.0 Programmer’s Reference 19-20 </SystemService_Test> Request (check the status of the test) <SystemService_Test xmlns=

i.LON SmartServer 2.0 Programmer’s Reference 19-21 Property Description Required/ Optional <UCPTTestType> Enumeration that defines the type

i.LON SmartServer 2.0 Programmer’s Reference 19-22 <UCPTdetailDescr></UCPTdetailDescr> <AoTestLog> <TestLo

i.LON SmartServer 2.0 Programmer’s Reference 20-1 20 Using the SOAP Interface as a Web Service This chapter assumes that you have some familiarity

i.LON SmartServer 2.0 Programmer’s Reference 20-2 4. Add a service reference to the version 4.0 WSDL to your project. To do this, follow these s

i.LON SmartServer 2.0 Programmer’s Reference 20-3 c. In the URL or Address box, enter the following address: http://SmartServer IP address/WSDL

i.LON SmartServer 2.0 Programmer’s Reference 20-4 e. In the Namespace box, enter a name for the service reference. You will use this name when y

i.LON SmartServer 2.0 Programmer’s Reference 20-5 f. Click OK. The new service reference appears in the list of references in the Solution Explor

i.LON SmartServer 2.0 Programmer’s Reference 20-6 7. In the Name box, enter “iLON_SoapCalls” and then click Add. 8. You should now use the iLON

i.LON SmartServer 2.0 Programmer’s Reference 20-7 3. Enter a name, location, and project type for the project, and then click OK. 4. Add a Web

i.LON SmartServer 2.0 Programmer’s Reference 2-19 </p:messageProperties> </SOAP-ENV:Header> <SOAP-ENV:Body> <ReadResponse xm

i.LON SmartServer 2.0 Programmer’s Reference 20-8 b. In the URL or Address box, enter the following address: http://SmartServer IP address/WSDL

i.LON SmartServer 2.0 Programmer’s Reference 20-9 e. Click Add Reference. The new Web reference appears in the list of references in the Solutio

i.LON SmartServer 2.0 Programmer’s Reference 20-10 5. A .NET 2.0 client must turn off the keep-alive attribute to communicate with the SmartServer

i.LON SmartServer 2.0 Programmer’s Reference 20-11 class iLON_WebService : iLON_SmartServer.iLON100 // iLON_SmartServer refers to the name o

i.LON SmartServer 2.0 Programmer’s Reference 20-12 namespace SmartServerConsoleExample { class iLON_SoapCalls { // your SmartServer

i.LON SmartServer 2.0 Programmer’s Reference 20-13 20.2.2 Instantiating the Web Service Client in Visual C# .NET 2.0 using System; using System.Co

i.LON SmartServer 2.0 Programmer’s Reference 20-14 20.2.3 Instantiating the Web Service Client in Visual Basic .NET 3.5 The following example show

i.LON SmartServer 2.0 Programmer’s Reference 20-15 Note: The following examples assume that you are using a SmartServer that has been set to its f

i.LON SmartServer 2.0 Programmer’s Reference 20-16 // -------------- WRITING A DATA POINT VALUE --------------

i.LON SmartServer 2.0 Programmer’s Reference 20-17 after you have completed section 20.2.1, Referencing and Inheriting from the WSDL Using .NET 2.0

i.LON SmartServer 2.0 Programmer’s Reference 3-1 3 SmartServer Applications and the SOAP/XML Interface This chapter provides an overview of the ap

i.LON SmartServer 2.0 Programmer’s Reference 20-18 "Net/LON/iLON App/Digital Output 1/nviClaValue_1"; ((iLON_Sma

i.LON SmartServer 2.0 Programmer’s Reference 20-19 20.3.3 Reading and Writing Data Point Values in Visual Basic .NET 3.5 The following Visual Basi

i.LON SmartServer 2.0 Programmer’s Reference 20-20 SmartServer._iLON.InvokeCmd(itemCollInvoke) ' set the DP priority to 200 (

i.LON SmartServer 2.0 Programmer’s Reference 20-21 a. Open a Command Prompt window to the following folder on your computer: C:\Program Files\Mi

i.LON SmartServer 2.0 Programmer’s Reference 20-22 4. Add a reference to the Microsoft.Web.Services2.dll component. To do this, click Project an

i.LON SmartServer 2.0 Programmer’s Reference 20-23 7. Write the code for web service. You can simply copy and paste the following code snippet in

i.LON SmartServer 2.0 Programmer’s Reference 20-24 // create the response object Item_Coll itemColl_resp = new Item_Coll()

i.LON SmartServer 2.0 Programmer’s Reference 20-25 <section name="microsoft.web.services2" type="Microsoft.Web.Services2.Co

i.LON SmartServer 2.0 Programmer’s Reference 20-26 a. Right-click the LAN icon or a dial-out connection icon, point to Add Host, and then click Se

i.LON SmartServer 2.0 Programmer’s Reference 20-27 f. Configure the following properties for the WebBinder Target server: i.LON SmartServer Prope

i.LON SmartServer 2.0 Programmer’s Reference 3-2 manage these tasks. You can also create a Real-Time Cock to create events based on sunrise and su

i.LON SmartServer 2.0 Programmer’s Reference 20-28 hexadecimal format. Maximum Age Specify the maximum age (in seconds) to be written to the targe

i.LON SmartServer 2.0 Programmer’s Reference 20-29 d. Click Submit. 13. Return to your .NET project, put a break point on the first line in Wr

i.LON SmartServer 2.0 Programmer’s Reference 20-30

i.LON SmartServer 2.0 Programmer’s Reference 21-1 21 Programming Examples This chapter includes programming examples, written in Visual C# (.NET 3

i.LON SmartServer 2.0 Programmer’s Reference 21-2 try { // See Section 20.2.1 (NET 3.5) or 20.2.2 (NET 2.0)for more information on iL

i.LON SmartServer 2.0 Programmer’s Reference 21-3 21.1.2.1 Creating a Data Logger The following C# console example creates a new data logger from

i.LON SmartServer 2.0 Programmer’s Reference 21-4 // -------------- CREATING A DATA LOGGER -------------- //Create an xSelec

i.LON SmartServer 2.0 Programmer’s Reference 21-5 dataPointRef2.UCPTpollRate = 60; dataPointRef2.dpType = "Input

i.LON SmartServer 2.0 Programmer’s Reference 21-6 Console.Out.WriteLine("Item: " + ItemColl.Item[j].UCPTname + ", fault code: "

i.LON SmartServer 2.0 Programmer’s Reference 21-7 Console.ReadLine(); } finally { iLON_SoapCalls.Clo

i.LON SmartServer 2.0 Programmer’s Reference 3-3 3.3 SmartServer Resource Files There are many configuration properties you can configure with the

i.LON SmartServer 2.0 Programmer’s Reference 21-8 Console.Out.WriteLine("Item: " + ItemCfgColl.Item[j].UCPTname + &qu

i.LON SmartServer 2.0 Programmer’s Reference 21-9 myScheduler.UCPTname = "Net/LON/iLON App/myScheduler"; my

i.LON SmartServer 2.0 Programmer’s Reference 21-10 offEvent.UCPTvalue[0].Value = "OFF"; offEvent.UCPTvalue[

i.LON SmartServer 2.0 Programmer’s Reference 21-11 sat.UCPTwednesday = 0; sat.UCPTthursday = 0; sat.UC

i.LON SmartServer 2.0 Programmer’s Reference 21-12 myScheduler.DayBased[2] = new iLON_SmartServer.UFPTscheduler_CfgDayBased();

i.LON SmartServer 2.0 Programmer’s Reference 21-13 //create Exception item holidays.Exception = new i

i.LON SmartServer 2.0 Programmer’s Reference 21-14 //create exception dates myCalendar.Exception[0].Schedule = new iLON_Smart

i.LON SmartServer 2.0 Programmer’s Reference 21-15 myCalendar.Exception[0].Schedule[3].UCPTschedDay = new iLON_SmartServer.E_LonString()

i.LON SmartServer 2.0 Programmer’s Reference 21-16 class Program { //Function required for converting device Neuron IDs and program ID

i.LON SmartServer 2.0 Programmer’s Reference 21-17 my_LON_Device1.Command[1].UCPTstatus.Value = "STATUS_REQUEST";

i.LON SmartServer 2.0 Programmer’s Reference 3-4 3.3.3 User-Defined Network Variable Type (UNVT) Device Resource Files Device manufacturers create

i.LON SmartServer 2.0 Programmer’s Reference 21-18 ", fault string: " + Device_Return_ItemColl.Item[j].fault.faultstring);

i.LON SmartServer 2.0 Programmer’s Reference 21-19 // If you are using NET 2.0 Framework, uncomment the following line of code to enter

i.LON SmartServer 2.0 Programmer’s Reference 21-20 deviceItems.Command[0].UCPTcommand = iLON_SmartServer.LON_Device_eComma

i.LON SmartServer 2.0 Programmer’s Reference 21-21 Console.Out.WriteLine(deviceItemsCheck.UCPTname + "RESET REQUEST STAT

i.LON SmartServer 2.0 Programmer’s Reference 21-22 { int nLen = str.Length / 2; byte[] arr = new byte[nLen];

i.LON SmartServer 2.0 Programmer’s Reference 21-23 //Check scan status bool scanDone = false; whil

i.LON SmartServer 2.0 Programmer’s Reference 21-24 Console.WriteLine("Neuron ID = " + NID); Strin

i.LON SmartServer 2.0 Programmer’s Reference 21-25 iLON_SmartServer.LON_Device_eCommand.ChangeCommissionStatus;

i.LON SmartServer 2.0 Programmer’s Reference 21-26 finally { iLON_SoapCalls.CloseBindingToSmartServer();

i.LON SmartServer 2.0 Programmer’s Reference 21-27 iLON_SmartServer_System.messageProperties_system systemInfo = new iLON_SmartServer_S

i.LON SmartServer 2.0 Programmer’s Reference 3-5 Precision – Single floats always use 7 digits of precision, including digits before and after the

i.LON SmartServer 2.0 Programmer’s Reference 21-28 { // Specify the binding to be used for the client. BasicHttpBin

i.LON SmartServer 2.0 Programmer’s Reference 21-29 // _iLON.Credentials = new System.Net.NetworkCredential("ilon",

i.LON SmartServer 2.0 Programmer’s Reference 21-30 21.2 Visual Basic.NET Examples 21.2.1 Reading and Writing Data Point Values in Visual Basic.N

i.LON SmartServer 2.0 Programmer’s Reference 21-31 Next Dim ItemWriteDpValues As ILON_SmartServer.Item_Coll = SmartServer.

i.LON SmartServer 2.0 Programmer’s Reference 21-32 Dim SmartServer As iLON_SoapCalls = New iLON_SoapCalls SmartServer.BindClientTo

i.LON SmartServer 2.0 Programmer’s Reference 21-33 myDataLogger.DataPoint(1) = dataPointRef2 'call Set function

i.LON SmartServer 2.0 Programmer’s Reference 21-34 PrintGetError(ItemColl) Else Dim myDataLogger As iLON_SmartServe

i.LON SmartServer 2.0 Programmer’s Reference 21-35 ' print out error and exit Console.Out.WriteLine("An error occurred:&q

i.LON SmartServer 2.0 Programmer’s Reference 21-36 dataPointRef1.UCPTname = "Net/LON/iLON App/Digital Output 1/nviClaValue_1"

i.LON SmartServer 2.0 Programmer’s Reference 21-37 mon_to_fri.UCPTsaturday = 0 mon_to_fri.UCPTsunday = 0 dayB

i.LON SmartServer 2.0 Programmer’s Reference 3-6 3.4.2 Get Functions You can use the Get function to retrieve the configuration of any application

i.LON SmartServer 2.0 Programmer’s Reference 21-38 '---create ON event---- Dim onEvent_Sun As New iLON_SmartServer.UF

i.LON SmartServer 2.0 Programmer’s Reference 21-39 Dim lockEvent_holiday As New iLON_SmartServer.UFPTscheduler_CfgEvent() l

i.LON SmartServer 2.0 Programmer’s Reference 21-40 Dim newScheduler As iLON_SmartServer.Item = ItemColl_Set_Scheduler_Return.Item(

i.LON SmartServer 2.0 Programmer’s Reference 21-41 myCalendar.Exception(0).Schedule(1).UCPTschedMonth = New iLON_SmartServer.E_LonString()

i.LON SmartServer 2.0 Programmer’s Reference 21-42 Console.ReadLine() Finally SmartServer.CloseBindingToSmartServer()

i.LON SmartServer 2.0 Programmer’s Reference 21-43 my_LON_Device1.UCPTprogramId = HexStringToArray("80000105288a0403") my

i.LON SmartServer 2.0 Programmer’s Reference 21-44 'get the device template to show FBs and DPs in Web UI my_LON_Device2.Comma

i.LON SmartServer 2.0 Programmer’s Reference 21-45 'we create an xSelect object and then specify the filter to be used Dim xSel

i.LON SmartServer 2.0 Programmer’s Reference 21-46 ItemColl_SetReturn.xSelect = "//Item[@xsi:type=""LON_Device_Cfg"&quo

i.LON SmartServer 2.0 Programmer’s Reference 21-47 21.2.6 Discovering and Installing External Devices in Visual Basic.NET This console example sca

i.LON SmartServer 2.0 Programmer’s Reference iv 3.4.5 Write Functions...3-7

i.LON SmartServer 2.0 Programmer’s Reference 3-7 3.4.4 Read Functions You can use the Read function to read the value, status, or priority of a da

i.LON SmartServer 2.0 Programmer’s Reference 21-48 networkScan.UCPTscan(0) = domain 'send InvokeCmd Dim

i.LON SmartServer 2.0 Programmer’s Reference 21-49 End If ' -------------- CREATING DISCOVERED LONWORKS DEVICE

i.LON SmartServer 2.0 Programmer’s Reference 21-50 my_LON_Device.Command = New iLON_SmartServer.LON_Device_CfgCommand(2) {}

i.LON SmartServer 2.0 Programmer’s Reference 21-51 21.2.7 Configuring the SmartServer in Visual Basic.NET This console example uses the system inf

i.LON SmartServer 2.0 Programmer’s Reference 21-52 vbNewLine) Thread.Sleep(10000) Dim newTime As New iLON_SmartServer_Sys

i.LON SmartServer 2.0 Programmer’s Reference 21-53 ' Closing the client gracefully ' closes the connection and cleans up

i.LON SmartServer 2.0 Programmer’s Reference 22-1 22 Programming the SmartServer with Java You can write custom applications for the SmartServer in

i.LON SmartServer 2.0 Programmer’s Reference 22-2 2. Download the Maven 2.2.1 .zip file. 3. Browse to the C:\eclipse\eclipse 3.5\ilon.ws.clients

i.LON SmartServer 2.0 Programmer’s Reference 22-3 22.2 Creating a JAX-WS Client To create a JAX-WS client, follow these steps: 1. Create the java

i.LON SmartServer 2.0 Programmer’s Reference 22-4 b. The Import dialog opens with the Select window. Expand General, click Existing Projects into

i.LON SmartServer 2.0 Programmer’s Reference 3-8

i.LON SmartServer 2.0 Programmer’s Reference 22-5 c. The Import window opens. In the Root Directory property, enter C:\eclipse\eclipse 3.5\ilon.w

i.LON SmartServer 2.0 Programmer’s Reference 22-6 b. In the Work With property, enter http://m2eclipse.sonatype.org/update/. In the Type Filter T

i.LON SmartServer 2.0 Programmer’s Reference 22-7 d. Restart Eclipse. To do this, click File and then click Restart. If the following warning dia

i.LON SmartServer 2.0 Programmer’s Reference 22-8 b. The Preferences dialog opens. Expand JAVA and then click Installed JREs. c. Add the JDK t

i.LON SmartServer 2.0 Programmer’s Reference 22-9 d. A jdk entry is listed under Installed JREs. e. Delete the existing jre6 entry. To do this,

i.LON SmartServer 2.0 Programmer’s Reference 22-10 f. Click OK. g. Browse to C:\WINDOWS\system32 and rename the java.exe, javaw.exe, javaws.exe f

i.LON SmartServer 2.0 Programmer’s Reference 22-11 • In the Properties dialog, click Java Build Path and then click the Libraries tab. If there i

i.LON SmartServer 2.0 Programmer’s Reference 22-12 • A JRE System Library [jdk] entry is listed • Click OK. 6. Enable Maven to manage your Jav

i.LON SmartServer 2.0 Programmer’s Reference 22-13 a. In the Project Explorer view, right-click the ilon-ws folder, point to Maven, and then click

i.LON SmartServer 2.0 Programmer’s Reference 22-14 8. Enter the following command in the C:\eclipse\eclipse 3.5\ilon.ws.clients folder to generate

i.LON SmartServer 2.0 Programmer’s Reference 4-1 4 Using the SmartServer Data Server The SmartServer’s internal Data Server is a software componen

i.LON SmartServer 2.0 Programmer’s Reference 22-15 9. Enter the following command in the C:\eclipse\eclipse 3.5\ilon.ws.clients\jax-ws folder to ge

i.LON SmartServer 2.0 Programmer’s Reference 22-16 11. Run the Client.java class. To do this, click Run and then click Run or Debug.

i.LON SmartServer 2.0 Programmer’s Reference 22-17 12. Observe the output in the Console view at the bottom of the development environment. 22.3

i.LON SmartServer 2.0 Programmer’s Reference 22-18 package com.echelon.sample.client.ilon; import com.echelon.wsdl.web_services_ns.ilon100.v4_0.mes

i.LON SmartServer 2.0 Programmer’s Reference 22-19 } ItemColl writeResponse = SmartServer.write(itemDataColl);

i.LON SmartServer 2.0 Programmer’s Reference 22-20 import com.echelon.wsdl.web_services_ns.ilon100.v4_0.message.UFPTdataLoggerCfg; import com.echelo

i.LON SmartServer 2.0 Programmer’s Reference 22-21 logFormat_LonString.setLonFormat("UCPTlogFormat"); myDataLo

i.LON SmartServer 2.0 Programmer’s Reference 22-22 import com.echelon.wsdl.web_services_ns.ilon100.v4_0.wsdl.ILON100; import com.echelon.wsdl.web_se

i.LON SmartServer 2.0 Programmer’s Reference 22-23 // print out error and exit System.out.println("An error

i.LON SmartServer 2.0 Programmer’s Reference 22-24 /** * @param args */ public static byte[] hexStringToByteArray(String s) { int le

i.LON SmartServer 2.0 Programmer’s Reference 4-2 Two of the most important properties in the Data Server for any data point are the <UCPTpointS

i.LON SmartServer 2.0 Programmer’s Reference 22-25 //run device application

i.LON SmartServer 2.0 Programmer’s Reference 22-26 LONDeviceCfg.Command getTemplate_my_LON_Device2 = new LONDeviceCfg.Command();

i.LON SmartServer 2.0 Programmer’s Reference 22-27 You can execute this code after you have setup the Java programming environment as described in s

i.LON SmartServer 2.0 Programmer’s Reference 22-28 new LONNetworkScanCommandInvoke.Command(); scanFrequency.setUCPTcommand(LONDeviceIlonNi

i.LON SmartServer 2.0 Programmer’s Reference 22-29 // A "<network>/#DeviceDiscovery" data logger is automatically created by

i.LON SmartServer 2.0 Programmer’s Reference 22-30 String xifName = templateName_justxif[templateNameLength-1]; Syst

i.LON SmartServer 2.0 Programmer’s Reference 22-31 newDevice.getUCPTapplicationStatus().getValue() + ".");

i.LON SmartServer 2.0 Programmer’s Reference A-1 Appendix A: SOAP Tester Example You can use the iLON SOAP Tester (version 2.0.3994) to perform func

i.LON SmartServer 2.0 Programmer’s Reference A-2 4. Click List. This calls the Data Server’s List function and returns all the data points on the

i.LON SmartServer 2.0 Programmer’s Reference A-3 6. In this example, we want to read and write only to the SmartServer’s digital relay outputs; th

i.LON SmartServer 2.0 Programmer’s Reference 4-3 • The data points on the SmartServer’s internal automated systems device (i.LON App), which conta

i.LON SmartServer 2.0 Programmer’s Reference A-4 7. Click List. This calls the Data Server’s List function and returns all the data points that

i.LON SmartServer 2.0 Programmer’s Reference A-5 8. Click Read. This calls the Data Server’s Read function and returns the Dp_Data type for the su

i.LON SmartServer 2.0 Programmer’s Reference A-6 9. Toggle the values of the data points. By default, the subject data points have pre-defined ON

www.echelon.com

i.LON SmartServer 2.0 Programmer’s Reference 4-4 <ValueDef> <UCPTindex>0</UCPTindex> <UCPTname>OFF</UCPTname>

i.LON SmartServer 2.0 Programmer’s Reference 4-5 You can use additional filters in the xSelect statement to return a specific set of data points on

i.LON SmartServer 2.0 Programmer’s Reference 4-6 Alternatively, you can specify one or more data point properties such as <UCPTformatDescription

i.LON SmartServer 2.0 Programmer’s Reference 4-7 Property Description <UCPTname> The name of the data point in the following format: <netw

i.LON SmartServer 2.0 Programmer’s Reference 4-8 Property Description standard (SNVT) format type included in the resource files on the SmartServer

i.LON SmartServer 2.0 Programmer’s Reference v 8.2 Creating and Modifying the Analog Functional Block XML File...8-2 8.3 Analog Functiona

i.LON SmartServer 2.0 Programmer’s Reference 4-9 Property Description function to edit the unit strings of data point fields. <UCPTbaseType>

i.LON SmartServer 2.0 Programmer’s Reference 4-10 Property Description it exists for the data point type selected. This value represents the minim

i.LON SmartServer 2.0 Programmer’s Reference 4-11 or more <Item> elements. Each <Item> element includes a <UCPTname> property th

i.LON SmartServer 2.0 Programmer’s Reference 4-12 include the data point’s <UCPTname> and <UCPTlastUpdate> properties and the position

i.LON SmartServer 2.0 Programmer’s Reference 4-13 Response <ReadResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/messag

i.LON SmartServer 2.0 Programmer’s Reference 4-14 Property Description <UCPThidden> A flag indicating whether the data point is hidden or sho

i.LON SmartServer 2.0 Programmer’s Reference 4-15 • If <UCPTmaxAge> is set to 0, the Data Server returns polls the data point and returns th

i.LON SmartServer 2.0 Programmer’s Reference 4-16 <UCPTvalue LonFormat= "SNVT_scene.function">SC_RECALL</UCPTvalue> <UCPTv

i.LON SmartServer 2.0 Programmer’s Reference 4-17 Response <WriteResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/mess

i.LON SmartServer 2.0 Programmer’s Reference 4-18 For example, consider a scenario where a SOAP application uses the Write function to write to the

i.LON SmartServer 2.0 Programmer’s Reference vi 14 LONWORKS Driver ... 14-1

i.LON SmartServer 2.0 Programmer’s Reference 4-19 data point is still registered on its respective bus. The following code sample demonstrates ho

i.LON SmartServer 2.0 Programmer’s Reference 4-20 much slower (40 data point updates per second) than IP-852 connections (1,000 updates per second)

i.LON SmartServer 2.0 Programmer’s Reference 4-21 <UCPTannotation>Dp_In_WebBinding;xsi:type=&quot;Dp_Ref&quot;</UCPTannotation&g

i.LON SmartServer 2.0 Programmer’s Reference 4-22 Property Description <UCPTname> The name of the source data point in the Web connection in

i.LON SmartServer 2.0 Programmer’s Reference 4-23 Property Description Acknowledged messaging service (ST_WEB_ACK). This means that the sending de

i.LON SmartServer 2.0 Programmer’s Reference 4-24 Request <Set xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/"&g

i.LON SmartServer 2.0 Programmer’s Reference 5-1 5 Data Loggers You can use Data Loggers to monitor activity on your network. Each Data Logger wi

i.LON SmartServer 2.0 Programmer’s Reference 5-2 <Item xsi:type="UFPTdataLogger_Cfg" > <UCPTname>Net/LON/iLON App/Data

i.LON SmartServer 2.0 Programmer’s Reference 5-3 SmartServer will require a reboot to read the configuration of the downloaded file. Additionally,

i.LON SmartServer 2.0 Programmer’s Reference 5-4 <iLonItem> <Item> <UCPTname>Net/LON/iLON App/Data Logger[0]</UCPTname>

i.LON SmartServer 2.0 Programmer’s Reference vii 16.1.1 Using the List Function on M-Bus Channels ...16-1 16.1.2 Using the

i.LON SmartServer 2.0 Programmer’s Reference 5-5 Property Description <UCPTname> The name of the data logger in the following format: <net

i.LON SmartServer 2.0 Programmer’s Reference 5-6 Property Description <UCPTlogType> Either LT_HISTORICAL or LT_CIRCULAR. This indicates whet

i.LON SmartServer 2.0 Programmer’s Reference 5-7 Property Description <UCPTlogFileName> The path of the data log file on the SmartServer flas

i.LON SmartServer 2.0 Programmer’s Reference 5-8 Property Description 214,748,364.0 seconds. The Data Logger will check for updates to the data po

i.LON SmartServer 2.0 Programmer’s Reference 5-9 Request <Set xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">

i.LON SmartServer 2.0 Programmer’s Reference 5-10 Request (data point updates recorded during a specific interval) <Read xmlns="http://wsdl

i.LON SmartServer 2.0 Programmer’s Reference 5-11 entries in the log file. <UCPTmodificationNumber> A counter indicating the number of time

i.LON SmartServer 2.0 Programmer’s Reference 5-12 5.3.4.1 Local Times and Coordinated Universal Time The timestamps for the <UCPTstart> and

i.LON SmartServer 2.0 Programmer’s Reference 5-13 <UCPTstop>2008-02-28T14:00:00.070-08:00</UCPTstop> <UCPTmodificationNumber&g

i.LON SmartServer 2.0 Programmer’s Reference 6-1 6 Alarm Generator Use the Alarm Generator application to generate alarms based on the values of t

i.LON SmartServer 2.0 Programmer’s Reference viii 20 Using the SOAP Interface as a Web Service ... 20-1 20.1 Referencin

i.LON SmartServer 2.0 Programmer’s Reference 6-2 <Item xsi:type="UFPTalarmGenerator_Cfg" > <UCPTname>Net/LON/iLON App/Alarm

i.LON SmartServer 2.0 Programmer’s Reference 6-3 Get Retrieve the configuration of any Alarm Generator that you have added to the SmartServer. S

i.LON SmartServer 2.0 Programmer’s Reference 6-4 <UCPTlastUpdate>2008-02-28T15:45:26.060-08:00</UCPTlastUpdate> <UCPTuri>#800

i.LON SmartServer 2.0 Programmer’s Reference 6-5 Property Description deleted. In this case, it has the following values: IS_NOTSYNCED IS_DELETE

i.LON SmartServer 2.0 Programmer’s Reference 6-6 Property Description point every five seconds to ensure that each application gets a current value

i.LON SmartServer 2.0 Programmer’s Reference 6-7 Property Description Point – lowLimit2Offset The value entered for <UCPThighLimit2Offset> mu

i.LON SmartServer 2.0 Programmer’s Reference 6-8 Property Description will be generated. The <UCPTpointSatus> of this data point will be upda

i.LON SmartServer 2.0 Programmer’s Reference 6-9 Property Description e-mail messages each time they are updated to an alarm status. For more info

i.LON SmartServer 2.0 Programmer’s Reference 6-10 Identifier Description FN_NE Not equal. An alarm will be generated if the input value is not equ

i.LON SmartServer 2.0 Programmer’s Reference 6-11 Offset Limit Alarm Generated When... Alarm Status <UCPThighLimit1Offset> Input Value>

i.LON SmartServer 2.0 Programmer’s Reference ix 22.1.1 Installing Echelon SmartServer JAX-ES Programming Example...

i.LON SmartServer 2.0 Programmer’s Reference 6-12 Event Input Data Point Status Comments Value of input data point goes below hysteresis level fo

i.LON SmartServer 2.0 Programmer’s Reference 6-13 <UCPTpollRate>0.0</UCPTpollRate> <UCPTalarm2Description>none</UCPTalarm2Desc

i.LON SmartServer 2.0 Programmer’s Reference 6-14

i.LON SmartServer 2.0 Programmer’s Reference 7-1 7 Alarm Notifier Use the Alarm Notifier application to log user-defined alarm conditions, and to

i.LON SmartServer 2.0 Programmer’s Reference 7-2 In addition, the Alarm Notifier application generates a summary log that summarizes the log entrie

i.LON SmartServer 2.0 Programmer’s Reference 7-3 <UCPTemailAggregTime>0</UCPTemailAggregTime> <Mail> <UCPTindex>0<

i.LON SmartServer 2.0 Programmer’s Reference 7-4 7.3 Alarm Notifier SOAP Interface You can use the SOAP interface to perform the following functio

i.LON SmartServer 2.0 Programmer’s Reference 7-5 7.3.2 Using the Get Function on an Alarm Notifier You can use the Get function to retrieve the co

i.LON SmartServer 2.0 Programmer’s Reference 7-6 <UCPTlevel>255</UCPTlevel> <UCPTalarmText>Online</UCPTalarmText>

i.LON SmartServer 2.0 Programmer’s Reference 7-7 Property Description <UCPTuri> The name of the file containing the configuration web page fo