Options
All
  • Public
  • Public/Protected
  • All
Menu

Module node-opcua

  subscribe now with sterfive to access the online-user manual

Index

Enumerations

Classes

Interfaces

Type aliases

Events

Variables

Functions

Type aliases

AccessLevelString

AccessLevelString: string

AddStateVariableOptionals

AddStateVariableOptionals: "EffectiveDisplayName" | "Name" | "Number" | string

AddTwoStateVariableOptionals

AddTwoStateVariableOptionals: AddStateVariableOptionals | "TransitionTime" | "EffectiveTransitionTime" | "TrueState" | "FalseState"

BindVariableOptions

BindVariableOptions: BindVariableOptionsVariation1 | BindVariableOptionsVariation2 | BindVariableOptionsVariation3

BrowseDescriptionLike

BrowseDescriptionLike: string | BrowseDescriptionOptions

Byte

Byte: UInt8

ByteString

ByteString: Buffer

CallMethodRequestLike

CallMethodRequestLike: CallMethodRequestOptions

Callback

Callback<T>: (err: Error | null, result?: T) => void

Type parameters

  • T

Type declaration

    • (err: Error | null, result?: T): void

    • Parameters

      • err: Error | null
      • Optional result: T

      Returns void

Callback2

Callback2<T>: (err: Error | null, result?: T) => void

Type parameters

  • T

Type declaration

    • (err: Error | null, result?: T): void

    • Parameters

      • err: Error | null
      • Optional result: T

      Returns void

CallbackT

CallbackT<T>: (err: Error | null, result?: T) => void

Type parameters

  • T

Type declaration

    • (err: Error | null, result?: T): void

    • Parameters

      • err: Error | null
      • Optional result: T

      Returns void

CallbackWithData

CallbackWithData: CallbackT<Buffer>

CharArray

CharArray: string

ClientHandle

ClientHandle: number

ClosingReason

ClosingReason: "Timeout" | "Terminated" | "CloseSession" | "Forcing"

ConstructorFunc

ConstructorFunc: (...args: any[]) => BaseUAObject

Type declaration

    • (...args: any[]): BaseUAObject

    • Parameters

      • Rest ...args: any[]

      Returns BaseUAObject

ContinuationPoint

ContinuationPoint: Buffer

Counter

Counter: number

CreateMonitoredItemHook

CreateMonitoredItemHook: (subscription: Subscription, monitoredItem: MonitoredItemBase) => Promise<StatusCode>

Type declaration

CreateMonitoredItemsRequestLike

CreateMonitoredItemsRequestLike: CreateMonitoredItemsRequestOptions

CreateNodeOptions

CreateNodeOptions: any

CreateSecureChannelCallbackFunc

CreateSecureChannelCallbackFunc: (err: Error | null, secureChannel?: ClientSecureChannelLayer) => void

Type declaration

CreateSubscriptionRequestLike

CreateSubscriptionRequestLike: CreateSubscriptionRequestOptions

DataValueCallback

DataValueCallback: (err: Error | null, dataValue?: DataValue) => void

Type declaration

    • (err: Error | null, dataValue?: DataValue): void

    • Parameters

      • err: Error | null
      • Optional dataValue: DataValue

      Returns void

DataValueLike

DataValueLike: DataValueOptions | DataValue

DateTime

DateTime: Date | DateWithPicoseconds | null

DeleteMonitoredItemHook

DeleteMonitoredItemHook: (subscription: Subscription, monitoredItem: MonitoredItemBase) => Promise<StatusCode>

Type declaration

DeleteMonitoredItemsRequestLike

DeleteMonitoredItemsRequestLike: DeleteMonitoredItemsRequestOptions

DeleteSubscriptionsRequestLike

DeleteSubscriptionsRequestLike: DeleteSubscriptionsRequestOptions

Double

Double: number

Duration

Duration: number

ErrorCallback

ErrorCallback: (err?: Error) => void

Type declaration

    • (err?: Error): void

    • Parameters

      • Optional err: Error

      Returns void

EventTypeLike

EventTypeLike: string | NodeId | UAEventType

FindEndpointCallback

FindEndpointCallback: (err: Error | null, result?: FindEndpointResult) => void

Type declaration

FindServersOnNetworkRequestLike

FindServersOnNetworkRequestLike: FindServersOnNetworkRequestOptions

FindServersRequestLike

FindServersRequestLike: FindServersRequestOptions

Float

Float: number

FolderType

FolderType: UAObjectType

Guid

Guid: string

IHistoricalDataNodeOptions

IHistoricalDataNodeOptions: IVariableHistorianOptions | { historian: IVariableHistorian }

Int16

Int16: number

Int32

Int32: number

Int64

Int64: UInt32[]

Int8

Int8: number

LocaleId

LocaleId: UAString

LocalizedTextLike

LocalizedTextLike: LocalizedTextOptions | string

MethodFunctor

MethodFunctor: (this: UAMethod, inputArguments: Variant[], context: SessionContext, callback: MethodFunctorCallback) => void

Type declaration

MethodFunctorCallback

MethodFunctorCallback: (err: Error | null, callMethodResult: CallMethodResultOptions) => void

Type declaration

MethodId

MethodId: NodeIdLike

ModellingRuleType

ModellingRuleType: "Mandatory" | "Optional" | "MandatoryPlaceholder" | "OptionalPlaceholder" | "ExposesItsArray" | null

ModifyMonitoredItemsRequestLike

ModifyMonitoredItemsRequestLike: ModifyMonitoredItemsRequestOptions

ModifySubscriptionRequestLike

ModifySubscriptionRequestLike: ModifySubscriptionRequestOptions

NodeIdLike

NodeIdLike: string | NodeId | number

NodeIdLikeOrWithNodeId

NodeIdLikeOrWithNodeId: NodeIdLike | { nodeId: NodeId }

Notification

Notification: DataChangeNotification | EventNotificationList | StatusChangeNotification

NumberType

NumberType: number | number[]

PseudoVariant

PseudoVariant: PseudoVariantNull | PseudoVariantString | PseudoVariantBoolean | PseudoVariantNodeId | PseudoVariantDateTime | PseudoVariantByteString | PseudoVariantDuration | PseudoVariantLocalizedText | PseudoVariantStatusCode | PseudoVariantNumber | PseudoVariantExtensionObject | PseudoVariantExtensionObjectArray

PseudoVariantNumber

PseudoVariantNumber: PseudoVariantUInt32 | PseudoVariantUInt16 | PseudoVariantByte | PseudoVariantInt32 | PseudoVariantInt16 | PseudoVariantSByte | PseudoVariantDouble | PseudoVariantFloat

QualifiedNameLike

QualifiedNameLike: QualifiedNameOptions | string

QueryFirstRequestLike

QueryFirstRequestLike: QueryFirstRequestOptions

QueueItem

QueueItem: MonitoredItemNotification | EventFieldList

Request

Request: RequestB | CloseSecureChannelRequest

Response

Response: ResponseB | ServiceFault

ResponseCallback

ResponseCallback<T>: (err: Error | null, response?: T) => void

Type parameters

  • T

Type declaration

    • (err: Error | null, response?: T): void

    • Parameters

      • err: Error | null
      • Optional response: T

      Returns void

SByte

SByte: Int8

SecurityHeader

SecurityHeader: AsymmetricAlgorithmSecurityHeader | SymmetricAlgorithmSecurityHeader

SetMonitoringModeRequestLike

SetMonitoringModeRequestLike: SetMonitoringModeRequestOptions

StatusCodeCallback

StatusCodeCallback: CallbackT<StatusCode>

StringGetter

StringGetter: () => string

Type declaration

    • (): string

    • Returns string

SubscriptionId

SubscriptionId: number

TransferSubscriptionsRequestLike

TransferSubscriptionsRequestLike: TransferSubscriptionsRequestOptions

TransitionSelector

TransitionSelector: (transitions: Transition[], fromState: State, toState: State) => Transition | null

Type declaration

UABaseEventType

UABaseEventType: UAObjectType

UABoolean

UABoolean: boolean

UAClonable

UAClonable: UAObject | UAVariable | UAMethod

UAString

UAString: string | null

UInt16

UInt16: number

UInt32

UInt32: number

UInt64

UInt64: UInt32[]

UInt8

UInt8: number

UserIdentityInfo

UserIdentityInfo: AnonymousIdentity | UserIdentityInfoX509 | UserIdentityInfoUserName

UtcTime

UtcTime: DateTime

ValidUserAsyncFunc

ValidUserAsyncFunc: (this: ServerSession, username: string, password: string, callback: (err: Error | null, isAuthorized?: boolean) => void) => void

Type declaration

    • (this: ServerSession, username: string, password: string, callback: (err: Error | null, isAuthorized?: boolean) => void): void

    • Parameters

      • this: ServerSession
      • username: string
      • password: string
      • callback: (err: Error | null, isAuthorized?: boolean) => void
          • (err: Error | null, isAuthorized?: boolean): void

          • Parameters

            • err: Error | null
            • Optional isAuthorized: boolean

            Returns void

      Returns void

ValidUserFunc

ValidUserFunc: (this: ServerSession, username: string, password: string) => boolean

Type declaration

    • (this: ServerSession, username: string, password: string): boolean

    • Parameters

      Returns boolean

VariableDataValueGetterAsync

VariableDataValueGetterAsync: (callback: DataValueCallback) => void

Type declaration

VariableDataValueGetterSync

VariableDataValueGetterSync: () => DataValue

Type declaration

VariableDataValueSetterWithCallback

VariableDataValueSetterWithCallback: (dataValue: DataValue, callback: StatusCodeCallback) => void

Type declaration

VariableSetter

VariableSetter: VariableSetterVariation1 | VariableSetterVariation2

VariableSetterVariation1

VariableSetterVariation1: (this: UAVariable, value: Variant) => StatusCode

Type declaration

VariableSetterVariation2

VariableSetterVariation2: (this: UAVariable, value: Variant, callback: (err: Error | null, statusCode: StatusCode) => void) => void

Type declaration

VariantByteString

VariantByteString: VariantT<Buffer, ByteString>

VariantDouble

VariantDouble: VariantT<number, Double>

VariantLike

VariantLike: VariantOptions

VerifyBufferFunc

VerifyBufferFunc: (chunk: Buffer) => boolean

Type declaration

    • (chunk: Buffer): boolean

    • Parameters

      • chunk: Buffer

      Returns boolean

WithSessionFunc

WithSessionFunc: (session: ClientSession) => Promise<void>

Type declaration

WithSessionFuncP

WithSessionFuncP<T>: (session: ClientSession) => Promise<T>

Type parameters

  • T

Type declaration

WithSubscriptionFunc

WithSubscriptionFunc: (session: ClientSession, subscription: ClientSubscription) => Promise<void>

Type declaration

WithSubscriptionFuncP

WithSubscriptionFuncP<T>: (session: ClientSession, subscription: ClientSubscription) => Promise<T>

Type parameters

  • T

Type declaration

XmlLoaderFunc

XmlLoaderFunc: (nodeset2xmlUri: string, callback: CallbackT<string>) => void

Type declaration

    • (nodeset2xmlUri: string, callback: CallbackT<string>): void

    • Parameters

      • nodeset2xmlUri: string
      • callback: CallbackT<string>

      Returns void

Events

RegisterServerManager

RegisterServerManager:

RegisterServerManager is responsible to Register an opcua server on a LDS or LDS-ME server This class takes in charge :

  • the initial registration of a server
  • the regular registration renewal (every 8 minutes or so ...)
  • dealing with cases where LDS is not up and running when server starts. ( in this case the connection will be continuously attempted using the infinite back-off strategy
  • the un-registration of the server ( during shutdown for instance)

Events:

Emitted when the server is trying to registered the LDS but when the connection to the lds has failed serverRegistrationPending is sent when the backoff signal of the connection process is rained

param
param
param

constructor

discoveryServerEndpointUrl

discoveryServerEndpointUrl: string

timeout

timeout: number

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

_emitEvent

  • _emitEvent(eventName: string): void

  • Parameters

    • eventName: string

    Returns void

_establish_initial_connection

  • _establish_initial_connection(outer_callback: ErrorCallback): void

  • Parameters

    Returns void

_setState

  • Parameters

    Returns void

_trigger_next

  • _trigger_next(): void

  • Returns void

addListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RegisterServerManager

dispose

  • dispose(): void

  • Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RegisterServerManager

on

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RegisterServerManager

once

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RegisterServerManager

prependListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RegisterServerManager

prependOnceListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RegisterServerManager

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns RegisterServerManager

removeListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RegisterServerManager

setMaxListeners

start

  • Parameters

    Returns void

stop

  • Parameters

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Variables

Const NamespaceOptions

NamespaceOptions: { nodeIdNameSeparator: string }

Type declaration

  • nodeIdNameSeparator: string

Const _enumerationBrowseDirection

_enumerationBrowseDirection: Enum

Const _enumerationDataType

_enumerationDataType: Enum

Const _enumerationMessageSecurityMode

_enumerationMessageSecurityMode: Enum

Const _enumerationResultMask

_enumerationResultMask: Enum

Const _enumerationTimestampsToReturn

_enumerationTimestampsToReturn: Enum

Const attributeNameById

attributeNameById: {}

Type declaration

  • [key: string]: OpenMode

Const crypto_utils

crypto_utils: typeof crypto_util1

Const emptyGuid

emptyGuid: "00000000-0000-0000-0000-000000000000" = "00000000-0000-0000-0000-000000000000"

Const extraStatusCodeBits

extraStatusCodeBits: {}

StatusCode Special bits

Type declaration

  • [key: string]: number

Const minOPCUADate

minOPCUADate: Date

Const nodesets

nodesets: { adi: string; autoId: string; cnc: string; commercialKitchenEquipment: string; di: string; gds: string; machineTool: string; machineVision: string; machinery: string; packML: string; robotics: string; standard: string }

Type declaration

  • adi: string
  • autoId: string
  • cnc: string
  • commercialKitchenEquipment: string
  • di: string
  • gds: string
  • machineTool: string
  • machineVision: string
  • machinery: string
  • packML: string
  • robotics: string
  • standard: string

Const offsetFactor1601

offsetFactor1601: number[]

Const periodicClockAdjustment

periodicClockAdjustment: { adjustmentCount: number; interval: number; timerInstallationCount: number }

Type declaration

  • adjustmentCount: number
  • interval: number
  • timerInstallationCount: number

Const requestHandleNotSetValue

requestHandleNotSetValue: 3735928559 = 3735928559

Const schemaBrowseDirection

schemaBrowseDirection: { enumValues: typeof BrowseDirection; name: string }

Type declaration

Const schemaDiagnosticInfo

schemaDiagnosticInfo: StructuredTypeSchema

Const schemaEnumNodeClass

schemaEnumNodeClass: { documentation: string; enumValues: typeof NodeClass; name: string }

Type declaration

  • documentation: string
  • enumValues: typeof NodeClass
  • name: string

Const schemaQualifiedName

schemaQualifiedName: StructuredTypeSchema

Const schemaResultMask

schemaResultMask: { enumValues: typeof ResultMask; name: string }

Type declaration

Const schemaSessionAuthenticationToken

schemaSessionAuthenticationToken: { name: string; subType: string }

Type declaration

  • name: string
  • subType: string

Const schemaTimestampsToReturn

schemaTimestampsToReturn: { enumValues: typeof TimestampsToReturn; name: string }

Type declaration

Const serverCapabilities

serverCapabilities: string[]

Const standardUnits

standardUnits: StandardUnits

Const utils

utils: typeof utils1

Functions

__checkWhereClause

  • Parameters

    Returns boolean

_announceServerOnMulticastSubnet

  • _announceServerOnMulticastSubnet(multicastDNS: bonjour.Bonjour, options: Announcement): Promise<bonjour.Service>

  • Parameters

    Returns Promise<bonjour.Service>

_findGoodDataValueAfter

  • _findGoodDataValueAfter(dataValues: DataValue[], index: number, bTreatUncertainAsBad: boolean): DataValueWithIndex

  • Parameters

    • dataValues: DataValue[]
    • index: number
    • bTreatUncertainAsBad: boolean

    Returns DataValueWithIndex

_findGoodDataValueBefore

  • _findGoodDataValueBefore(dataValues: DataValue[], index: number, bTreatUncertainAsBad: boolean): DataValueWithIndex

  • Parameters

    • dataValues: DataValue[]
    • index: number
    • bTreatUncertainAsBad: boolean

    Returns DataValueWithIndex

accessLevelFlagToString

  • Parameters

    Returns string

acknowledgeCondition

  • Parameters

    Returns Promise<StatusCode>

acknwoledgeAllConditions

  • acknwoledgeAllConditions(session: ClientSession, message: string): Promise<void>

  • Parameters

    Returns Promise<void>

acquireBonjour

  • acquireBonjour(): bonjour.Bonjour

  • Returns bonjour.Bonjour

addAggregateSupport

  • Parameters

    Returns void

addElement

adjustBrowseDirection

adjustProcessingOptions

adjustVariant

  • Parameters

    Returns Variant

apply_timestamps

apply_timestamps_no_copy

assert

  • assert(cond: boolean | object | null | undefined | func, message?: string): void

  • Parameters

    • cond: boolean | object | null | undefined | func
    • Optional message: string

    Returns void

asymmetricVerifyChunk

  • asymmetricVerifyChunk(self: CryptoFactory, chunk: Buffer, certificate: Certificate): boolean

  • Parameters

    Returns boolean

binaryStoreSize_ArgumentList

  • binaryStoreSize_ArgumentList(description: any, args: any): number

  • Parameters

    • description: any
    • args: any

    Returns number

bindExtObjArrayNode

bn_dateToHundredNanoSecondFrom1601

  • bn_dateToHundredNanoSecondFrom1601(date: Date, picoseconds: number): any

  • Parameters

    • date: Date
    • picoseconds: number

      : represent the portion of the date that cannot be managed by the javascript Date object

    Returns any

bn_dateToHundredNanoSecondFrom1601Excess

  • bn_dateToHundredNanoSecondFrom1601Excess(date: Date, picoseconds: number): number

  • Parameters

    • date: Date
    • picoseconds: number

    Returns number

bn_hundredNanoSecondFrom1601ToDate

  • bn_hundredNanoSecondFrom1601ToDate(high: number, low: number, picoseconds?: number, _value?: Date | null): DateWithPicoseconds

  • Parameters

    • high: number
    • low: number
    • Optional picoseconds: number
    • Optional _value: Date | null

    Returns DateWithPicoseconds

browseAll

  • Parameters

    Returns Promise<BrowseResult>

  • Parameters

    Returns Promise<BrowseResult[]>

buffer_ellipsis

  • buffer_ellipsis(buffer: Buffer, start?: number, end?: number): string

  • Parameters

    • buffer: Buffer
    • Optional start: number
    • Optional end: number

    Returns string

buildVariantArray

  • buildVariantArray(dataType: DataType, nbElements: number, defaultValue: any): any[] | Uint8Array | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array

  • Parameters

    • dataType: DataType
    • nbElements: number
    • defaultValue: any

    Returns any[] | Uint8Array | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array

build_address_space_for_conformance_testing

  • build_address_space_for_conformance_testing(addressSpace: AddressSpace, options: any): void

  • Parameters

    Returns void

build_retrieveInputArgumentsDefinition

calculateIntervalMaxValue

calculateIntervalMinValue

callConditionRefresh

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns void

callMethodHelper

capitalizeFirstLetter

  • capitalizeFirstLetter(str: string): string

  • Parameters

    • str: string

    Returns string

checkSelectClause

  • method

    checkSelectClause

    Parameters

    Returns StatusCode

checkSelectClauses

  • method

    checkSelectClauses

    Parameters

    Returns StatusCode[]

    an array of StatusCode

checkWhereClause

check_flag

  • check_flag(value: number, mask: number | { value: number }): boolean

  • check if a set of bits are set in the values

    method

    check_flag

    Parameters

    • value: number
    • mask: number | { value: number }

    Returns boolean

chooseSecurityHeader

  • Parameters

    • msgType: string

    Returns SecurityHeader

Const coerceAccessLevelFlag

  • Parameters

    • str: string | number | null

    Returns AccessLevelFlag

coerceBoolean

  • coerceBoolean(value: string): boolean

  • Parameters

    • value: string

    Returns boolean

coerceByte

  • coerceByte(value: number | string | null): UInt8

  • Parameters

    • value: number | string | null

    Returns UInt8

coerceByteString

  • coerceByteString(value: number[] | string | ByteString): ByteString

  • Parameters

    • value: number[] | string | ByteString

    Returns ByteString

coerceClock

  • Parameters

    Returns PreciseClock

coerceConnectionStrategy

coerceDateTime

  • coerceDateTime(value: any): Date

  • Parameters

    • value: any

    Returns Date

coerceDouble

  • coerceDouble(value: number | null | string): Double

  • Parameters

    • value: number | null | string

    Returns Double

coerceExpandedNodeId

  • Parameters

    • value: any

    Returns ExpandedNodeId

coerceFloat

  • coerceFloat(value: number | null | string): Float

  • Parameters

    • value: number | null | string

    Returns Float

coerceInt16

  • coerceInt16(value: number | string | null): Int16

  • Parameters

    • value: number | string | null

    Returns Int16

coerceInt32

  • Parameters

    Returns Int32

Const coerceInt64

  • Parameters

    Returns UInt64

coerceInt8

  • coerceInt8(value: number | string | null): Int8

  • Parameters

    • value: number | string | null

    Returns Int8

coerceLocalizedText

coerceMessageSecurityMode

  • Parameters

    • Optional value: number | string

    Returns MessageSecurityMode

coerceNodeId

  • coerceNodeId(value: any, namespace?: number): NodeId

  • Convert a value into a nodeId:

    method

    coerceNodeId

    static
    description:
    • if nodeId is a string of form : "i=1234" => nodeId({value=1234, identifierType: NodeIdType.NUMERIC})
    • if nodeId is a string of form : "s=foo" => nodeId({value="foo", identifierType: NodeIdType.STRING})
    • if nodeId is a NodeId : coerceNodeId returns value

    Parameters

    • value: any
    • Optional namespace: number

    Returns NodeId

coerceQualifiedName

  • Parameters

    • value: null

    Returns null

  • Parameters

    Returns QualifiedName

  • Parameters

    • value: string

    Returns QualifiedName

coerceSByte

  • coerceSByte(value: number | string | null): Int8

  • Parameters

    • value: number | string | null

    Returns Int8

coerceSecurityPolicy

  • Parameters

    • Optional value: any

    Returns SecurityPolicy

coerceStatusCode

  • Parameters

    • statusCode: any

    Returns StatusCode

coerceTimestampsToReturn

  • Parameters

    • value: number | null | undefined

    Returns TimestampsToReturn

coerceUInt16

  • coerceUInt16(value: number | string | null): UInt16

  • Parameters

    • value: number | string | null

    Returns UInt16

coerceUInt32

  • coerceUInt32(value: null | string | number | EnumItemLike): UInt32

  • Parameters

    • value: null | string | number | EnumItemLike

    Returns UInt32

coerceUInt64

  • Parameters

    Returns UInt64

coerceUInt8

  • coerceUInt8(value: number | string | null): UInt8

  • Parameters

    • value: number | string | null

    Returns UInt8

coerceVariantType

  • coerceVariantType(dataType: DataType, value: any): any

  • Parameters

    Returns any

compare_buffers

  • compare_buffers(buf1: Buffer, buf2: Buffer, max_length?: number): void

  • Parameters

    • buf1: Buffer
    • buf2: Buffer
    • Optional max_length: number

    Returns void

computeDerivedKeys

  • Parameters

    Returns DerivedKeys1

computeSignature

  • computeSignature(senderCertificate: Buffer | null, senderNonce: Nonce | null, receiverPrivateKey: PrivateKeyPEM | null, securityPolicy: SecurityPolicy): SignatureData | undefined

  • Parameters

    • senderCertificate: Buffer | null
    • senderNonce: Nonce | null
    • receiverPrivateKey: PrivateKeyPEM | null
    • securityPolicy: SecurityPolicy

    Returns SignatureData | undefined

confirmAllConditions

  • confirmAllConditions(session: ClientSession, message: string): Promise<void>

  • Parameters

    Returns Promise<void>

confirmCondition

  • Parameters

    Returns Promise<StatusCode>

constructBrowsePathFromQualifiedName

  • method

    constructBrowsePathFromQualifiedName

    Parameters

    Returns BrowsePath

constructEventFilter

  • helper to construct event filters: construct a simple event filter

    example
    constructEventFilter(["SourceName","Message","ReceiveTime"]);

constructEventFilter(["SourceName",{namespaceIndex:2 , "MyData"}]);
constructEventFilter(["SourceName","2:MyData" ]);

constructEventFilter(["SourceName" ,["EnabledState","EffectiveDisplayName"] ]);
constructEventFilter(["SourceName" ,"EnabledState.EffectiveDisplayName" ]);

    Parameters

    • arrayOfNames: string[] | string
    • Optional conditionTypes: NodeId[] | NodeId

    Returns EventFilter

constructInt64

  • Parameters

    Returns number[]

convertAccessLevelFlagToByte

  • Parameters

    Returns number

convertDataTypeDefinitionToStructureTypeSchema

  • convertDataTypeDefinitionToStructureTypeSchema(session: IBasicSession, dataTypeNodeId: NodeId, name: string, definition: DataTypeDefinition, dataTypeFactory: DataTypeFactory, cache: {}): Promise<StructuredTypeSchema>

  • Parameters

    Returns Promise<StructuredTypeSchema>

createExtObjArrayNode

decodeAccessLevelFlag

decodeArray

  • decode an array from a BinaryStream

    Parameters

    • stream: BinaryStream

      the stream.

    • decodeElementFunc: (stream: BinaryStream) => any

      The function to decode a single array element. This function returns the element decoded from the stream

    Returns any[] | null

    an array of elements or nul

decodeBoolean

  • decodeBoolean(stream: BinaryStream, _value?: boolean): boolean

  • Parameters

    Returns boolean

decodeBrowseDirection

Const decodeByte

  • Parameters

    Returns UInt8

decodeByteString

  • decodeByteString(stream: BinaryStream, _value?: ByteString): ByteString

  • Parameters

    Returns ByteString

decodeDataValue

decodeDateTime

  • Parameters

    Returns DateWithPicoseconds

decodeDiagnosticInfo

decodeDouble

  • decodeDouble(stream: BinaryStream, value?: number): number

  • Parameters

    Returns number

decodeExpandedNodeId

decodeFloat

  • Parameters

    Returns Float

decodeGuid

  • Parameters

    Returns Guid

Const decodeHighAccuracyDateTime

  • Parameters

    Returns DateWithPicoseconds

decodeInt16

  • Parameters

    Returns Int16

decodeInt32

  • Parameters

    Returns Int32

Const decodeInt64

  • Parameters

    Returns UInt64

decodeInt8

  • Parameters

    Returns Int8

decodeLocaleId

  • Parameters

    Returns LocaleId

decodeLocalizedText

decodeMessage

  • Parameters

    Returns BaseUAObject

decodeNodeId

  • Parameters

    Returns NodeId

decodeQualifiedName

Const decodeSByte

  • Parameters

    Returns Int8

decodeStatusCode

  • Parameters

    Returns any

decodeString

  • decodeString(stream: BinaryStream, value?: string | null): string | null

  • Parameters

    Returns string | null

decodeTimestampsToReturn

Const decodeUABoolean

  • decodeUABoolean(stream: BinaryStream, _value?: boolean): boolean

  • Parameters

    Returns boolean

Const decodeUAString

  • decodeUAString(stream: BinaryStream, value?: string | null): string | null

  • Parameters

    Returns string | null

decodeUInt16

  • Parameters

    Returns UInt16

decodeUInt32

  • Parameters

    Returns UInt32

decodeUInt64

  • Parameters

    Returns UInt64

decodeUInt8

  • Parameters

    Returns UInt8

decode_ArgumentList

  • decode_ArgumentList(definition: any[], stream: BinaryStream): any[]

  • Parameters

    Returns any[]

dumpBrowseDescription

  • Parameters

    Returns void

dumpEvent

  • Parameters

    Returns Promise<void>

dumpReferenceDescription

  • Parameters

    Returns void

dumpReferenceDescriptions

  • Parameters

    Returns void

dumpReferences

  • method

    dumpReferences

    static

    Parameters

    Returns void

dumpToBSD

dumpXml

  • dumpXml(node: BaseNode, options: any): string

encodeAccessLevelFlag

  • encodeAccessLevelFlag(value: AccessLevelFlag, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeArray

  • encodeArray(arr: any[] | null, stream: OutputBinaryStream, encodeElementFunc: (value: any, stream: OutputBinaryStream) => void): void
  • method

    encodeArray

    Parameters

    • arr: any[] | null

      the array to encode.

    • stream: OutputBinaryStream

      the stream.

    • encodeElementFunc: (value: any, stream: OutputBinaryStream) => void

      The function to encode a single array element.

        • (value: any, stream: OutputBinaryStream): void

        • Parameters

          • value: any
          • stream: OutputBinaryStream

          Returns void

    Returns void

encodeBoolean

  • encodeBoolean(value: boolean, stream: OutputBinaryStream): void

  • Parameters

    • value: boolean
    • stream: OutputBinaryStream

    Returns void

encodeBrowseDirection

  • encodeBrowseDirection(value: BrowseDirection, stream: OutputBinaryStream): void

  • Parameters

    Returns void

Const encodeByte

  • encodeByte(value: UInt8, stream: OutputBinaryStream): void

  • Parameters

    • value: UInt8
    • stream: OutputBinaryStream

    Returns void

encodeByteString

  • encodeByteString(byteString: ByteString, stream: OutputBinaryStream): void

  • Parameters

    • byteString: ByteString
    • stream: OutputBinaryStream

    Returns void

encodeDataValue

  • encodeDataValue(dataValue: DataValue, stream: OutputBinaryStream): void

  • Parameters

    • dataValue: DataValue
    • stream: OutputBinaryStream

    Returns void

encodeDateTime

  • encodeDateTime(date: Date | null, stream: OutputBinaryStream): void

  • Parameters

    • date: Date | null
    • stream: OutputBinaryStream

    Returns void

encodeDiagnosticInfo

  • encodeDiagnosticInfo(value: DiagnosticInfo | null, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeDouble

  • encodeDouble(value: Double, stream: OutputBinaryStream): void

  • Parameters

    • value: Double
    • stream: OutputBinaryStream

    Returns void

encodeExpandedNodeId

  • encodeExpandedNodeId(expandedNodeId: ExpandedNodeId, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeFloat

  • encodeFloat(value: Float, stream: OutputBinaryStream): void

  • Parameters

    • value: Float
    • stream: OutputBinaryStream

    Returns void

encodeGuid

  • encodeGuid(guid: Guid, stream: OutputBinaryStream): void

  • Parameters

    • guid: Guid
    • stream: OutputBinaryStream

    Returns void

encodeHighAccuracyDateTime

  • encodeHighAccuracyDateTime(date: Date | null, picoseconds: number, stream: OutputBinaryStream): void

  • Parameters

    • date: Date | null
    • picoseconds: number

      {number of picoseconds to improve javascript date... }

    • stream: OutputBinaryStream

    Returns void

encodeInt16

  • encodeInt16(value: Int16, stream: OutputBinaryStream): void

  • Parameters

    • value: Int16
    • stream: OutputBinaryStream

    Returns void

encodeInt32

  • encodeInt32(value: Int32, stream: OutputBinaryStream): void

  • Parameters

    • value: Int32
    • stream: OutputBinaryStream

    Returns void

Const encodeInt64

  • encodeInt64(value: UInt64 | number, stream: OutputBinaryStream): void

  • Parameters

    • value: UInt64 | number
    • stream: OutputBinaryStream

    Returns void

encodeInt8

  • encodeInt8(value: Int8, stream: OutputBinaryStream): void

  • Parameters

    • value: Int8
    • stream: OutputBinaryStream

    Returns void

encodeLocaleId

  • encodeLocaleId(localeId: LocaleId, stream: OutputBinaryStream): void

  • Parameters

    • localeId: LocaleId
    • stream: OutputBinaryStream

    Returns void

encodeLocalizedText

  • encodeLocalizedText(value: LocalizedText, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeNodeId

  • encodeNodeId(nodeId: NodeId, stream: OutputBinaryStream): void

  • Parameters

    • nodeId: NodeId
    • stream: OutputBinaryStream

    Returns void

encodeQualifiedName

  • encodeQualifiedName(value: QualifiedName, stream: OutputBinaryStream): void

  • Parameters

    Returns void

Const encodeSByte

  • encodeSByte(value: Int8, stream: OutputBinaryStream): void

  • Parameters

    • value: Int8
    • stream: OutputBinaryStream

    Returns void

encodeStatusCode

  • Parameters

    Returns void

encodeString

  • encodeString(value: null | string, stream: OutputBinaryStream): void

  • Parameters

    • value: null | string
    • stream: OutputBinaryStream

    Returns void

encodeTimestampsToReturn

  • Parameters

    Returns void

Const encodeUABoolean

  • encodeUABoolean(value: boolean, stream: OutputBinaryStream): void

  • Parameters

    • value: boolean
    • stream: OutputBinaryStream

    Returns void

Const encodeUAString

  • encodeUAString(value: null | string, stream: OutputBinaryStream): void

  • Parameters

    • value: null | string
    • stream: OutputBinaryStream

    Returns void

encodeUInt16

  • encodeUInt16(value: UInt16, stream: OutputBinaryStream): void

  • Parameters

    • value: UInt16
    • stream: OutputBinaryStream

    Returns void

encodeUInt32

  • encodeUInt32(value: UInt32, stream: OutputBinaryStream): void

  • Parameters

    • value: UInt32
    • stream: OutputBinaryStream

    Returns void

encodeUInt64

  • encodeUInt64(value: UInt64 | number, stream: OutputBinaryStream): void

  • Parameters

    • value: UInt64 | number
    • stream: OutputBinaryStream

    Returns void

encodeUInt8

  • encodeUInt8(value: UInt8, stream: OutputBinaryStream): void

  • Parameters

    • value: UInt8
    • stream: OutputBinaryStream

    Returns void

encode_ArgumentList

  • encode_ArgumentList(definition: any[], args: any, stream: OutputBinaryStream): void

  • Parameters

    • definition: any[]
    • args: any
    • stream: OutputBinaryStream

    Returns void

ensureDatatypeExtracted

  • Parameters

    • addressSpace: any

    Returns Promise<ExtraDataTypeManager>

ensureDatatypeExtractedWithCallback

ensureObjectIsSecure

  • ensureObjectIsSecure(node: BaseNode): void

  • make sure that the given ia node can only be read by Admistrrator user on a encrypted channel

    Parameters

    Returns void

extractConditionFields

  • Parameters

    Returns Promise<string[]>

extractEventFields

  • method

    extractEventFields extract a array of eventFields from a event node, matching the selectClauses

    Parameters

    Returns Variant[]

extractFirstCertificateInChain

  • extractFirstCertificateInChain(certificateChain?: Buffer | null): Buffer | null

  • Parameters

    • Optional certificateChain: Buffer | null

    Returns Buffer | null

extractFullyQualifiedDomainName

  • extractFullyQualifiedDomainName(): Promise<string>

  • extract FullyQualifiedDomainName of this computer

    Returns Promise<string>

extractRange

  • return a deep copy of the dataValue by applying indexRange if necessary on Array/Matrix

    Parameters

    • dataValue: DataValue
    • indexRange: NumericalRange

    Returns DataValue

fieldsToJson

  • Parameters

    • fields: string[]
    • eventFields: Variant[]

    Returns EventStuff

findActiveConditions

  • Enumerate all events

    Parameters

    Returns Promise<EventStuff[]>

findServers

  • findServers(discoveryServerEndpointUri: string, callback: (err: Error | null, result?: FindServerResults) => void): void
  • findServers(discoveryServerEndpointUri: string): Promise<FindServerResults>

  • extract the server endpoints exposed by a discovery server

    method

    findServers

    async

    Parameters

    Returns void

  • Parameters

    • discoveryServerEndpointUri: string

    Returns Promise<FindServerResults>

findServersOnNetwork

  • findServersOnNetwork(discoveryServerEndpointUri: string): Promise<ServerOnNetwork[]>
  • findServersOnNetwork(discoveryServerEndpointUri: string, callback: (err: Error | null, servers?: ServerOnNetwork[]) => void): void

  • extract the server endpoints exposed by a discovery server

    Parameters

    • discoveryServerEndpointUri: string

    Returns Promise<ServerOnNetwork[]>

  • Parameters

    • discoveryServerEndpointUri: string
    • callback: (err: Error | null, servers?: ServerOnNetwork[]) => void

    Returns void

fromURI

  • Parameters

    • uri: string | null

    Returns SecurityPolicy

generateAddressSpace

  • generateAddressSpace(addressSpace: AddressSpace, xmlFiles: string | string[], callback: (err?: Error) => void): void
  • generateAddressSpace(addressSpace: AddressSpace, xmlFiles: string | string[]): Promise<void>

  • Parameters

    • addressSpace: AddressSpace
    • xmlFiles: string | string[]
    • callback: (err?: Error) => void
        • (err?: Error): void

        • Parameters

          • Optional err: Error

          Returns void

    Returns void

  • Parameters

    Returns Promise<void>

generateAddressSpaceRaw

  • Parameters

    Returns Promise<void>

generateAddressSpaceRawCallback

  • generateAddressSpaceRawCallback(addressSpace: AddressSpace, xmlFiles: string | string[], xmlLoader: (nodeset2xmlUri: string, callback: CallbackT<string>) => void, callback?: ErrorCallback): void
  • xmlfiles:

    a lis of xml files

    Parameters

    • addressSpace: AddressSpace

      the addressSpace to populate

    • xmlFiles: string | string[]
    • xmlLoader: (nodeset2xmlUri: string, callback: CallbackT<string>) => void

      a helper function to return the content of the xml file

        • (nodeset2xmlUri: string, callback: CallbackT<string>): void

        • Parameters

          • nodeset2xmlUri: string
          • callback: CallbackT<string>

          Returns void

    • Optional callback: ErrorCallback

    Returns void

getAggregateConfiguration

getAggregateData

getAverageData

  • getAverageData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

  • Parameters

    • node: UAVariable
    • processingInterval: number
    • startDate: Date
    • endDate: Date
    • callback: (err: Error | null, dataValues?: DataValue[]) => void
        • (err: Error | null, dataValues?: DataValue[]): void

        • Parameters

          • err: Error | null
          • Optional dataValues: DataValue[]

          Returns void

    Returns void

getCryptoFactory

  • Parameters

    Returns CryptoFactory | null

getCurrentClock

  • Returns PreciseClock

getCurrentClockWithJavascriptDate

  • Returns PreciseClock

    PreciseClock

getDataTypeDefinition

  • Parameters

    Returns Promise<StructuredTypeSchema>

getDefaultCertificateManager

  • Parameters

    • name: "PKI" | "UserPKI"

    Returns OPCUACertificateManager

getExtraDataTypeManager

  • Parameters

    Returns Promise<any>

getFakeTransport

  • getFakeTransport(): any

  • Returns any

getFullyQualifiedDomainName

  • getFullyQualifiedDomainName(optional_max_length?: number): string

  • Parameters

    • Optional optional_max_length: number

    Returns string

getFunctionParameterNames

  • getFunctionParameterNames(func: Function): RegExpMatchArray

  • Parameters

    • func: Function

    Returns RegExpMatchArray

getHostname

  • getHostname(): string

  • Returns string

getInterpolatedData

  • getInterpolatedData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

  • Parameters

    • node: UAVariable
    • processingInterval: number
    • startDate: Date
    • endDate: Date
    • callback: (err: Error | null, dataValues?: DataValue[]) => void
        • (err: Error | null, dataValues?: DataValue[]): void

        • Parameters

          • err: Error | null
          • Optional dataValues: DataValue[]

          Returns void

    Returns void

getInterval

  • getInterval(startTime: Date, duration: number, indexHint: number, dataValues: DataValue[]): Interval

  • Parameters

    • startTime: Date
    • duration: number
    • indexHint: number
    • dataValues: DataValue[]

    Returns Interval

getMaxData

  • getMaxData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

  • Parameters

    • node: UAVariable
    • processingInterval: number
    • startDate: Date
    • endDate: Date
    • callback: (err: Error | null, dataValues?: DataValue[]) => void
        • (err: Error | null, dataValues?: DataValue[]): void

        • Parameters

          • err: Error | null
          • Optional dataValues: DataValue[]

          Returns void

    Returns void

getMethodDeclaration_ArgumentList

getMinData

  • getMinData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

  • Parameters

    • node: UAVariable
    • processingInterval: number
    • startDate: Date
    • endDate: Date
    • callback: (err: Error | null, dataValues?: DataValue[]) => void
        • (err: Error | null, dataValues?: DataValue[]): void

        • Parameters

          • err: Error | null
          • Optional dataValues: DataValue[]

          Returns void

    Returns void

getObjectClassName

  • getObjectClassName(obj: object): string
  • method

    getObjectClassName

    Parameters

    • obj: object

    Returns string

getOptionsForSymmetricSignAndEncrypt

getStatusCodeFromCode

  • getStatusCodeFromCode(code: number): any

  • returns the StatusCode corresponding to the provided value, if any

    note:

    if code is not known , then StatusCodes.Bad will be returned

    Parameters

    • code: number

    Returns any

getThumbprint

  • getThumbprint(certificateChain: Buffer | null): Buffer | null

  • Parameters

    • certificateChain: Buffer | null

    Returns Buffer | null

Let get_clock_tick

  • get_clock_tick(): number

  • Returns number

Const get_empty_nodeset_filename

  • get_empty_nodeset_filename(): string

  • Returns string

Const get_mini_nodeset_filename

  • get_mini_nodeset_filename(): string

  • Returns string

hasTokenExpired

  • Parameters

    Returns boolean

hexDump

  • hexDump(buffer: Buffer | null, width?: number, maxSize?: number): string

  • Parameters

    • buffer: Buffer | null
    • Optional width: number
    • Optional maxSize: number

    Returns string

installAggregateConfigurationOptions

installAlarmMonitoring

  • Parameters

    Returns Promise<ClientAlarmList>

installPeriodicClockAdjustment

  • installPeriodicClockAdjustment(): void

  • Returns void

install_optional_cpu_and_memory_usage_node

  • install_optional_cpu_and_memory_usage_node(server: any): void

  • optionally install a CPU Usage and Memory Usage node ( condition : running on linux and require("usage")

    method

    install_optional_cpu_and_memory_usage_node

    Parameters

    • server: any

    Returns void

interpolateValue

  • Parameters

    Returns DataValue

interpolatedValue

isBad

  • Parameters

    Returns boolean

isDataEncoding

  • isDataEncoding(dataEncoding: any): boolean

  • Parameters

    • dataEncoding: any

    Returns boolean

isEmptyNonce

  • isEmptyNonce(nonce: Buffer): boolean

  • returns true if the nonce is null or zero (all bytes set to 0)

    Parameters

    • nonce: Buffer

    Returns boolean

isGood

  • Parameters

    Returns boolean

isGoodish

  • Parameters

    Returns boolean

isMinDate

  • isMinDate(date?: Date | null): boolean

  • Parameters

    • Optional date: Date | null

    Returns boolean

isNullOrUndefined

  • isNullOrUndefined(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isOutsideDeadbandAbsolute

  • isOutsideDeadbandAbsolute(variant1: Variant, variant2: Variant, deadbandValue: number): boolean
  • method

    isOutsideDeadbandAbsolute

    Parameters

    Returns boolean

    true if the element is in deadBand

isOutsideDeadbandNone

  • isOutsideDeadbandNone(variant1: Variant, variant2: Variant): boolean
  • method

    isOutsideDeadbandNone

    Parameters

    Returns boolean

    true if the element is in deadBand

isOutsideDeadbandPercent

  • method

    isOutsideDeadband

    Parameters

    Returns boolean

    true if the element is outside deadBand

isValidAttributeId

  • isValidAttributeId(attributeId: number): boolean

  • Parameters

    • attributeId: number

    Returns boolean

isValidBoolean

  • isValidBoolean(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

Const isValidByte

  • isValidByte(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidByteString

  • isValidByteString(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidDataEncoding

  • Parameters

    Returns boolean

isValidDateTime

  • isValidDateTime(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidDouble

  • isValidDouble(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidFloat

  • isValidFloat(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidGuid

  • isValidGuid(guid: string): boolean

  • checks if provided string is a valid Guid a valid GUID has the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX when X is a hexadecimal digit

    method

    isValidGuid

    Parameters

    • guid: string

      the GUID to test for validaty

    Returns boolean

    • true if the string is a valid GUID.

isValidInt16

  • isValidInt16(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidInt32

  • isValidInt32(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

Const isValidInt64

  • isValidInt64(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidInt8

  • isValidInt8(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidNodeId

  • isValidNodeId(nodeId: NodeId): boolean

  • Parameters

    Returns boolean

Const isValidSByte

  • isValidSByte(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidString

  • isValidString(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidUInt16

  • isValidUInt16(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidUInt32

  • isValidUInt32(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidUInt64

  • isValidUInt64(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidUInt8

  • isValidUInt8(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isValidVariant

  • Parameters

    Returns boolean

is_valid_endpointUrl

  • is_valid_endpointUrl(endpointUrl: string): boolean

  • Parameters

    • endpointUrl: string

    Returns boolean

lowerFirstLetter

  • lowerFirstLetter(str: string): string

  • lowerFirstLetter convert a OPCUA Identifier to a javascript Identifier

    summary

    OPCUA and Javascript use two different rules to build identifiers.

    OPCUA Identifier usually starts with a upper case letter and word are join together, this is known as the Pascal case, or CapitalizedWords convention. (for instance HelloWorld) But sometime, OPCUA indentifiers do not follow this convention strictly and we can find various other convention being applied such as underscore between word, or addintion of ACRONYMED prefixes. On it's own, this causes great confusion and inconsistancy in programming style.

    Javascritpt uses a slightly different convention called camelCase where word are joined together and inner words starts with a capital letter whereas first word starts with a lower case letter. (for instance helloWorld)

    In node-opcua we have taken the opinionated decision to consistently use camelCase convention for object properties so that all the code look nice and consistent. the lowerFirstLetter method can be used to easily convert from the OPCUA naming convention to javascript naming convention by applying the following rules.

    • each ascii sequence in a identifier will be converted to lower camel case.
    • when an identifier only contains upper case letter then it will be untouched. ( i.e CQDF => CQFD) (this rules helps to preserve acronyms)
    • when a identifier starts with more than one UpperCase letter but still contain lowercase letter then the first Uppercase letter excluding the last one will be converted to lower case ( ie: EURange = > euRange)
    • when a identifier contains several sequences delimited with underscores (_) the above rules will be applied to each of the element of the sequence ( ie: ALM_FlowOutOfTolerance => ALM_flowOutOfTolerance ( ALM=>ALM , FlowOutOfTolerance=>flowOutOfTolerance)
    reference
    example

    HelloWorld => helloWorld XAxis => xAxis EURange => euRange DATE => DATE XYZ => XYZ AB => AB Ab => ab A => a T1ABC8 => T1ABC8 F_ABC_D => F_ABC_D ALM_Timeout => ALM_timeout SV_GasOn => SV_gasOn DI_VAL_FlowImp => DI_VAL_flowImp

    Parameters

    • str: string

    Returns string

makeAccessLevelFlag

  • Parameters

    • str: string | number | null

    Returns AccessLevelFlag

makeApplicationUrn

  • makeApplicationUrn(hostname: string, suffix: string): string

  • Parameters

    • hostname: string
    • suffix: string

    Returns string

makeAttributeEventName

makeBoiler

  • makeBoiler(addressSpace: AddressSpace, options: { browseName: string; organizedBy: BaseNode }): Boiler

  • Parameters

    Returns Boiler

makeBrowsePath

  • Parameters

    Returns BrowsePath

makeEUInformation

  • makeEUInformation(symbol: string, shortName: string, longName: string): EUInformation

  • Parameters

    • symbol: string
    • shortName: string
    • longName: string

    Returns EUInformation

makeExpandedNodeId

  • method

    makeExpandedNodeId

    Parameters

    • value: any
    • Optional namespace: number

    Returns ExpandedNodeId

makeNodeClassMask

  • Parameters

    • str: string

    Returns NodeClassMask

makeNodeId

  • makeNodeId(value: string | Buffer | number, namespace?: number): NodeId

  • construct a node Id from a value and a namespace.

    method

    makeNodeId

    static

    Parameters

    • value: string | Buffer | number
    • Optional namespace: number

    Returns NodeId

makeRefId

  • makeRefId(referenceTypeName: string): NodeId

  • Parameters

    • referenceTypeName: string

    Returns NodeId

makeRelativePath

  • makeRelativePath(str: string, addressSpace?: any): RelativePath

  • construct a RelativePath from a string containing the relative path description. The string must comply to the OPCUA BNF for RelativePath ( see part 4 - Annexe A)

    method

    makeRelativePath

    example:
     var relativePath = makeRelativePath("/Server.ServerStatus.CurrentTime");

    Parameters

    • str: string
    • Optional addressSpace: any

    Returns RelativePath

makeResultMask

  • Parameters

    • str: string

    Returns ResultMask

makeSubject

  • makeSubject(applicationName: string, hostname: string): string

  • Parameters

    • applicationName: string
    • hostname: string

    Returns string

matchUri

  • matchUri(endpointUri1: string | null, endpointUri2: string | null): boolean

  • returns true if two endpoint matches the same address:

    see

    https://www.dnscheck.co/faq

    see

    https://tools.ietf.org/html/rfc4343 : Domain Name System (DNS) Case Insensitivity Clarification

    Parameters

    • endpointUri1: string | null
    • endpointUri2: string | null

    Returns boolean

messageHeaderToString

  • messageHeaderToString(messageChunk: Buffer): string

  • convert the messageChunk header to a string

    method

    messageHeaderToString

    Parameters

    • messageChunk: Buffer

    Returns string

nonceAlreadyBeenUsed

  • nonceAlreadyBeenUsed(nonce?: Buffer): boolean

  • Parameters

    • Optional nonce: Buffer

    Returns boolean

packTcpMessage

  • packTcpMessage(msgType: string, encodableObject: BaseUAObject): Buffer

  • Parameters

    • msgType: string
    • encodableObject: BaseUAObject

    Returns Buffer

parseEndpointUrl

  • parseEndpointUrl(endpointUrl: string): url.Url

  • Parameters

    • endpointUrl: string

    Returns url.Url

performCertificateSanityCheck

  • performCertificateSanityCheck(serverOrClient: "server" | "client", certificateManager: OPCUACertificateManager, applicationUri: string): Promise<void>

  • Parameters

    Returns Promise<void>

populateDataTypeManager

  • Extract all custom dataType

    async

    Parameters

    Returns Promise<void>

prepareFQDN

  • prepareFQDN(): Promise<void>

  • Returns Promise<void>

promoteOpaqueStructure

  • Parameters

    Returns Promise<void>

promoteToMultiStateDiscrete

  • promoteToMultiStateDiscrete(node: UAVariable): UAMultiStateDiscrete

  • Parameters

    Returns UAMultiStateDiscrete

promoteToMultiStateValueDiscrete

  • promoteToMultiStateValueDiscrete(node: UAVariable): UAMultiStateValueDiscrete

  • Parameters

    Returns UAMultiStateValueDiscrete

promoteToStateMachine

  • Parameters

    Returns StateMachine

promoteToTwoStateDiscrete

  • Parameters

    Returns UATwoStateDiscrete

randomAccessLevel

  • Returns AccessLevelFlag

randomBoolean

  • randomBoolean(): boolean

  • Returns boolean

Const randomByte

  • Returns UInt8

randomByteString

  • randomByteString(value: any, len: number): ByteString

  • Parameters

    • value: any
    • len: number

    Returns ByteString

randomDateTime

  • randomDateTime(): Date

  • Returns Date

randomDouble

  • Returns Double

randomFloat

  • Returns Float

randomGuid

  • randomGuid(): Guid

  • Returns Guid

randomInt16

  • Returns Int16

randomInt32

  • Returns Int32

randomInt64

  • Returns Int64

randomInt8

  • randomInt8(): Int8

  • Returns Int8

randomNodeId

  • Returns NodeId

Const randomSByte

  • randomSByte(): Int8

  • Returns Int8

randomString

  • randomString(): string

  • Returns string

randomUInt16

  • Returns UInt16

randomUInt32

  • Returns UInt32

randomUInt64

  • Returns UInt64

randomUInt8

  • Returns UInt8

readHistoryServerCapabilities

readNodeSet2XmlFile

  • readNodeSet2XmlFile(xmlFile: string, callback: (err: Error | null, xmlData?: string) => void): void

  • Parameters

    • xmlFile: string
    • callback: (err: Error | null, xmlData?: string) => void
        • (err: Error | null, xmlData?: string): void

        • Parameters

          • err: Error | null
          • Optional xmlData: string

          Returns void

    Returns void

readProcessedDetails

readRawMessageHeader

  • readRawMessageHeader(data: Buffer): PacketInfo

  • Parameters

    • data: Buffer

    Returns PacketInfo

readUAAnalogItem

  • method

    readUAAnalogItem

    Parameters

    Returns Promise<AnalogDataItemSnapshot>

  • Parameters

    Returns void

referenceTypeToString

  • Parameters

    Returns string

releaseBonjour

  • releaseBonjour(): void

  • Returns void

removeElement

replaceBufferWithHexDump

  • replaceBufferWithHexDump(obj: any): any

  • Parameters

    • obj: any

    Returns any

resolveDynamicExtensionObject

  • Parameters

    Returns void

resolveFullyQualifiedDomainName

  • resolveFullyQualifiedDomainName(str: string): string

  • Parameters

    • str: string

    Returns string

resolveNodeId

  • method

    resolveNodeId

    static

    Parameters

    Returns NodeId

    the nodeId

resolveReferenceNode

resolveReferenceType

roundToFloat2

  • roundToFloat2(float: number): number

  • Parameters

    • float: number

    Returns number

sameAnnouncement

  • Parameters

    Returns boolean

sameDataValue

  • method

    sameDataValue

    Parameters

    Returns boolean

    true if data values are identical

sameNodeId

  • Parameters

    Returns boolean

sameStatusCode

  • Parameters

    Returns boolean

sameVariant

  • returns true if the two variant represent the same value

    Parameters

    • v1: Variant

      the first variant to compare

    • v2: Variant

      the variant to compare with

    Returns boolean

serverTimestampHasChanged

  • Parameters

    Returns boolean

setDeprecated

  • setDeprecated(constructor: Function, methodName: string, helpString: string): void

  • Parameters

    • constructor: Function
    • methodName: string
    • helpString: string

    Returns void

setFakeTransport

  • setFakeTransport(mockSocket: any): void

  • Parameters

    • mockSocket: any

    Returns void

set_flag

  • set_flag(value: number, mask: number | { value: number }): number

  • set a flag

    method

    set_flag

    Parameters

    • value: number
    • mask: number | { value: number }

    Returns number

simpleAttributeOperandToShortString

  • method

    toShortString

    example:

    Parameters

    Returns string

sourceTimestampHasChanged

  • Parameters

    Returns boolean

stringToQualifiedName

  • method

    stringToQualifiedName

    example

    stringToQualifiedName("Hello") => {namespaceIndex: 0, name: "Hello"} stringToQualifiedName("3:Hello") => {namespaceIndex: 3, name: "Hello"}

    Parameters

    • value: string

    Returns QualifiedName

timestamp

  • timestamp(): string

  • Returns string

timestampHasChanged

  • Parameters

    Returns boolean

toURI

  • Parameters

    Returns string

uninstallAlarmMonitoring

  • uninstallAlarmMonitoring(session: ClientSession): Promise<void>

  • Parameters

    Returns Promise<void>

uninstallPeriodicClockAdjustment

  • uninstallPeriodicClockAdjustment(): void

  • Returns void

validateLocaleId

  • validateLocaleId(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

verifyArguments_ArgumentList

  • method

    verifyArguments_ArgumentList

    Parameters

    Returns { inputArgumentResults?: StatusCode[]; statusCode: StatusCode }

    statusCode,inputArgumentResults

verifyIsOPCUAValidCertificate

  • verifyIsOPCUAValidCertificate(certificate: Certificate, certificateFile: string, type: "client" | "server", applicationUri: string): void

  • Parameters

    • certificate: Certificate
    • certificateFile: string
    • type: "client" | "server"
    • applicationUri: string

    Returns void

verifySignature

  • verifySignature(receiverCertificate: Buffer, receiverNonce: Buffer, signature: SignatureData, senderCertificate: Buffer, securityPolicy: SecurityPolicy): boolean

  • Parameters

    Returns boolean

writeTCPMessageHeader

  • writeTCPMessageHeader(msgType: string, chunkType: string, totalLength: number, stream: OutputBinaryStream): void

  • Parameters

    • msgType: string
    • chunkType: string
    • totalLength: number
    • stream: OutputBinaryStream

    Returns void

Generated using TypeDoc