Echelon i.LON SmartServer Technical Information download pdf (Page 12)

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 SmartServer. The SmartServer performs error-checking on all data written in a SOAP message,

so that invalid data will not be written to any of the XML files. The SmartServer will not perform

error-checking on any XML files downloaded to it via FTP, and so manually editing the XML files

may cause errors during the boot process. Additionally, you can send SOAP messages to the

SmartServer while it is operating, and the SmartServer will update the XML files affected by the

SOAP messages without requiring a reboot.

You may find the information in this document that pertains to manually creating and managing XML

files useful if you are using several SmartServers, and would like to use the same configuration on

each one. In that case, you could configure one of the SmartServers, copy its XML files, and

download them to the appropriate directories of the other SmartServers to obtain the same

configuration in all of them.

1.2

Programming Samples

Chapter 21 of this document includes programming samples written in

Visual C# .NET, Visual Basic

.NET, and Java

to illustrate concepts described in this manual. To make these samples more easily

understood, they have been simplified. Error checking has been removed, and in some cases, the

examples are only fragments that may not compile without errors or warnings.

1.3

Getting Started

You should review Chapters 2 and 3 before proceeding to the rest of this document and learning about

the functions and applications of the SOAP/XML interface. Chapter 2,

SOAP Messages and the

SmartServer WSDL, describes the WSDL file which defines the SOAP/XML interface. Chapter 3,

SmartServer Applications and the SOAP/XML Interface, provides an overview of the SmartServer

applications and includes a roadmap to follow when configuring those applications with a SOAP

application.

You can begin to learn how to program the SmartServer using SOAP/XML using the iLON SOAP

Tester (version 2.0.3994). The SOAP Tester is an unsupported engineering-level tool provided by

Echelon that lets you perform functional testing of the SmartServer’s pre-defined SOAP functions and

your user-defined SOAP functions. You can download the SOAP Tester from the i.LON SmartServer

Community Web site at

http://ilonsmartserver.com/files. If you have a SmartServer 2.0 (Release

4.03), the SOAP Tester is also included on the i.LON SmartServer 2.0 DVD in the

iLon100\iLon100\unsupported\SoapTester folder. For more information on using the SOAP Tester,

see

Appendix A: SOAP Tester Example.

You can also learn how to program the SmartServer using SOAP/XML by installing an HTTP

debugging proxy program like Charles on your computer. The Charles proxy records all SOAP and

other HTTP traffic to and from your computer. You can use Internet Explorer to perform normal

operations with the SmartServer Web interface and record the SOAP messages that are being sent to

the SmartServer. You can download a free trial version of the Charles proxy from the Charles Web

site. For more information on using and downloading the Charles proxy, go to the Charles Web site at

www.charlesproxy.com.

1.4

SmartServer SOAP/XML Interface Upgrades

The format and contents of the SOAP messages you can send to a SmartServer are defined by the

SOAP namespace that the SmartServer is using. The SOAP/XML interface used for the SmartServer

(software version 4.0) is new. It uses a common set of generic methods (list, get, set, delete, read,

write, clear, and invoke) for retrieving and configuring the data of the various SmartServer

applications. This differs from the SOAP/XML interface that was used for e3 (software version 3.0)

release, in which each application had its own specialized set of messages and structures.

There have been three different SOAP namespaces introduced during the four releases of the i.LON

servers. The version 1.0 namespace was introduced for Release 1.0, the version 1.1 namespace was

1 2 ... 7 8 9 10 11 12 13 14 15 16 17 ... 442 443

SmartServer 2.0 1
Programmer's Reference 1
Table of Contents 3
viii 8
About This Document 11
Programming Samples 12
Getting Started 12
SmartServer WSDL File 16
Security 16
SOAP Request 17
SOAP Messages Formats 18
SOAP Header 19
SOAP Envelope 19
SOAP Body 20
2.5.3.3 Error Codes 22
Namespace 23
SOAP Message Schema 23
SOAP Function Types 23
2-10 24
2-11 25
2-12 26
2-13 27
2-14 28
2-15 29
2-16 30
2-17 31
2-18 32
2-19 33
Interface 34
SmartServer Resource Files 36
Data Point Templates 37
Data Formatting 37
SOAP Functions 38
Get Functions 39
Set Functions 39
Performance Issues 40
ONWORKS devices connected to 42
Data Server SOAP Interface 45
4-10 51
4-11 52
4-12 53
4-13 54
4-14 55
4-15 56
4-16 57
4-17 58
4-18 59
4-19 60
4-20 61
4-21 62
4-22 63
4-23 64
4-24 65
5 Data Loggers 66
Data Logger SOAP Interface 68
<UCPTlogType> 71
<UCPTlogSize> 71
<UCPTlogFormat> 71
<UCPTlogLevelAlarm> 71
5-10 75
5-11 76
5-12 77
5-13 78
6 Alarm Generator 79
<UCPTitemStatus> 82
SNVT_alarm Output 86
SNVT_alarm2 Output 86
6-10 88
6-11 89
6-12 90
6-13 91
6-14 92
7 Alarm Notifier 93
<DataPoint> 100
<Mail> 100
<ActiveAlarm> 100
<PassiveAlarm> 100
7.3.2.1 Input Data Points 101
7-10 102
7-11 103
7-12 104
7-13 105
7-14 106
7-15 107
7-16 108
7-17 109
7-18 110
7-19 111
7-20 112
7-21 113
7-22 114
7-23 115
7-24 116
7-25 117
7-26 118
8 Analog Function Block 119
Compare 123
<UCPTcompFunction> 124
<UCPTmajorityValue> 124
<UCPTtrueThreshold> 124
8.3.2.1 Output Functions 126
8-10 128
8-11 129
8-12 130
8-13 131
9 Scheduler 132
Scheduler SOAP Interface 134
</GetResponse> 137
<DayBased> 138
<DateBased> 138
9-10 141
9-11 142
9-12 143
9-13 144
9-14 145
9-15 146
9-16 147
9-17 148
9-18 149
10-1 150
10 Calendar 150
10-2 151
10-3 153
10-4 154
10-5 155
10-6 156
10-7 157
10-8 158
10-9 159
10-10 160
10-11 161
10-12 162
10-13 163
10-14 164
10-15 165
10-16 166
11-1 167
11 Real-Time Clock 167
11-2 168
11-3 169
11-4 170
11-5 171
11-6 172
12-1 173
12 Type Translator 173
12-2 174
12-3 175
12-4 176
12-5 177
12-6 178
12-7 179
12-8 180
12-9 181
12-10 182
12-11 183
12-12 184
12-13 185
12-14 186
12-15 187
12-16 188
13-1 189
13 Type Translator Rules 189
13-2 190
13-3 191
13-4 192
13-5 193
13-6 194
13-7 195
13-8 196
13-9 197
13-10 198
13-11 199
13-12 200
14-1 201
WORKS Driver 201
14-2 202
14-3 203
14-4 204
14-5 205
14-6 206
14-7 207
14-8 208
14-9 209
14-10 210
14-11 211
14-12 212
14-13 213
14-14 214
14-15 215
14-16 216
14-17 217
14-18 218
14-19 219
14-20 220
14-21 221
14-22 222
14-23 223
14-24 224
14-25 225
14-26 226
14-27 227
14-28 228
14-29 229
14-30 230
14-31 231
14-32 232
14-33 233
14-34 234
14-35 235
14-36 236
14-37 237
14-38 238
14-39 239
14-40 240
14-41 241
14-42 242
14-43 243
14-44 244
14-45 245
14-46 246
14-47 247
14-48 248
14-49 249
15 Modbus Driver 250
<UCPTname> 251
<UCPTannotation> 251
<UCPThidden> 251
<UCPTlastUpdate> 251
<UCPTdescription> 252
<UCPTuri> 252
<UCPThandle> 252
<UCPTchannelType> 252
<UCPTport> 252
<InterfaceOptions> 253
<UCPTserialMode> 254
<UCPTretryCount> 254
<UCPTminOfflineTime> 254
15-7 256
15-8 257
15-9 258
15-10 259
15-11 260
15-12 261
15-13 262
15-14 263
15-15 264
15-16 265
15-17 266
15-18 267
16-1 268
16 M-Bus Driver 268
16-2 269
16-3 270
16-4 271
16-5 272
16-6 273
16-7 274
16-8 275
16-9 276
16-10 277
16-11 278
16-12 279
16-13 280
16-14 281
16-15 282
16-16 283
17-1 284
17 Virtual Driver 284
17-2 285
17-3 286
17-4 287
17-5 288
17-6 289
17-7 290
17-8 291
17-9 292
17-10 293
17-11 294
17-12 295
18-1 296
18 File System Data 296
18-2 297
18-3 298
18-4 299
18-5 300
19-1 301
19-2 302
19-3 303
19-4 304
19-5 305
19-6 306
19-7 307
19-8 308
19-9 309
19-10 310
19-11 311
19-12 312
19-13 313
19-14 314
19-15 315
19-16 316
19-17 317
19-18 318
19-19 319
19-20 320
19-21 321
19-22 322
20-1 323
20-2 324
20-3 325
20-4 326
20-5 327
20-6 328
20-7 329
20-8 330
20-9 331
20-10 332
20-11 333
20-12 334
20-13 335
20-14 336
20-15 337
20-16 338
20-17 339
20-18 340
20-19 341
20-20 342
20-21 343
20-22 344
20-23 345
20-24 346
20-25 347
20-26 348
20-27 349
20-28 350
20-29 351
20-30 352
21-1 353
21 Programming Examples 353
21-2 354
21-3 355
21-4 356
21-5 357
21-6 358
21-7 359
21-8 360
21-9 361
21-10 362
21-11 363
21-12 364
21-13 365
21-14 366
21-15 367
21-16 368
21-17 369
21-18 370
21-19 371
21-20 372
21-21 373
21-22 374
21-23 375
21-24 376
21-25 377
21-26 378
21-27 379
21-28 380
21-29 381
21-30 382
21-31 383
21-32 384
21-33 385
21-34 386
21-35 387
21-36 388
21-37 389
21-38 390
21-39 391
21-40 392
21-41 393
21-42 394
21-43 395
21-44 396
21-45 397
21-46 398
21-47 399
21-48 400
21-49 401
21-50 402
21-51 403
21-52 404
21-53 405
Installing Maven 2.2.1 406
Creating a JAX-WS Client 408
22-10 415
22-11 416
22-12 417
22-13 418
22-14 419
22-15 420
22-16 421
22-17 422
22-18 423
22-19 424
22-20 425
22-21 426
22-22 427
22-23 428
22-24 429
22-25 430
22-26 431
22-27 432
22-28 433
22-29 434
22-30 435
22-31 436
<UCPTvalue 442

Comments to this Manuals

No comments

Echelon i.LON SmartServer Technical Information Page 12

Comments to this Manuals