mqtt-devices-parser 1.0.0 → 1.0.2

package/Changelog.md

@@ -1,3 +1,8 @@
+# 1.0.2
+	-	passes config struct por methods
+
+# 1.0.1
+	- adds deploy method
 
 # 1.0.0
 	- Module to parse mqtt messages from devices

package/Readme.md

@@ -1,65 +1,23 @@
 
 # mqtt-devices-parser
 
-MQTT parser
-Parses topics received from devices and updates data on dB
-
-## Setup
-
-### Command
-  >> node deploy
-
-  1. build/sync all tables inside models folder
-  2. registers users and clients if not registered already
-
-  3. build/sync all tables inside projects folder
-  4. registers projects and models/apps if not registered already
-
-## Working mode
-
-### Command
-  >> node index
-
-  1. Checks all projects inside src/projects folder and enable it if is activated in config/index.js
-
-  2. Connects to defined MQTT broker
-
-  3. Parse MQTT messages starting with :project/MACRO_UID_PREFIX+uid/
-
-    3.1 register device if not exists
-    3.2 Associate to a project if project is registered
-    3.3 Associate to a model/app if model is registered
-
-  4. Call project parseMessage function
-
-## Instructions
-
-  Projects folders must be kept
-
-  The following functions must exist inside a file with the same name of the project
+## NPM Module
+  - MQTT parser
+  - Parses topics coming from devices and updates data on dB
 
+## Deploy
   ```
-  module.exports = {
-    sync_db : async()=>{
-    },
-    init : async ()=>{
-    },
-    parseMessage : async (client, project, device, topic, payload, retain, cb)=>{
-    },
-  }
+  parser.deploy(config,projectsPath);
   ```
 
-  Ex: If project name is freeRTOS2, so must exist a file in projects/freeRTOS2/freeRTOS2.js.
-
-  Calling the following methods will write data in a ${table} with the name of the project, and also
-  in other table called "logs_"+${table}. Data will be written if there is a field in the respective table
-  with the same name as the name in topic.
-
+## Run
   ```
-  $.db_data.update(project,device?.id,topic,payload);
-  $.db_data.addLog("logs_"+project,device.id,topic,payload);
+  parser.init(config,projects);
   ```
 
+## Examples
+  check example path to see how to use this module
+
 ## UnitTest
 
 

package/example/deploy.js

@@ -0,0 +1,14 @@
+const config = require('../config');
+const parser = require('mqtt-devices-parser');
+
+global.BASE_DIR = process.cwd();
+var projectsPath = global.BASE_DIR+'../projects/';
+
+parser.deploy(config,projectsPath);
+
+process.on('unhandledRejection', (reason, promise) => {
+  console.error('Unhandled Rejection at:', promise, 'reason:', reason);
+  // exit with failure code
+  if($.config.dev)
+    process.exit(1);
+});

package/example/index.js

@@ -0,0 +1,25 @@
+config = require('./config');
+const fs = require('fs');
+const parser = require('mqtt-devices-parser');
+
+global.BASE_DIR = process.cwd();
+var projectsPath = '../projects/';
+var projects = [];
+
+fs.readdirSync(projectsPath)
+.filter((file) => {
+  return (file.indexOf('.') == -1);
+})
+.forEach((project) => {
+  if(config.projects[project])
+    projects.push(project);
+});
+
+parser.init(config,projects);
+
+process.on('unhandledRejection', (reason, promise) => {
+  console.error('Unhandled Rejection at:', promise, 'reason:', reason);
+  // exit with failure code
+  if($.config.dev)
+    process.exit(1);
+});

package/index.js

@@ -1,4 +1,5 @@
 const mqtt = require("mqtt");
+const fs = require('fs').promises;
 
 $ = {};
 $.md5 = require('md5');
@@ -18,6 +19,7 @@ const packageJson = require(__dirname+'/package.json');
 const packageVersion = packageJson.version;
 
 var projects = [];
+var project = {};
 
 var self = module.exports = {
 
@@ -30,17 +32,79 @@ var self = module.exports = {
       if(_projects != null)
         projects = _projects;
 
-      await $.models.init();
+      await $.models.init(_config);
       await $.models.connect();
 
       //auth.init();
-      await $.device.init(projects);
+      await $.device.init(_config,projects);
 
       console.log("mqtt connecting..")
       mqtt_connect();
 
       return resolve();
     })
+  },
+
+  readModelsInsideProjects: async(projectsPath)=>{
+
+    return new Promise( async (resolve,reject) => {
+
+      // load projects dbs
+      var files = await fs.readdir(projectsPath)
+
+      files = files.filter((file) => {
+        // Exclude any extension file
+        return (file.indexOf('.') == -1);
+      })
+
+      let counter_help = 0;
+      files.forEach( async(name,counter) => {
+        if($.config.projects[name]){
+          project[name] = {};
+          project[name]['module'] = null;
+          project[name].module = require(`${projectsPath}${name}/${name}.js`)
+          await project[name].module.sync_db();
+          counter_help++;
+          if(files.length == counter_help) return resolve();
+        }else{
+          counter_help++;
+          if(files.length == counter_help) return resolve();
+        }
+
+      });
+
+    });
+
+  },
+
+  deploy: async(_config,projectsPath)=>{
+
+    if(_config != null)
+        $.config = _config;
+
+    await $.models.init();
+    await $.models.connect();
+
+    //main tables
+    if($.config.sync_main_tables){
+
+      await $.models.load(__dirname+"/models");
+      await $.models.dropTableIndexes();
+      await $.models.sync();
+
+      let user = await $.models.insertUser("admin","admin",5); // ads user
+      //console.log(user);
+      let user_id = user.dataValues.id;
+      await $.models.insertUser("device","device",3);
+      await $.models.insertUser("client","client_pwd",3);
+      await $.models.insertClient("admin","admin",user_id); // ads client with credentials admin@admin
+    }
+
+    // project tables
+    await self.readModelsInsideProjects(projectsPath);
+    await $.models.dropTableIndexes();
+    await $.models.sync();
+
   }
 }
 
@@ -109,5 +173,3 @@ function mqtt_connect(){
     console.log(error)
   })
 }
-
-

package/models/models.js

@@ -6,24 +6,22 @@ var mysql = require('mysql2');
 var sequelize;
 
 //var modelsPath = './models/';
-var config = require('../config');
 
 var self = module.exports = {
 
-   init : async ()=>{
-
-      return new Promise((resolve,reject) => {
-         sequelize = new Sequelize(
-            config.mysqldb.name,
-            config.mysqldb.user,
-            config.mysqldb.pwd,
-            {
-               host: config.mysqldb.host,
-               dialect: 'mysql'
-            },
-         );
-         return resolve(sequelize);
-      })
+  init : async (config)=>{
+
+    return new Promise((resolve,reject) => {
+       sequelize = new Sequelize({
+          database: config.mysqldb.name,
+          username: config.mysqldb.user,
+          password: config.mysqldb.pwd,
+          host: config.mysqldb.host,
+          port: config.mysqldb.port,
+          dialect: 'mysql',
+       });
+       return resolve(sequelize);
+     })
    },
 
    connect : async ()=>{
@@ -223,4 +221,3 @@ var self = module.exports = {
    }
 
 }
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mqtt-devices-parser",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "index.js",
   "scripts": {

package/src/db/db.js

@@ -1,10 +1,9 @@
-var config = require('../../config');
 var mysql = require('mysql2');
 
 var pool;
 
 var self = module.exports = {
-  connect : (cb)=>{
+  connect : (config,cb)=>{
     pool      =    mysql.createPool({
       connectionLimit : config.mysqldb.conn_limit,
       host     : config.mysqldb.host,
@@ -312,4 +311,3 @@ var self = module.exports = {
     });
   }
 }
-

package/src/device/device.js

@@ -4,10 +4,10 @@ const logs_table = "sensor_logs";
 
 var self = module.exports = {
 
-  init : async (projects)=>{
+  init : async (config,projects)=>{
 
     return new Promise(async (resolve,reject) => {
-      $.db.connect(()=>{
+      $.db.connect(config,()=>{
         console.log("MYSQL is connected");
 
         projects.map( async (name,counter)=>{
@@ -94,4 +94,3 @@ var self = module.exports = {
   },
 
 }
-

package/src/unitTest/device.test.js

@@ -55,7 +55,7 @@ let client = {
 };
 
 async function setup(){
-  await $.models.init();
+  await $.models.init($.config);
   await $.models.connect();
 }
 
@@ -70,7 +70,7 @@ async function test1(){
       projects.push(project);
     });
 
-  await $.device.init(projects);
+  await $.device.init($.config,projects);
 
   topics.forEach((topic,counter)=>{
 
@@ -87,4 +87,3 @@ async function test1(){
 
 setup();
 test1();
-

package/deploy.js

@@ -1,70 +0,0 @@
-const fs = require('fs').promises;
-
-$ = {};
-$.config = require('./config');
-$.models = require('./models/models.js');
-var projectsPath = './src/projects/';
-var project = [];
-
-async function readModelsInsideProjects(){
-
-	return new Promise( async (resolve,reject) => {
-
-		// load projects dbs
-		var files = await fs.readdir(projectsPath)
-
-	    files = files.filter((file) => {
-	    	// Exclude any extension file
-	    	return (file.indexOf('.') == -1);
-	    })
-
-	    let counter_help = 0;
-	    files.forEach( async(name,counter) => {
-	    	if($.config.projects[name]){
-		    	project[name] = {
-		        	module : null
-				};
-				project[name].module = require('./src/projects/'+name+'/'+name+".js")
-				await project[name].module.sync_db();
-				counter_help++;
-				if(files.length == counter_help) return resolve();
-	    	}else{
-	    		counter_help++;
-				if(files.length == counter_help) return resolve();
-	    	}
-
-	    });
-
-	});
-
-}
-
-
-async function init(){
-
-	await $.models.init();
-	await $.models.connect();
-
-	//main tables
-	if($.config.sync_main_tables){
-		await $.models.load(__dirname+"/models");
-		await $.models.dropTableIndexes();
-		await $.models.sync();
-
-		let user = await $.models.insertUser("admin","admin",5); // ads user
-		//console.log(user);
-		let user_id = user.dataValues.id;
-		await $.models.insertUser("device","device",3);
-		await $.models.insertUser("client","client_pwd",3);
-		await $.models.insertClient("admin","admin",user_id); // ads client with credentials admin@admin
-	}
-
-	// project tables
-	await readModelsInsideProjects();
-	await $.models.dropTableIndexes();
-    await $.models.sync();
-
-}
-
-
-init();

package/src/projects/demo/apps/myapp.js

@@ -1,25 +0,0 @@
-var models_name = ["myapp"];
-var model_table = "myapp";
-var model_logs_table = "logs_myapp";
-
-module.exports = {
-
-  init : async()=>{
-    console.log("App myapp from project freeRTOS2 started");
-
-    models_name.forEach(async(model_name)=>{
-      let res = await $.db_model.getByName(model_name);
-      let model_id = res?.id;
-
-      if(model_id == null) $.db_model.insert(model_name,model_table,model_logs_table);
-    })
-
-  },
-
-  parseMessage : async (client,app,device,topic,payload,retain,cb)=>{
-
-    $.db_data.update(model_table,device.id,topic,payload);
-    $.db_data.addLog(model_logs_table,device.id,topic,payload);
-
-  }
-}

package/src/projects/demo/demo.js

@@ -1,77 +0,0 @@
-const moment = require('moment');
-const fs = require('fs');
-const path = require('path');
-
-var app = [];
-
-MACRO_UID_PREFIX          = "uid:"
-
-module.exports = {
-
-  sync_db : async()=>{
-
-    return new Promise( async (resolve,reject) => {
-
-      console.log("Sync dbs for rtls-linux module");
-      await $.models.init();
-      await $.models.connect();
-      await $.models.load(__dirname+"/models");
-
-      return resolve();
-    });
-  },
-
-  init : async ()=>{
-
-    console.log("Project rtls-linux started");
-    await $.models.load(__dirname+"/models");
-
-    // load apps
-    if(fs.existsSync(__dirname+"/apps")){
-      fs.readdirSync(__dirname+"/apps")
-      .filter((file) => {
-        // Exclude any extension file
-        return (file.indexOf('.') == -1);
-      })
-      .forEach((name) => {
-        app[name] = {
-            module : null
-        };
-
-        app[name].module = require(__dirname + '/apps/'+name+'/'+name+".js")
-        app[name].module.init();
-      });
-    }
-  },
-
-  parseMessage : async (client, project, device, topic, payload, retain, cb)=>{
-
-    // The next two lines updates dB with received data
-    $.db_data.update(project,device.id,topic,payload);
-    $.db_data.addLog("logs_"+project,device.id,topic,payload);
-
-    let index = topic.indexOf("/")
-    if(index == -1)
-      return cb();
-
-    if(topic.substring(0,3) == "app") {
-      topic = topic.substring(4);
-      index = topic.indexOf("/")
-      if(index == -1)
-        return cb();
-
-      let app_name = topic.substring(0,index);
-      topic = topic.substring(index+1);
-      if(app[app_name]){ // call app
-        let res = await $.db_model.getByName(app_name);
-        let model_id = res?.id;
-        if(model_id != null && device.model_id != model_id) $.db_device.updateModel(device.uid,model_id);
-        app[app_name].module.parseMessage(client,app_name,device,topic,payload,retain,()=>{})
-      }
-
-    }
-
-  }
-
-
-}

package/src/projects/demo/models/logs_myapp.js

@@ -1,17 +0,0 @@
-
-module.exports = (sequelize,DataTypes)=>{
-	return sequelize.define("logs_myapp", {
-		device_id: {
-			type: DataTypes.INTEGER,
-			references: {
-				model: 'devices',
-				key: 'id'
-			}
-		}
-	},
-	{
-		tableName: 'logs_myapp',
-		freezeTableName: true
-	})
-}
-

package/src/projects/demo/models/myapp.models.js

@@ -1,18 +0,0 @@
-
-module.exports = (sequelize,DataTypes)=>{
-	return sequelize.define("myapp", {
-		device_id: {
-			type: DataTypes.INTEGER,
-			unique: true,
-			references: {
-				model: 'devices',
-				key: 'id'
-			}
-		},
-	},
-	{
-		tableName: 'myapp',
-		freezeTableName: true
-	})
-}
-