The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    UAAlarmConditionBase Class

    Extends UAAcknowledgeableConditionBase
    Defined in: packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:111
    Module: opcua.address_space.AlarmsAndConditions

    Constructor

    Methods

    (static)UAAcknowledgeableConditionBase.instantiate

    (
    • addressSpace
    • conditionTypeId
    • options
    • data
    )
    UAAcknowledgeableConditionBase

    Inherited from UAAcknowledgeableConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:318

    Parameters:

    Returns:

    UAAcknowledgeableConditionBase:

    (static)UAAlarmConditionBase.instantiate

    (
    • alarmConditionTypeId
    • options
    • data
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:662

    Parameters:

    • alarmConditionTypeId Object
    • options Object
      • inputNode
      • optionals

        could be "SuppressedState" , "ShelvingState"

      • [maxTimeShelved] Number | Null optional

        max TimeShelved duration (in ms)

    • data Object

    _calculateConditionInfo

    (
    • stateData
    • isActive
    • value
    • oldCondition
    )
    ConditionInfo

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:556

    Parameters:

    • stateData Object

      the new calculated state of the alarm

    • isActive Boolean
    • value Number

      the new value of the limit alarm

    • oldCondition ConditionInfo

      given for information purpose

      • severity
      • quality
      • message
      • retain

    Returns:

    ConditionInfo:

    the new condition info

    this method need to be overridden by the instantiate to allow custom message and severity to be set based on specific context of the alarm.

    Example:

    var myAlarm = addressSpace.instantiateExclusiveLimitAlarm({...}); myAlarm._calculateConditionInfo = function(stateName,value,oldCondition) { var percent = Math.ceil(value * 100); return new ConditionInfo({ message: "Tank is almost " + percent + "% full", severity: 100, quality: StatusCodes.Good }); };

    _confirm_branch

    (
    • eventId
    • comment
    • branch
    • message
    )
    private

    Inherited from UAAcknowledgeableConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:223

    Parameters:

    • eventId Object
    • comment Object
    • branch Object
    • message Object

    _setEnabledState

    (
    • requestedEnabledState
    )
    StatusCode private

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:926

    Parameters:

    • requestedEnabledState Boolean

    Returns:

    StatusCode: StatusCodes.Good if successful or BadConditionAlreadyEnabled/BadConditionAlreadyDisabled

    acknowledgeAndAutoConfirmBranch

    (
    • branch
    • comment
    )

    Inherited from UAAcknowledgeableConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:278

    Parameters:

    • branch Object
    • comment Object

    autoConfirmBranch

    (
    • branch
    • comment
    )

    Inherited from UAAcknowledgeableConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:260

    Parameters:

    • branch Object
    • comment Object

    getBranchCount

    () Number

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:813

    Returns:

    Number:

    getEnabledState

    () Boolean

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:904

    Returns:

    Boolean:

    getEnabledStateAsString

    () String

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:912

    Returns:

    String:

    getInputNodeNode

    () BaseNode

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:438

    Returns:

    BaseNode:

    return the node in the address space pointed by the inputNode value

    Note: please note the difference between alarm.inputNode

    • alarm.inputNode is a UAVariable property of the alarm object holding the nodeid of the input node in its value.
    • getInputNodeNode() is the UAVariable that contains the value that affects the state of the alarm and whose node id is stored in alarm.inputNode

    getMaxTimeShelved

    () Duration

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:199

    Returns:

    Duration:

    getSuppressedOrShelved

    () Boolean

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:177

    Returns:

    Boolean:

    isSuppressedOrShelved

    () Boolean

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:154

    Returns:

    Boolean:

    post_initialize

    () private

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:790

    raiseConditionEvent Raise a Instance Event (see also UAObject#raiseEvent to raise a transient event)

    (
    • branch
    )

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:1079

    Parameters:

    setLocalTime

    (
    • time
    )

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:1023

    Parameters:

    • time Date

    setMaxTimeShelved

    (
    • duration
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:186

    Parameters:

    • duration Object

      ( Duration in Milliseconds)

    setReceiveTime

    (
    • time
    )

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:1014

    Parameters:

    • time Date

    Properties

    inputNode

    UAVariable dataType is DataType.NodeId

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:483

    The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state. If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values; it is up to the system to determine which Variable’s NodeId is used.

    maxTimeShelved

    UAVariable

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:778

    The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved. The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve Method call. If a value that exceeds the value of this property is passed to the TimedShelve Method, than a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that an Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.

    shelvingState

    UAShelvingStateMachine

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:742

    ShelvingState suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user. It is quite often used to block nuisance Alarms.

    suppressedState

    UATwoStateVariable

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:723

    SuppressState is used internally by a Server to automatically suppress Alarms due to system specific reasons. For example a system may be configured to suppress Alarms that are associated with machinery that is shutdown, such as a low level Alarm for a tank that is currently not in use.

    suppressedState

    UAVariable - DataType Boolean

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:756

    The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.

    Events

    acknowledged

    Inherited from UAAcknowledgeableConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:197

    Event Payload:

    confirmed

    Inherited from UAAcknowledgeableConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:249

    Event Payload:

    • eventId Object
    • comment Object
    • eventId raised Object

      when the alarm branch has been confirmed