Module node-opcua

node-opcua

an implementation of an OPC UA stack fully written in javascript and NodeJS

Documentation

"NodeOPCUA by Example" (https://leanpub.com/node-opcuabyexample-edition2024) provides a good starting point to understand and start using node-opcua.

More advanced interactive material & documentation is made available online for Registered members of the NodeOPCUA Subscription. Please visit https://support.sterfive.com to apply or contact Sterfive.

Sponsors & Backers

We appreciate that, once you have evaluated the software you consider supporting our effort by applying to our sponsor program:

Grants ensure the following:

🔨 Long-term maintenance of the project
⚙️ maintain the website and continuous integration platform
🛣 Progress on the road map
🐛 Quick responses to bug reports
🚀 New features & enhancements
⚖️ representing the node-opcua user community at the OPC Foundation

Support

Technical Support is exclusively provided to registered members of the NodeOPCUA Subscription (https://support.sterfive.com) or through dedicated Professional Services.

License

Node-OPCUA is made available to you under the MIT open-source license.

See LICENSE for details.

value-added extensions

Contact Sterfive SAS (mailto:contact@sterfive.com) for additional companion modules that are available to registered members:

node-opcua-pub-sub : Part 14 implementation to develop OPC UA PubSub over MQTT applications
node-opcua-webproxy: to operate node-opcua from within a web browser
node-opcua-optimized-client: super-charge OPC UA Client
react-components: a collection of React UI components
aggregator: a powerful OPC UA aggregator that can combine and monitor hundred of servers and millions of variables.
node-opcua-gds: a Global Discovery Server (Part 12)
node-opcua-modeler-ex: a powerful NO-GUI OPC UA modeler

Copyright

Index

Enumerations

AccessLevelExFlag AccessLevelFlag AccessRestrictionsFlag AggregateFunction ApplicationType AttributeIds BrowseDirection DataChangeTrigger DataType DataTypeExtractStrategy DataTypeIds DeadbandType DiagnosticInfo_EncodingByte DiagnosticInfo_OperationLevelMask DiagnosticInfo_ServiceLevelMask EnumApplication EnumAxisScale EnumBrokerTransportQualityOfService EnumConversionLimitEnum EnumDataSetOrdering EnumDiagnosticsLevel EnumDuplex EnumExceptionDeviationFormat EnumFilterOperator EnumHistoryUpdate EnumId EnumIdentityCriteria EnumInterfaceAdminStatus EnumInterfaceOperStatus EnumMessageSecurityMode EnumNamingRule EnumNegotiationStatus EnumNodeAttributesMask EnumNodeClass EnumOpenFileMode EnumOverrideValueHandling EnumPerformUpdate EnumPubSubDiagnosticsCounterClassification EnumPubSubState EnumRedundancySupport EnumRedundantServerMode EnumSecurityTokenRequest EnumServerState EnumStructure EnumTrustListMasks EnumTsnFailureCode EnumTsnListenerStatus EnumTsnStreamState EnumTsnTalkerStatus EnumUserToken EUEngineeringUnit EventNotifierFlags FilterOperator HistoryUpdateType LogLevel MessageSecurityMode MethodIds MonitoringMode NodeClass NodeClassMask NodeIdType ObjectIds ObjectTypeIds PermissionFlag PermissionType ReferenceTypeIds RegisterServerManagerStatus RegisterServerMethod ResultMask SecurityPolicy SecurityTokenRequestType ServerState SubscriptionState TimestampsToReturn UserTokenType VariableIds VariableTypeIds VariantArrayType WellKnownRoles WellKnownRolesNodeId

Classes

AcknowledgeMessage ActivateSessionRequest ActivateSessionResponse AddNodesRequest AddNodesResponse AddReferencesRequest AddReferencesResponse AddressSpace AggregateConfiguration AggregateFilter AnonymousIdentityToken ApplicationDescription Argument AsymmetricAlgorithmSecurityHeader AttributeOperand BaseNode BinaryStream BonjourHolder BrowseDescription BrowseNextRequest BrowseNextResponse BrowsePath BrowsePathResult BrowsePathTarget BrowseRequest BrowseResponse BrowseResult BuildInfo CallMethodRequest CallMethodResult CallRequest CallResponse CancelRequest CancelResponse CertificateManager ChannelSecurityToken ClientAlarm ClientAlarmList ClientMonitoredItem ClientMonitoredItemGroup ClientSecureChannelLayer ClientSubscription ClientTCP_transport CloneHelper CloseSecureChannelRequest CloseSecureChannelResponse CloseSessionRequest CloseSessionResponse ConstantStatusCode ContentFilter ContentFilterElement ContentFilterElementResult ContentFilterResult ContinuationPointManager CreateMonitoredItemsRequest CreateMonitoredItemsResponse CreateSessionRequest CreateSessionResponse CreateSubscriptionRequest CreateSubscriptionResponse DataChangeFilter DataChangeNotification DataTypeDefinition DataValue DataValueT DeleteMonitoredItemsRequest DeleteMonitoredItemsResponse DeleteNodesRequest DeleteNodesResponse DeleteReferencesRequest DeleteReferencesResponse DeleteSubscriptionsRequest DeleteSubscriptionsResponse DiagnosticInfo ElementOperand EndpointDescription EnumValueType EventData EventFieldList EventFilter EventFilterResult EventNotificationList ExpandedNodeId ExtensionObject ExtraDataTypeManager FilterContextOnAddressSpace FilterOperand FindServersOnNetworkRequest FindServersOnNetworkResponse FindServersRequest FindServersResponse GetEndpointsRequest GetEndpointsResponse HelloMessage HistoryData HistoryModifiedData HistoryReadDetails HistoryReadRequest HistoryReadResponse HistoryReadResult HistoryReadValueId HistoryUpdateRequest HistoryUpdateResponse HistoryUpdateResult Interval IssuedIdentityToken LineFile LiteralOperand LocalizedText MdnsDiscoveryConfiguration MessageBuilder MessageBuilderBase MessageChunker ModelChangeStructureDataType ModifiableStatusCode ModificationInfo ModifyMonitoredItemsRequest ModifyMonitoredItemsResponse ModifySubscriptionRequest ModifySubscriptionResponse MonitoredItem MonitoredItemCreateRequest MonitoredItemCreateResult MonitoredItemModifyRequest MonitoredItemModifyResult MonitoredItemNotification MonitoringFilter MonitoringParameters NodeId NodeIdManager NodeTypeDescription NotificationData NotificationMessage NumericRange OPCUABaseServer OPCUACertificateManager OPCUAClient OPCUAClientBase OPCUADiscoveryServer OPCUASecureObject OPCUAServer OPCUAServerEndPoint OpenSecureChannelRequest OpenSecureChannelResponse ParsingResult PseudoSession PublishRequest PublishResponse QualifiedName QueryDataDescription QueryDataSet QueryFirstRequest QueryFirstResponse QueryNextRequest QueryNextResponse Range ReadAtTimeDetails ReadEventDetails ReadProcessedDetails ReadRawModifiedDetails ReadRequest ReadResponse ReadValueId RedundantServerDataType ReferenceDescription RegisteredServer RegisterNodesRequest RegisterNodesResponse RegisterServer2Request RegisterServer2Response RegisterServerManagerMDNSONLY RegisterServerRequest RegisterServerResponse RelativePath RelativePathElement RepublishRequest RepublishResponse RequestHeader ResponseHeader RolePermissionType SamplingIntervalDiagnosticsDataType SecureMessageChunkManager SemanticChangeStructureDataType SequenceNumberGenerator ServerCapabilities ServerDiagnosticsSummaryDataType ServerEngine ServerOnNetwork ServerOperationLimits ServerSecureChannelLayer ServerSession ServerSidePublishEngine ServerStatusDataType ServiceCounterDataType ServiceFault SessionContext SessionDiagnosticsDataType SessionSecurityDiagnosticsDataType SetMonitoringModeRequest SetMonitoringModeResponse SetPublishingModeRequest SetPublishingModeResponse SetTriggeringRequest SetTriggeringResponse SignatureData SignedSoftwareCertificate SimpleAttributeOperand StatusChangeNotification StatusCode StatusCodes Subscription SubscriptionAcknowledgement SubscriptionDiagnosticsDataType SymmetricAlgorithmSecurityHeader TCP_transport TCPErrorMessage TimeZoneDataType TokenStack TransferResult TransferSubscriptionsRequest TransferSubscriptionsResponse TranslateBrowsePathsToNodeIdsRequest TranslateBrowsePathsToNodeIdsResponse UAMethod UAReferenceType UAUserManager1 UAUserManagerBase UAVariableType UnregisterNodesRequest UnregisterNodesResponse UserIdentityToken UserNameIdentityToken UserTokenPolicy VariableHistorian Variant ViewDescription WatchDog WriteRequest WriteResponse WriteValue X509IdentityToken

Interfaces

Type Aliases

Functions

_accessLevelFlagToString _announceServerOnMulticastSubnet _findGoodDataValueAfter _findGoodDataValueBefore _getCompleteRequiredModelsFromValuesAndReferences _recomputeRequiredModelsFromTypes _recomputeRequiredModelsFromTypes2 accessLevelExFlagToString accessLevelFlagToString accessRestrictionsFlagToString acknowledgeAllConditions acknowledgeCondition addAggregateFunctionSupport addAggregateStandardFunctionSupport addAggregateSupport addElement adjustBrowseDirection adjustLimitsWithParameters adjustNamespaceArray adjustProcessingOptions adjustVariant and announcementToServiceConfig apply_timestamps apply_timestamps_no_copy assert asymmetricVerifyChunk binaryStoreSize_ArgumentList bindExtObjArrayNode bn_dateToHundredNanoSecondFrom1601 bn_dateToHundredNanoSecondFrom1601Excess bn_hundredNanoSecondFrom1601ToDate browseAll browseAll2 buffer_ellipsis buildVariantArray calculateIntervalMaxValue calculateIntervalMinValue callConditionRefresh callMethodCondition callMethodHelper capitalizeFirstLetter check_flag checkDebugFlag checkFilter checkSelectClause checkSelectClauses chooseSecurityHeader clearSessionCache coerceAccessLevelFlag coerceBoolean coerceByte coerceByteString coerceClock coerceConnectionStrategy coerceDateTime coerceDouble coerceExpandedNodeId coerceFloat coerceInt16 coerceInt32 coerceInt64 coerceInt64toInt32 coerceInt8 coerceLocalizedText coerceMessageSecurityMode coerceNodeId coerceQualifiedName coerceSByte coerceSecurityPolicy coerceStatusCode coerceTimestampsToReturn coerceUInt16 coerceUInt32 coerceUInt64 coerceUInt64toInt32 coerceUInt8 coerceVariantType compare_buffers computeDerivedKeys computeSignature confirmAllConditions confirmCondition constructBrowsePathFromQualifiedName constructEventFilter constructInt64 constructNamespaceDependency constructNamespacePriorityTable constructSelectClause constructSimpleBrowsePath convertAccessLevelFlagToByte convertDataTypeDefinitionToStructureTypeSchema convertStructureTypeSchemaToStructureDefinition createExtObjArrayNode createMonitoredItemsLimit decode_ArgumentList decodeAccessLevelExFlag decodeAccessLevelFlag decodeArray decodeBoolean decodeBrowseDirection decodeByte decodeByteString decodeDataValue decodeDateTime decodeDiagnosticInfo decodeDouble decodeExpandedNodeId decodeFloat decodeGuid decodeHighAccuracyDateTime decodeInt16 decodeInt32 decodeInt64 decodeInt8 decodeLocaleId decodeLocalizedText decodeMessage decodeNodeId decodeQualifiedName decodeSByte decodeStatusCode decodeString decodeUABoolean decodeUAString decodeUInt16 decodeUInt32 decodeUInt64 decodeUInt8 dumpBrowseDescription dumpEvent dumpReferenceDescription dumpReferenceDescriptions dumpReferences dumpToBSD dumpXml encode_ArgumentList encodeAccessLevelExFlag encodeAccessLevelFlag encodeArray encodeBoolean encodeBrowseDirection encodeByte encodeByteString encodeDataValue encodeDateTime encodeDiagnosticInfo encodeDouble encodeExpandedNodeId encodeFloat encodeGuid encodeHighAccuracyDateTime encodeInt16 encodeInt32 encodeInt64 encodeInt8 encodeLocaleId encodeLocalizedText encodeNodeId encodeQualifiedName encodeSByte encodeStatusCode encodeString encodeUABoolean encodeUAString encodeUInt16 encodeUInt32 encodeUInt64 encodeUInt8 ensureDatatypeExtracted ensureDatatypeExtractedWithCallback ensureObjectIsSecure extractConditionFields extractDataTypeManagerPrivate extractDataValueToPromote extractEventField extractEventFields extractEventFieldsBase extractFirstCertificateInChain extractFullyQualifiedDomainName extractRange filterDiagnosticInfo filterDiagnosticInfoLevel filterDiagnosticOperationLevel filterDiagnosticServiceLevel findActiveConditions findBasicDataType findInTypeOrSuperType findMethodId findOrder findServers findServersOnNetwork findStructureDataType findSuperType fromURI generateAddressSpace generateAddressSpaceRaw get_clock_tick get_empty_nodeset_filename get_mini_nodeset_filename getAggregateConfiguration getAggregateData getArgumentDefinitionHelper getAverageData getBuiltInDataType getChildByBrowseName getContextMaxMessageSize getCountData getCryptoFactory getCurrentClock getCurrentClockWithJavascriptDate getDefaultCertificateManager getDurationBadData getDurationGoodData getExtensionObjectConstructor getExtraDataTypeManager getFakeTransport getFullyQualifiedDomainName getFunctionParameterNames getHostname getInterpolatedData getInterval getMaxData getMethodDeclaration_ArgumentList getMinData getMinOPCUADate getNodeIdManager getObjectClassName getOptionsForSymmetricSignAndEncrypt getPartialCertificateChain getPartialCertificateChain1 getPercentBadData getPercentGoodData getStatusCodeFromCode getSymbols getThumbprint greaterThan greaterThanOrEqual hasTokenExpired hexDump hrtime inList innerBrowse innerBrowseNext installAggregateConfigurationOptions installAlarmMonitoring installPeriodicClockAdjustment installSessionLoggingOnEngine installSubscriptionMonitoring instantiateCertificateExpirationAlarm Int64ToBigInt interpolatedValue interpolateValue invalidateExtraDataTypeManager is_valid_endpointUrl isDataEncoding isEmptyNonce isGoodish2 isMinDate isNullOrUndefined isOutsideDeadbandAbsolute isOutsideDeadbandNone isOutsideDeadbandPercent isUncertain isValidAttributeId isValidBoolean isValidByte isValidByteString isValidDataEncoding isValidDateTime isValidDouble isValidFloat isValidGuid isValidInt16 isValidInt32 isValidInt64 isValidInt8 isValidNodeId isValidSByte isValidString isValidUInt16 isValidUInt32 isValidUInt64 isValidUInt8 isValidVariant l lessThan LessThanOrEqual lowerFirstLetter make_debugLog make_warningLog makeAccessLevelExFlag makeAccessLevelFlag makeAccessRestrictionsFlag makeApplicationUrn makeAttributeEventName makeBrowsePath makeContentFilter makeContentFilterElements makeDefaultCloneExtraInfo makeEUInformation makeExpandedNodeId makeNodeClassMask makeNodeId makeOptionalsMap makePermissionFlag makeRelativePath makeResultMask makeRoles makeSubject makeUserManager matchUri messageHeaderToString n nonceAlreadyBeenUsed ofType or packTcpMessage parseEndpointUrl performCertificateSanityCheck permissionFlagToString populateDataTypeManager preLoad prepareFQDN promoteOpaqueStructure promoteOpaqueStructureInNotificationData promoteToMultiStateDiscrete promoteToMultiStateValueDiscrete promoteToStateMachine promoteToStateMachineType promoteToTwoStateDiscrete randomAccessLevel randomAccessLevelEx randomBoolean randomByte randomByteString randomDateTime randomDouble randomFloat randomGuid randomInt16 randomInt32 randomInt64 randomInt8 randomNodeId randomSByte randomString randomUInt16 randomUInt32 randomUInt64 randomUInt8 readAllAttributes readHistoryServerCapabilities readNamespaceArray readNodeSet2XmlFile readOperationLimits readProcessedDetails readRawMessageHeader readServerCapabilities readUAAnalogItem reconstructFunctionalGroupType reconstructNonHierarchicalReferences referenceTypeToString registerNodePromoter removeElement replaceBufferWithHexDump resolveDynamicExtensionObject resolveFullyQualifiedDomainName resolveNodeId resolveOpaqueOnAddressSpace resolveOpaqueStructureInExtensionObject resolveOperand resolveReferenceNode resolveReferenceType roundToFloat2 RSAPKCS1V15_Decrypt RSAPKCS1V15_Encrypt s sameDataValue sameNodeId sameService sameStatusCode sameVariant serverTimestampHasChanged serviceToString set_flag setDebugLogger setDeprecated setErrorLogger setFakeTransport setLogLevel setNamespaceMetaData setNextSubscriptionId setSymbols setWarningLogger simpleBrowsePathsToString simpleBrowsePathToString sourceTimestampHasChanged stringPathToSimpleBrowsePath stringToQualifiedName timestamp timestampHasChanged toURI UInt64ToBigInt uninstallAlarmMonitoring uninstallPeriodicClockAdjustment validateDataType validateDataTypeCorrectness validateIsNumericDataType validateLocaleId verifyArguments_ArgumentList verifyIsOPCUAValidCertificate verifyRankAndDimensions verifySignature writeTCPMessageHeader

Events

RegisterServerManager