Echelon OpenLNS manuals

Owner’s manuals and user’s guides for Software Echelon OpenLNS.
We providing 1 pdf manuals Echelon OpenLNS for download free by document types: User Manual


Echelon OpenLNS User Manual (1081 pages)


Brand: Echelon | Category: Software | Size: 5.70 MB |

 

Table of contents

OpenLNS

1

Programmer's Reference

1

Chips or LonPoint Modules

2

Table of Contents

3

Preface

31

Purpose

32

Audience

32

System Requirements

32

ONWORKS/IP-852 Router

33

OpenLNS Documentation

34

Content

36

OpenLNS Object Server

38

Introduction

39

OpenLNS Object Hierarchy

41

Object Naming Convention

42

Objects

44

Account

45

ClassID

46

Accounts

47

ActivationLicense

51

ActivatedVersion

52

DeviceCapacity

53

DeviceCapacityConsumed

53

ExpirationDate

54

LicenseId

54

LicenseStatus

55

IsTrialLicense

55

MaxOpenSystems

56

RequiredVersion

56

RunTimeLimit

57

RunTimeRemaining

57

Aliases

60

CommussionEx

69

Decommission

70

GetMessagePoint

75

PropagateDeviceConfigUpdates

83

ReleasePendingUpdates

84

ResyncToTemplate

88

ONWORKS Interfaces

94

Upgrade

95

section in

97

Properties

100

AliasCapacity

101

AliasUseCount

102

AppImagePath

102

AttachmentStatus

103

AuthenticationEnabled

103

BitmapFilePath

105

Channel

105

ClassId

106

CommissionStatus

106

ConfigurationState

108

ConnectionUpdateType

109

Description

110

DetailInfo

111

Device Template

111

Extensions

111

HasBeenCommissioned

112

IconFilePath

113

InitialAuthenticationKey

113

Interface

114

LastTestInfo

115

LastUpgradeStatus

115

Location

116

LocationInNeuron

116

MonitorSets

117

NetworkServiceDevice

118

NeuronId

118

NodeId

119

NsiHandle

120

PingClass

122

Priority

123

ProgramId

124

SelfDocumentation

124

SubnetId

127

Subnets

127

Subsystems

128

UpgradeRequirement

128

AppDevices

129

Methods

130

AddReference

132

_NewEnum

136

Application

137

MajorAPIVersion

138

MajorVersion

138

BufferConfiguration

141

InputBufferCount

143

InputBufferSize

143

OutputBufferCount

144

OutputBufferSize

144

PriorityBufferCount

145

PriorityBufferSize

145

MaxPriority

152

RouterDevices

153

TransceiverId

154

Channels

156

ItemByHandle

158

FilterType

160

RefChannel 1

162

RefChannel 2

163

RefTransceiverType

163

ComponentApp

165

CommandID

166

ComponentClassID

167

DefaultAppFlag

169

ManufacturerID

170

ComponentApps

172

ConfigProperties

177

ConfigProperty

181

GetRawValuesEx

184

SetRawValuesEx

186

AppliesTo

188

AppliesToType

188

ByteLength

190

ConfigFileOffset

191

ConfigFileType

192

ConfigNv

193

ConfigNvIndex

194

ConstantAttribute

195

DeviceSpecificAttribute

197

Dimension

199

FlagsByte

199

FormatName

200

ONMARK resource files

202

FuncProfileDescription

203

FuncProfileName

203

FuncProfileProgrammaticName

204

ImplementationType

204

properties of the

205

Precision

208

TypeInherits

208

TypeIndex

209

ValueStatus

210

ConnectDescTemplate

211

AliasOptions

213

BroadcastOptions

213

PropertyOptions

217

ReceiveTimer

219

RepeatCount

220

RepeatTimer

221

RetryCount

223

ServiceType

224

TransmitTimer

225

UseAuthenticationFlag

226

UsePriorityFlag

227

ConnectDescTemplates

228

Connections

232

NetworkVariables

234

CreditInfo

235

DaysRemaining

236

DeficitCredits (Deprecated)

236

LicensedCredits (Deprecated)

237

LicenseType (Deprecated)

237

DatabaseValidationReport

238

ErrorSummaries

241

PassedValidation

242

RepairedErrors

242

TotalObjectsValidated

243

UnrepairedErrors

244

ErrorType

246

ObjectClassInvolved

249

ObjectInternalId

250

ObjectName

250

ParentObjectClass

252

ParentObjectInternalId

253

ParentObjectName

254

Repairable

254

RepairAttempted

256

Repaired

256

NumberOfInstances

266

ObjectDetailsAvailable

267

DataPoint

269

GetField

271

AutoRead

273

AutoWrite

274

FieldCount

275

FieldName

276

FormatSpec

277

FormattedValue

278

MaxValue

280

MessageCode

281

MinValue

282

RawValue

284

SourceIndex

285

SourceOptions

286

TypeName

288

DataValue

290

DataType

292

FloatValue

292

IntValue

292

MonitorTag

293

NetworkVariable

293

SourceNodeId

294

ErrorLog

297

LostMessages

297

MissedMessages

298

ModelNumber

298

ReceiveTxFull

299

ResetCause

300

TransactionTimeouts

303

VersionNumber

303

XmitErrors

303

DeviceTemplate

304

DeviceClass

310

DeviceSubclass

310

DeviceValidation

310

DynamicNvSupported

313

HostSelect

315

ProgramType

319

RegisteredComponent

319

SelfDocConsistency

320

UserTypeFileName

322

DeviceTemplates

323

Category

330

ConnErrAppDeviceHandle1

331

ConnErrAppDeviceHandle2

331

ConnErrIndex1

332

ConnErrIndex2

332

ConnErrIndexType1

333

ConnErrIndexType2

334

ErrObjClassId

335

ErrObjHandle

337

Extension

339

CopyWithParent

340

OwnerClassId

343

FileTransfer

351

ReadFile

353

AuthenticationFlag

355

FileCount

356

FileIndex

357

FileInfo

358

FileSize

358

FileType

359

HostTimeout

359

PriorityFlag

360

ReadBufferLength

361

RxTimeOut

362

StartPosition

362

TxTimeOut

363

FormatLocale

364

CategoryPreferenceList

366

DateFormatSeparator

368

DateFormatSeparatorSource

368

DecimalPointCharacter

370

DecimalPointCharacterSource

370

DoubleFloatPrecision

372

FallbackFormat

373

FloatPrecision

374

LanguageId

375

LanguageIdSource

376

ListSeparatorCharacter

378

ListSeparatorCharacterSource

378

MeasurementUnits

380

MeasurementUnitsSource

381

ShortDateFormat

383

ShortDateFormatSource

384

ShortTimeFormat

385

ShortTimeFormatSource

387

TimeFormatSeparator

388

TimeFormatSeparatorSource

389

FormatLocales

390

AltFormatName

398

AltFormatNamesCount

398

FormatType

401

UnitsAdder

407

AddCompatibleNvEx

411

AddComplementaryNv

412

AddComplementaryNvEx

413

AddNvFromString

415

CreateTypeSpec

415

DownloadConfigProperties

416

RemoveNv

422

UploadConfigProperties

422

ConfigPropertiesAvailable

426

CpByHandle

427

DynamicLonMarkObjectCapacity

428

DynamicMessageTags

429

LonMarkObjects

429

MaxNvInUse

430

MaxNvSupported

430

MessageTags

431

StaticNvCount

433

Version

434

LdrfLanguage

439

LanguageCode

442

LdrfLanguages

445

LonMarkAlarm

448

IndexToSNVT

450

LimitValue

451

ObjectId

452

PriorityLevel

453

TimeStamp

453

MoveToInterface

456

AlarmFormat

459

FuncProfileIsDerived

463

IsDynamic

465

ParentInterface

469

PrincipalNv

470

ProgrammaticName

470

ReportMask

471

Request

472

SelfTestResults

474

TypeSpec

477

AddFromTypeSpec

480

ItemByIndex

481

ItemByProgrammaticName

481

RemoveByIndex

482

MessageTag

486

Connect

488

AddressTableIndex

490

Direction

492

MtTargets

494

MonitorSet

501

IsEnabled

508

IsPollingEnabled

509

MsgMonitorPoints

510

MsgOptions

510

NvMonitorPoints

512

NvOptions

512

MsgMonitorOptions

520

FilterByCode

522

FilterBySource

523

FilterCode

523

Retries

525

UseAsyncSend

527

MsgMonitorPoint

530

Disable

531

SendMsgWait

533

Unadvise

533

CurrentOptions

535

DefaultOptions

535

InputFormatSpec

537

OutputDataPoint

538

OutputFromatSpec

538

RequestDataPoint

539

Events

542

Network

551

CancelValidation

553

CreateTemporaryMonitorSet

555

OpenIndependent

556

PreReplace

557

Replace

558

Validate

559

CurrentMonitorSets

564

DatabasePath

565

EventInterval

566

IsOpenIndependent

569

NetworkServiceDevices

571

NsiTimeout

571

OriginalName

572

RemoteNetworkName

573

ServerIdentifier

574

Networks

575

RemoveEx

577

NetworkInterface

581

NetworkInterfaces

584

NetworkResources

587

ExclusiveSelectorPoolSize

589

ExclusiveSelectorsAvailable

590

GroupIdsAllocated

591

RouterCount

592

SharableSelectorPoolSize

592

DefaultApplication

597

LcaNsdType

600

MipIsLayer2

600

NetworkInterfaceFlag

602

NodeHandle

602

NsiNodeId

603

NsiSubnetId

604

NssFlag

604

AddTarget

612

Disconnect

614

DsRestoreOptions

614

DsSaveOptions

615

GetDataPoint

615

AppDevice

619

AppDeviceName

620

AuthenticationConfigFlag

620

ChangeableTypeSupport

621

ConfigClassFlag

624

DsFormatType

627

DsIsDefaultFormat

631

DsPollInterval

632

DsPriority

634

EstimatedMaxRate

634

EstimatedRate

635

ImplementsCp

637

IsConfigProperty

638

IsPolled

639

LmNumberManufacturerAssigned

641

LonMarkMemberIndex

641

LonMarkMemberNumber

642

LonMarkObjectNumber

643

MaxLength

643

NvTargets

645

OfflineFlag

646

PriorityConfigFlag

648

Selector

650

ServiceTypeConfigFlag

652

SnvtTypeIsModifiable

653

SyncFlag

654

NvMonitorOptions

665

Authentication

667

GenerateInitialFetch

668

PollInterval

669

ReportByException

671

ResetPollingIfUpdated

672

SuppressPollingIfBound

676

ThrottleInterval

677

UseBoundUpdates

680

NvMonitorPoint

681

UpdateErrorEvent

691

ObjectServer

699

AcceptIncomingSession

702

BeginIncomingSessionEvents

703

CompactDb

705

EndIncomingSessionEvents

705

ExtensionByHandle

706

RebuildLdrfCatalog

708

SetCustomerInfo

708

ActiveRemoteNI

711

CausesValidation

712

Container

713

CurrentFormatLocale

713

DragIcon

714

DragMode

714

LdrfCatalogPath

720

RemoteFlag

723

RemoteNetworks

724

ResourceLanguageId

725

Visible

727

VNINetworks

727

DragDrop

729

DragOver

729

GotFocus

729

LostFocus

729

OnAttachmentEvent

729

OnChangeEvent

731

OnCommission

733

OnDbConversionEvent

735

OnDbValidationEvent

736

OnIncomingSessionEvent

737

OnLonMarkObjectStatusChange

738

OnMissedEvent

739

OnMsgMonitorPointErrorEvent

739

OnMsgMonitorPointEvent

742

OnMsgMonitorPointUpdateEvent

744

OnNetworkVariableUpdate

746

OnNodeConnChangeEvent

747

OnNodeIntfChangeEvent

749

OnNvMonitorPointErrorEvent

754

OnNvMonitorPointEvent

756

OnNvMonitorPointUpdateEvent

759

OnNVUpdateError

759

OnSessionChangeEvent

759

OnSystemMgmtModeChangeEvent

761

OnSystemNssIdle

762

OnSystemServicePin

763

ObjectStatus

764

AlarmNotifyDisabled

766

CommFailure

768

Disabled

769

ElectricalFault

770

FailSelfTest

771

FeedbackFailure

772

InAlarm

773

InOverride

774

InvalidId

775

InvalidRequest

775

LockedOut

776

ManualControl

777

MechanicalFault

778

OpenCircuit

779

OutOfLimits

780

OutOfService

781

OverRange

782

ProgrammingFail

783

ProgrammingMode

784

ResetComplete

786

SelfTestInProgress

787

Summary

788

UnableToMeasure

789

UnderRange

790

PingIntervals

791

MobileClassPingInterval

792

PermanentClassPingInterval

793

StationaryClassPingInterval

794

TemporaryClassPingInterval

794

RecoveryStatus

795

CurrentPhaseNumber

797

ItemsInPhase

797

NumbersPhases

798

PhaseType

798

ProgressIndicator

799

ProgressIndicatorType

800

TotalAppDevices

801

TotalChannels

801

TotalConnections

802

TotalNvMts

802

TotalRouters

803

CommissionEx

805

PostMove

808

PreMove

808

ReplaceEx

810

FarSide

823

NearSide

826

Routers

830

ItemByNeuronID

835

RouterSide

839

PendingNeuronId

844

ServiceStatus

849

QueuePosition

851

ResourceType

851

SourceAddress

853

DomainId

854

Subsystem

866

BeginChangeEvent

882

BeginCommissionEvent

882

BeginMissedEvent

883

BeginServicePinEvent

885

BeginSession

885

CancelTransaction

887

CommittTransaction

888

DeconfigNetwork

888

DiscoverDevices

891

DoEventSync

893

DoRestoreOptions

894

EndAttachmentEvent

895

EndChangeEvent

895

EndSession

898

EndSystemMgmtModeChangeEvent

898

GetPermission

899

GetProgramId

900

PrepareToRecoverFromNetwork

901

RecoverFromNetwork

903

RetryUpdates

905

SetEventSyncMode

906

StartTransaction

908

ApplicationHandle

911

ApplicationName

912

AuthenticationKey

912

ClientId

914

CommissionedDeviceCount

914

CurrentAccount

915

DiscoveryInterval

917

DiscoveryLimitedFlag

918

DsRepeatTimer

922

DsRetries

923

DsRetryCount

924

DsTxTimer

925

HostTimer

927

ImportDirectory

928

InstallOptions

928

LastError

930

LaunchLcaServerFlag

931

MgmtMode

933

NssDbVersion

936

PermissionString

937

RegisterServicePin

939

RemoteChannel

940

SecurityLevel

944

TemplateLibrary

948

TxTimer

949

UncommissionedDeviceCount

950

UninstalledDeviceCount

951

UpdateInterval

952

Systems

953

TestInfo

959

ActualDomainId

960

ActualNeuronId

960

ActualNodeId

961

ActualProgramId

961

ActualSubnetId

962

AuxResultData

962

ExpectedDomainId

964

ExpectedNeuronId

965

ExpectedNodeId

965

ExpectedProgramId

966

ExpectedSubnetId

966

IsDetailInfoValid

967

IsComplete

975

ObjectType

977

UpgradeInfo

981

FromIndex

983

FromOwnerIndex

984

ToIndex

990

ToOwnerIndex

990

UpgradeInfos

991

UpgradeStatus

994

Sequence

997

UprgradeInfos

997

Interfaces

1000

ILcaMsgMonitorPointListener

1001

UpdateEvent

1002

ILcaNvMonitorPointListener

1003

ILcaProgressListener

1005

OpenLNS Errors

1008

Network Services Errors

1009

Network Interface Errors

1030

Connection Errors

1033

Object Server Errors

1038

ONWORKS

1043

ONWORKS\Bin folder

1046

Data Server Errors

1050

Formatter Errors

1058

VNI Errors

1062

Appendix A

1070

Deprecated Items

1070

Deprecated Objects

1072

Deprecated Methods

1073

Deprecated Properties

1075

Deprecated Events

1080





More products and manuals for Software Echelon

Models Document Type
OpenLNS Server License User Manual   Echelon OpenLNS Server License User Manual, 24 pages
LonTal Stack User Manual   Echelon LonTal Stack User Manual, 247 pages
OpenLNS Commissioning Tool User Manual   Echelon OpenLNS Commissioning Tool User Manual, 393 pages
LonWorks Network XML User Manual   Echelon LonWorks Network XML User Manual, 74 pages
Neuron Field Compiler User Manual   Echelon Neuron Field Compiler User Manual, 27 pages
OpenLDV User Manual   Echelon OpenLDV User Manual, 194 pages
LonScanner FX Protocol Analyzer User Manual   Echelon LonScanner FX Protocol Analyzer User Manual, 75 pages
LNS Plug-in User Manual   Echelon LNS Plug-in User Manual, 69 pages
LonBridg Server User Manual   Echelon LonBridg Server User Manual, 67 pages
FT 5000 EVB User Manual   Echelon FT 5000 EVB User Manual, 36 pages
Mini FX User Manual   Echelon Mini FX User Manual, 139 pages
Mini FX/PL Examples User Manual   Echelon Mini FX/PL Examples User Manual, 23 pages
NodeBuilder FX User Manual   Echelon NodeBuilder FX User Manual, 300 pages
NodeBuilder FX/PL Examples User Manual   Echelon NodeBuilder FX/PL Examples User Manual, 43 pages
NodeBuilder Resource Editor User Manual   Echelon NodeBuilder Resource Editor User Manual, 90 pages
LonMaker User Manual   Echelon LonMaker User Manual, 423 pages
Mini EVK PL-20N User Manual   Echelon Mini EVK PL-20N User Manual, 2 pages
Mini EVK User Manual   Echelon Mini EVK User Manual, 98 pages
Mini EVK FT User Manual   Echelon Mini EVK FT User Manual, 2 pages
LNS User Manual   Echelon LNS User Manual, 368 pages