mqtt-devices-parser 1.0.0

package/src/db/device.js

@@ -0,0 +1,111 @@
+const moment = require('moment');
+var mysql = require('mysql2')
+
+var self = module.exports = {
+
+	get : async (uid)=>{
+		return new Promise((resolve,reject) => {
+
+			let query = "SELECT id,uid,project_id,model_id,status FROM ?? where uid = ?";
+		    let table = ["devices",uid];
+		    query = mysql.format(query,table);
+
+		    $.db.queryRow(query)
+		    .then( rows => {
+		      if(rows.length > 0)
+		        return resolve(rows[0]);
+		      else
+		        return resolve(null);
+		    })
+		    .catch( err => {
+		      console.log(err);
+		      return resolve(null);
+		    });
+		});
+	},
+
+	insert : async(uid)=>{
+
+		return new Promise((resolve,reject) => {
+			let obj = {
+				uid : uid,
+				createdAt : moment().utc().format('YYYY-MM-DD HH:mm:ss'),
+				updatedAt : moment().utc().format('YYYY-MM-DD HH:mm:ss')
+			}
+
+		    $.db.insert("devices",obj)
+		    .then (rows => {
+		      return resolve(rows[0]);
+		    })
+		    .catch(error => {
+		      return reject(error);
+		    });
+		});
+  	},
+
+  	updateStatus : async(uid,status)=>{
+		return new Promise((resolve,reject) => {
+
+		    let obj = {
+		      status : status,
+		      updatedAt : moment().utc().format('YYYY-MM-DD HH:mm:ss')
+		    };
+
+		    let filter = {
+		      uid : uid,
+		    };
+
+		    $.db.update("devices",obj,filter)
+		    .then (rows => {
+		      return resolve(rows);
+		    })
+		    .catch(error => {
+		      return reject(error);
+			});
+	  });
+  	},
+
+  	updateProject : async(uid,project_id)=>{
+		return new Promise((resolve,reject) => {
+
+		    let obj = {
+		      project_id : project_id,
+		      updatedAt : moment().utc().format('YYYY-MM-DD HH:mm:ss')
+		    };
+
+		    let filter = {
+		      uid : uid,
+		    };
+
+		    $.db.update("devices",obj,filter)
+		    .then (rows => {
+		      return resolve(rows);
+		    })
+		    .catch(error => {
+		      return reject(error);
+			});
+	  });
+  	},
+
+  	updateModel : async(uid,model_id)=>{
+		return new Promise((resolve,reject) => {
+
+		    let obj = {
+		      model_id : model_id,
+		      updatedAt : moment().utc().format('YYYY-MM-DD HH:mm:ss')
+		    };
+
+		    let filter = {
+		      uid : uid,
+		    };
+
+		    $.db.update("devices",obj,filter)
+		    .then (rows => {
+		      return resolve(rows);
+		    })
+		    .catch(error => {
+		      return reject(error);
+			});
+	  });
+  	},
+}

package/src/db/firmware.js

@@ -0,0 +1,79 @@
+const moment = require('moment');
+var mysql = require('mysql2')
+
+var self = module.exports = {
+
+	getLatestFWVersion : async (modelId,release)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "";
+		let table = [];
+
+		if(release == "stable"){
+			query = `SELECT fw_version,filename,token FROM firmwares where model_id = ? and fw_release = ? ORDER BY CAST(SUBSTRING_INDEX(fw_version, '.', 1) AS UNSIGNED) DESC,
+			 CAST(SUBSTRING_INDEX(SUBSTRING_INDEX(fw_version, '.', 2), '.', -1) AS UNSIGNED) DESC,
+			 CAST(SUBSTRING_INDEX(fw_version, '.', -1) AS UNSIGNED) DESC
+			 LIMIT 1`;
+			table = [modelId,release];
+		}else{
+			query = `SELECT fw_version,filename,token FROM firmwares where model_id = ? ORDER BY CAST(SUBSTRING_INDEX(fw_version, '.', 1) AS UNSIGNED) DESC,
+			 CAST(SUBSTRING_INDEX(SUBSTRING_INDEX(fw_version, '.', 2), '.', -1) AS UNSIGNED) DESC,
+			 CAST(SUBSTRING_INDEX(fw_version, '.', -1) AS UNSIGNED) DESC
+			 LIMIT 1`;
+			table = [modelId];
+		}
+
+	    query = mysql.format(query,table);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getLatestAppVersion : async (modelId,release)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "";
+		let table = [];
+
+		if(release == "stable"){
+			query = `SELECT app_version,filename,token FROM firmwares where model_id = ? and fw_release = ? ORDER BY CAST(SUBSTRING_INDEX(app_version, '.', 1) AS UNSIGNED) DESC,
+			 CAST(SUBSTRING_INDEX(SUBSTRING_INDEX(app_version, '.', 2), '.', -1) AS UNSIGNED) DESC,
+			 CAST(SUBSTRING_INDEX(app_version, '.', -1) AS UNSIGNED) DESC
+			 LIMIT 1`;
+			table = [modelId,release];
+		}else{
+			query = `SELECT app_version,filename,token FROM firmwares where model_id = ? ORDER BY CAST(SUBSTRING_INDEX(app_version, '.', 1) AS UNSIGNED) DESC,
+			 CAST(SUBSTRING_INDEX(SUBSTRING_INDEX(app_version, '.', 2), '.', -1) AS UNSIGNED) DESC,
+			 CAST(SUBSTRING_INDEX(app_version, '.', -1) AS UNSIGNED) DESC
+			 LIMIT 1`;
+			table = [modelId];
+		}
+
+	    query = mysql.format(query,table);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+}

package/src/db/model.js

@@ -0,0 +1,115 @@
+const moment = require('moment');
+var mysql = require('mysql2')
+
+var self = module.exports = {
+
+	getById : async (projectId)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT * FROM ?? where id = ?";
+	    let table = ["models",projectId];
+	    query = mysql.format(query,table);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getByName : async (model)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT * FROM ?? where name = ?";
+	    let table = ["models",model];
+	    query = mysql.format(query,table);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getAll : async ()=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT id,name FROM ??";
+	    let table = ["models"];
+	    query = mysql.format(query,table);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+		  return resolve(rows);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	insert : async(model, model_table, logs_table)=>{
+
+		return new Promise((resolve,reject) => {
+			let obj = {
+				name : model,
+				model_table : model_table,
+				logs_table : logs_table,
+				createdAt : moment().utc().format('YYYY-MM-DD HH:mm:ss'),
+				updatedAt : moment().utc().format('YYYY-MM-DD HH:mm:ss')
+			}
+
+		    $.db.insert("models",obj)
+		    .then (rows => {
+		      return resolve(rows[0]);
+		    })
+		    .catch(error => {
+		      return reject(error);
+		    });
+		});
+  	},
+
+  	update : async(model, model_table, logs_table)=>{
+
+		return new Promise((resolve,reject) => {
+			let obj = {
+				name : model,
+				model_table : model_table,
+				logs_table : logs_table,
+				createdAt : moment().utc().format('YYYY-MM-DD HH:mm:ss'),
+				updatedAt : moment().utc().format('YYYY-MM-DD HH:mm:ss')
+			};
+
+			let filter = {
+				name : model
+			};
+
+		    $.db.update("models",obj,filter)
+		    .then (rows => {
+		      return resolve(rows[0]);
+		    })
+		    .catch(error => {
+		      return reject(error);
+		    });
+		});
+  	},
+
+}

package/src/db/project.js

@@ -0,0 +1,91 @@
+const moment = require('moment');
+var mysql = require('mysql2')
+
+
+var self = module.exports = {
+
+	getById : async (projectId)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT * FROM ?? where id = ?";
+	    let table = ["projects",projectId];
+	    query = mysql.format(query,table);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getByName : async (project)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT * FROM ?? where name = ?";
+	    let table = ["projects",project];
+	    query = mysql.format(query,table);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getAll : async ()=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT id,name FROM ??";
+	    let table = ["projects"];
+	    query = mysql.format(query,table);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+		  return resolve(rows);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	insert : async(project, project_table, logs_table)=>{
+
+		return new Promise((resolve,reject) => {
+			let obj = {
+				name : project,
+				project_table : project_table,
+				logs_table : logs_table,
+				createdAt : moment().utc().format('YYYY-MM-DD HH:mm:ss'),
+				updatedAt : moment().utc().format('YYYY-MM-DD HH:mm:ss')
+			}
+
+		    $.db.insert("projects",obj)
+		    .then (rows => {
+		      return resolve(rows[0]);
+		    })
+		    .catch(error => {
+		      return reject(error);
+		    });
+		});
+  	},
+
+}

package/src/db/sensor.js

@@ -0,0 +1,113 @@
+const moment = require('moment');
+var mysql = require('mysql2')
+const table = "sensors"
+
+var self = module.exports = {
+
+	getById : async (id)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT * FROM ?? where id = ?";
+	    let args = [table,id];
+	    query = mysql.format(query,args);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getByRef : async (ref)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT * FROM ?? where ref = ?";
+	    let args = [table,ref];
+	    query = mysql.format(query,args);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getByName : async (name)=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT * FROM ?? where name = ?";
+	    let args = [table,name];
+	    query = mysql.format(query,args);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows[0]);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getAll : async ()=>{
+
+	  return new Promise((resolve,reject) => {
+
+	    let query = "SELECT id,name FROM ??";
+	    let args = [table];
+	    query = mysql.format(query,args);
+
+	    $.db.queryRow(query)
+	    .then( rows => {
+		  return resolve(rows);
+	    })
+	    .catch( err => {
+	      console.log(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	insert : async(table,deviceId,sensorId,payload)=>{
+
+		return new Promise((resolve,reject) => {
+			let obj = {
+				device_id : deviceId,
+				sensor_id : sensorId,
+				value : payload,
+				createdAt : moment().utc().format('YYYY-MM-DD HH:mm:ss'),
+				updatedAt : moment().utc().format('YYYY-MM-DD HH:mm:ss')
+			}
+
+		    $.db.insert(table,obj)
+		    .then (rows => {
+		      return resolve(rows[0]);
+		    })
+		    .catch(error => {
+		      return reject(error);
+		    });
+		});
+  	},
+
+}

package/src/device/Readme.md

@@ -0,0 +1,59 @@
+
+# Devices
+
+## State Machine
+This modules parses mqtt messages with the following format
+
+:project/:device/
+
+Only messages with MACRO_UID_PREFIX in topic will be parsed.
+MACRO_UID_PREFIX allows the module to discover the device uid.
+If uid doesn't exist in db it will add it.
+After that, it will associate the project if the project exists in db.
+If the device already exists it will verify the project and update it in case of need
+
+:project/:device/status
+Updates the device status
+
+:project/:device/model
+Updates the model if the model already exists in db
+
+
+## New Project
+
+In order to support a new type of device, you need to create a js file with the same name of topic before MACRO_UID_PREFIX
+
+Example:
+
+topic: demo/uid:001122aabbcc
+MACRO_UID_PREFIX = "uid:"
+
+demo is the project
+uid:001122aabbcc is the UID
+
+Then, inside projects folder, you can create a demo folder with apps and models as subfolders
+Ex:
+
+../projects/demo/demo.js
+../projects/demo/apps/myapp/myapp.js
+../projects/demo/models/myapp.models.js
+
+All messages published on the topic demo will be processed by demo.js file
+You can also create models inside models folder and use it to store data
+
+Furthermore, all published topics started with:
+:project/:uid/app/:app
+will call the respective modules inside apps folder.
+
+Ex:
+demo/uid:001122aabbcc/app/myapp/hello
+will result in a call to myapp.parseMessage
+
+To activate the project you just need to add the project in config/index.js file and set to true
+projects: {
+	demo : process.env.demo || true
+}
+
+
+
+

package/src/device/device.js

@@ -0,0 +1,97 @@
+
+var project = [];
+const logs_table = "sensor_logs";
+
+var self = module.exports = {
+
+  init : async (projects)=>{
+
+    return new Promise(async (resolve,reject) => {
+      $.db.connect(()=>{
+        console.log("MYSQL is connected");
+
+        projects.map( async (name,counter)=>{
+          console.log("project:",name)
+          project[name] = {
+            module : null
+          };
+          project[name].module = require(`${BASE_DIR}/projects/${name}/${name}.js`)
+          project[name].module?.init();
+          let row = await $.db_project.getByName(name);
+          if(row == null)
+            $.db_project.insert(name,name,"logs_"+name);
+
+          if(counter == projects.length-1)
+            return resolve();
+        })
+      })
+    });
+
+
+  },
+
+  parseMessage : async (client,topic,payload,retain)=>{
+
+    let topic_bck = topic;
+
+    //let index = topic.indexOf(MACRO_UID_PREFIX);
+    // --- project ---
+    let index = topic.indexOf("/");
+    if(index == -1)
+        return;
+    let project_name = topic.substring(0,index);
+
+    // --- uid ---
+    topic = topic.substring(index+1);
+    index = topic.indexOf("/");
+    if(index == -1)
+        return;
+    let uid = topic.substring(0,index);
+
+    topic = topic.substring(index+1);
+
+    // check if topic corresponds to a device
+    if(uid.startsWith(MACRO_UID_PREFIX)){
+      let device = await $.db_device.get(uid);
+
+      if(device == null){
+        $.db_device.insert(uid)
+        .then(async()=>{
+          device = await $.db_device.get(uid);
+        })
+        .catch( (err) => {});
+      }
+
+      if(device?.project_id == null){
+        let res = await $.db_project.getByName(project_name);
+        let project_id = res?.id;
+        if(project_id != null) $.db_device.updateProject(uid,project_id);
+      }
+
+      if(topic.endsWith("status")){
+        if(payload == "online" || payload == "offline")
+          await $.db_device.updateStatus(uid,payload);
+        console.log(project_name,uid,payload)
+      }else if(topic.endsWith("model")){
+        let res = await $.db_model.getByName(payload);
+        let model_id = res?.id;
+
+        if(model_id != null) $.db_device.updateModel(uid,model_id);
+      }
+
+      if(device.project_id != null && device.model_id != null){
+        let res = await $.db_sensor.getByRef(topic)
+        if(res != null){
+          $.db_sensor.insert(logs_table,device.id,res.id,payload);
+        }
+      }
+
+      if(project[project_name]){
+        project[project_name].module.parseMessage(client,project_name,device,topic,payload,retain,()=>{});
+      }
+    }
+
+  },
+
+}
+

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

@@ -0,0 +1,25 @@
+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);
+
+  }
+}