mqtt-devices-parser 1.0.32 → 1.0.33

package/Changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.0.33
+	feat(db): sensors supports readable option
+	feat(db): supports actuators, template actuators and logs actuators
+	feat: support actuators (actions,template and logs) (#18)
+	perf: Adopt labeled Pino logging (#17)
+	feat: add log.level parameter to config
+
 ## 1.0.32
 	fix: handleFotaError call
 

package/config/index.js

@@ -1,6 +1,9 @@
 module.exports = {
   version : "0.0.0",
   dev : process.env.dev || "true",
+  log : {
+    level : process.env.LOG_LEVEL || "trace"
+  },
   web:{
     protocol : process.env.HTTP_PROTOCOL  || "http://",
     domain: process.env.DOMAIN            || '10.168.1.162',

package/index.js

@@ -1,3 +1,4 @@
+const logger = require('./src/logger').child({ label: 'MQTT' });
 const mqtt = require("mqtt");
 const fs = require('fs').promises;
 
@@ -15,6 +16,7 @@ $.db_device = require('./src/db/device');
 $.db_model = require('./src/db/model');
 $.db_firmware = require('./src/db/firmware');
 $.db_sensor = require('./src/db/sensor');
+$.db_actuator = require('./src/db/actuator');
 $.db_fota = require('./src/db/fota');
 $.mqtt_client = null;
 $.parser = require('./src/aux/parser')
@@ -133,7 +135,7 @@ var self = module.exports = {
 
 function mqtt_connect(){
 
-  console.log(`[MQTT] connecting to ${$.config.mqtt.host}:${$.config.mqtt.port}..`)
+  logger.info(`[MQTT] connecting to ${$.config.mqtt.host}:${$.config.mqtt.port}..`)
 
   const mqtt_prefix = $.config.mqtt.logs_path+"/"+$.config.mqtt.client;
   let checkFota = null;
@@ -167,18 +169,18 @@ function mqtt_connect(){
           $.mqtt_client.publish(mqtt_prefix+"/"+project,"deactive",{qos:2,retain:true});
       };
     })
-    console.log(`[MQTT] connected`);
+    logger.info(`[MQTT] connected`);
 
     if (!$.config.kafka.enabled) {
       projects.map( project=>{
-        console.log("[MQTT] subscribing project:",project);
+        logger.info("[MQTT] subscribing project:",project);
         $.mqtt_client.subscribe(project+"/#", (err) => {
           if(err){
-            console.log("[MQTT] error");
-            console.error(err);
+            logger.info("[MQTT] error");
+            logger.error(err);
           }
           else
-            console.log("[MQTT] subscribed to project:",project);
+            logger.info("[MQTT] subscribed to project:",project);
         })
       })
     }
@@ -203,34 +205,34 @@ function mqtt_connect(){
     // Only parse MQTT messages if enabled in configuration
     if (!$.config.kafka.enabled) {
 
-      console.log(`[MQTT] rx: ${topic.toString()}`);
+      logger.info(`[MQTT] rx: ${topic.toString()}`);
       // payload is Buffer
       $.device.parseMessage($.mqtt_client,topic.toString(),payload.toString(),packet.retain);
     }
   });
 
   $.mqtt_client.on("reconnect",()=>{
-    console.log("[MQTT] reconnected")
+    logger.info("[MQTT] reconnected")
   });
 
   $.mqtt_client.on("close",()=>{
-    console.log("[MQTT] closed")
+    logger.info("[MQTT] closed")
     checkFota = null;
   });
 
   $.mqtt_client.on("offline",()=>{
-    console.log("[MQTT] offline")
+    logger.info("[MQTT] offline")
     checkFota = null;
   });
 
   $.mqtt_client.on("disconnect",(packet)=>{
-    console.log(`[MQTT] disconnected`);
-    console.log(packet);
+    logger.info(`[MQTT] disconnected`);
+    logger.info(packet);
     checkFota = null;
   })
 
   $.mqtt_client.on("error",(error)=>{
-    console.log("[MQTT] error");
-    console.error(error)
+    logger.info("[MQTT] error");
+    logger.error(error)
   })
 }

package/models/actuators.models.js

@@ -0,0 +1,61 @@
+module.exports = (sequelize,DataTypes)=>{
+  return sequelize.define("actuators", {
+    model_id: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+      references: {
+        model: 'models',
+        key: 'id'
+      },
+      onDelete: 'CASCADE',
+      onUpdate: 'CASCADE'
+    },
+    device_id: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+      references: {
+        model: 'devices',
+        key: 'id'
+      },
+      onDelete: 'CASCADE',
+      onUpdate: 'CASCADE'
+    },
+    ref: {
+      type: DataTypes.STRING,
+      allowNull: false
+    },
+    name: {
+      type: DataTypes.STRING,
+      allowNull: false
+    },
+    type: {
+      type: DataTypes.ENUM('set', 'switch', 'number', 'text', 'json'),
+      allowNull: false
+    },
+    property: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      defaultValue: ''
+    },
+    value: {
+      type: DataTypes.STRING,
+      allowNull: true
+    },
+    error: {
+      type: DataTypes.TEXT,
+      allowNull: true
+    },
+    active: {
+      type: DataTypes.BOOLEAN,
+      allowNull: true
+    },
+    graph: {
+      type: DataTypes.JSON,
+      allowNull: true
+    },
+  },
+  {
+    tableName: 'actuators',
+    freezeTableName: true
+  })
+}

package/models/actuatorsTemplate.models.js

@@ -0,0 +1,47 @@
+module.exports = (sequelize,DataTypes)=>{
+  return sequelize.define("actuatorsTemplate", {
+    model_id: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+      references: {
+        model: 'models',
+        key: 'id'
+      },
+      onDelete: 'CASCADE',
+      onUpdate: 'CASCADE'
+    },
+    ref: {
+      type: DataTypes.STRING,
+      allowNull: false
+    },
+    name: {
+      type: DataTypes.STRING,
+      allowNull: false
+    },
+    type: {
+      type: DataTypes.ENUM('set', 'switch', 'number', 'text', 'json'),
+      allowNull: false
+    },
+    property: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      defaultValue: ''
+    },
+    value: {
+      type: DataTypes.STRING,
+      allowNull: true
+    },
+    active: {
+      type: DataTypes.BOOLEAN,
+      allowNull: true
+    },
+    graph: {
+      type: DataTypes.JSON,
+      allowNull: true
+    },
+  },
+  {
+    tableName: 'actuatorsTemplate',
+    freezeTableName: true
+  })
+}

package/models/logs_actuators.models.js

@@ -0,0 +1,42 @@
+module.exports = (sequelize,DataTypes)=>{
+	return sequelize.define("logs_actuators", {
+      device_id: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+        references: {
+          model: 'devices',
+          key: 'id'
+        },
+        onDelete: 'CASCADE',
+        onUpdate: 'CASCADE'
+      },
+      actuator_id: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+        references: {
+          model: 'actuators',
+          key: 'id'
+        },
+        onDelete: 'CASCADE',
+        onUpdate: 'CASCADE'
+      },
+      value: {
+        type: DataTypes.STRING,
+        allowNull: true
+      },
+      error: {
+        type: DataTypes.STRING,
+        allowNull: true
+      },
+      confirmed: {
+      	type: DataTypes.BOOLEAN,
+      	default: false,
+        allowNull: false
+      }
+	},
+	{
+		tableName: 'logs_actuators',
+		freezeTableName: true
+	})
+}
+

package/models/models.js

@@ -1,3 +1,4 @@
+const logger = require('../src/logger').child({ label: 'Models' });
 const fs = require('fs').promises;
 const path = require('path');
 const { Sequelize, DataTypes } = require("sequelize");
@@ -27,11 +28,11 @@ var self = module.exports = {
       sequelize
         .authenticate()
         .then(() => {
-          console.log('Connection has been established successfully.');
+          logger.info('Connection has been established successfully.');
           return resolve();
         })
         .catch((error) => {
-          console.error('Unable to connect to the database: ', error);
+          logger.error('Unable to connect to the database: ', error);
           return reject();
         });
     });
@@ -52,7 +53,7 @@ var self = module.exports = {
 
         // Use a for...of loop to load models sequentially
         for (const file of files) {
-          console.log(`Sync file ${file}`);
+          logger.info(`Sync file ${file}`);
           const model = require(path.join(modelsPath, file));
           await model(sequelize, DataTypes); // Ensure each model is loaded before moving to the next
         }
@@ -70,11 +71,11 @@ var self = module.exports = {
       sequelize
         .sync({ alter: true })
         .then(async () => {
-          console.log('All tables were synced!');
+          logger.info('All tables were synced!');
           return resolve();
         })
         .catch((error) => {
-          console.error('Unable to create table : ', error);
+          logger.error('Unable to create table : ', error);
           return reject();
         });
     });
@@ -84,7 +85,7 @@ var self = module.exports = {
     return new Promise((resolve, reject) => {
       let tables = Object.keys(sequelize.models);
 
-      console.log(tables);
+      logger.info(tables);
       if (!tables?.length) return resolve();
 
       tables.forEach(async (tableName, counter) => {
@@ -126,7 +127,7 @@ var self = module.exports = {
             sequelize
               .query(query)
               .then((res) => {
-                console.log(`Dropped index ${index.Key_name}`);
+                logger.info(`Dropped index ${index.Key_name}`);
                 if (counter === filteredIndexes.length - 1) return resolve();
               })
               .catch((error) => {
@@ -187,14 +188,14 @@ var self = module.exports = {
       })
         .then(([user, created]) => {
           if (created) {
-            console.log('New user created:', type);
+            logger.info('New user created:', type);
           } else {
-            console.log('User already exists:', type);
+            logger.info('User already exists:', type);
           }
           return resolve(user);
         })
         .catch((error) => {
-          console.error('Error:', error);
+          logger.error('Error:', error);
           return reject(error);
         });
     });
@@ -212,14 +213,14 @@ var self = module.exports = {
       })
         .then(([client, created]) => {
           if (created) {
-            console.log('New client created:', nick);
+            logger.info('New client created:', nick);
           } else {
-            console.log('Client already exists:', nick);
+            logger.info('Client already exists:', nick);
           }
           return resolve(client);
         })
         .catch((error) => {
-          console.error('Error:', error);
+          logger.error('Error:', error);
           return reject(error);
         });
     });
@@ -240,14 +241,14 @@ var self = module.exports = {
       })
         .then(([client, created]) => {
           if (created) {
-            console.log('New project created:', project?.name);
+            logger.info('New project created:', project?.name);
           } else {
-            console.log('Project already exists:', project?.name);
+            logger.info('Project already exists:', project?.name);
           }
           return resolve(client);
         })
         .catch((error) => {
-          console.error('Error:', error);
+          logger.error('Error:', error);
           return reject(error);
         });
     });
@@ -270,10 +271,10 @@ var self = module.exports = {
           return { record, created };
         })
       );
-      console.log("Insert/Update completed for LwM2M Objects.");
+      logger.info("Insert/Update completed for LwM2M Objects.");
       return results;
     } catch (error) {
-      console.error("Error inserting/updating LwM2M Objects:", error.message);
+      logger.error("Error inserting/updating LwM2M Objects:", error.message);
       throw error;
     }
   },
@@ -296,10 +297,10 @@ var self = module.exports = {
           return { record, created };
         })
       );
-      console.log("Insert/Update completed for LwM2M Resources.");
+      logger.info("Insert/Update completed for LwM2M Resources.");
       return results;
     } catch (error) {
-      console.error("Error inserting/updating LwM2M Resources:", error.message);
+      logger.error("Error inserting/updating LwM2M Resources:", error.message);
       throw error;
     }
   },
@@ -353,7 +354,7 @@ var self = module.exports = {
       } else {
         // Skip invalid entries but warn
         // eslint-disable-next-line no-console
-        console.warn('Skipping invalid resource entry:', entry);
+        logger.warn('Skipping invalid resource entry:', entry);
       }
     }
 
@@ -393,11 +394,11 @@ var self = module.exports = {
       });
 
       // eslint-disable-next-line no-console
-      console.log('Insert/Update completed for LwM2M Resources.');
+      logger.info('Insert/Update completed for LwM2M Resources.');
       return results;
     } catch (error) {
       // eslint-disable-next-line no-console
-      console.error('Error inserting/updating LwM2M Resources:', error.message);
+      logger.error('Error inserting/updating LwM2M Resources:', error.message);
       throw error;
     }
   }

package/models/sensors.models.js

@@ -22,6 +22,11 @@ module.exports = (sequelize,DataTypes)=>{
 			allowNull: false,
 			defaultValue: true
 		},
+		readable: {
+			type: DataTypes.BOOLEAN,
+			allowNull: true,
+			default: true
+		},
 		ref: {
 			type: DataTypes.STRING,
 			allowNull: false,

package/models/sensorsTemplate.models.js

@@ -14,6 +14,11 @@ module.exports = (sequelize,DataTypes)=>{
 			allowNull: false,
 			defaultValue: true
 		},
+		readable: {
+			type: DataTypes.BOOLEAN,
+			allowNull: true,
+			default: true
+		},
 		ref: {
 			type: DataTypes.STRING,
 			allowNull: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mqtt-devices-parser",
-  "version": "1.0.32",
+  "version": "1.0.33",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -20,6 +20,7 @@
     "mysql2": "^3.2.0",
     "net": "^1.0.2",
     "path": "^0.12.7",
+    "pino": "^9.14.0",
     "semver": "^7.3.8",
     "sequelize": "^6.32.1",
     "websocket-stream": "^5.4.0"

package/src/db/actuator.js

@@ -0,0 +1,172 @@
+const moment = require('moment');
+var mysql = require('mysql2')
+const table = "actuators"
+
+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);
+	    });
+	  });
+	},
+
+	// not used !!
+	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,actuatorId,payload)=>{
+
+		return new Promise((resolve,reject) => {
+			let obj = {
+				device_id : deviceId,
+				actuator_id : actuatorId,
+				value : payload?.value,
+				error : payload?.error,
+				remoteUnixTs : payload?.timestamp, // local timestamp
+				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);
+		    });
+		});
+  	},
+
+	update : async(table,obj,filter)=>{
+
+		return new Promise((resolve,reject) => {
+
+			$.db.update(table,obj,filter)
+			.then (rows => {
+				return resolve(rows);
+			})
+			.catch(error => {
+				return reject(error);
+			});
+		});
+	},
+
+	getLastLogId : async(table,actuatorId)=>{
+
+		return new Promise((resolve,reject) => {
+
+		    let query = "SELECT id FROM ?? WHERE actuator_id = ? AND confirmed = 0 ORDER BY id DESC LIMIT 1";
+		    let args = [table,actuatorId];
+		    query = mysql.format(query,args);
+
+		    $.db.queryRow(query)
+		    .then( rows => {
+		    	if(rows?.length > 0)
+			  		return resolve(rows[0].id);
+			  	else
+			  		return resolve(null);
+		    })
+		    .catch( err => {
+		      console.log(err);
+		      return resolve(null);
+		    });
+		  });
+	},
+
+	confirmMessage: async(table,lastLogId)=>{
+
+		let obj = {
+			confirmed : true
+		}
+		let filter = {
+			id : lastLogId
+		}
+
+		return new Promise((resolve,reject) => {
+
+			$.db.update(table,obj,filter)
+			.then (rows => {
+				return resolve(rows);
+			})
+			.catch(error => {
+				return reject(error);
+			});
+		});
+	},
+}

package/src/db/db.js

@@ -1,3 +1,4 @@
+const logger = require('../logger').child({ label: 'Database' });
 var mysql = require('mysql2');
 
 var pool;
@@ -15,12 +16,12 @@ var self = module.exports = {
     });
     pool.getConnection(function(err,connection){
         if(err) {
-          console.log("ISSUE WITH MYSQL \n" + err);
+          logger.info("ISSUE WITH MYSQL \n" + err);
           process.exit(1);
         } else {
           setInterval(function(){self.pingMySQL(connection);}, 3600000); // 1 hour
           connection.on('error', function(err) {
-            console.log("Mysql error: "+err.code); // 'ER_BAD_DB_ERROR'
+            logger.info("Mysql error: "+err.code); // 'ER_BAD_DB_ERROR'
             process.exit(1);
           });
           cb();
@@ -37,7 +38,7 @@ var self = module.exports = {
   pingMySQL : (connection)=>{
     connection.ping(function (err) {
       if (err) throw err;
-      //console.log(String(Date.now())+'Server responded to ping');
+      //logger.info(String(Date.now())+'Server responded to ping');
     });
   },