The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.4.5

    • APIs

    Show:

    AddressSpace Class

    Defined in: packages\node-opcua-address-space\src\ua_two_state_variable.js:2
    Module: opcua.address_space

    AddressSpace is a collection of UA nodes.

    const addressSpace = new AddressSpace();

    Constructor

    AddressSpace

    (
    • conditionTypeId
    • options
    • data
    )
    UAConditionBase

    Defined in packages\node-opcua-address-space\src\ua_two_state_variable.js:2

    Parameters:

    • conditionTypeId Object
    • options Object
    • data Object

    Returns:

    UAConditionBase:

    Methods

    _coerceNode

    (
    • node
    )
    private

    Defined in packages\node-opcua-address-space\src\address_space.js:804

    Parameters:

    • node Object

    Returns:

    :

    _isFolder

    (
    • addressSpace
    • folder
    )
    Boolean private

    Defined in packages\node-opcua-address-space\src\address_space.js:787

    return true if nodeId is a Folder

    Parameters:

    • addressSpace Object
    • folder Object

    Returns:

    Boolean:

    addAlias

    (
    • alias_name
    • nodeId
    )

    Defined in packages\node-opcua-address-space\src\address_space.js:205

    Parameters:

    • alias_name String

      the alias name

    • nodeId NodeId

    addEnumerationType

    (
    • options
    )

    Defined in packages\node-opcua-address-space\src\address_space_add_enumeration_type.js:25

    Parameters:

    • options Object
      • browseName String
      • enumeration Array
      • enumeration[].displayName String | LocalizedText
      • enumeration[].value Number
      • enumeration[].description String | LocalizedText | Null

    addEnumerationType

    (
    • options
    )

    Defined in packages\node-opcua-address-space\src\address_space_add_enumeration_type.js:38

    Parameters:

    • options Object
      • browseName String
      • enumeration Array
      • enumeration[].displayName String | LocalizedText
      • enumeration[].value Number
      • enumeration[].description String | LocalizedText | Null

    addFolder

    (
    • parentFolder
    • options
    )
    BaseNode

    Defined in packages\node-opcua-address-space\src\address_space.js:1015

    Parameters:

    • parentFolder Object
    • options String | Object
      • browseName String

        the name of the folder

      • [nodeId] NodeId optional

        . An optional nodeId for this object

    Returns:

    BaseNode:

    addMethod

    (
    • parentObject
    • options
    )
    Object

    Defined in packages\node-opcua-address-space\src\address_space_add_method.js:58

    Parameters:

    • parentObject Object
    • options Object
      • [nodeId=null] NodeId optional

        the object nodeid.

      • [browseName=""] String optional

        the object browse name.

      • [description=""] String optional

        the object description.

      • inputArguments Array
      • outputArguments Array

    Returns:

    Object:

    addMultiStateValueDiscrete

    (
    • options
    • [options.value
    )
    Object | UAVariable

    Provided by the opcua.address_space.AlarmsAndConditions module.

    Defined in packages\node-opcua-address-space\src\data_access\address_space_add_MultiStateValueDiscrete.js:43

    Parameters:

    • options Object
    • [options.value UInt32

      = 0 }

    Returns:

    Object | UAVariable:

    Example:

     namespace.addMultiStateValueDiscrete({
                          componentOf:parentObj,
                          browseName: "myVar",
                          enumValues: {
                              "Red":    0xFF0000,
                              "Green":  0x00FF00,
                              "Blue":   0x0000FF
                          }
                      });
                      addMultiStateValueDiscrete(parentObj,{
                          browseName: "myVar",
                          enumValues: [
                              {
                                 value: 0xFF0000,
                                 displayName: "Red",
                                 description: " The color Red"
                              },
                              {
                                 value: 0x00FF000,
                                 displayName: "Green",
                                 description: " The color Green"
                              },
                              {
                                 value: 0x0000FF,
                                 displayName: "Blue",
                                 description: " The color Blue"
                              }
                         ]
                      });

    addTransition

    (
    • component
    • fromState
    • toState
    • transitionNumber
    )
    UAObject

    Defined in packages\node-opcua-address-space\src\state_machine\address_space_state_machine.js:66

    Parameters:

    • component UAObject
    • fromState StateType | InitialStateType
    • toState StateType | InitialStateType
    • transitionNumber Number

    Returns:

    UAObject:

    TransitionType

    addTwoStateDiscrete

    (
    • options
    • [options.value
    • [options.trueState
    • [options.falseState
    )
    Object | UAVariable

    Provided by the opcua.address_space.AlarmsAndConditions module.

    Defined in packages\node-opcua-address-space\src\data_access\address_space_add_TwoStateDiscrete.js:13

    Parameters:

    • options Object
      • browseName String
      • [nodeId] NodeId optional
    • [options.value Boolean

      }

    • [options.trueState String

      = "ON" }

    • [options.falseState String

      = "OFF" }

    Returns:

    Object | UAVariable:

    addYArrayItem

    (
    • options
    )

    Provided by the opcua.address_space.AlarmsAndConditions module.

    Defined in packages\node-opcua-address-space\src\data_access\address_space_add_YArrayItem.js:27

    Parameters:

    • options Object
      • componentOf NodeId
      • browseName String
      • title String
      • [instrumentRange] optional
        • [low] Double optional
        • [high] Double optional
      • engineeringUnitsRange.low Double
      • engineeringUnitsRange.high Double
      • engineeringUnits String
      • [nodeId] NodeId optional
      • accessLevel
      • userAccessLevel
      • title String
      • axisScaleType AxisScaleEnumeration
      • xAxisDefinition AxisInformation
        • engineeringUnits EURange
        • range
        • range.low
        • range.high
        • title LocalizedText
        • axisScaleType AxisScaleEnumeration
        • axisSteps Array
          =
      • value

    browsePath

    (
    • browsePath
    )
    BrowsePathResult

    Defined in packages\node-opcua-address-space\src\address_space_browse.js:21

    browse some path.

    Parameters:

    Returns:

    BrowsePathResult:

    This service can be used translates one or more browse paths into NodeIds. A browse path is constructed of a starting Node and a RelativePath. The specified starting Node identifies the Node from which the RelativePath is based. The RelativePath contains a sequence of ReferenceTypes and BrowseNames.

    StatusCode
    BadNodeIdUnknown
    BadNodeIdInvalid
    BadNothingToDo - the relative path contains an empty list )
    BadBrowseNameInvalid - target name is missing in relative path
    UncertainReferenceOutOfServer - The path element has targets which are in another server.
    BadTooManyMatches
    BadQueryTooComplex
    BadNoMatch

    browseSingleNode

    (
    • nodeId
    • browseDescription
    • [session]
    )
    BrowseResult

    Defined in packages\node-opcua-address-space\src\address_space.js:1073

    Parameters:

    Returns:

    BrowseResult:

    constructExtensionObject

    (
    • dataType
    • [options =null]
    )
    Object

    Defined in packages\node-opcua-address-space\src\address_space_construct_extension_object.js:37

    Parameters:

    • dataType UADataType
    • [options =null] Object optional

    Returns:

    Object:

    Example:

            // example 1
                            var extObj = addressSpace.constructExtensionObject("BuildInfo",{ productName: "PRODUCTNAME"});
                    
                            // example 2
                            serverStatusDataType.should.be.instanceOf(UADataType);
                            serverStatusDataType.browseName.toString().should.eql("ServerStatusDataType");
                            var serverStatus  = addressSpace.constructExtensionObject(serverStatusDataType);
                            serverStatus.constructor.name.should.eql("ServerStatus");

    dispose

    ()

    Defined in packages\node-opcua-address-space\src\address_space.js:1031

    cleanup all resources maintained by this addressSpace.

    extractRootViews

    (
    • node
    )
    BaseNode

    Defined in packages\node-opcua-address-space\src\address_space.js:854

    walk up the hierarchy of objects until a view is found objects may belong to multiples views. Note: this method doesn't return the main view => Server object.

    Parameters:

    • node BaseNode

    Returns:

    BaseNode:

    findCorrespondingBasicDataType

    (
    • dataTypeNode
    )

    Defined in packages\node-opcua-address-space\src\address_space.js:348

    Parameters:

    • dataTypeNode Object

    Example:

    const dataType = addressSpace.findDataType("ns=0;i=12");
                    addressSpace.findCorrespondingBasicDataType(dataType).should.eql(DataType.String);
                    
                    const dataType = addressSpace.findDataType("ServerStatus"); // ServerStatus
                    addressSpace.findCorrespondingBasicDataType(dataType).should.eql(DataType.ExtensionObject);

    findDataType

    (
    • dataType
    • [namespaceIndex=0]
    )
    DataType | Null

    Defined in packages\node-opcua-address-space\src\address_space.js:311

    Find the DataType node from a NodeId or a browseName

    Parameters:

    • dataType String | NodeId
    • [namespaceIndex=0] Number optional

      an optional namespace index

    Returns:

    DataType | Null:

    Example:

     const dataDouble = addressSpace.findDataType("Double");
                    
                     const dataDouble = addressSpace.findDataType(resolveNodeId("ns=0;i=3"));

    findNode

    (
    • nodeId
    )
    BaseNode | Null

    Defined in packages\node-opcua-address-space\src\address_space.js:217

    find an node by node Id

    Parameters:

    • nodeId NodeId | String

      a nodeId or a string coerce-able to nodeID, representing the object to find.

    Returns:

    BaseNode | Null:

    findObjectType

    (
    • objectType
    • [namespaceIndex=0]
    )
    UAObjectType | Null

    Defined in packages\node-opcua-address-space\src\address_space.js:394

    Parameters:

    • objectType String | NodeId | QualifiedName
    • [namespaceIndex=0] Number optional

      an optional namespace index

    Returns:

    UAObjectType | Null:

    Example:

    const objectType = addressSpace.findObjectType("ns=0;i=58");
                     objectType.browseName.toString().should.eql("BaseObjectType");
                    const objectType = addressSpace.findObjectType("BaseObjectType");
                     objectType.browseName.toString().should.eql("BaseObjectType");
                    const objectType = addressSpace.findObjectType(resolveNodeId("ns=0;i=58"));
                     objectType.browseName.toString().should.eql("BaseObjectType");
                    const objectType = addressSpace.findObjectType("CustomObjectType",36);
                     objectType.nodeId.namespace.should.eql(36);
                     objectType.browseName.toString().should.eql("BaseObjectType");
                    const objectType = addressSpace.findObjectType("36:CustomObjectType");
                     objectType.nodeId.namespace.should.eql(36);
                     objectType.browseName.toString().should.eql("BaseObjectType");

    findReferenceType

    (
    • refType
    • [namespace=0]
    )
    ReferenceType | Null

    Defined in packages\node-opcua-address-space\src\address_space.js:478

    Parameters:

    • refType String | NodeId
    • [namespace=0] Number optional

      an optional namespace index

    Returns:

    ReferenceType | Null:

    refType could be a string representing a nodeid : e.g. 'i=9004' or ns=1;i=6030 a string representing a browse name : e.g 'HasTypeDefinition' in this case it should be in the alias list

    findReferenceTypeFromInverseName

    (
    • inverseName
    )
    ReferenceType

    Defined in packages\node-opcua-address-space\src\address_space.js:524

    find a ReferenceType by its inverse name.

    Parameters:

    • inverseName String

      the inverse name of the ReferenceType to find

    Returns:

    ReferenceType:

    findTransitionNode

    (
    • fromStateNode
    • toStateNode
    )
    UAObject

    Defined in packages\node-opcua-address-space\src\state_machine\finite_state_machine.js:247

    Parameters:

    • fromStateNode NodeId | BaseNode | String
    • toStateNode NodeId | BaseNode | String

    Returns:

    UAObject:

    findVariableType

    (
    • variableType
    • [namespaceIndex=0]
    )
    UAObjectType | Null

    Defined in packages\node-opcua-address-space\src\address_space.js:428

    Parameters:

    • variableType String | NodeId
    • [namespaceIndex=0] Number optional

      an optional namespace index

    Returns:

    UAObjectType | Null:

    Example:

    const objectType = addressSpace.findVariableType("ns=0;i=62");
                    objectType.browseName.toString().should.eql("BaseVariableType");
                    
                    const objectType = addressSpace.findVariableType("BaseVariableType");
                    objectType.browseName.toString().should.eql("BaseVariableType");
                    
                    const objectType = addressSpace.findVariableType(resolveNodeId("ns=0;i=62"));
                    objectType.browseName.toString().should.eql("BaseVariableType");

    getCurrentState

    () String

    Defined in packages\node-opcua-address-space\src\state_machine\finite_state_machine.js:299

    Returns:

    String:

    getDefaultNamespace

    () NameSpace

    Defined in packages\node-opcua-address-space\src\address_space.js:131

    Returns:

    NameSpace:

    the default namespace (standard OPCUA namespace)

    getNamespace

    (
    • namespace
    )
    NameSpace

    Defined in packages\node-opcua-address-space\src\address_space.js:112

    Parameters:

    • namespace String | Number

      index or namespace uri.

    Returns:

    NameSpace:

    the namespace

    getNamespaceArray

    () Namespace

    Defined in packages\node-opcua-address-space\src\address_space.js:197

    Returns:

    Namespace:

    the namespace array

    getNamespaceIndex

    (
    • namespaceUri
    )
    Number

    Defined in packages\node-opcua-address-space\src\address_space.js:185

    Parameters:

    • namespaceUri Strings

    Returns:

    Number:

    the namespace index of a namespace given by its namespace uri

    getOwnNamespace objects instances managed by the server will be created in this namespace.

    () NameSpace

    Defined in packages\node-opcua-address-space\src\address_space.js:139

    Returns:

    NameSpace:

    address space own namespace

    getStateByName

    (
    • name
    )
    Null | UAObject

    Defined in packages\node-opcua-address-space\src\state_machine\finite_state_machine.js:118

    Parameters:

    • name String

    Returns:

    Null | UAObject:

    historyRead

    (
    • context
    • historyReadDetails
    • indexRange
    • dataEncoding
    • continuationPoint
    • callback
    )

    Defined in packages\node-opcua-address-space\src\historical_access\ua_variable_history.js:11

    Parameters:

    installHistoricalDataNode

    (
    • node
    • [options]
    )

    Defined in packages\node-opcua-address-space\src\historical_access\address_space_historical_data_node.js:143

    Parameters:

    • node Object

      UAVariable

    • [options] Object optional
      • [maxOnlineValues= 1000] optional

    inverseReferenceType

    (
    • referenceType
    )
    String

    Defined in packages\node-opcua-address-space\src\address_space.js:634

    returns the inverse name of the referenceType.

    Parameters:

    • referenceType String

      : the reference type name

    Returns:

    String:

    the name of the inverse reference type.

    Example:

    addressSpace.inverseReferenceType("OrganizedBy").should.eql("Organizes");
                    addressSpace.inverseReferenceType("Organizes").should.eql("OrganizedBy");

    isNodeIdString

    (
    • str
    )

    Defined in packages\node-opcua-address-space\src\address_space.js:455

    returns true if str matches a nodeID, e.g i=123 or ns=...

    Parameters:

    • str Object

    isValidTransition

    (
    • toStateNode
    )
    Boolean

    Defined in packages\node-opcua-address-space\src\state_machine\finite_state_machine.js:220

    Parameters:

    • toStateNode Object

    Returns:

    Boolean:

    make_back_references

    (
    • addressSpace
    )

    Defined in packages\node-opcua-address-space\src\loader\load_nodeset2.js:41

    Parameters:

    normalizeReferenceType

    (
    • params.referenceType
    • params.isForward
    )
    Object

    Defined in packages\node-opcua-address-space\src\address_space.js:534

    Parameters:

    • params.referenceType String | NodeId
    • params.isForward Boolean

      default value: true;

    Returns:

    Object:

    a new reference object with the normalized name { referenceType: , isForward: }

    registerNamespace register a new namespace

    (
    • namespaceUri
    )
    Namespace

    Defined in packages\node-opcua-address-space\src\address_space.js:158

    Parameters:

    • namespaceUri String

    Returns:

    Namespace:

    registerShutdownTask

    ()

    Defined in packages\node-opcua-address-space\src\address_space.js:1049

    register a function that will be called when the server will perform its shut down.

    resolveNodeId

    (
    • nodeId
    )
    NodeId

    Defined in packages\node-opcua-address-space\src\address_space.js:276

    resolved a string or a nodeId to a nodeID

    Parameters:

    Returns:

    NodeId:

    setState

    (
    • toStateNode
    )

    Defined in packages\node-opcua-address-space\src\state_machine\finite_state_machine.js:313

    Parameters: