@vitormnm/node-red-simple-opcua 1.0.0 → 1.0.2

package/client/lib/opcua-client-subscription-service.js

@@ -1,171 +0,0 @@
-"use strict";
-
-const {
-    ClientMonitoredItem,
-    ClientSubscription,
-    TimestampsToReturn,
-    AttributeIds,
-    constructEventFilter
-} = require("node-opcua");
-
-const {
-    dataValueToItemResult,
-    dataValueToItemResultEvent,
-    resolveName,
-    resolveNodeId,
-    statusCodeToString
-} = require("../opcua-client-utils");
-
-class OpcUaClientSubscriptionService {
-    async startDataSubscription(node, msg, itemsResolver) {
-        const items = itemsResolver.ensureClientItems(node, msg, "OPC UA subscription");
-        await this.stop(node);
-
-        const session = await node.connection.getSession();
-        const subscription = ClientSubscription.create(session, {
-            requestedPublishingInterval: node.publishingInterval,
-            requestedLifetimeCount: 60,
-            requestedMaxKeepAliveCount: 10,
-            maxNotificationsPerPublish: 100,
-            publishingEnabled: true,
-            priority: 1
-        });
-
-        subscription.on("error", (error) => {
-            node.status({ fill: "red", shape: "ring", text: "subscription error" });
-            node.error(error);
-        });
-
-        node.subscription = subscription;
-        node.monitoredItems = items.map((item) => {
-            const monitoredItem = ClientMonitoredItem.create(
-                subscription,
-                { nodeId: resolveNodeId(item) },
-                {
-                    samplingInterval: node.samplingInterval,
-                    discardOldest: true,
-                    queueSize: 1
-                },
-                TimestampsToReturn.Both
-            );
-
-            monitoredItem.on("changed", (dataValue) => {
-                const payload = dataValueToItemResult(item, dataValue);
-                node.status({
-                    fill: "blue",
-                    shape: "dot",
-                    text: resolveName(item, payload.nodeID) + " changed"
-                });
-                node.send({
-                    topic: payload.name,
-                    payload,
-                    opcua: {
-                        mode: "subscription",
-                        nodeID: payload.nodeID,
-                        status: payload.status
-                    }
-                });
-            });
-
-            monitoredItem.on("err", (message) => {
-                node.status({ fill: "red", shape: "ring", text: statusCodeToString(message) });
-            });
-
-            return monitoredItem;
-        });
-
-        return items;
-    }
-
-    async startEventSubscription(node, msg, itemsResolver) {
-        const items = itemsResolver.ensureClientItems(node, msg, "OPC UA subscription");
-        await this.stop(node);
-
-        const session = await node.connection.getSession();
-        const subscription = ClientSubscription.create(session, {
-            requestedPublishingInterval: node.publishingInterval,
-            requestedLifetimeCount: 60,
-            requestedMaxKeepAliveCount: 10,
-            maxNotificationsPerPublish: 100,
-            publishingEnabled: true,
-            priority: 2
-        });
-
-        subscription.on("error", (error) => {
-            node.status({ fill: "red", shape: "ring", text: "subscription error" });
-            node.error(error);
-        });
-
-        node.subscription = subscription;
-
-        const eventFilter = constructEventFilter([
-            "EventId",
-            "EventType",
-            "SourceName",
-            "SourceNode",
-            "Message",
-            "Severity",
-            "ActiveState",
-            "AckedState",
-            "ConfirmedState",
-            "Time"
-        ]);
-
-        node.monitoredItems = items.map((item) => {
-            const monitoredItem = ClientMonitoredItem.create(
-                subscription,
-                {
-                    nodeId: resolveNodeId(item),
-                    attributeId: AttributeIds.EventNotifier
-                },
-                {
-                    samplingInterval: 0,
-                    queueSize: 100,
-                    discardOldest: true,
-                    filter: eventFilter
-                },
-                TimestampsToReturn.Both
-            );
-
-            monitoredItem.on("changed", async (eventFields) => {
-                const payload = await dataValueToItemResultEvent(item, eventFields, session);
-                node.status({
-                    fill: "blue",
-                    shape: "dot",
-                    text: resolveName(item, payload.nodeID) + " changed"
-                });
-                node.send({
-                    topic: payload.name,
-                    payload,
-                    opcua: {
-                        mode: "subscription",
-                        nodeID: payload.nodeID,
-                        status: payload.status
-                    }
-                });
-            });
-
-            monitoredItem.on("err", (message) => {
-                node.status({ fill: "red", shape: "ring", text: statusCodeToString(message) });
-            });
-
-            return monitoredItem;
-        });
-
-        return items;
-    }
-
-    async stop(node) {
-        const subscription = node.subscription;
-        node.monitoredItems = [];
-        node.subscription = null;
-
-        if (subscription) {
-            await subscription.terminate();
-        }
-    }
-}
-
-module.exports = {
-    OpcUaClientSubscriptionService
-};

package/client/lib/opcua-client-write-service.js

@@ -1,53 +0,0 @@
-"use strict";
-
-const { DataType, coerceNodeId } = require("node-opcua");
-const {
-    buildVariantFromItem,
-    dataValueToItemResult,
-    normalizeTypeName,
-    resolveNodeId,
-    statusCodeToString
-} = require("../opcua-client-utils");
-
-class OpcUaClientWriteService {
-    async execute(node, msg, session, itemsResolver) {
-        const items = itemsResolver.ensureWriteItems(node, msg);
-        const results = [];
-
-        for (const item of items) {
-            const nodeId = resolveNodeId(item);
-
-            try {
-                const explicitType = normalizeTypeName(item.type);
-                const builtInType = await session.getBuiltInDataType(coerceNodeId(nodeId));
-                const typeName = explicitType || DataType[builtInType];
-                const variant = buildVariantFromItem(item, typeName);
-                const statusCode = await session.writeSingleNode(nodeId, variant);
-                const dataValue = await session.readVariableValue(nodeId);
-                const result = dataValueToItemResult(item, dataValue);
-
-                if (statusCode && statusCode.name && statusCode.name !== "Good") {
-                    result.status = statusCodeToString(statusCode);
-                }
-
-                results.push(result);
-            } catch (itemError) {
-                results.push({
-                    name: item.name || nodeId,
-                    nodeID: nodeId,
-                    value: item.value,
-                    type: normalizeTypeName(item.type) || null,
-                    status: itemError.message,
-                    sourceTimestamp: null,
-                    serverTimestamp: null
-                });
-            }
-        }
-
-        return results;
-    }
-}
-
-module.exports = {
-    OpcUaClientWriteService
-};

package/client/opcua-client-config.html

@@ -1,80 +0,0 @@
-<script type="text/javascript">
-    (function () {
-        function toggleCredentials() {
-            var authType = $("#node-config-input-authType").val();
-            $(".opcua-client-auth-row").toggle(authType === "username");
-        }
-
-        RED.nodes.registerType("opcua-client-config", {
-            category: "config",
-            defaults: {
-                name: { value: "" },
-                endpoint: { value: "opc.tcp://localhost:4840", required: true },
-                securityPolicy: { value: "None", required: true },
-                securityMode: { value: "None", required: true },
-                authType: { value: "anonymous", required: true }
-            },
-            credentials: {
-                username: { type: "text" },
-                password: { type: "password" }
-            },
-            label: function () {
-                return this.name || this.endpoint || "opcua-client-config";
-            },
-            oneditprepare: function () {
-                $("#node-config-input-authType").on("change", toggleCredentials);
-                toggleCredentials();
-            }
-        });
-    })();
-</script>
-
-<script type="text/html" data-template-name="opcua-client-config">
-    <div class="form-row">
-        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-config-input-name" placeholder="OPC UA Client">
-    </div>
-    <div class="form-row">
-        <label for="node-config-input-endpoint"><i class="fa fa-plug"></i> Endpoint</label>
-        <input type="text" id="node-config-input-endpoint" placeholder="opc.tcp://localhost:4840">
-    </div>
-    <div class="form-row">
-        <label for="node-config-input-securityPolicy"><i class="fa fa-lock"></i> Security Policy</label>
-        <select id="node-config-input-securityPolicy">
-            <option value="None">None</option>
-            <option value="Basic128Rsa15">Basic128Rsa15</option>
-            <option value="Basic256">Basic256</option>
-            <option value="Basic256Sha256">Basic256Sha256</option>
-            <option value="Aes128_Sha256_RsaOaep">Aes128_Sha256_RsaOaep</option>
-            <option value="Aes256_Sha256_RsaPss">Aes256_Sha256_RsaPss</option>
-        </select>
-    </div>
-    <div class="form-row">
-        <label for="node-config-input-securityMode"><i class="fa fa-shield"></i> Security Mode</label>
-        <select id="node-config-input-securityMode">
-            <option value="None">None</option>
-            <option value="Sign">Sign</option>
-            <option value="SignAndEncrypt">SignAndEncrypt</option>
-        </select>
-    </div>
-    <div class="form-row">
-        <label for="node-config-input-authType"><i class="fa fa-user"></i> Auth</label>
-        <select id="node-config-input-authType">
-            <option value="anonymous">Anonymous</option>
-            <option value="username">Username/Password</option>
-        </select>
-    </div>
-    <div class="form-row opcua-client-auth-row">
-        <label for="node-config-input-username"><i class="fa fa-user-circle"></i> Username</label>
-        <input type="text" id="node-config-input-username">
-    </div>
-    <div class="form-row opcua-client-auth-row">
-        <label for="node-config-input-password"><i class="fa fa-key"></i> Password</label>
-        <input type="password" id="node-config-input-password">
-    </div>
-</script>
-
-<script type="text/html" data-help-name="opcua-client-config">
-    <p>Shared OPC UA client connection for read, write and method nodes.</p>
-    <p>This is a Node-RED configuration node, using <code>category: "config"</code> and the <code>node-config-input-*</code> field pattern described in the official docs.</p>
-</script>

package/client/opcua-client-config.js

@@ -1,159 +0,0 @@
-"use strict";
-
-const {
-    OPCUAClient,
-    getMethodArgumentDefinition,
-    resolveMethodObjectId,
-    resolveSecurityMode,
-    resolveSecurityPolicy
-} = require("./opcua-client-utils");
-
-const {
-    browseNode,
-    ROOT_NODE_ID
-} = require("./lib/opcua-client-browser");
-
-module.exports = function (RED) {
-    function OpcUaClientConfigNode(config) {
-        RED.nodes.createNode(this, config);
-        const node = this;
-
-        node.name = (config.name || "").trim();
-        node.endpoint = (config.endpoint || "").trim();
-        node.securityPolicy = config.securityPolicy || "None";
-        node.securityMode = config.securityMode || "None";
-        node.authType = config.authType || "anonymous";
-        node.client = null;
-        node.session = null;
-        node.connectPromise = null;
-        node.methodObjectIdCache = new Map();
-        node.methodDefinitionCache = new Map();
-
-        node.on("close", function (done) {
-            node.closeConnection().then(() => done(), done);
-        });
-    }
-
-    OpcUaClientConfigNode.prototype.getSession = async function () {
-        if (this.session) {
-            return this.session;
-        }
-
-        if (this.connectPromise) {
-            return this.connectPromise;
-        }
-
-        if (!this.endpoint) {
-            throw new Error("OPC UA endpoint is not configured");
-        }
-
-        this.connectPromise = (async () => {
-            const client = OPCUAClient.create({
-                endpointMustExist: false,
-                keepSessionAlive: true,
-                securityMode: resolveSecurityMode(this.securityMode),
-                securityPolicy: resolveSecurityPolicy(this.securityPolicy)
-            });
-
-            try {
-                await client.connect(this.endpoint);
-
-                const credentials = this.credentials || {};
-                const session = this.authType === "username"
-                    ? await client.createSession({
-                        userName: credentials.username || "",
-                        password: credentials.password || ""
-                    })
-                    : await client.createSession();
-
-                session.on("session_closed", () => {
-                    this.session = null;
-                    this.methodObjectIdCache.clear();
-                    this.methodDefinitionCache.clear();
-                });
-
-                this.client = client;
-                this.session = session;
-                return session;
-            } catch (error) {
-                try {
-                    await client.disconnect();
-                } catch (disconnectError) {
-                    // Ignore secondary disconnect failures after a failed connect/createSession.
-                }
-                this.client = null;
-                this.session = null;
-                throw error;
-            } finally {
-                this.connectPromise = null;
-            }
-        })();
-
-        return this.connectPromise;
-    };
-
-    OpcUaClientConfigNode.prototype.resolveMethodObjectId = async function (session, methodNodeId) {
-        return resolveMethodObjectId(session, methodNodeId, this.methodObjectIdCache);
-    };
-
-    OpcUaClientConfigNode.prototype.getMethodArgumentDefinition = async function (session, methodNodeId) {
-        return getMethodArgumentDefinition(session, methodNodeId, this.methodDefinitionCache);
-    };
-
-    OpcUaClientConfigNode.prototype.closeConnection = async function () {
-        const session = this.session;
-        const client = this.client;
-
-        this.session = null;
-        this.client = null;
-        this.connectPromise = null;
-        this.methodObjectIdCache.clear();
-        this.methodDefinitionCache.clear();
-
-        if (session) {
-            try {
-                await session.close();
-            } catch (error) {
-                // Ignore close errors during shutdown.
-            }
-        }
-
-        if (client) {
-            try {
-                await client.disconnect();
-            } catch (error) {
-                // Ignore disconnect errors during shutdown.
-            }
-        }
-    };
-
-    RED.nodes.registerType("opcua-client-config", OpcUaClientConfigNode, {
-        credentials: {
-            username: { type: "text" },
-            password: { type: "password" }
-        }
-    });
-
-    RED.httpAdmin.get("/opcua-client-config/:id/browse", RED.auth.needsPermission("flows.read"), async function (req, res) {
-        try {
-            const configNode = RED.nodes.getNode(req.params.id);
-
-            if (!configNode) {
-                res.status(404).json({ error: "OPC UA client configuration not found" });
-                return;
-            }
-
-            const payload = await browseForEditor(configNode, req.query.nodeId);
-            res.json(payload);
-        } catch (error) {
-            res.status(500).json({ error: error.message });
-        }
-    });
-};
-
-async function browseForEditor(configNode, nodeId) {
-    const session = await configNode.getSession();
-    return browseNode(session, {
-        nodeID: nodeId || ROOT_NODE_ID
-    });
-}