@blokcert/node-red-contrib-ocpp 1.0.0

package/nodes/ocpp-command.html

@@ -0,0 +1,201 @@
+<script type="text/javascript">
+    RED.nodes.registerType('ocpp-command', {
+        category: 'OCPP',
+        color: '#FF9800',
+        defaults: {
+            name: { value: '' },
+            server: { value: '', type: 'ocpp-config', required: true },
+            command: { value: '' },
+            timeout: { value: 30000, validate: RED.validators.number() },
+            streamMaxLen: { value: 1000, validate: RED.validators.number() },
+            waitForResponse: { value: true },
+        },
+        inputs: 1,
+        outputs: 2,
+        outputLabels: ['sent', 'response/error'],
+        icon: 'font-awesome/fa-bolt',
+        paletteLabel: 'ocpp command',
+        label: function () {
+            if (this.command) {
+                return this.name || `ocpp ${this.command}`;
+            }
+            return this.name || 'ocpp command';
+        },
+        labelStyle: function () {
+            return this.name ? 'node_label_italic' : '';
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="ocpp-command">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-command"><i class="fa fa-terminal"></i> Command</label>
+        <select id="node-input-command">
+            <option value="">(set via msg.ocpp.command)</option>
+            <optgroup label="OCPP 1.6 & 2.0.1">
+                <option value="Reset">Reset</option>
+                <option value="UnlockConnector">UnlockConnector</option>
+                <option value="TriggerMessage">TriggerMessage</option>
+                <option value="ChangeAvailability">ChangeAvailability</option>
+                <option value="ClearCache">ClearCache</option>
+                <option value="GetConfiguration">GetConfiguration / GetVariables</option>
+                <option value="ChangeConfiguration">ChangeConfiguration / SetVariables</option>
+            </optgroup>
+            <optgroup label="OCPP 1.6">
+                <option value="RemoteStartTransaction">RemoteStartTransaction</option>
+                <option value="RemoteStopTransaction">RemoteStopTransaction</option>
+                <option value="ReserveNow">ReserveNow</option>
+                <option value="CancelReservation">CancelReservation</option>
+                <option value="UpdateFirmware">UpdateFirmware</option>
+                <option value="GetDiagnostics">GetDiagnostics</option>
+                <option value="SendLocalList">SendLocalList</option>
+                <option value="GetLocalListVersion">GetLocalListVersion</option>
+            </optgroup>
+            <optgroup label="OCPP 2.0.1">
+                <option value="RequestStartTransaction">RequestStartTransaction</option>
+                <option value="RequestStopTransaction">RequestStopTransaction</option>
+                <option value="SetVariables">SetVariables</option>
+                <option value="GetVariables">GetVariables</option>
+                <option value="GetBaseReport">GetBaseReport</option>
+                <option value="SetChargingProfile">SetChargingProfile</option>
+                <option value="ClearChargingProfile">ClearChargingProfile</option>
+                <option value="GetCompositeSchedule">GetCompositeSchedule</option>
+            </optgroup>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-timeout"><i class="fa fa-clock-o"></i> Timeout (ms)</label>
+        <input type="number" id="node-input-timeout" placeholder="30000">
+    </div>
+    <div class="form-row">
+        <label for="node-input-waitForResponse"><i class="fa fa-reply"></i> Wait Response</label>
+        <input type="checkbox" id="node-input-waitForResponse" style="width: auto; margin-left: 0;">
+        <span style="margin-left: 10px;">Wait for device response (enables second output)</span>
+    </div>
+    <div class="form-row">
+        <label for="node-input-streamMaxLen"><i class="fa fa-list-ol"></i> Stream Max Len</label>
+        <input type="number" id="node-input-streamMaxLen" placeholder="1000">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="ocpp-command">
+    <p>Sends CSMS-initiated commands to charging stations.</p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">object</span></dt>
+        <dd>The command payload to send to the device.</dd>
+
+        <dt>ocpp.tenant <span class="property-type">string</span></dt>
+        <dd>Target operator/tenant identifier (required).</dd>
+
+        <dt>ocpp.deviceId <span class="property-type">string</span></dt>
+        <dd>Target charger/station ID (required).</dd>
+
+        <dt>ocpp.command <span class="property-type">string</span></dt>
+        <dd>Command action (overrides node config).</dd>
+
+        <dt>ocpp.messageId <span class="property-type">string</span></dt>
+        <dd>Custom message ID (auto-generated if not provided).</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <ol class="node-ports">
+        <li>Command Sent
+            <dl class="message-properties">
+                <dt>payload <span class="property-type">object</span></dt>
+                <dd>Original payload</dd>
+                <dt>ocpp.messageId <span class="property-type">string</span></dt>
+                <dd>Generated/provided message ID</dd>
+                <dt>ocpp.sentAt <span class="property-type">number</span></dt>
+                <dd>Timestamp when command was sent</dd>
+            </dl>
+        </li>
+        <li>Response/Error (when Wait Response is enabled)
+            <dl class="message-properties">
+                <dt>payload <span class="property-type">object</span></dt>
+                <dd>Response payload from device</dd>
+                <dt>ocpp.response <span class="property-type">boolean</span></dt>
+                <dd>True if this is a response</dd>
+                <dt>ocpp.error <span class="property-type">boolean</span></dt>
+                <dd>True if this is an error/timeout</dd>
+                <dt>ocpp.receivedAt <span class="property-type">number</span></dt>
+                <dd>Timestamp when response was received</dd>
+            </dl>
+        </li>
+    </ol>
+
+    <h3>Properties</h3>
+    <dl class="message-properties">
+        <dt>Command <span class="property-type">select</span></dt>
+        <dd>OCPP command to send. Can be overridden via <code>msg.ocpp.command</code>.</dd>
+
+        <dt>Timeout <span class="property-type">number</span></dt>
+        <dd>How long to wait for device response (ms).</dd>
+
+        <dt>Wait Response <span class="property-type">boolean</span></dt>
+        <dd>If enabled, waits for device response and outputs on second port.</dd>
+    </dl>
+
+    <h3>Common Commands</h3>
+    <table>
+        <tr><th>Command</th><th>Description</th></tr>
+        <tr><td>Reset</td><td>Reboot the charging station</td></tr>
+        <tr><td>RemoteStartTransaction</td><td>Start charging remotely (1.6)</td></tr>
+        <tr><td>RequestStartTransaction</td><td>Start charging remotely (2.0.1)</td></tr>
+        <tr><td>UnlockConnector</td><td>Unlock a connector</td></tr>
+        <tr><td>TriggerMessage</td><td>Request status update</td></tr>
+        <tr><td>ChangeAvailability</td><td>Set connector availability</td></tr>
+    </table>
+
+    <h3>Example: Remote Start</h3>
+    <pre>
+// For OCPP 1.6
+msg.ocpp = {
+    tenant: "operator1",
+    deviceId: "charger001",
+    command: "RemoteStartTransaction"
+};
+msg.payload = {
+    connectorId: 1,
+    idTag: "USER123"
+};
+return msg;
+
+// For OCPP 2.0.1
+msg.ocpp = {
+    tenant: "operator1",
+    deviceId: "station001",
+    command: "RequestStartTransaction"
+};
+msg.payload = {
+    evseId: 1,
+    idToken: {
+        idToken: "USER123",
+        type: "ISO14443"
+    }
+};
+return msg;
+    </pre>
+
+    <h3>Example: Reset</h3>
+    <pre>
+msg.ocpp = {
+    tenant: "operator1",
+    deviceId: "charger001",
+    command: "Reset"
+};
+msg.payload = {
+    type: "Soft"  // or "Hard"
+};
+return msg;
+    </pre>
+</script>

package/nodes/ocpp-command.js

@@ -0,0 +1,241 @@
+/**
+ * OCPP Command Node
+ * Sends CSMS-initiated commands to charging stations
+ */
+const { Keys } = require('../lib/redis-client');
+const { buildCall } = require('../lib/ocpp-normalizer');
+const crypto = require('crypto');
+
+module.exports = function (RED) {
+    function OCPPCommandNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        // Get config node
+        node.server = RED.nodes.getNode(config.server);
+        if (!node.server) {
+            node.error('No OCPP config node configured');
+            node.status({ fill: 'red', shape: 'ring', text: 'no config' });
+            return;
+        }
+
+        // Node configuration
+        node.command = config.command || ''; // Can be overridden by msg
+        node.timeout = parseInt(config.timeout, 10) || 30000;
+        node.streamMaxLen = parseInt(config.streamMaxLen, 10) || 1000;
+        node.waitForResponse = config.waitForResponse !== false; // Default true
+
+        const redis = node.server.redis;
+
+        // Pending commands waiting for response
+        const pendingCommands = new Map();
+
+        /**
+         * Generate unique message ID
+         */
+        function generateMessageId() {
+            return crypto.randomUUID();
+        }
+
+        /**
+         * Handle incoming messages
+         */
+        node.on('input', async (msg, send, done) => {
+            try {
+                // Determine target device
+                const tenant = msg.ocpp?.tenant || msg.tenant;
+                const deviceId = msg.ocpp?.deviceId || msg.deviceId;
+
+                if (!tenant || !deviceId) {
+                    throw new Error('Missing tenant or deviceId. Set msg.ocpp.tenant and msg.ocpp.deviceId');
+                }
+
+                // Determine command action
+                const action = msg.ocpp?.command || msg.command || node.command;
+                if (!action) {
+                    throw new Error('Missing command action. Set msg.ocpp.command or configure in node');
+                }
+
+                // Generate message ID
+                const messageId = msg.ocpp?.messageId || generateMessageId();
+
+                // Build command payload
+                const payload = msg.payload || {};
+
+                // Build OCPP CALL message
+                const callMessage = buildCall(messageId, action, payload);
+
+                // Send to device
+                const outboundKey = Keys.outbound(tenant, deviceId);
+                await redis.xadd(
+                    outboundKey,
+                    'MAXLEN', '~', node.streamMaxLen,
+                    '*',
+                    'messageId', messageId,
+                    'data', callMessage,
+                    'timestamp', Date.now().toString()
+                );
+
+                node.log(`Sent command ${action} to ${tenant}:${deviceId} (${messageId})`);
+
+                // Update status
+                node.status({
+                    fill: 'blue',
+                    shape: 'dot',
+                    text: `${action} → ${tenant}:${deviceId}`,
+                });
+
+                // Prepare output message
+                const outMsg = {
+                    ...msg,
+                    ocpp: {
+                        ...msg.ocpp,
+                        messageId,
+                        action,
+                        tenant,
+                        deviceId,
+                        identity: `${tenant}:${deviceId}`,
+                        sentAt: Date.now(),
+                    },
+                };
+
+                if (node.waitForResponse) {
+                    // Store pending command for response matching
+                    const pendingKey = Keys.pending(tenant, deviceId);
+
+                    // Store command info in Redis for response matching
+                    await redis.hset(pendingKey,
+                        messageId, JSON.stringify({
+                            action,
+                            sentAt: Date.now(),
+                            timeout: node.timeout,
+                        })
+                    );
+                    await redis.expire(pendingKey, Math.ceil(node.timeout / 1000) + 10);
+
+                    // Set up timeout
+                    const timeoutId = setTimeout(async () => {
+                        pendingCommands.delete(messageId);
+
+                        // Remove from Redis
+                        await redis.hdel(pendingKey, messageId).catch(() => {});
+
+                        node.status({
+                            fill: 'yellow',
+                            shape: 'dot',
+                            text: `timeout: ${action}`,
+                        });
+
+                        // Send timeout error on second output
+                        const timeoutMsg = {
+                            ...outMsg,
+                            ocpp: {
+                                ...outMsg.ocpp,
+                                error: true,
+                                errorCode: 'Timeout',
+                                errorDescription: `Command ${action} timed out after ${node.timeout}ms`,
+                            },
+                        };
+
+                        node.send([null, timeoutMsg]);
+                    }, node.timeout);
+
+                    // Store for cleanup
+                    pendingCommands.set(messageId, {
+                        timeoutId,
+                        msg: outMsg,
+                        action,
+                    });
+
+                    // Send on first output (command sent)
+                    if (send) {
+                        send([outMsg, null]);
+                    } else {
+                        node.send([outMsg, null]);
+                    }
+                } else {
+                    // Don't wait for response, just send confirmation
+                    if (send) {
+                        send(outMsg);
+                    } else {
+                        node.send(outMsg);
+                    }
+                }
+
+                if (done) {
+                    done();
+                }
+
+            } catch (err) {
+                node.error(`Command error: ${err.message}`, msg);
+                node.status({ fill: 'red', shape: 'dot', text: err.message });
+
+                if (done) {
+                    done(err);
+                }
+            }
+        });
+
+        /**
+         * Handle response messages (can be connected from another ocpp-in node filtering for responses)
+         */
+        node.handleResponse = function (messageId, response, isError) {
+            const pending = pendingCommands.get(messageId);
+            if (!pending) {
+                return false; // Not our command
+            }
+
+            // Clear timeout
+            clearTimeout(pending.timeoutId);
+            pendingCommands.delete(messageId);
+
+            // Update status
+            node.status({
+                fill: isError ? 'red' : 'green',
+                shape: 'dot',
+                text: `${pending.action}: ${isError ? 'error' : 'response'}`,
+            });
+
+            // Send response on second output
+            const responseMsg = {
+                ...pending.msg,
+                payload: response,
+                ocpp: {
+                    ...pending.msg.ocpp,
+                    response: true,
+                    error: isError,
+                    receivedAt: Date.now(),
+                },
+            };
+
+            node.send([null, responseMsg]);
+            return true;
+        };
+
+        // Initial status
+        node.status({ fill: 'grey', shape: 'ring', text: 'ready' });
+
+        // Update status when Redis is ready
+        if (redis) {
+            redis.once('ready', () => {
+                node.status({ fill: 'green', shape: 'ring', text: 'connected' });
+            });
+
+            if (redis.status === 'ready') {
+                node.status({ fill: 'green', shape: 'ring', text: 'connected' });
+            }
+        }
+
+        // Cleanup on close
+        node.on('close', (done) => {
+            // Clear all pending timeouts
+            for (const [, pending] of pendingCommands) {
+                clearTimeout(pending.timeoutId);
+            }
+            pendingCommands.clear();
+            done();
+        });
+    }
+
+    RED.nodes.registerType('ocpp-command', OCPPCommandNode);
+};

package/nodes/ocpp-config.html

@@ -0,0 +1,85 @@
+<script type="text/javascript">
+    RED.nodes.registerType('ocpp-config', {
+        category: 'config',
+        defaults: {
+            name: { value: '' },
+            host: { value: 'localhost', required: true },
+            port: { value: 6379, required: true, validate: RED.validators.number() },
+            db: { value: 0, validate: RED.validators.number() },
+            consumerGroup: { value: 'biz-workers', required: true },
+            consumerName: { value: '' },
+        },
+        credentials: {
+            password: { type: 'password' },
+        },
+        label: function () {
+            return this.name || `${this.host}:${this.port}`;
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="ocpp-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="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-host"><i class="fa fa-server"></i> Host</label>
+        <input type="text" id="node-config-input-host" placeholder="localhost">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-port"><i class="fa fa-plug"></i> Port</label>
+        <input type="number" id="node-config-input-port" placeholder="6379">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-password"><i class="fa fa-lock"></i> Password</label>
+        <input type="password" id="node-config-input-password" placeholder="(optional)">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-db"><i class="fa fa-database"></i> DB</label>
+        <input type="number" id="node-config-input-db" placeholder="0">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-consumerGroup"><i class="fa fa-users"></i> Consumer Group</label>
+        <input type="text" id="node-config-input-consumerGroup" placeholder="biz-workers">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-consumerName"><i class="fa fa-user"></i> Consumer Name</label>
+        <input type="text" id="node-config-input-consumerName" placeholder="(auto-generated)">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="ocpp-config">
+    <p>Configuration node for OCPP Redis connection.</p>
+
+    <h3>Properties</h3>
+    <dl class="message-properties">
+        <dt>Host <span class="property-type">string</span></dt>
+        <dd>Redis server hostname or IP address.</dd>
+
+        <dt>Port <span class="property-type">number</span></dt>
+        <dd>Redis server port (default: 6379).</dd>
+
+        <dt>Password <span class="property-type">string</span></dt>
+        <dd>Optional Redis password for authentication.</dd>
+
+        <dt>DB <span class="property-type">number</span></dt>
+        <dd>Redis database number (default: 0).</dd>
+
+        <dt>Consumer Group <span class="property-type">string</span></dt>
+        <dd>Redis Streams consumer group name (default: biz-workers).</dd>
+
+        <dt>Consumer Name <span class="property-type">string</span></dt>
+        <dd>Consumer name within the group. Auto-generated if empty.</dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>This configuration node is shared by OCPP input and output nodes.
+    It manages the Redis connection used for OCPP message streams.</p>
+
+    <h3>Redis Streams</h3>
+    <ul>
+        <li><code>ws:inbound</code> - Inbound messages from charging stations</li>
+        <li><code>ws:out:{tenant}:{deviceId}</code> - Outbound messages to devices</li>
+    </ul>
+</script>

package/nodes/ocpp-config.js

@@ -0,0 +1,54 @@
+/**
+ * OCPP Config Node
+ * Shared configuration for Redis connection and OCPP settings
+ */
+const { getConnection, closeConnection } = require('../lib/redis-client');
+
+module.exports = function (RED) {
+    function OCPPConfigNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        // Store configuration
+        node.host = config.host || 'localhost';
+        node.port = parseInt(config.port, 10) || 6379;
+        node.db = parseInt(config.db, 10) || 0;
+        node.consumerGroup = config.consumerGroup || 'biz-workers';
+        node.consumerName = config.consumerName || `node-red-${process.pid}`;
+
+        // Password from credentials (secure storage)
+        node.password = node.credentials?.password || '';
+
+        // Get or create Redis connection
+        try {
+            node.redis = getConnection(node.id, {
+                host: node.host,
+                port: node.port,
+                password: node.password,
+                db: node.db,
+            });
+
+            node.redis.on('ready', () => {
+                node.log(`Redis connected: ${node.host}:${node.port}`);
+            });
+
+            node.redis.on('error', (err) => {
+                node.error(`Redis error: ${err.message}`);
+            });
+        } catch (err) {
+            node.error(`Failed to create Redis connection: ${err.message}`);
+        }
+
+        // Cleanup on close
+        node.on('close', (done) => {
+            closeConnection(node.id);
+            done();
+        });
+    }
+
+    RED.nodes.registerType('ocpp-config', OCPPConfigNode, {
+        credentials: {
+            password: { type: 'password' },
+        },
+    });
+};