ctrlx-datalayer-subscribe.js

/**
 *
 * MIT License
 *
 * Copyright (c) 2020-2023 Bosch Rexroth AG
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

const CtrlxProblemError = require('./lib/CtrlxProblemError');


module.exports = function(RED) {
  'use strict';
  const CtrlxDatalayerSubscription = require('./lib/CtrlxDatalayerSubscription');


  /* ---------------------------------------------------------------------------
   * NODE - Subscribe
   * -------------------------------------------------------------------------*/
  function CtrlxDatalayerSubscribe(config) {
    RED.nodes.createNode(this, config);

    // Save settings in local node
    this.subscription = config.subscription;
    this.configSubscription = RED.nodes.getNode(this.subscription);
    this.name = config.name;
    this.path = config.path;
    this.eventCounter = 0;
    this.isDynamic = config.hasOwnProperty("inputs") && config.inputs == 1


    //
    // Define functions called by nodes
    //
    let node = this;
    this.setStatus = function(status) {
      node.status(status);
    };

    const Actions = {
      SUBSCRIBE: 'subscribe',
      UNSUBSCRIBE: 'unsubscribe',
    };
    const allowableActions = Object.values(Actions);


    if (this.configSubscription) {
      node.status({ fill: 'red', shape: 'ring', text: 'not logged in' });

      if (this.configSubscription.configNodeDevice.connected) {
        node.status({ fill: 'green', shape: 'dot', text: 'authenticated' });
      }


      //
      // Emit handler
      //
      let notifyHandler = function (err, data, lastEventId) {
        if (err) {
          if (err.message) {
            node.status({ fill: 'red', shape: 'ring', text: `subscription failed: ${err.message}` });
            node.error(err.message);
          } else {
            node.status({ fill: 'red', shape: 'ring', text: `subscription failed` });
            node.error('unknown error');
          }
        } else {
          node.eventCounter++;
          node.status({ fill: 'green', shape: 'dot', text: `received data #${node.eventCounter}` });
          node.send({
            topic: data.node,
            payload: data.value,
            type: data.type,
            timestamp: CtrlxDatalayerSubscription.convertTimestamp2Javascript(data.timestamp),
            timestampFiletime: data.timestamp
          });
        }
      };

      if (!node.isDynamic) {
        node.configSubscription.register(node, node.path, notifyHandler);
      } else {
        node.status({ fill: 'yellow', shape: 'ring', text: 'not subscribed' });
      }


      //
      // Input handler (dynamic)
      //
      node.on('input', function (msg, send, done) {
        const action = msg.action;

        if (!allowableActions.includes(action)) {
          done(new Error(`Invalid action: ${action}`));
          return;
        }

        if (action === Actions.SUBSCRIBE) {
          node.configSubscription.register(node, msg.path, notifyHandler);
          node.eventCounter = 0;
        } else if (action === Actions.UNSUBSCRIBE) {
          node.configSubscription.deregister(node, (err) => {
            node.status({ fill: 'yellow', shape: 'ring', text: 'not subscribed' });
            node.eventCounter = 0;
            done(err);
          });
        }

      });


      //
      // Close handler
      //
      this.on('close', function(done) {
        node.configSubscription.deregister(node, done);
        node.eventCounter = 0;
      });


    } else {
      this.error('Missing configuration node for subscription to ctrlX Data Layer');
    }
  }

  RED.nodes.registerType('ctrlx-datalayer-subscribe', CtrlxDatalayerSubscribe);
};