NodeOPCUA API Documentation
    Preparing search index...

    Interface PromoteToAlarmOptions

    The options promoteToAlarm accepts.

    The names are the ones instantiateAlarmCondition already uses, so the two routes to a working alarm read the same. Everything is optional here: a node being promoted usually already carries the children and references the factory would have created.

    interface PromoteToAlarmOptions {
        conditionClass?:
            | NodeId
            | BaseNode<BaseNodeEvents>
            | UAObject<UAObjectEvents>
            | null;
        conditionName?: string;
        conditionSource?:
            | NodeId
            | BaseNode<BaseNodeEvents>
            | UAObject<UAObjectEvents>
            | null;
        inputNode?: NodeId | UAVariable<UAVariableEvents>;
        maxTimeShelved?: number;
    }
    Index
    conditionClass? conditionName? conditionSource? inputNode? maxTimeShelved?
    conditionClass?:
        | NodeId
        | BaseNode<BaseNodeEvents>
        | UAObject<UAObjectEvents>
        | null

    Defaults to the ConditionType, as at instantiation time.

    conditionName?: string
    conditionSource?:
        | NodeId
        | BaseNode<BaseNodeEvents>
        | UAObject<UAObjectEvents>
        | null

    The node this alarm reports on. Wired as a backward HasCondition reference and used to fill SourceNode and SourceName, exactly as at instantiation time. The node has to be an event source, otherwise the events the alarm raises reach no one.

    inputNode?: NodeId | UAVariable<UAVariableEvents>

    The variable whose value drives the alarm; monitoring is installed when it is given.

    maxTimeShelved?: number

    Settings
    Member Visibility

    On This Page
    Properties