iobroker.lorawan 0.3.2 → 0.3.3

package/README.md

@@ -22,6 +22,9 @@ For now there is documentation in English here: http://www.hafenmeister.com/Lora
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 0.3.3 (2024-02-19)
+* (BenAhrdt) set infos into native
+
 ### 0.3.2 (2024-02-16)
 * (BenAhrdt) wording recieved => received in messageing
 

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "lorawan",
-    "version": "0.3.2",
+    "version": "0.3.3",
     "news": {
+      "0.3.3": {
+        "en": "set infos into native",
+        "de": "informationen in die heimat",
+        "ru": "установить информацию на родной",
+        "pt": "definir informações em nativo",
+        "nl": "info's instellen in native",
+        "fr": "définir les infos dans native",
+        "it": "impostare le informazioni in nativo",
+        "es": "set infos into native",
+        "pl": "zestaw infos do rodzimej",
+        "uk": "встановити інформацію на рідні",
+        "zh-cn": "设置为本地信息"
+      },
       "0.3.2": {
         "en": "wording recieved => received in messageing",
         "de": "zurückgegeben => in der mitteilung empfangen",
@@ -80,19 +93,6 @@
         "pl": "budowa zmienionych katalogów i wdrożona wiadomość",
         "uk": "створення каталогу змінено та повідомлення",
         "zh-cn": "更改目录构建并执行消息"
-      },
-      "0.1.12": {
-        "en": "default value crc config bug fixed",
-        "de": "standardwert crc config bug behoben",
-        "ru": "по умолчанию",
-        "pt": "valor padrão crc config bug corrigido",
-        "nl": "standaard waarde crc config bug vast",
-        "fr": "valeur par défaut crc config bug corrigé",
-        "it": "valore predefinito crc config bug fisso",
-        "es": "valor predeterminado crc config error fijo",
-        "pl": "wartość domyślna błąd konfiguracyjny crc",
-        "uk": "за замовчуванням значення crc config fix",
-        "zh-cn": "默认值 crc 配置错误已修正"
       }
     },
     "title": "LoRaWAN",
@@ -195,19 +195,6 @@
         "def": false
       },
       "native": {}
-    },
-    {
-      "_id": "info.logAvailableConfignames",
-      "type": "state",
-      "common": {
-        "role": "button",
-        "name": "logs the names of available device configurations",
-        "type": "boolean",
-        "read": true,
-        "write": true,
-        "def": false
-      },
-      "native": {}
     }
   ]
 }

package/lib/modules/directorieshandler.js

@@ -1,3 +1,4 @@
+const { isDeepStrictEqual } = require("util");
 const fs = require("fs");
 
 class directorieshandlerClass {
@@ -6,8 +7,9 @@ class directorieshandlerClass {
 
 		// used dataentries in directory structurt
 		this.searchableAttributeNames = {
-			apllicationId: "applicationId",
-			deviceEUI: "devEui",
+			applicationId: "applicationId",
+			applicationName: "applicationName",
+			deviceEUI: "deviceEui",
 			deviceId: "deviceId"
 		};
 
@@ -34,17 +36,26 @@ class directorieshandlerClass {
 		// declare the directory structre
 		this.directories = {
 			application:{
-				objectStateId : async (topic,message) =>{
-					return await this.getAttributValue(topic,message,this.searchableAttributeNames.apllicationId);
+				objectId : (topic,message) =>{
+					return this.getAttributValue(topic,message,this.searchableAttributeNames.applicationId);
+				},
+				objectCommonFromNative: {name:"applicationName"},
+				objectNative : (topic,message) =>{
+					return {
+						applicationName : this.getAttributValue(topic,message,this.searchableAttributeNames.applicationName)
+					};
 				},
-				objectCommonName: "application",
 				devices:{
 					deviceEUI:{
-						objectStateId : async (topic,message) =>{
-							return await this.getAttributValue(topic,message,this.searchableAttributeNames.deviceEUI);
+						objectId : (topic,message) =>{
+							return this.getAttributValue(topic,message,this.searchableAttributeNames.deviceEUI);
 						},
-						objectCommonName: async (topic,message) =>{
-							return await this.getAttributValue(topic,message,this.searchableAttributeNames.deviceId);
+						objectCommonFromNative: {name:"deviceId"},
+						objectNative : (topic,message) =>{
+							return {
+								applicationName : this.getAttributValue(topic,message,this.searchableAttributeNames.applicationName),
+								deviceId : this.getAttributValue(topic,message,this.searchableAttributeNames.deviceId)
+							};
 						},
 						objectType: "device",
 						configuration:{
@@ -90,9 +101,11 @@ class directorieshandlerClass {
 			}
 		};
 		this.ignoredElementNames ={
-			objectStateId: "objectStateId",
+			objectId: "objectId",
 			objectCommonName: "objectCommonName",
-			objectType: "objectType"
+			objectCommonFromNative: "objectCommonFromNative",
+			objectType: "objectType",
+			objectNative : "objectNative"
 		};
 	}
 
@@ -131,38 +144,79 @@ class directorieshandlerClass {
 					if(!this.ignoredElementNames[elementName] && !options?.ignoredElementNames[elementName]){
 						// Check if the element is an object
 						if(typeof obj[elementName] === "object" && obj[elementName] && !obj[elementName].isState){
-							// if there is an declared ObjectStateName (must be a function)=> take it
+							// Generate the desired id
 							let objectId = `${startDirectory}.${elementName}`;
 							let internalObjectId = elementName;
-							if(obj[elementName].objectStateId){
-								internalObjectId = `${await obj[elementName].objectStateId(topic,message)}`;
+							if(obj[elementName].objectId){
+								internalObjectId = `${obj[elementName].objectId(topic,message)}`;
 								objectId = `${startDirectory}.${internalObjectId}`;
 							}
 							if(objectId.indexOf(".") === 0){
 								objectId = objectId.substring(1,objectId.length);
 							}
-							let objectCommonName = "";
+							let myObject = {};
+							// check object exists
+							if(await this.adapter.objectExists(objectId)){
+								myObject = await this.adapter.getObjectAsync(objectId);
+							}
+							const myObjectBefore = structuredClone(myObject);
+
+							//Set type of object
+							if(!myObject.type){
+								myObject.type = obj[elementName].objectType? obj[elementName].objectType : "folder";
+							}
+
+							//check for common
+							if(!myObject.common){
+								myObject.common = {};
+							}
+
+							// check whether a common name was specified
 							if(obj[elementName].objectCommonName && typeof obj[elementName].objectCommonName === "function"){
-								objectCommonName = await obj[elementName].objectCommonName(topic,message);
-								await this.adapter.extendObject(objectId,{
-									type: obj[elementName].objectType? obj[elementName].objectType : "folder",
-									common: {
-										name: objectCommonName
-									},
-									native : {},
-								});
+								if(typeof obj[elementName].objectCommonName === "function"){
+									myObject.common.name = obj[elementName].objectCommonName(topic,message);
+								}
+								else{
+									myObject.common.name = obj[elementName].objectCommonName;
+								}
+							}
+
+							// Check wheter a native content was specified
+							if(!myObject.native){
+								myObject.native = {};
 							}
-							else{
-								if(obj[elementName].objectCommonName){
-									objectCommonName = obj[elementName].objectCommonName;
+							if(obj[elementName].objectNative){
+								const objectNative = obj[elementName].objectNative(topic,message);
+								for(const attribute in objectNative){
+									myObject.native[attribute] = objectNative[attribute];
 								}
-								await this.adapter.setObjectNotExistsAsync(objectId,{
-									type: obj[elementName].objectType? obj[elementName].objectType : "folder",
-									common: {
-										name: objectCommonName
-									},
-									native : {},
-								});
+
+								// Assigne to common, if there are values specified
+								if(obj[elementName].objectCommonFromNative){
+									for(const attribute in obj[elementName].objectCommonFromNative){
+										// Check, whether the actual native is present
+										if(myObject.native[obj[elementName].objectCommonFromNative[attribute]]){
+											// check for old common => existing object
+											if(myObjectBefore.common){
+												//check for content
+												if(myObjectBefore.common[attribute] === myObjectBefore.native[obj[elementName].objectCommonFromNative[attribute]] ||
+												myObjectBefore.common[attribute] === ""){
+													myObject.common[attribute] = myObject.native[obj[elementName].objectCommonFromNative[attribute]];
+												}
+											}
+											else{
+												myObject.common[attribute] = myObject.native[obj[elementName].objectCommonFromNative[attribute]];
+											}
+										}
+									}
+								}
+							}
+							// Check for name
+							if(!myObject.common.name){
+								myObject.common.name = "";
+							}
+							if(!isDeepStrictEqual(myObject,myObjectBefore)){
+								await this.adapter.setObject(objectId,myObject);
 							}
 							// Jump into next step (next directory / attribute)
 							await this.generateRekursivObjects(obj[elementName],objectId,topic,message);
@@ -183,8 +237,8 @@ class directorieshandlerClass {
 									stateCommonWrite = obj[elementName].stateCommonWrite ? obj[elementName].stateCommonWrite : stateCommonWrite;
 									stateCommonRole = obj[elementName].stateCommonRole ? obj[elementName].stateCommonRole : stateCommonRole;
 								}
-								if(obj[elementName].objectStateId){
-									internalObjectId = `${await obj[elementName].objectStateId(topic,message)}`;
+								if(obj[elementName].objectId){
+									internalObjectId = `${obj[elementName].objectId(topic,message)}`;
 									objectId = `${startDirectory}.${internalObjectId}`;
 								}
 							}
@@ -227,15 +281,15 @@ class directorieshandlerClass {
 	 * ************************** Attribute ******************************
 	 * ******************************************************************/
 
-	async getAttributValue(topic,message,resolvetype){
+	getAttributValue(topic,message,resolvetype){
 		const activeFunction = "getAttributValue";
 		try{
 			// Select search in case of origin
 			switch(this.adapter.config.origin){
 				case this.adapter.origin.ttn:
-					return await this.getTtnAttributValue(topic,message,resolvetype);
+					return this.getTtnAttributValue(topic,message,resolvetype);
 				case this.adapter.origin.chirpstack:
-					return await this.getChirpstackAttributValue(topic,message,resolvetype);
+					return this.getChirpstackAttributValue(topic,message,resolvetype);
 			}
 		}
 		catch(error){
@@ -244,19 +298,15 @@ class directorieshandlerClass {
 	}
 
 	/*********************************************************************
-	 * ************************ Object Directory *************************
+	 * ******************** Object Start Directory ***********************
 	 * ******************************************************************/
 
-	async getObjectDirectory(topic,message,resolvetype){
-		const activeFunction = "getObjectDirectory";
+	getDeviceStartDirectory(topic,message){
+		const activeFunction = "getDeviceStartDirectory";
 		try{
-			// Select search in case of origin
-			switch(this.adapter.config.origin){
-				case this.adapter.origin.ttn:
-					return await this.getTtnObjectDirectory(topic,message,resolvetype);
-				case this.adapter.origin.chirpstack:
-					return await this.getChirpstackObjectDirectory(topic,message,resolvetype);
-			}
+			const applicationId = `${this.getAttributValue(topic,message,this.searchableAttributeNames.applicationId)}`;
+			const deviceEUI = `${this.getAttributValue(topic,message,this.searchableAttributeNames.deviceEUI)}`;
+			return `${applicationId}.devices.${deviceEUI}`;
 		}
 		catch(error){
 			this.adapter.log.error(`error at ${activeFunction}:  ${error} - - - Message: ${JSON.stringify(message)}`);
@@ -291,15 +341,18 @@ class directorieshandlerClass {
 	 * ************************** Attribute ******************************
 	 * ******************************************************************/
 
-	async getTtnAttributValue(topic,message,resolvetype){
+	getTtnAttributValue(topic,message,resolvetype){
 		const activeFunction = "getTtnAttributValue";
 		try{
 			this.adapter.log.silly(`attribute ${resolvetype} is requested for ttn`);
 			const topicResolved =  this.getTopicResolved(topic);
 			switch(resolvetype){
-				case this.searchableAttributeNames.apllicationId:
+				case this.searchableAttributeNames.applicationId:
 					return topicResolved?.applicationId;
 
+				case this.searchableAttributeNames.applicationName:
+					return topicResolved?.applicationName;
+
 				case this.searchableAttributeNames.deviceEUI:
 					return message.end_device_ids.dev_eui;
 
@@ -316,33 +369,6 @@ class directorieshandlerClass {
 		}
 	}
 
-	/*********************************************************************
-	 * ************************ Object Directory *************************
-	 * ******************************************************************/
-
-	async getTtnObjectDirectory(topic,message,resolvetype){
-		const activeFunction = "getTtnObjectDirectory";
-		try{
-			this.adapter.log.silly(`directory ${resolvetype} is requested for ttn`);
-			const topicResolved =  this.getTopicResolved(topic);
-			if(typeof message !== "string"){
-				switch(resolvetype){
-					case this.searchableAttributeNames.deviceEUI:
-						return `${topicResolved?.applicationId}.devices.${message.end_device_ids.dev_eui}`;
-
-					default:
-						return message;
-				}
-			}
-			else{
-				return message;
-			}
-		}
-		catch(error){
-			this.adapter.log.error(`error at ${activeFunction}:  ${error} - - - Message: ${JSON.stringify(message)}`);
-		}
-	}
-
 	/*********************************************************************
 	 * ************************ Object Directory *************************
 	 * ******************************************************************/
@@ -352,6 +378,7 @@ class directorieshandlerClass {
 		try{
 			const topicElements = topic.split("/");
 			const topicResolved = {
+				applicationName: "",
 				applicationId: topicElements[1],
 				deviceId: topicElements[3],
 				messageType: topicElements[topicElements.length - 1]
@@ -359,6 +386,7 @@ class directorieshandlerClass {
 			// clean up application id
 			const indexOfOrigin = topicResolved.applicationId.indexOf("@");
 			if(indexOfOrigin !== -1){
+				topicResolved.applicationName = topicResolved.applicationId;
 				topicResolved.applicationId = topicResolved.applicationId.substring(0,indexOfOrigin);
 			}
 			return topicResolved;
@@ -379,15 +407,19 @@ class directorieshandlerClass {
 	 * ******************************************************************/
 
 
-	async getChirpstackAttributValue(topic,message,resolvetype){
+	// !!! Dont use resoletypes with message.deviceInfo in down => No deviceInfo in down message present
+	getChirpstackAttributValue(topic,message,resolvetype){
 		const activeFunction = "getChirpstackAttributValue";
 		try{
 			this.adapter.log.silly(`attribute ${resolvetype} is requested for chirpstack`);
 			const topicResolved =  this.getTopicResolved(topic);
 			switch(resolvetype){
-				case this.searchableAttributeNames.apllicationId:
+				case this.searchableAttributeNames.applicationId:
 					return topicResolved?.applicationId;
 
+				case this.searchableAttributeNames.applicationName:
+					return message.deviceInfo.applicationName;
+
 				case this.searchableAttributeNames.deviceEUI:
 					return topicResolved?.deviceEUI;
 
@@ -404,35 +436,6 @@ class directorieshandlerClass {
 		}
 	}
 
-	/*********************************************************************
-	 * ************************ Object Directory *************************
-	 * ******************************************************************/
-
-	async getChirpstackObjectDirectory(topic,message,resolvetype){
-		const activeFunction = "getChirpstackObjectDirectory";
-		try{
-			this.adapter.log.silly(`directory ${resolvetype} is requested for chirpstack`);
-			const topicResolved =  this.getTopicResolved(topic);
-			let devUid = undefined;
-			if(topicResolved?.messageType !== "down"){
-				devUid = message.deviceInfo.devEui;
-			}
-			else{
-				devUid = message.devEui;
-			}
-			switch(resolvetype){
-				case this.searchableAttributeNames.deviceEUI:
-					return `${topicResolved?.applicationId}.devices.${devUid}`;
-
-				default:
-					return message;
-			}
-		}
-		catch(error){
-			this.adapter.log.error(`error at ${activeFunction}:  ${error} - - - Message: ${JSON.stringify(message)}`);
-		}
-	}
-
 	/*********************************************************************
 	 * ************************ Resolved Topic ***************************
 	 * ******************************************************************/

package/lib/modules/downlinkConfighandler.js

@@ -38,7 +38,7 @@ class downlinkConfighandlerClass {
 			// generate the Config without own objects
 			const ownConfig = [];
 			for(const downlinkConfig of Object.values(this.activeDownlinkConfigs)){
-				ownConfig.push(JSON.parse(JSON.stringify(downlinkConfig)));
+				ownConfig.push(structuredClone(downlinkConfig));//JSON.parse(JSON.stringify(downlinkConfig)));
 				delete ownConfig[ownConfig.length - 1].downlinkState;
 			}
 			// Add internal base downlinks

package/lib/modules/messagehandler.js

@@ -169,7 +169,7 @@ class messagehandlerClass {
 			const messageType = topic.substring(topic.lastIndexOf("/") + 1 ,topic.length);
 			this.adapter.log.silly(`the messagetype ${messageType} was determined`);
 			// generate startdirectory of device
-			const deviceStartdirectory = await this.directoryhandler.getObjectDirectory(topic,message,this.directoryhandler.searchableAttributeNames.deviceEUI);
+			const deviceStartdirectory = this.directoryhandler.getDeviceStartDirectory(topic,message);
 			this.adapter.log.silly(`the startdirectory ${deviceStartdirectory} was determined`);
 
 			/*********************************************************************
@@ -418,7 +418,7 @@ class messagehandlerClass {
 			const messageType = topic.substring(topic.lastIndexOf("/") + 1 ,topic.length);
 			this.adapter.log.silly(`the messagetype ${messageType} was determined`);
 			// generate startdirectory of device
-			const deviceStartdirectory = await this.directoryhandler.getObjectDirectory(topic,message,this.directoryhandler.searchableAttributeNames.deviceEUI);
+			const deviceStartdirectory = this.directoryhandler.getDeviceStartDirectory(topic,message);
 			this.adapter.log.silly(`the startdirectory ${deviceStartdirectory} was determined`);
 
 			/*********************************************************************

package/main.js

@@ -214,18 +214,6 @@ class Lorawan extends utils.Adapter {
 						}
 						this.setStateAsync(id,state.val,true);
 					}
-					// logging of the actual available configs
-					else if(id.indexOf(".logAvailableConfignames") !== -1){
-						this.log.info(`The following devicenames has an existing downlink-config`);
-						let index = 0;
-						for(const devicename in this.downlinkConfighandler?.activeDownlinkConfigs){
-							index++;
-							if(devicename !== this.downlinkConfighandler.internalDevices.baseDevice){
-								this.log.info(`Device ${index}: ${devicename}`);
-							}
-						}
-						this.setStateAsync(id,state.val,true);
-					}
 				}
 			} else {
 				// The state was deleted
@@ -340,7 +328,8 @@ class Lorawan extends utils.Adapter {
 				// Get Obect from startdirectory
 				const startDirectoryObject = await this.getObjectAsync(changeInfo.objectStartDirectory);
 				if(startDirectoryObject){
-					changeInfo.deviceId = startDirectoryObject.common.name;
+					changeInfo.applicationName = startDirectoryObject.native.applicationName;
+					changeInfo.deviceId = startDirectoryObject.native.deviceId;
 				}
 				// Get deviceType
 				const deviceTypeIdState = await this.getStateAsync(myId);
@@ -407,7 +396,7 @@ class Lorawan extends utils.Adapter {
 					if(obj.message.deviceEUI){
 						const changeInfo = await this.getChangeInfoFromDeviceEUI(obj.message.deviceEUI,`${this.messagehandler?.directoryhandler.reachableSubfolders.configuration}.devicetype`);
 						if(changeInfo){
-							result = {applicationId: changeInfo.applicationId, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, received:obj.message};
+							result = {applicationId: changeInfo.applicationId, applicationName: changeInfo.applicationName, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, received:obj.message};
 						}
 						else{
 							result = {error:true, message:"No device found", received:obj.message};
@@ -428,7 +417,7 @@ class Lorawan extends utils.Adapter {
 							if(await this.objectExists(uplinkId)){
 								const stateResult = await this.getStateAsync(changeInfo.id);
 								if(stateResult){
-									result = {applicationId: changeInfo.applicationId, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, value: stateResult.val, received:obj.message};
+									result = {applicationId: changeInfo.applicationId, applicationName: changeInfo.applicationName, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, value: stateResult.val, received:obj.message};
 								}
 							}
 							else{
@@ -460,7 +449,7 @@ class Lorawan extends utils.Adapter {
 											// Check limit
 											if((!downlinkObject.common.min || obj.message.value >= downlinkObject.common.min) && (!downlinkObject.common.max || obj.message.value <= downlinkObject.common.max)){
 												await this.setStateAsync(downlinkId,obj.message.value);
-												result = {applicationId: changeInfo.applicationId, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, downlink: obj.message.downlink, value: obj.message.value, received:obj.message};
+												result = {applicationId: changeInfo.applicationId, applicationName: changeInfo.applicationName, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, downlink: obj.message.downlink, value: obj.message.value, received:obj.message};
 											}
 											else{
 												result = {error:true, message:"value is not in valid range", received:obj.message};
@@ -477,7 +466,7 @@ class Lorawan extends utils.Adapter {
 										}
 										else{
 											await this.setStateAsync(downlinkId,obj.message.value);
-											result = {applicationId: changeInfo.applicationId, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, downlink: obj.message.downlink, value: obj.message.value, received:obj.message};
+											result = {applicationId: changeInfo.applicationId, applicationName: changeInfo.applicationName, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, downlink: obj.message.downlink, value: obj.message.value, received:obj.message};
 										}
 									}
 								}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.lorawan",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "converts the desired lora gateway data to a ioBroker structure",
   "author": {
     "name": "BenAhrdt",