nodbus-plus 0.8.2 → 1.0.0

package/src/protocol/serial_adu.js

@@ -1,29 +0,0 @@
-/**
-** Modbus TCP Aplication Data Unit base class.
-* @module protocol/serial_adu
-* @author Hector E. Socarras.
-* @version 0.4.0
-*/
-
-const ADU = require('./adu');
-
-
-module.exports = class SerialADU extends ADU {
-    constructor(aduRaw =Buffer.alloc(1)){
-      super(aduRaw)
-
-      //propiedad error cheking
-      this.errorCheck = 0;
-    }
-
-    static isAsciiAdu(aduBuffer){
-      let firstByte = aduBuffer[0];
-      let lastByte = aduBuffer[aduBuffer.length - 1];
-      let preLastByte = aduBuffer[aduBuffer.length - 2];
-
-      if(firstByte == 0x3A & preLastByte == 0x0D & lastByte == 0x0A){
-        return true;
-      }
-      else return false
-    }
-}

package/src/protocol/tcp_adu.js

@@ -1,84 +0,0 @@
-/**
-** Modbus TCP Aplication Data Unit base class.
-* @module protocol/tcp_adu
-* @author Hector E. Socarras.
-* @version 0.4.0
-*/
-
-const ADU = require('./adu');
-const MBAP = require('./mbap');
-
-/**
- * Class representing a modbus tcp aplication data unit.
- * @extends ADU
-*/
-class TcpADU extends ADU {
-  /**
-  * Create a ADU.
-  * @param {Buffer} aduRaw Frame modbus.
-  */
-  constructor(aduRaw = Buffer.alloc(1)){
-    super(aduRaw);
-
-    this.transactionCounter = 0;
-
-    /**
-    * Header of frame modbus tcp
-    * @type {object}
-    */
-    this.mbap = new MBAP();
-  }
-
-/**
-* function to make adu frame from  MBAP and PDU object
-*/
-  MakeBuffer(){
-
-      //creando el buffer de la pdu
-      this.pdu.MakeBuffer();
-
-      //creando en buffer del mbap
-      this.mbap.transactionID = this.transactionCounter;
-      this.mbap.protocolID = 0;
-      this.mbap.length = this.pdu.pduBuffer.length+1;
-      this.mbap.unitID = this.address;
-      this.mbap.MakeBuffer();
-
-      var buff = Buffer.alloc(this.pdu.pduBuffer.length+this.mbap.mbapBuffer.length);
-
-      this.mbap.mbapBuffer.copy(buff);
-      this.pdu.pduBuffer.copy(buff,7);
-
-      this.aduBuffer = buff;
-  }
-
-  /**
-  *function to parse the adu buffer to make MBAP and PDU object
-  * @throws {string}
-  */
-  ParseBuffer() {
-
-      if(this.aduBuffer.length > 7) {
-        try {
-          this.mbap.mbapBuffer = this.aduBuffer.slice(0,7);
-          this.mbap.ParseBuffer();          
-          this.address = this.mbap.unitID;
-          this.pdu.pduBuffer = this.aduBuffer.slice(7);
-          this.pdu.ParseBuffer();
-          
-        }
-        catch(err)
-        {
-          throw err;
-        }
-      }
-      else {
-          throw new Error('adu buffer not contain a valid frame');
-      }
-
-  }
-
-
-}
-
-module.exports = TcpADU;

package/src/protocol/word_register.js

@@ -1,122 +0,0 @@
-/**
-** Word datatype memory.
-* @module protocol/word_register
-* @author Hector E. Socarras.
-* @version 0.4.0
-*/
-
-/**
- * Class representing a word memory area.
-*/
-class WordRegister {
-  /**
-  * Create a word register.
-  * @param {number} size total amount of references (inputs or holdings registers).
-  */
-  constructor(size = 1024){
-
-    /**
-    *core. using litle endian encoding
-    *@type {Buffer}
-    */
-    this.registerBuffer = Buffer.alloc(size * 2);
-
-    /**
-    *@type {number}
-    */
-    this.size = size;
-
-
-  }
-
-  
-
-/**
-*function to encode a register to send through a stream.
-* protocol send in BE; register are store in LE
-*@param {number} dataAddress address of register
-*@return {buffer}
-*/
-  EncodeRegister(dataAddress = 0){
-    if(dataAddress <= this.size){
-      let offset = dataAddress * 2;
-
-      let buffRegister = Buffer.alloc(2);
-      buffRegister[0] = this.registerBuffer[offset + 1];
-      buffRegister[1] = this.registerBuffer[offset];
-      return buffRegister;
-    }
-    else{
-      return false;
-    }
-  }
-
-  /**
-  *function to decode a register receive through a stream.
-  * protocol send in BE; register are store in LE
-  *@param {buffer} value
-  *@param {number} dataAddress address of register
-  */
-  DecodeRegister(value, dataAddress = 0){
-      if(dataAddress <= this.size){
-        let offset = dataAddress * 2;
-
-        this.registerBuffer[offset] = value[1];
-        this.registerBuffer[offset + 1] = value[0];
-        return true;
-
-      }
-      else{
-        return false;
-      }
-    }
-
-/**
-* function to set the register
-* @param {Buffer} value a Buffer with value encode  in litleendian
-* @param {number} dataAddress address of register
-* @return {boolean} true if success
-*/
-  SetRegister(value, dataAddress = 0){
-    if(dataAddress <= this.size){
-      let offset = dataAddress * 2;
-      if (value instanceof Buffer && value.length == 2) {
-        value.copy(this.registerBuffer, offset)
-        return true;
-      }
-      else{
-        throw new typeError('Value must be a size 2 Buffer');
-      }
-
-    }
-    else{
-      return false;
-    }
-  }
-
-/**
-* function to get the register
-* @param {number} dataAddress address of register
-* @return {buffer}
-*/
-  GetRegister(dataAddress = 0){
-    if(dataAddress <= this.size){
-      let offset = dataAddress * 2;
-
-      return this.registerBuffer.slice(offset, offset + 2);
-    }
-    else{
-      return false;
-    }
-  }
-
-  /**
-   * function to rezise the buffer of register
-   * @param {number} newSise
-   */
-  ReSize(newSize){
-    this.registerBuffer = Buffer.alloc(newSize * 2);
-  }
-}
-
-module.exports = WordRegister;

package/src/server/m_stcp_server.js

@@ -1,310 +0,0 @@
-/**
-* Modbus Serial encapsulated on Tcp server module.
-* @module server/m_stcp_server.
-* @author Hector E. Socarras.
-* @version 0.4.0
-*/
-
-const ModbusSlave = require('../protocol/modbus_slave');
-const TcpServer = require('../net/tcpserver');
-const RTU_ADU = require('../protocol/rtu_adu');
-const ASCII_ADU = require('../protocol/ascii_adu');
-
-/**
- * Class representing a modbus serial over tcp server.
- * @extends ModbusSlave
-*/
-class ModbusSTCPServer extends ModbusSlave {
-  /**
-  * Create a Modbus Tcp Server.
-  * @param {number} p Port to listen.
-  * @param {string} mode mode of work. 'rtu' frame rtu only, 'ascii' frame ascii only, 'aut' (default) both mode
-  */
-    constructor(p = 502, modbusAddress = 1, mode = 'aut'){
-      super(modbusAddress);
-
-      var self = this;
-
-      /**
-      * network layer
-      * @type {object}
-      */
-      this.tcpServer = new TcpServer();
-
-      //Adding listeners to tcpServer events
-
-      this.tcpServer.onData = this.ProcessModbusIndication.bind(this);
-
-      /**
-      * @fires ModbusTCPServer#connection
-      */
-       this.tcpServer.onConnection = function EmitConnection (socket) {
-          /**
-         * connection event.
-         * Emited when new connecton is sablished
-         * @event ModbusTCPServer#connection
-         * @type {object}
-         * @see https://nodejs.org/api/net.html
-         */
-          this.emit('connection',socket);
-      }.bind(this);
-
-
-      /**
-      * Event connection closed
-      * Emited when socket closed
-      * @see https://nodejs.org/api/net.html
-      * @fires ModbusTCPServer#connection-closed
-      */
-      this.tcpServer.onConnectionClose = function EmitConnectionClosed(socket){
-        /**
-       * connection-closed event.
-       * @event ModbusTCPServer#connection-closed
-       * @type {object}
-       */
-          this.emit('connection-closed', socket)
-      }.bind(this);
-
-      /**
-      * Event access denied
-      * Emited when new connecton is rejected by filter rules
-      * @fires ModbusTCPServer#access-denied
-      */
-      this.tcpServer.onAccessDenied = function EmitAccesDenied(socket){
-        /**
-       * access-denied event.
-       * @event ModbusTCPServer#access-denied
-       * @type {object}
-       */
-        this.emit('access-denied', socket);
-      }.bind(this);
-
-      /**
-      * Event listening
-      * Emited when server is listening
-      * @see https://nodejs.org/api/net.html
-      * @fires ModbusTCPServer#listening
-      */
-      this.tcpServer.onListening  = function EmitListening(port){
-        /**
-       * listening event.
-       * @event ModbusTCPServer#listening
-       * @type {number}
-       */
-        this.emit('listening',self.port);
-      }.bind(this);
-
-      /**
-      * Event closed
-      * Emited when server is closed
-      * @see https://nodejs.org/api/net.html
-      * @fires ModbusTCPServer#closed
-      */
-      this.tcpServer.onServerClose = function EmitClosed(){
-        /**
-       * closed event.
-       * @event ModbusTCPServer#closed
-       */
-        this.emit('closed');
-      }.bind(this);
-
-      /**
-      * Event error
-      * Emited when error hapen
-      * @fires ModbusTCPServer#error
-      */
-      this.tcpServer.onError = function EmitError(err){
-        /**
-       * error event.
-       * @event ModbusTCPServer#error
-       */
-        this.emit('error', err);
-      }.bind(this);
-
-      /**
-      * Event response
-      * Emited when response is send to master
-      * @fires ModbusTCPServer#response
-      */
-      this.tcpServer.onWrite = function EmitResponse(resp){
-        /**
-       * response event.
-       * @event ModbusTCPServer#response
-       */
-        this.emit('response', resp);
-      }.bind(this);
-
-      /**
-      * Event client disconnect
-      * Emited when client send fin packet
-      * @fires ModbusTCPServer#client-disconnect
-      */
-      this.tcpServer.onClientEnd = function EmitClientDisconnect(socket){
-        /**
-       * client-disconnect event.
-       * @event ModbusTCPServer#client-disconnect
-       */
-        this.emit('client-disconnect',socket);
-      }
-
-      /**
-      * port
-      * @type {number}
-      * @public
-      */
-      Object.defineProperty(self, 'port', {
-        get : function(){
-          return self.tcpServer.port;
-        },
-        set : function(p){
-          self.tcpServer.port = p;
-        }
-      })
-      this.port = p;
-
-
-
-      /**
-      * mode
-      * @type {string}
-      */
-      this.mode = mode;
-
-      /**
-      * listening status
-      * @type {bool}
-      * @public
-      */
-      Object.defineProperty(self, 'isListening',{
-        get: function(){
-          return self.tcpServer.isListening;
-        }
-      })
-
-      /**
-      * max client
-      * @type {number}
-      * @public
-      */
-      Object.defineProperty(self, 'maxConnections',{
-        get: function(){
-          return self.tcpServer.maxConnections;
-        },
-        set: function(max){
-          self.tcpServer.maxConnections = max;
-        }
-      })
-
-      //Sellando el tcpServer
-      Object.defineProperty(self, 'tcpServer', {
-        enumerable:false,
-        writable:false,
-        configurable:false
-      })
-      
-    }
-
-    /**
-    * Function to start the server
-    */
-    Start(){
-      this.tcpServer.Start();
-    }
-
-    /**
-    * Function to stop the server
-    */
-    Stop(){
-      this.tcpServer.Stop();
-    }
-
-    /**
-    * Function to execute when data are recive
-    * @param {Buffer} aduBuffer frame received by server
-    * @return {Buffer} response;
-    * @fires ModbusTCPServer#indication {Buffer}
-    */
-    ProcessModbusIndication(aduBuffer){
-
-      /**
-     * indication event.
-     * @event ModbusTCPServer#indication
-     */
-      this.emit('indication', aduBuffer);
-
-      let ADU;
-      var indicationADU;
-
-      switch (this.mode){
-        case 'rtu':
-          ADU =  RTU_ADU;
-          break;
-        case 'ascii':
-          ADU = ASCII_ADU;
-          break;
-        case 'aut':
-          (ASCII_ADU.isAsciiAdu(aduBuffer)) ? ADU = ASCII_ADU : ADU =  RTU_ADU;
-      }
-
-      indicationADU = new ADU(aduBuffer);
-
-
-        //checking adu
-        if (this.AnalizeADU(indicationADU)){            
-            return Buffer.alloc(0);
-        }
-        else{          
-            //adu ok
-            indicationADU.ParseBuffer();
-            //creando la respuesta
-            var responsePDU = this.BuildResponse(indicationADU.pdu);
-
-            if(indicationADU.address == 0){
-              //broadcast no response
-              return Buffer.alloc(0);
-            }
-            else{
-              //response
-              if(responsePDU != null){
-                var modbusResponse = new ADU();
-                modbusResponse.address = indicationADU.address;                
-                modbusResponse.pdu = responsePDU;
-                modbusResponse.MakeBuffer();
-
-              return modbusResponse.aduBuffer;
-              }
-              else{
-                return Buffer.alloc(0);
-              }
-            }
-
-        }
-    }
-
-
-    /**
-    * Make the response modbus tcp header
-    * @param {buffer} adu frame off modbus indication
-    * @return {number} error code. 1- error, 0-no errror
-    * @fires ModbusTCPServer#error {object}
-    */
-    AnalizeADU(adu){
-      try{
-        adu.ParseBuffer();
-
-        if ((adu.address != this.modbusAddress & adu.address != 0) | adu.address > 247){
-            //ignore the frame if address missmatch
-            return 1;
-        }
-        else{
-          return 0;
-        }
-      }
-      catch(e){
-        this.emit('error', e);
-        return 1;
-      }
-    }
-}
-
-module.exports = ModbusSTCPServer;