openlns programmer's reference - echelon …...openlns programmer’s reference v detailinfo 74...

OpenLNS Programmer's Reference

078-0437-01A

ii

Echelon, LON, LonWorks, Neuron, 3120, 3150, i.LON, LNS, LonMaker, LONMARK, LonTalk, NodeBuilder, and the Echelon logo are trademarks of Echelon Corporation registered in the United States and other countries. LonSupport, OpenLDV, and LNS Powered by Echelon are trademarks of Echelon Corporation.

Other brand and product names are trademarks or registered trademarks of their respective holders.

Neuron Chips and other OEM Products were not designed for use in equipment or systems which involve danger to human health or safety or a risk of property damage and Echelon assumes no responsibility or liability for use of the Neuron Chips or LonPoint Modules in such applications.

Parts manufactured by vendors other than Echelon and referenced in this document have been described for illustrative purposes only, and may not have been tested by Echelon. It is the responsibility of the customer to determine the suitability of these parts for each application.

ECHELON MAKES NO REPRESENTATION, WARRANTY, OR CONDITION OF ANY KIND, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE OR IN ANY COMMUNICATION WITH YOU, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR ANY PARTICULAR PURPOSE, NONINFRINGEMENT, AND THEIR EQUIVALENTS.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Echelon Corporation.

Printed in the United States of America. Copyright ©1997–2013 by Echelon Corporation. Echelon Corporation www.echelon.com

OpenLNS Programmer’s Reference iii

Table of Contents Preface ................................................................................................ xxxi

Purpose ...................................................................................................... xxxii Audience ..................................................................................................... xxxii System Requirements ................................................................................ xxxii

OpenLNS SDK ..................................................................................... xxxii OpenLNS Server Computer (Smaller Network) .................................. xxxiii OpenLNS Server Computer (Larger, Busier Network) ....................... xxxiii

OpenLNS Documentation ......................................................................... xxxiv For More Information and Technical Support ............................................ xxxiv Content ...................................................................................................... xxxvi

1 OpenLNS Object Server .................................................................... 1 Introduction ...................................................................................................... 2 OpenLNS Object Server Object Model ........................................................... 2 OpenLNS Object Hierarchy ............................................................................. 4 Object Naming Convention ............................................................................. 5

2 Objects ............................................................................................... 7 Account ............................................................................................................ 8

Methods .................................................................................................... 8 Properties .................................................................................................. 8

AccountNumber .................................................................................. 8 Charges .............................................................................................. 8 ClassID ............................................................................................... 9 Description .......................................................................................... 9 Name ................................................................................................ 10

Accounts ........................................................................................................ 10 Methods .................................................................................................. 10

Add ................................................................................................... 11 Remove ............................................................................................ 11

Properties ................................................................................................ 11 ClassId .............................................................................................. 11 Count ................................................................................................ 12 Item ................................................................................................... 12 _NewEnum ....................................................................................... 13

ActivationLicense ........................................................................................... 14 Methods .................................................................................................. 14

Refresh ............................................................................................. 14 Properties ................................................................................................ 14

ActivatedVersion ............................................................................... 15 ClassId .............................................................................................. 15 DaysRemaining ................................................................................ 16 DeviceCapacity ................................................................................. 16 DeviceCapacityConsumed ............................................................... 16 ExpirationDate .................................................................................. 17 LicenseId .......................................................................................... 17 LicenseStatus ................................................................................... 18 IsTrialLicense ................................................................................... 18 MaxOpenSystems ............................................................................ 19 RequiredVersion ............................................................................... 19 RunTimeLimit ................................................................................... 20 RunTimeRemaining .......................................................................... 20

OpenLNS Programmer’s Reference iv

Alias ............................................................................................................... 21 Methods .................................................................................................. 21 Properties ................................................................................................ 21

ClassId .............................................................................................. 21 Index ................................................................................................. 22 Parent ............................................................................................... 22 Selector ............................................................................................ 23

Aliases ........................................................................................................... 23 Methods .................................................................................................. 24

ItemByIndex ...................................................................................... 24 Refresh ............................................................................................. 24

Properties ................................................................................................ 24 ClassId .............................................................................................. 25 Count ................................................................................................ 25 Item ................................................................................................... 25 Parent ............................................................................................... 26 _NewEnum ....................................................................................... 26

AppDevice ..................................................................................................... 27 Methods .................................................................................................. 29

ClearStatus ....................................................................................... 29 Commission ...................................................................................... 29 CommussionEx ................................................................................ 32 Decommission .................................................................................. 33 Delay ................................................................................................. 33 DownloadConfigProperties ............................................................... 34 GetMessagePoint ............................................................................. 38 Load .................................................................................................. 40 LoadEx.............................................................................................. 42 MoveEx ............................................................................................. 43 PostMove .......................................................................................... 45 PreMove ........................................................................................... 45 PropagateDeviceConfigUpdates ...................................................... 46 Reboot .............................................................................................. 47 ReleasePendingUpdates .................................................................. 47 Replace ............................................................................................ 48 ReplaceEx ........................................................................................ 49 Reset ................................................................................................ 51 ResyncToTemplate .......................................................................... 51 Test ................................................................................................... 52 Upgrade ............................................................................................ 58 UploadConfigProperties ................................................................... 60 Wink .................................................................................................. 63

Properties ................................................................................................ 63 AliasCapacity .................................................................................... 64 AliasUseCount .................................................................................. 65 AppImagePath .................................................................................. 65 AttachmentStatus ............................................................................. 66 AuthenticationEnabled ..................................................................... 66 BitmapFilePath ................................................................................. 68 Channel ............................................................................................ 68 ClassId .............................................................................................. 69 CommissionStatus ............................................................................ 69 ConfigurationState ............................................................................ 71 ConnectionUpdateType .................................................................... 72 Delay ................................................................................................. 73 Description ........................................................................................ 73

OpenLNS Programmer’s Reference v

DetailInfo .......................................................................................... 74 Device Template ............................................................................... 74 Extensions ........................................................................................ 74 Handle .............................................................................................. 75 HasBeenCommissioned ................................................................... 75 IconFilePath ...................................................................................... 76 InitialAuthenticationKey .................................................................... 76 Interface ............................................................................................ 77 Interfaces .......................................................................................... 77 LastTestInfo ...................................................................................... 78 LastUpgradeStatus ........................................................................... 78 Location ............................................................................................ 79 LocationInNeuron ............................................................................. 79 MonitorSets ...................................................................................... 80 MtHubs ............................................................................................. 80 Name ................................................................................................ 81 NetworkServiceDevice ..................................................................... 81 NeuronId ........................................................................................... 81 NodeId .............................................................................................. 82 NonGroupRcvTimerNonGroupRcvTimer_Property ......................... 83 NsiHandle ......................................................................................... 83 NVHubs ............................................................................................ 84 Parent ............................................................................................... 84 PingClass ......................................................................................... 85 PendingNeuronIdPendingNeuronId_Property.................................. 86 Priority ............................................................................................... 86 ProgramId ......................................................................................... 87 SelfDocumentation ........................................................................... 87 State ................................................................................................. 88 SubnetId ........................................................................................... 90 Subnets ............................................................................................ 90 Subsystems ...................................................................................... 91 UpgradeRequirement ....................................................................... 91

AppDevices ................................................................................................... 92 Methods .................................................................................................. 93

Add ................................................................................................... 93 AddReference ................................................................................... 95 ItemByHandle ................................................................................... 96 ItemByNeuronID ............................................................................... 96 Remove ............................................................................................ 96

Properties ................................................................................................ 97 ClassId .............................................................................................. 97 Count ................................................................................................ 98 Item ................................................................................................... 98 Parent ............................................................................................... 99 _NewEnum ....................................................................................... 99

Application ................................................................................................... 100 Methods ................................................................................................ 100 Properties .............................................................................................. 100

ClassId ............................................................................................ 101 MajorAPIVersion ............................................................................. 101 MajorVersion .................................................................................. 101 MinorAPIVersion ............................................................................. 102 MinorVersion .................................................................................. 102 Name .............................................................................................. 102 Parent ............................................................................................. 103

OpenLNS Programmer’s Reference vi

State ............................................................................................... 103 BufferConfiguration ...................................................................................... 104

Methods ................................................................................................ 105 Properties .............................................................................................. 105

ClassId ............................................................................................ 105 InputBufferCount ............................................................................ 106 InputBufferSize ............................................................................... 106 OutputBufferCount .......................................................................... 107 OutputBufferSize ............................................................................ 107 PriorityBufferCount ......................................................................... 108 PriorityBufferSize ............................................................................ 108

Channel ....................................................................................................... 109 Methods ................................................................................................ 109 Properties .............................................................................................. 110

AltPathType .................................................................................... 110 AppDevices .................................................................................... 111 BitmapFilePath ............................................................................... 111 ClassId ............................................................................................ 112 Delay ............................................................................................... 112 Description ...................................................................................... 113 Extensions ...................................................................................... 113 Handle ............................................................................................ 114 IconFilePath .................................................................................... 114 MaxPriority ...................................................................................... 115 Name .............................................................................................. 115 Parent ............................................................................................. 116 RouterDevices ................................................................................ 116 TransceiverId .................................................................................. 117

Channels ..................................................................................................... 119 Methods ................................................................................................ 119

Add ................................................................................................. 119 ItemByHandle ................................................................................. 121 Remove .......................................................................................... 122

Properties .............................................................................................. 122 ClassId ............................................................................................ 122 Count .............................................................................................. 123 FilterType ........................................................................................ 123 Item ................................................................................................. 124 Parent ............................................................................................. 125 RefChannel 1 .................................................................................. 125 RefChannel 2 .................................................................................. 126 RefTransceiverType ....................................................................... 126 _NewEnum ..................................................................................... 127

ComponentApp ............................................................................................ 128 Methods ................................................................................................ 128 Properties .............................................................................................. 128

ClassId ............................................................................................ 129 CommandID ................................................................................... 129 ComponentClassID ........................................................................ 130 DefaultAppFlag ............................................................................... 132 Description ...................................................................................... 133 ManufacturerID ............................................................................... 133 Name .............................................................................................. 134 Parent ............................................................................................. 134 RegisteredServer ............................................................................ 135 VersionNumber ............................................................................... 135

OpenLNS Programmer’s Reference vii

ComponentApps .......................................................................................... 135 Methods ................................................................................................ 136

Add ................................................................................................. 136 Remove .......................................................................................... 137

Properties .............................................................................................. 137 ClassId ............................................................................................ 137 Count .............................................................................................. 138 Item ................................................................................................. 138 Parent ............................................................................................. 139 _NewEnum ..................................................................................... 139

ConfigProperties .......................................................................................... 140 Methods ................................................................................................ 140

ItemByHandle ................................................................................. 140 Properties .............................................................................................. 141

ClassId ............................................................................................ 141 Count .............................................................................................. 141 Item ................................................................................................. 142 Parent ............................................................................................. 143 _NewEnum ..................................................................................... 143

ConfigProperty ............................................................................................. 144 Methods ................................................................................................ 145

GetDataPoint .................................................................................. 145 GetRawValuesEx ........................................................................... 147 SetRawValuesEx ............................................................................ 149 SetValueToUnknown ...................................................................... 150

Properties .............................................................................................. 150 AppliesTo ........................................................................................ 151 AppliesToType ................................................................................ 151 ByteLength ..................................................................................... 153 ClassId ............................................................................................ 153 ConfigFileOffset .............................................................................. 154 ConfigFileType ............................................................................... 155 ConfigNv ......................................................................................... 156 ConfigNvIndex ................................................................................ 157 ConstantAttribute ............................................................................ 158 Description ...................................................................................... 160 DeviceSpecificAttribute .................................................................. 160 Dimension ....................................................................................... 162 FlagsByte ........................................................................................ 162 FormatName ................................................................................... 163 FuncProfileDescription ................................................................... 166 FuncProfileName ............................................................................ 166 FuncProfileProgrammaticName ..................................................... 167 Handle ............................................................................................ 167 ImplementationType ....................................................................... 167 Mode ............................................................................................... 169 Name .............................................................................................. 170 Parent ............................................................................................. 170 Precision ......................................................................................... 171 TypeInherits .................................................................................... 171 TypeIndex ....................................................................................... 172 ValueStatus .................................................................................... 173

ConnectDescTemplate ................................................................................ 174 Methods ................................................................................................ 175 Properties .............................................................................................. 175

AliasOptions ................................................................................... 176

OpenLNS Programmer’s Reference viii

BroadcastOptions ........................................................................... 176 ClassId ............................................................................................ 177 Description ...................................................................................... 178 Handle ............................................................................................ 178 MTHubs .......................................................................................... 178 Name .............................................................................................. 179 NVHubs .......................................................................................... 179 Parent ............................................................................................. 180 PropertyOptions .............................................................................. 180 ReceiveTimer ................................................................................. 182 RepeatCount .................................................................................. 183 RepeatTimer ................................................................................... 184 RetryCount ..................................................................................... 186 ServiceType .................................................................................... 187 TransmitTimer ................................................................................ 188 UseAuthenticationFlag ................................................................... 189 UsePriorityFlag ............................................................................... 190

ConnectDescTemplates .............................................................................. 191 Methods ................................................................................................ 191



Connections ................................................................................................. 195 Methods ................................................................................................ 196 Properties .............................................................................................. 196

ClassId ............................................................................................ 196 MessageTags ................................................................................. 196 NetworkVariables ........................................................................... 197 Parent ............................................................................................. 197

CreditInfo ..................................................................................................... 198 Methods ................................................................................................ 198 Properties .............................................................................................. 198

ClassId ............................................................................................ 198 DaysRemaining .............................................................................. 199 DeficitCredits (Deprecated) ............................................................ 199 LicensedCredits (Deprecated) ....................................................... 200 LicenseType (Deprecated) ............................................................. 200 MaxDeficitCredits (Deprecated) ..................................................... 201 UsedCredits (Deprecated) .............................................................. 201

DatabaseValidationReport .......................................................................... 201 Methods ................................................................................................ 202

Export ............................................................................................. 202 Properties .............................................................................................. 203

ClassId ............................................................................................ 203 ErrorSummaries ............................................................................. 204 Parent ............................................................................................. 204 PassedValidation ............................................................................ 205 RepairedErrors ............................................................................... 205 TotalObjectsValidated .................................................................... 206 UnrepairedErrors ............................................................................ 207

OpenLNS Programmer’s Reference ix

DatabaseValidationErrorInstance ................................................................ 207 Methods ................................................................................................ 208 Properties .............................................................................................. 208

ClassId ............................................................................................ 208 ErrorType ........................................................................................ 209 ObjectClassInvolved ....................................................................... 212 ObjectInternalId .............................................................................. 213 ObjectName .................................................................................... 213 Parent ............................................................................................. 214 ParentObjectClass.......................................................................... 215 ParentObjectInternalId ................................................................... 216 ParentObjectName ......................................................................... 217 Repairable ...................................................................................... 217 RepairAttempted ............................................................................. 219 Repaired ......................................................................................... 219

DatabaseValidationErrorSummaries ........................................................... 220 Methods ................................................................................................ 221 Properties .............................................................................................. 221


DatabaseValidationErrorSummary .............................................................. 224 Methods ................................................................................................ 224

GetInstance .................................................................................... 224 Properties .............................................................................................. 225

ClassId ............................................................................................ 225 ErrorType ........................................................................................ 226 NumberOfInstances ....................................................................... 229 ObjectDetailsAvailable ................................................................... 230 Parent ............................................................................................. 230 Repairable ...................................................................................... 231 RepairAttempted ............................................................................. 232

DataPoint ..................................................................................................... 232 Methods ................................................................................................ 233

GetField .......................................................................................... 234 Read ............................................................................................... 234 Write ............................................................................................... 235

Properties .............................................................................................. 235 AutoRead ........................................................................................ 236 AutoWrite ........................................................................................ 237 ClassId ............................................................................................ 238 FieldCount ...................................................................................... 238 FieldName ...................................................................................... 239 FormatSpec .................................................................................... 240 FormattedValue .............................................................................. 241 MaxValue ........................................................................................ 243 MessageCode ................................................................................ 244 MinValue ......................................................................................... 245 Parent ............................................................................................. 246 RawValue ....................................................................................... 247 SourceIndex ................................................................................... 248 SourceOptions ................................................................................ 249 TypeName ...................................................................................... 251 Value ............................................................................................... 251

OpenLNS Programmer’s Reference x

DataValue .................................................................................................... 253 Methods ................................................................................................ 253 Properties .............................................................................................. 254

AppDevice ...................................................................................... 254 ClassId ............................................................................................ 254 Data ................................................................................................ 255 DataType ........................................................................................ 255 FloatValue ...................................................................................... 255 IntValue........................................................................................... 255 Length ............................................................................................. 256 MonitorTag ..................................................................................... 256 NetworkVariable ............................................................................. 256 SourceNodeId ................................................................................. 257 SourceSubnetId .............................................................................. 258 StringValue ..................................................................................... 258

DetailInfo ...................................................................................................... 258 Methods ................................................................................................ 259 Properties .............................................................................................. 259

ClassId ............................................................................................ 259 ErrorLog .......................................................................................... 260 LostMessages ................................................................................ 260 MissedMessages ............................................................................ 261 ModelNumber ................................................................................. 261 Parent ............................................................................................. 262 ReceiveTxFull ................................................................................. 262 ResetCause .................................................................................... 263 State ............................................................................................... 264 TransactionTimeouts ...................................................................... 266 VersionNumber ............................................................................... 266 XmitErrors ....................................................................................... 266

DeviceTemplate ........................................................................................... 267 Methods ................................................................................................ 268

Import .............................................................................................. 268 ResyncToResources ...................................................................... 268

Properties .............................................................................................. 270 AppDevices .................................................................................... 270 BitmapFilePath ............................................................................... 271 ClassId ............................................................................................ 271 ComponentApps ............................................................................. 272 Description ...................................................................................... 272 DeviceClass .................................................................................... 273 DeviceSubclass .............................................................................. 273 DeviceValidation ............................................................................. 273 DynamicNvSupported .................................................................... 276 Extensions ...................................................................................... 277 Format ............................................................................................ 277 Handle ............................................................................................ 278 HostSelect ...................................................................................... 278 IconFilePath .................................................................................... 279 Interface .......................................................................................... 279 ManufacturerID ............................................................................... 280 ModelNo ......................................................................................... 280 Name .............................................................................................. 280 Parent ............................................................................................. 281 ProgramId ....................................................................................... 281 ProgramType .................................................................................. 282

OpenLNS Programmer’s Reference xi

RegisteredComponent ................................................................... 282 SelfDocConsistency ....................................................................... 283 SelfDocumentation ......................................................................... 285 UserTypeFileName......................................................................... 285 XifPath ............................................................................................ 286

DeviceTemplates ......................................................................................... 286 Methods ................................................................................................ 287

Add ................................................................................................. 287 ItemByHandle ................................................................................. 288 ItemByProgramID ........................................................................... 288 Remove .......................................................................................... 288


Error ............................................................................................................. 292 Methods ................................................................................................ 292 Properties .............................................................................................. 292

Category ......................................................................................... 293 ClassId ............................................................................................ 293 ConnErrAppDeviceHandle1 ........................................................... 294 ConnErrAppDeviceHandle2 ........................................................... 294 ConnErrIndex1 ............................................................................... 295 ConnErrIndex2 ............................................................................... 295 ConnErrIndexType1 ....................................................................... 296 ConnErrIndexType2 ....................................................................... 297 Description ...................................................................................... 298 ErrObjClassId ................................................................................. 298 ErrObjHandle .................................................................................. 300 Number ........................................................................................... 301 Parent ............................................................................................. 301

Extension ..................................................................................................... 302 Methods ................................................................................................ 302 Properties .............................................................................................. 302

ClassId ............................................................................................ 303 CopyWithParent ............................................................................. 303 Description ...................................................................................... 304 Extensions ...................................................................................... 304 Handle ............................................................................................ 305 Key .................................................................................................. 305 Owner ............................................................................................. 305 OwnerClassId ................................................................................. 306 Parent ............................................................................................. 306 Value1............................................................................................. 307 Value2............................................................................................. 308 Value3............................................................................................. 308

Extensions ................................................................................................... 309 Methods ................................................................................................ 310


Properties .............................................................................................. 311 ClassId ............................................................................................ 311 Count .............................................................................................. 312

OpenLNS Programmer’s Reference xii

Item ................................................................................................. 312 Parent ............................................................................................. 313 _NewEnum ..................................................................................... 313

FileTransfer ................................................................................................. 314 Methods ................................................................................................ 315

AddTarget ....................................................................................... 315 ClearTargets ................................................................................... 315 ReadFile ......................................................................................... 316 WriteFile ......................................................................................... 317

Properties .............................................................................................. 317 AuthenticationFlag .......................................................................... 318 ClassId ............................................................................................ 318 FileCount ........................................................................................ 319 FileIndex ......................................................................................... 320 FileInfo ............................................................................................ 321 FileSize ........................................................................................... 321 FileType .......................................................................................... 322 HostTimeout ................................................................................... 322 Parent ............................................................................................. 323 PriorityFlag ..................................................................................... 323 ReadBufferLength .......................................................................... 324 RetryCount ..................................................................................... 324 RxTimeOut ..................................................................................... 325 StartPosition ................................................................................... 325 TxTimeOut ...................................................................................... 326

FormatLocale ............................................................................................... 327 Methods ................................................................................................ 328 Properties .............................................................................................. 328

CategoryPreferenceList .................................................................. 329 ClassId ............................................................................................ 330 DateFormatSeparator ..................................................................... 331 DateFormatSeparatorSource ......................................................... 331 DecimalPointCharacter .................................................................. 333 DecimalPointCharacterSource ....................................................... 333 DoubleFloatPrecision ..................................................................... 335 FallbackFormat ............................................................................... 336 FloatPrecision ................................................................................. 337 LanguageId ..................................................................................... 338 LanguageIdSource ......................................................................... 339 ListSeparatorCharacter .................................................................. 341 ListSeparatorCharacterSource ....................................................... 341 MeasurementUnits ......................................................................... 343 MeasurementUnitsSource .............................................................. 344 Name .............................................................................................. 345 Parent ............................................................................................. 345 ShortDateFormat ............................................................................ 346 ShortDateFormatSource ................................................................ 347 ShortTimeFormat ............................................................................ 348 ShortTimeFormatSource ................................................................ 350 TimeFormatSeparator .................................................................... 351 TimeFormatSeparatorSource ......................................................... 352

FormatLocales ............................................................................................. 353 Methods ................................................................................................ 354

Add ................................................................................................. 354 Remove .......................................................................................... 355

Properties .............................................................................................. 356

OpenLNS Programmer’s Reference xiii


FormatSpec ................................................................................................. 359 Methods ................................................................................................ 360 Properties .............................................................................................. 360

AltFormatName .............................................................................. 361 AltFormatNamesCount ................................................................... 361 ClassId ............................................................................................ 362 FormatName ................................................................................... 362 FormatType .................................................................................... 364 Index ............................................................................................... 365 Parent ............................................................................................. 366 Precision ......................................................................................... 366 ProgramId ....................................................................................... 367 Scope.............................................................................................. 368 Units ................................................................................................ 370 UnitsAdder ...................................................................................... 370 UnitsMultiplier ................................................................................. 371

Interface ....................................................................................................... 371 Methods ................................................................................................ 373

AddCompatibleNv ........................................................................... 373 AddCompatibleNvEx ...................................................................... 374 AddComplementaryNv ................................................................... 375 AddComplementaryNvEx ............................................................... 376 AddNvFromString ........................................................................... 378 CreateTypeSpec ............................................................................. 378 DownloadConfigProperties ............................................................. 379 RemoveNv ...................................................................................... 385 UploadConfigProperties ................................................................. 385

Properties .............................................................................................. 387 ClassId ............................................................................................ 388 ConfigProperties ............................................................................. 388 ConfigPropertiesAvailable .............................................................. 389 CpByHandle ................................................................................... 390 DynamicLonMarkObjectCapacity ................................................... 391 DynamicMessageTags ................................................................... 392 LonMarkObjects ............................................................................. 392 MaxNvInUse ................................................................................... 393 MaxNvSupported ............................................................................ 393 MessageTags ................................................................................. 394 Name .............................................................................................. 394 NetworkVariables ........................................................................... 395 Parent ............................................................................................. 395 StaticNvCount ................................................................................. 396 SupportsDynamicNvsOnStaticLMOs ............................................. 396 Version ........................................................................................... 397

Interfaces ..................................................................................................... 398 Methods ................................................................................................ 398

Add ................................................................................................. 398 Remove .......................................................................................... 399

Properties .............................................................................................. 399 ClassId ............................................................................................ 399 Count .............................................................................................. 400

OpenLNS Programmer’s Reference xiv

Item ................................................................................................. 400 Parent ............................................................................................. 401 _NewEnum ..................................................................................... 401

LdrfLanguage .............................................................................................. 402 Methods ................................................................................................ 402 Properties .............................................................................................. 403

ClassId ............................................................................................ 403 Extension ........................................................................................ 403 LanguageCode ............................................................................... 405 LdrfId ............................................................................................... 406 Name .............................................................................................. 407 Parent ............................................................................................. 407

LdrfLanguages ............................................................................................. 408 Methods ................................................................................................ 408 Properties .............................................................................................. 408


LonMarkAlarm ............................................................................................. 411 Methods ................................................................................................ 412 Properties .............................................................................................. 412

AlarmType ...................................................................................... 412 ClassId ............................................................................................ 413 IndexToSNVT ................................................................................. 413 LimitValue ....................................................................................... 414 Location .......................................................................................... 414 ObjectId .......................................................................................... 415 Parent ............................................................................................. 415 PriorityLevel .................................................................................... 416 TimeStamp ..................................................................................... 416 Value ............................................................................................... 417

LonMarkObject (Functional Block) .............................................................. 417 Methods ................................................................................................ 418

AssignNetworkVariable .................................................................. 418 MoveToInterface ............................................................................. 419 UnassignNetworkVariable .............................................................. 421

Properties .............................................................................................. 421 AlarmFormat ................................................................................... 422 ClassId ............................................................................................ 423 ComponentApps ............................................................................. 424 ConfigProperties ............................................................................. 424 Description ...................................................................................... 425 Extensions ...................................................................................... 425 FuncProfileDescription ................................................................... 426 FuncProfileIsDerived ...................................................................... 426 FuncProfileName ............................................................................ 427 FuncProfileProgrammaticName ..................................................... 427 Index ............................................................................................... 427 IsDynamic ....................................................................................... 428 LonMarkAlarm ................................................................................ 428 Mode ............................................................................................... 429 Name .............................................................................................. 431 NetworkVariables ........................................................................... 431 Parent ............................................................................................. 431

OpenLNS Programmer’s Reference xv

ParentInterface ............................................................................... 432 PrincipalNv ..................................................................................... 433 ProgrammaticName........................................................................ 433 ReportMask .................................................................................... 434 Request .......................................................................................... 435 SelfTestResults .............................................................................. 437 Status .............................................................................................. 439 TypeIndex ....................................................................................... 440 TypeSpec ....................................................................................... 440

LonMarkObjects .......................................................................................... 441 Methods ................................................................................................ 441

Add ................................................................................................. 441 AddEx ............................................................................................. 443 AddFromTypeSpec ......................................................................... 443 ItemByIndex .................................................................................... 444 ItemByProgrammaticName ............................................................ 444 Remove .......................................................................................... 445 RemoveByIndex ............................................................................. 445


MessageTag ................................................................................................ 449 Methods ................................................................................................ 450

AddTarget ....................................................................................... 450 Connect .......................................................................................... 451 Disconnect ...................................................................................... 452

Properties .............................................................................................. 452 AddressTableIndex......................................................................... 453 AppDevice ...................................................................................... 454 AppDeviceName ............................................................................. 454 ClassId ............................................................................................ 454 ConnectDescTemplate ................................................................... 455 Direction ......................................................................................... 455 Index ............................................................................................... 456 IsDynamic ....................................................................................... 456 MtHubs ........................................................................................... 457 MtTargets ....................................................................................... 457 Name .............................................................................................. 458 Parent ............................................................................................. 458

MessageTags .............................................................................................. 459 Methods ................................................................................................ 459

Add ................................................................................................. 459 Remove .......................................................................................... 460


MonitorSet ................................................................................................... 464 Methods ................................................................................................ 466

Close............................................................................................... 466 Disable ............................................................................................ 466

OpenLNS Programmer’s Reference xvi

Enable............................................................................................. 467 Open ............................................................................................... 468

Properties .............................................................................................. 470 ClassId ............................................................................................ 470 IsEnabled ........................................................................................ 471 IsOpen ............................................................................................ 472 IsPollingEnabled ............................................................................. 472 MsgMonitorPoints ........................................................................... 473 MsgOptions .................................................................................... 473 Name .............................................................................................. 474 NvMonitorPoints ............................................................................. 475 NvOptions ....................................................................................... 475 Parent ............................................................................................. 476 Tag .................................................................................................. 477

MonitorSets ................................................................................................. 478 Methods ................................................................................................ 478

Add ................................................................................................. 478 Remove .......................................................................................... 479


MsgMonitorOptions ..................................................................................... 483 Methods ................................................................................................ 484 Properties .............................................................................................. 484

Authentication ................................................................................. 484 ClassId ............................................................................................ 484 FilterByCode ................................................................................... 485 FilterBySource ................................................................................ 486 FilterCode ....................................................................................... 486 Parent ............................................................................................. 487 Priority ............................................................................................. 487 Retries ............................................................................................ 488 ServiceType .................................................................................... 489 UseAsyncSend ............................................................................... 490

MsgMonitorPoint .......................................................................................... 493 Methods ................................................................................................ 493

Advise ............................................................................................. 494 Disable ............................................................................................ 494 Enable............................................................................................. 495 SendMsgWait ................................................................................. 496 Unadvise ......................................................................................... 496

Properties .............................................................................................. 497 ClassId ............................................................................................ 497 CurrentOptions ............................................................................... 498 DefaultOptions ................................................................................ 498 InputFormatSpec ............................................................................ 500 Name .............................................................................................. 500 OutputDataPoint ............................................................................. 501 OutputFromatSpec ......................................................................... 501 Parent ............................................................................................. 502 RequestDataPoint .......................................................................... 502 Tag .................................................................................................. 504

Events ................................................................................................... 505

OpenLNS Programmer’s Reference xvii

UpdateErrorEvent ........................................................................... 505 UpdateEvent ................................................................................... 505

MsgMonitorPoints ........................................................................................ 508 Methods ................................................................................................ 508

Add ................................................................................................. 508 Remove .......................................................................................... 510


Network........................................................................................................ 514 Methods ................................................................................................ 515

Backup ............................................................................................ 515 CancelValidation ............................................................................. 516 Close............................................................................................... 517 CloseIndependent .......................................................................... 517 CompactDb ..................................................................................... 517 CreateTemporaryMonitorSet .......................................................... 518 Open ............................................................................................... 518 OpenIndependent ........................................................................... 519 PreReplace ..................................................................................... 520 Replace .......................................................................................... 521 Validate ........................................................................................... 522

Properties .............................................................................................. 524 AllowPropagateModeDuringRemote .............................................. 525 BitmapFilePath ............................................................................... 526 Channels ........................................................................................ 527 ClassId ............................................................................................ 527 CurrentMonitorSets ........................................................................ 527 DatabasePath ................................................................................. 528 Description ...................................................................................... 529 EventInterval ................................................................................... 529 Extensions ...................................................................................... 530 Handle ............................................................................................ 531 IconFilePath .................................................................................... 531 IsOpen ............................................................................................ 532 IsOpenIndependent ........................................................................ 532 MyVNI ............................................................................................. 533 Name .............................................................................................. 533 NetworkServiceDevices ................................................................. 534 NsiTimeout ..................................................................................... 534 OriginalName .................................................................................. 535 Parent ............................................................................................. 535 RemoteNetworkName .................................................................... 536 ServerIdentifier ............................................................................... 537 Systems .......................................................................................... 538

Networks ...................................................................................................... 538 Methods ................................................................................................ 538

Add ................................................................................................. 539 RemoveEx ...................................................................................... 540

Properties .............................................................................................. 541 ClassId ............................................................................................ 542 Count .............................................................................................. 542 Item ................................................................................................. 543

OpenLNS Programmer’s Reference xviii

Parent ............................................................................................. 543 _NewEnum ..................................................................................... 544

NetworkInterface ......................................................................................... 544 Methods ................................................................................................ 545 Properties ....

openlns programmer's reference - echelon …...openlns programmer’s reference v detailinfo 74...

Documents