nodbus-plus 0.8.2 → 1.0.0

package/src/net/tcpserver.js

@@ -1,329 +0,0 @@
-/**
-**  Tcp server module.
-* @module net/tcpserver.
-* @author Hector E. Socarras.
-* @version 0.4.0
-*/
-
-var net = require('net');
-
-/**
- * Class representing a tcp server layer for modbus tcp.
- */
-class TCPServer {
-  /**
-  * Create a Tcp Server.
-  */
-  constructor(){
-
-    var self = this;
-
-    /**
-    * tcp server
-    * @type {Object}
-    */
-    this.tcpServer = net.createServer();
-
-
-    let connections = [];
-    /**
-    * list of connections
-    * @type {Object[]}
-    */
-    Object.defineProperty(self,'activeConections',{
-        get: function(){ return connections}
-    })
-
-    /**
-    * listening status
-    * @type {boolean}
-    */
-    Object.defineProperty(self, 'isListening',{
-      get: function(){
-        return self.tcpServer.listening;
-      }
-    });
-
-    /**
-    * Max connections
-    * @type {number}
-    */
-    Object.defineProperty(self, 'maxConnections',{
-      get: function(){
-        return self.tcpServer.maxConnections;
-      },
-      set: function(max){
-        self.tcpServer.maxConnections = max;
-      }
-    });
-
-    /**
-    * port
-    * @type {number}
-    */
-    this.port = 502;
-
-    /**
-    * list of ip allowed
-    * @type {string[]}
-    */
-    this.listAuthorizedIP = ['INADDR_ANY'];
-
-    /**
-    * list of ip denied
-    * @type {string[]}
-    */
-    this.listForbidendIP  = ['NONE'];
-
-    /**
-    * Acces control function.
-    * @param {object} net.socket
-    * @return {bool}
-    */
-    function AllowConnection (socket) {
-
-        var isForbidden = self.listForbidendIP.indexOf(socket.remoteAddres);
-        var isAuthorized = self.listAuthorizedIP.indexOf(socket.remoteAddres);
-
-        if(isForbidden == -1 && self.listAuthorizedIP.indexOf('INADDR_ANY') >= 0 ){
-            return true
-        }
-        else if(isForbidden >= 0 ){
-            return false
-        }
-        else if(isAuthorized >= 0  & isForbidden == -1){
-            return true
-        }
-        else{
-            return false
-        }
-    }
-
-    //Socket config
-
-    /**
-    *  Inactivity time to close a connection
-    * @type {number}
-    */
-    this.connectionTimeout = 0;
-
-    //User listeners
-    /**
-    *  function to executed when event data is emited
-    * @param {Buffer} data
-    */
-    this.onData = function(data){console.log(data)};
-
-    /**
-    *  function to executed when event listening is emited
-    */
-    this.onListening = function(){ console.log('listening')};
-
-    /**
-    *  function to executed when event connection is emited
-    * @param {Object} net.socket
-    */
-    this.onConnection = function(){ console.log('new connection')};
-
-    /**
-    *  function to executed when event access-denied is emited
-    * @param {Object} net.socket
-    */
-    this.onAccessDenied = null;
-
-    /**
-    *  function to executed when event error is emited
-    * @param {Object} error
-    */
-    this.onError = function(err){ console.log(err)};
-
-    /**
-    *  function to executed when event close is emited
-    */
-    this.onServerClose = function(){ console.log('server close')};
-
-    /**
-    *  function to executed when event socket#close is emited
-    */
-    this.onConnectionClose = null;;
-
-    /**
-    *function to executed when event socket#end is emited
-    */
-    this.onClientEnd = null;
-
-    /**
-    *  function to executed when event write is emited
-    * @param {Buffer} buff
-    */
-    this.onWrite = null
-
-    this.tcpServer.on('error', function(err){
-      self.onError(err);
-    });
-
-    this.tcpServer.on('close', function(){
-      connections = [];
-      self.onServerClose();
-    });
-
-    this.tcpServer.on('listening', function(){
-      self.onListening()
-    });
-
-    this.tcpServer.on('connection', function(socket) {
-
-      self.onConnection(socket);
-
-        if(AllowConnection(socket)){
-
-            //agrego el socket a la lista de conexiones activas
-            connections.push(socket)
-
-            //defining sockets behavior
-            if(self.connectionTimeout > 0) {
-              socket.setTimeout(self.connectionTimeout);
-            }
-
-            socket.on('data',function(data){
-
-              var response = self.onData(data);
-
-                if(response.length <= 1 ){
-                    return;
-                }
-                else{
-                    socket.write(response, 'utf8', function(){
-                      if(self.onWrite){
-                        self.onWrite(response);
-                      }
-                    });
-                }
-            });
-
-            socket.on('error',self.onError);
-
-            socket.on('timeout',function() {
-                socket.end();
-            })
-
-
-            if(self.onClientEnd){
-              socket.on('end', self.onClientEnd);
-            }
-
-            socket.on('close',function(){
-                var index = connections.indexOf(socket);
-                connections.splice(index,1);
-            });
-
-            if(self.onConnectionClose){
-              socket.on('close', self.onConnectionClose);
-            }
-        }
-        else{
-            socket.end();
-            if(self.onAccessDenied){
-              self.onAccessDenied(socket);
-            }
-        }
-    });
-
-  }
-
-  /**
-  * Add a ip to list of allowed ip
-  * @param {string} ip format aaa.bbb.ccc.ddd
-  * @throws {string}
-  */
-  AddAuthorizedIP(ip){
-    if(typeof(ip) == 'string'){
-       this.listAuthorizedIP.push(ip);
-    }
-    else{
-      throw 'error of ip format'
-    }
-  }
-
-  /**
-  * Remove a ip to list of allowed ip
-  * @param {string} ip format aaa.bbb.ccc.ddd
-  * @throws {string}
-  */
-  RemoveAuthorizedIP (ip){
-       if(typeof(ip) == 'string'){
-           var index = listAuthorizedIP.indexOf(ip)
-           this.listAuthorizedIP.splice(index,i);
-       }
-       else{
-         throw 'error of ip format'
-       }
-  }
-
-  /**
-  * Add a ip to list of forbiden ip
-  * @param {string} ip format aaa.bbb.ccc.ddd
-  * @throws {string}
-  */
-  AddForbidenIP (ip){
-      if(typeof(ip) == 'string'){
-         this.listForbidendIPIP.push(ip);
-      }
-      else{
-        throw 'error of ip format'
-      }
-  }
-
-  /**
-  * Remove a ip to list of forbiden ip
-  * @param {string} ip format aaa.bbb.ccc.ddd
-  * @throws {string}
-  */
-  RemoveForbidendIP (ip){
-       if(typeof(ip) == 'string'){
-           var index = listAuthorizedIP.indexOf(ip)
-           this.listForbidendIP.splice(index,i);
-       }
-       else{
-         throw 'error of ip format'
-       }
-  }
-
-  /**
-  * Start the tcp server
-  */
-  Start (){
-      try {
-         this.tcpServer.listen(this.port)
-      }
-      catch(error){
-          this.onError(error);
-      }
-  }
-
-  /**
-  * Stop the tcp server
-  */
-  Stop (){
-      //cerrando el server
-      this.tcpServer.close();
-      var sockets = this.activeConections;
-      sockets.forEach(function(element){
-          element.destroy();
-      });
-  }
-
-  /**
-  * function to write in a conection
-  * @param {objec} socket
-  * @param {buffer} data
-  */
-  Write (socket,data){
-      socket.write(data);
-  }
-
-}
-
-
-
-module.exports = TCPServer;

package/src/protocol/adu.js

@@ -1,40 +0,0 @@
-/**
-** Modbus Aplication Data Unit base class.
-* @module protocol/adu.js.
-* @author Hector E. Socarras.
-* @version 0.4.0
-*/
-
-const PDU = require('./pdu');
-
-/**
- * Class representing a modbus aplication data unit.
-*/
- class ADU {
-   /**
-   * Create a ADU.
-   * @param {Buffer} aduRaw Frame modbus.
-   */
-    constructor(aduRaw = Buffer.alloc(1)){
-      /**
-      *Frame
-      *@type {Buffer}
-      */
-      this.aduBuffer = aduRaw;
-
-      /**
-      *modbus address
-      *@type {number}
-      */
-      this.address = 247;
-
-      /**
-      *Protocol data unit object
-      *@type {object}
-      */
-      this.pdu = new PDU();
-    }
-
-}
-
-module.exports = ADU;

package/src/protocol/ascii_adu.js

@@ -1,139 +0,0 @@
-/**
-*@brief Clase de Aplication Data Unit Ascii
-*
-*@author Hector E. Socarras.
-*date 19/5/2016
-*/
-
-const SerialADU = require('./serial_adu');
-
-
-module.exports = class AsciiADU extends SerialADU {
-  constructor(aduRaw = Buffer.alloc(1)){
-    super(aduRaw);
-
-  }
-
-  MakeBuffer(){
-
-    /**
-    *function to convert a value in 2 chars lenght buffer
-    *@param byte  number;
-    *@return {Buffer}
-    */
-    function Byte2Chars (byte){
-
-        var temp = Buffer.alloc(2);
-
-        if(byte > 0x0F){
-            //convierto el numero en su sttring equivalente en hexadecimal y lo escrbo en el buffer temp
-            temp.write((byte & 0x0F).toString(16).toUpperCase(), 1);
-            temp.write((byte >> 4).toString(16).toUpperCase());
-        }
-        else {
-
-            temp.write(0x00.toString(16).toUpperCase());
-            temp.write(byte.toString(16).toUpperCase(),1);
-        }
-
-        return temp;
-    }
-
-      //buffer temporal para el calculo de los caracteres
-      var charBuffer = Buffer.alloc(2);
-
-      //creando el buffer de la pdu
-      this.pdu.MakeBuffer();
-
-      //size of aduBuffer = 1 start char + 2 address char + 2*pduBuffer + 2 char lrc + 2 char end
-      var tempBuffer = Buffer.alloc(2*this.pdu.pduBuffer.length + 7);
-      var l = tempBuffer.length;
-
-      let rtuBuffer = Buffer.alloc(this.pdu.pduBuffer.length + 1)
-      rtuBuffer.writeUInt8(this.address);
-      this.pdu.pduBuffer.copy(rtuBuffer, 1);
-
-      //caracter ascii de inicio ':'
-      tempBuffer[0] = 0x3A;
-
-      if(this.address <= 247){
-          charBuffer = Byte2Chars(this.address);
-          charBuffer.copy(tempBuffer,1)
-      }
-      else{
-         throw Error('address error');
-         return;
-      }
-
-      for(var i = 0;i < this.pdu.pduBuffer.length;i++){
-         charBuffer = Byte2Chars(this.pdu.pduBuffer[i])
-         charBuffer.copy(tempBuffer,2*i+3)
-      }
-
-      this.errorCheck = this.GetLRC(rtuBuffer);
-
-
-      tempBuffer.write(this.errorCheck.toString(16).toUpperCase(), l-4, 2,'ascii');
-
-      //caracter ascii de fin 'CRLF'
-      tempBuffer[l-2] = 0x0D;
-      tempBuffer[l-1] = 0x0A;
-
-      this.aduBuffer = tempBuffer;
-
-  }
-
-  ParseBuffer() {
-      /**
-      *@brief function que parsea un buffer y para obtiener los atributos de la adu
-      */
-
-      var l= this.aduBuffer.length;
-      var rtuBuffer;
-
-      this.address = Number('0x'+this.aduBuffer.toString('ascii',1,3));
-
-      //pdu normal en rtu entendible por el serial server
-      this.pdu.pduBuffer = Buffer.alloc(Math.floor((l - 7)/2));
-
-      for(var i = 0; i < this.pdu.pduBuffer.length; i++){
-          this.pdu.pduBuffer[i]=Number('0x'+this.aduBuffer.toString('ascii',2*i+3 ,2*i+5));
-      }
-
-      rtuBuffer = Buffer.alloc(this.pdu.pduBuffer.length + 1)
-      rtuBuffer.writeUInt8(this.address);
-      this.pdu.pduBuffer.copy(rtuBuffer, 1);
-
-      this.errorCheck = Number('0x'+this.aduBuffer.toString('ascii',l-4,l-2));
-
-
-      if(this.errorCheck == this.GetLRC(rtuBuffer)){
-        try{
-          this.pdu.ParseBuffer();
-        }
-        catch(e){
-          throw err;
-        }
-      }
-      else{
-        throw new Error('checksum error');
-      }
-  }
-
-
-  GetLRC(frame){
-
-    var  byteLRC = Buffer.alloc(1);
-
-    for(var i = 0; i < frame.length;i++){
-      byteLRC[0] = byteLRC[0] + frame[i];
-    }
-
-    var lrc_temp = Buffer.alloc(1);
-    lrc_temp[0] = -byteLRC[0];
-    var lrc = lrc_temp.readUInt8(0)
-    return lrc;
-
-  }
-
-}

package/src/protocol/boolean_register.js

@@ -1,78 +0,0 @@
-/**
-** bolean datatype memory.
-* @module protocol/bolean_register
-* @author Hector E. Socarras.
-* @version 0.4.0
-*/
-
-/**
- * Class representing a boolean memory area.
-*/
-class BoleanRegister {
-  /**
-  * Create a bolean register.
-  * @param {number} size total amount of references (inputs or coils).
-  */
-  constructor(size = 1024){
-
-    /**
-    *core.
-    *@type {Buffer}
-    */
-    this.registerBuffer = Buffer.alloc((size > 8) ? size/8 : 1);
-
-    /**
-    *@type {number}
-    */
-    this.size = size;
-
-
-  }
-
-  ReadData(dataAddress = 0){
-    if(dataAddress <= this.size){
-
-      let Byte = this.registerBuffer[Math.floor(dataAddress/8)];
-      let offset = dataAddress%8;
-      let masks = [0x01, 0x02, 0x04, 0x08, 0x010, 0x20, 0x40, 0x80];
-
-      return ((Byte & masks[offset]) > 0 ) ? true : false;
-
-    }
-    else{
-      return undefined;
-    }
-  }
-
-  WriteData(value, dataAddress = 0){
-    if(dataAddress <= this.size){
-      let newByte = 0x00;
-      let Byte = this.registerBuffer[Math.floor(dataAddress/8)];
-      let offset = dataAddress%8;
-      let masks = [0x01, 0x02, 0x04, 0x08, 0x010, 0x20, 0x40, 0x80];
-      if(value == true || value > 0){
-        newByte = Byte | masks[offset];
-      }
-      else {
-        newByte = Byte & (~masks[offset]);
-      }
-
-      this.registerBuffer[Math.floor(dataAddress/8)] = newByte;
-      return true;
-    }
-    else{
-      return false;
-    }
-  }
-
-  /**
-   * function to rezise the buffer of register
-   * @param {number} newSise
-   */
-  ReSize(newSize){
-    this.registerBuffer = Buffer.alloc((newSize > 8) ? newSize/8 : 1);
-  }
-
-}
-
-module.exports = BoleanRegister;

package/src/protocol/functions/Force_Multiple_Coils.js

@@ -1,76 +0,0 @@
-/*
-*@author Hector E. Socarras
-*@brief
-*Se implementa la funcion 05 del protocolo de modbus.
-*Debuelve un objeto pdu con el echo del request.
-*
-*@param objeto pdu
-*/
-
-var PDU = require('../pdu');
-
-
-
-var ForceMultipleCoils = function (pdu){
-
-    var respPDU = new PDU();
-
-    //coil inicial ejemplo el coil 20 direccionado como 0x13 (19)
-    var startCoil = pdu.modbus_data.readUInt16BE(0);
-
-
-     if (startCoil >= this.coils.size){
-        //Verificando q la coil solicitada exista
-        //Creando exception 0x02
-        respPDU.modbus_function = pdu.modbus_function | 0x80;
-        respPDU.modbus_data[0] = 0x02;
-
-        this.emit('modbus_exception','ILLEGAL DATA ADDRESS');
-
-        return respPDU;
-    }
-    else {
-
-        //coil inicial ejemplo el coil 20 direccionado como 0x13 (19)
-        var startCoil = pdu.modbus_data.readUInt16BE(0);
-
-        //cantidad de coils a escribir
-        var number_points =   pdu.modbus_data.readUInt16BE(2);
-
-        //Datos a forzar
-        var forceDataCount = pdu.modbus_data.readUInt8(5);
-
-        let forceData = pdu.modbus_data.slice(5);
-
-        let filletMask = [0x00, 0xFE, 0xFC, 0xF8, 0xF0, 0xE0, 0xC0, 0x80];
-        let masks = [0x01, 0x02, 0x04, 0x08, 0x010, 0x20, 0x40, 0x80];
-
-        if( (forceData[forceData.length] & filletMask[number_points%8]) != 0x00){
-            //Creando exception 0x03
-            respPDU.modbus_function = pdu.modbus_function | 0x80;
-            respPDU.modbus_data[0] = 0x03;
-
-          this.emit('modbus_exception', 'Illegal Data');
-            return respPDU;
-
-        }
-        else{
-          let values = new Map();
-          for(var i = 0; i < number_points; i++){
-            let offset = startCoil + i;
-            let val = forceData[Math.floor(i/8)] & masks[i%8]
-            this.coils.WriteData(val, offset);
-            values.set(offset, val > 0);
-          }
-
-          respPDU.modbus_function = 0x0F;
-          respPDU.modbus_data = Buffer.alloc(4);
-          pdu.modbus_data.copy(respPDU.modbus_data,0,0,4);
-
-          this.emit('values', '0x', values);
-          return respPDU;
-        }
-    }
-}
-
-module.exports = ForceMultipleCoils;

package/src/protocol/functions/Force_Single_Coil.js

@@ -1,54 +0,0 @@
-/*
-*@author Hector E. Socarras
-*@brief
-*Se implementa la funcion 05 del protocolo de modbus.
-*Debuelve un objeto pdu con el echo del request.
-*
-*@param objeto pdu
-*/
-
-var PDU = require('../pdu');
-
-var ForceSingleCoil = function (pdu){
-
-    var respPDU = new PDU();
-
-    //coil inicial ejemplo el coil 20 direccionado como 0x13 (19)
-    var targetCoil = pdu.modbus_data.readUInt16BE(0);
-
-    //valor a forzar
-    var value = pdu.modbus_data.readUInt16BE(2);
-
-    if(targetCoil >= this.coils.size){
-        //Verificando q la coil solicitada exista
-        //Creando exception 0x02
-        respPDU.modbus_function = pdu.modbus_function | 0x80;
-        respPDU.modbus_data[0] = 0x02;
-
-        this.emit('modbus_exception','ILLEGAL DATA ADDRESS');
-
-        return respPDU;
-    }
-    else if (value != 0x0000 & value != 0xFF00 ) {
-        //verificando el campo valor sea valido
-        //Creando exception 0x03
-        respPDU.modbus_function = pdu.modbus_function | 0x80;
-        respPDU.modbus_data[0] = 0x03;
-
-        this.emit('modbus_exception','ILLEGAL VALUE');
-
-        return respPDU;
-    }
-    else {
-        let values = new Map();
-        this.coils.WriteData(value, targetCoil);
-        values.set(targetCoil, (value > 0));
-        //creando una copia del request
-        respPDU = pdu;
-        this.emit('values', '0x', values);
-
-        return respPDU;
-    }
-}
-
-module.exports = ForceSingleCoil;