iobroker.lorawan 0.0.13 → 0.0.14

package/README.md

@@ -19,6 +19,9 @@ Adapter was created in collaboration with Joerg Froehner LoraWan@hafenmeister.co
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 0.0.14 (2024-01-21)
+* (BenAhrdt) bugfix chirpstack directory
+
 ### 0.0.13 (2024-01-21)
 * (BenAhrdt) change device id selecting in chirpstack out of directory (for downlink queued)
 

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "lorawan",
-    "version": "0.0.13",
+    "version": "0.0.14",
     "news": {
+      "0.0.14": {
+        "en": "bugfix chirpstack directory",
+        "de": "bugfix chirpstack verzeichnis",
+        "ru": "bugfix chirpstack directory",
+        "pt": "gerenciamento de contas",
+        "nl": "bugfix chirpstack-map",
+        "fr": "répertoire bugfix chirpstack",
+        "it": "bugfix chirpstack directory",
+        "es": "directorio bugfix chirpstack",
+        "pl": "katalog chirpstock bugfix",
+        "uk": "javascript licenses api веб-сайт",
+        "zh-cn": "bugfix 奇普斯塔克目录"
+      },
       "0.0.13": {
         "en": "change device id selecting in chirpstack out of directory (for downlink queued)",
         "de": "id auswahl in chirpstack aus verzeichnis (für downlink queued)",
@@ -80,19 +93,6 @@
         "pl": "pierwsza realizacja chirpstock",
         "uk": "перша реалізація тирпастука",
         "zh-cn": "首次实施黑社会"
-      },
-      "0.0.7": {
-        "en": "hex to Upper case, more units for decoded payload values",
-        "de": "hex to Upper case, mehr Einheiten für decodierte Nutzwerte",
-        "ru": "hex to Upper case, more units for decode payload values",
-        "pt": "hex para caixa superior, mais unidades para valores de carga descodificados",
-        "nl": "hex naar Upper case, meer eenheden voor gedecodeerde lading waarden",
-        "fr": "hex à Upper case, plus d'unités pour les valeurs de charge utile décodées",
-        "it": "hex to Upper case, più unità per i valori di payload decodificato",
-        "es": "hex to Upper case, más unidades para valores de carga descodificados",
-        "pl": "hex do górnej skrzyni, więcej jednostek dla dekodowanych wartości ładunku",
-        "uk": "hex до верхнього корпусу, більше одиниць для декодованих значень навантаження",
-        "zh-cn": "十六进制到大写, 更多解码有效载荷值的单位"
       }
     },
     "title": "LoRaWAN",

package/lib/modules/directorieshandler.js

@@ -134,8 +134,7 @@ class directorieshandlerClass {
 	 * ******************************************************************/
 
 	async generateRekursivObjects(obj,startDirectory,topic,message,options = undefined){
-		const activeFunction = "handleTtnMessage";
-
+		const activeFunction = "generateRekursivObjects";
 		try{
 			// just proceed with ojects
 			if(typeof obj === "object"){
@@ -160,10 +159,10 @@ class directorieshandlerClass {
 								if(!this.reachableDirectories){
 									this.reachableDirectories = {};
 								}
-								if(!this.reachableDirectories[this.getObjectDirectory(topic,message,this.searchableAttributeNames.deviceId)]){
-									this.reachableDirectories[this.getObjectDirectory(topic,message,this.searchableAttributeNames.deviceId)] = {};
+								if(!this.reachableDirectories[await this.getObjectDirectory(topic,message,this.searchableAttributeNames.deviceId)]){
+									this.reachableDirectories[await this.getObjectDirectory(topic,message,this.searchableAttributeNames.deviceId)] = {};
 								}
-								this.reachableDirectories[this.getObjectDirectory(topic,message,this.searchableAttributeNames.deviceId)][obj[elementName].safeDirectory] = objectId;
+								this.reachableDirectories[await this.getObjectDirectory(topic,message,this.searchableAttributeNames.deviceId)][obj[elementName].safeDirectory] = objectId;
 							}
 							await this.adapter.setObjectNotExistsAsync(objectId,{
 								// @ts-ignore
@@ -235,12 +234,19 @@ class directorieshandlerClass {
 	 * ******************************************************************/
 
 	async getAttributValue(topic,message,resolvetype){
-		// Select search in case of origin
-		switch(this.adapter.config.origin){
-			case "ttn":
-				return await this.getTtnAttributValue(topic,message,resolvetype);
-			case "chirpstack":
-				return await this.getChirpstackAttributValue(topic,message,resolvetype);
+		const activeFunction = "getAttributValue";
+		try{
+			// Select search in case of origin
+			switch(this.adapter.config.origin){
+				case "ttn":
+					return await this.getTtnAttributValue(topic,message,resolvetype);
+				case "chirpstack":
+					return await this.getChirpstackAttributValue(topic,message,resolvetype);
+			}
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Message: " + JSON.stringify(message));
 		}
 	}
 
@@ -248,13 +254,20 @@ class directorieshandlerClass {
 	 * ************************ Object Directory *************************
 	 * ******************************************************************/
 
-	getObjectDirectory(topic,message,resolvetype){
-		// Select search in case of origin
-		switch(this.adapter.config.origin){
-			case "ttn":
-				return this.getTtnObjectDirectory(topic,message,resolvetype);
-			case "chirpstack":
-				return this.getChirpstackObjectDirectory(topic,message,resolvetype);
+	async getObjectDirectory(topic,message,resolvetype){
+		const activeFunction = "getObjectDirectory";
+		try{
+			// Select search in case of origin
+			switch(this.adapter.config.origin){
+				case "ttn":
+					return await this.getTtnObjectDirectory(topic,message,resolvetype);
+				case "chirpstack":
+					return await this.getChirpstackObjectDirectory(topic,message,resolvetype);
+			}
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Message: " + JSON.stringify(message));
 		}
 	}
 
@@ -262,13 +275,20 @@ class directorieshandlerClass {
 	 * *********************** Topic resolved ****************************
 	 * ******************************************************************/
 	getTopicResolved(topic){
-		this.adapter.log.silly(`topic ${topic} is requested for resolveing`);
-		// Select in case of origin
-		switch(this.adapter.config.origin){
-			case "ttn":
-				return this.getTtnTopicResolved(topic);
-			case "chirpstack":
-				return this.getChirpstackTopicResolved(topic);
+		const activeFunction = "getTopicResolved";
+		try{
+			this.adapter.log.silly(`topic ${topic} is requested for resolveing`);
+			// Select in case of origin
+			switch(this.adapter.config.origin){
+				case "ttn":
+					return this.getTtnTopicResolved(topic);
+				case "chirpstack":
+					return this.getChirpstackTopicResolved(topic);
+			}
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Topic: " + JSON.stringify(topic));
 		}
 	}
 
@@ -281,21 +301,28 @@ class directorieshandlerClass {
 	 * ******************************************************************/
 
 	async getTtnAttributValue(topic,message,resolvetype){
-		this.adapter.log.silly(`attribute ${resolvetype} is requested for ttn`);
-		const topicResolved =  this.getTopicResolved(topic);
-		switch(resolvetype){
-			case this.searchableAttributeNames.apllicationId:
-				return topicResolved?.applicationId;
+		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:
+					return topicResolved?.applicationId;
 
-			case this.searchableAttributeNames.deviceUid:
-				return message.end_device_ids.dev_eui;
+				case this.searchableAttributeNames.deviceUid:
+					return message.end_device_ids.dev_eui;
 
-			case this.searchableAttributeNames.deviceId:
-				return topicResolved?.deviceId;
+				case this.searchableAttributeNames.deviceId:
+					return topicResolved?.deviceId;
 
-			default:
-				this.adapter.log.warn(`No attribute with the name ${resolvetype} found.`);
-				return "";
+				default:
+					this.adapter.log.warn(`No attribute with the name ${resolvetype} found.`);
+					return "";
+			}
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Message: " + JSON.stringify(message));
 		}
 	}
 
@@ -303,20 +330,27 @@ class directorieshandlerClass {
 	 * ************************ Object Directory *************************
 	 * ******************************************************************/
 
-	getTtnObjectDirectory(topic,message,resolvetype){
-		this.adapter.log.silly(`directory ${resolvetype} is requested for ttn`);
-		const topicResolved =  this.getTopicResolved(topic);
-		if(typeof message !== "string"){
-			switch(resolvetype){
-				case this.searchableAttributeNames.deviceId:
-					return `${topicResolved?.applicationId}.devices.${message.end_device_ids.dev_eui}.${topicResolved?.deviceId}`;
+	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.deviceId:
+						return `${topicResolved?.applicationId}.devices.${message.end_device_ids.dev_eui}.${topicResolved?.deviceId}`;
 
-				default:
-					return message;
+					default:
+						return message;
+				}
+			}
+			else{
+				return message;
 			}
 		}
-		else{
-			return message;
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Message: " + JSON.stringify(message));
 		}
 	}
 
@@ -325,18 +359,25 @@ class directorieshandlerClass {
 	 * ******************************************************************/
 
 	getTtnTopicResolved(topic){
-		const topicElements = topic.split("/");
-		const topicResolved = {
-			applicationId: topicElements[1],
-			deviceId: topicElements[3],
-			messageType: topicElements[topicElements.length - 1]
-		};
-		// clean up application id
-		const indexOfOrigin = topicResolved.applicationId.indexOf("@");
-		if(indexOfOrigin !== -1){
-			topicResolved.applicationId = topicResolved.applicationId.substring(0,indexOfOrigin);
+		const activeFunction = "getTtnTopicResolved";
+		try{
+			const topicElements = topic.split("/");
+			const topicResolved = {
+				applicationId: topicElements[1],
+				deviceId: topicElements[3],
+				messageType: topicElements[topicElements.length - 1]
+			};
+			// clean up application id
+			const indexOfOrigin = topicResolved.applicationId.indexOf("@");
+			if(indexOfOrigin !== -1){
+				topicResolved.applicationId = topicResolved.applicationId.substring(0,indexOfOrigin);
+			}
+			return topicResolved;
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Topic: " + JSON.stringify(topic));
 		}
-		return topicResolved;
 	}
 
 
@@ -351,38 +392,45 @@ class directorieshandlerClass {
 
 
 	async getChirpstackAttributValue(topic,message,resolvetype){
-		this.adapter.log.silly(`attribute ${resolvetype} is requested for chirpstack`);
-		const topicResolved =  this.getTopicResolved(topic);
-		let devId = undefined;
-		switch(resolvetype){
-			case this.searchableAttributeNames.apllicationId:
-				return topicResolved?.applicationId;
-
-			case this.searchableAttributeNames.deviceUid:
-				return topicResolved?.devUid;
-
-			case this.searchableAttributeNames.deviceId:
-				if(topicResolved?.messageType === "up"){
-					devId = message.deviceInfo.deviceName;
-				}
-				else if(topicResolved?.messageType === "down")
-				{
-					const adapterObjectsAtStart = await this.adapter.getAdapterObjectsAsync();
-					for(const adapterObject of Object.values(adapterObjectsAtStart)){
-						if(adapterObject.type === "channel" && adapterObject.common.name !== "Information"){
-							const baseDeviceInfo = this.adapter.getBaseDeviceInfo(`${adapterObject._id}.deviceInfo`);
-							if(baseDeviceInfo.obectStartDirectory === adapterObject._id){
-								devId = baseDeviceInfo.obectStartDirectory;
-								break;
+		const activeFunction = "getChirpstackAttributValue";
+		try{
+			this.adapter.log.silly(`attribute ${resolvetype} is requested for chirpstack`);
+			const topicResolved =  this.getTopicResolved(topic);
+			let devId = undefined;
+			switch(resolvetype){
+				case this.searchableAttributeNames.apllicationId:
+					return topicResolved?.applicationId;
+
+				case this.searchableAttributeNames.deviceUid:
+					return topicResolved?.deviceUid;
+
+				case this.searchableAttributeNames.deviceId:
+					if(topicResolved?.messageType === "up"){
+						devId = message.deviceInfo.deviceName;
+					}
+					else if(topicResolved?.messageType === "down")
+					{
+						const adapterObjectsAtStart = await this.adapter.getAdapterObjectsAsync();
+						for(const adapterObject of Object.values(adapterObjectsAtStart)){
+							if(adapterObject.type === "channel" && adapterObject.common.name !== "Information"){
+								const baseDeviceInfo = this.adapter.getBaseDeviceInfo(`${adapterObject._id}.deviceInfo`);
+								if(baseDeviceInfo.obectStartDirectory === adapterObject._id){
+									devId = baseDeviceInfo.obectStartDirectory;
+									break;
+								}
 							}
 						}
 					}
-				}
-				return devId;
+					return devId;
 
-			default:
-				this.adapter.log.warn(`No attribute with the name ${resolvetype} found.`);
-				return "";
+				default:
+					this.adapter.log.warn(`No attribute with the name ${resolvetype} found.`);
+					return "";
+			}
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Message: " + JSON.stringify(message));
 		}
 	}
 
@@ -390,54 +438,68 @@ class directorieshandlerClass {
 	 * ************************ Object Directory *************************
 	 * ******************************************************************/
 
-	getChirpstackObjectDirectory(topic,message,resolvetype){
-		this.adapter.log.silly(`directory ${resolvetype} is requested for chirpstack`);
-		const topicResolved =  this.getTopicResolved(topic);
-		let devUid = undefined;
-		if(topicResolved?.messageType === "up"){
-			devUid = message.deviceInfo.devEui;
-		}
-		else if(topicResolved?.messageType === "down")
-		{
-			devUid = message.devEui;
-		}
-		if(devUid !== undefined){
-			if(typeof message !== "string"){
-				switch(resolvetype){
-					case this.searchableAttributeNames.deviceId:
-						return `${topicResolved?.applicationId}.devices.${devUid}.${topicResolved?.deviceId}`;
-
-					default:
-						return message;
+	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 === "up"){
+				devUid = message.deviceInfo.devEui;
+			}
+			else if(topicResolved?.messageType === "down")
+			{
+				devUid = message.devEui;
+			}
+			if(devUid !== undefined){
+				if(typeof message !== "string"){
+					switch(resolvetype){
+						case this.searchableAttributeNames.deviceId:
+							return `${topicResolved?.applicationId}.devices.${devUid}.${await this.getChirpstackAttributValue(topic,message,this.searchableAttributeNames.deviceId)}`; // Hier muss die device id rein. (mussnoch mit async geholt werden)
+
+						default:
+							return message;
+					}
+				}
+				else{
+					return message;
 				}
 			}
 			else{
-				return message;
+				this.adapter.log.warn(`no devEui found in message`);
+				this.adapter.log.warn(`message: ${message}`);
 			}
 		}
-		else{
-			this.adapter.log.warn(`no devEui found in message`);
-			this.adapter.log.warn(`message: ${message}`);
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Message: " + JSON.stringify(message));
 		}
 	}
 
 	/*********************************************************************
-	 * ************************ Object Directory *************************
+	 * ************************ Resolved Topic ***************************
 	 * ******************************************************************/
 
 	getChirpstackTopicResolved(topic){
-		const topicElements = topic.split("/");
-		const topicResolved = {
-			applicationId: topicElements[1],
-			deviceUid: topicElements[3],
-			messageType: topicElements[topicElements.length - 1]
-		};
-		// clean up application id
-		const indexOfOrigin = topicResolved.applicationId.indexOf("@");
-		if(indexOfOrigin !== -1){
-			topicResolved.applicationId = topicResolved.applicationId.substring(0,indexOfOrigin);
+		const activeFunction = "getChirpstackTopicResolved";
+		try{
+			const topicElements = topic.split("/");
+			const topicResolved = {
+				applicationId: topicElements[1],
+				deviceUid: topicElements[3],
+				messageType: topicElements[topicElements.length - 1]
+			};
+			// clean up application id
+			const indexOfOrigin = topicResolved.applicationId.indexOf("@");
+			if(indexOfOrigin !== -1){
+				topicResolved.applicationId = topicResolved.applicationId.substring(0,indexOfOrigin);
+			}
+			return topicResolved;
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+			this.adapter.log.warn("Topic: " + JSON.stringify(topic));
 		}
-		return topicResolved;
 	}
 }
 

package/lib/modules/messagehandler.js

@@ -110,9 +110,8 @@ 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 = this.directoryhandler.getObjectDirectory(topic,message,this.directoryhandler.searchableAttributeNames.deviceId);
+			const deviceStartdirectory = await this.directoryhandler.getObjectDirectory(topic,message,this.directoryhandler.searchableAttributeNames.deviceId);
 			this.adapter.log.silly(`the startdirectory ${deviceStartdirectory} was determined`);
-
 			/*********************************************************************
 			 * ************************ Main directories *************************
 			 * ******************************************************************/
@@ -135,7 +134,6 @@ class messagehandlerClass {
 
 			// check for uplink message
 			if(messageType === "up"){//if(message.uplink_message){
-
 				/*********************************************************************
 				 * ************************ Rawdata json *****************************
 				 * ******************************************************************/
@@ -159,7 +157,6 @@ class messagehandlerClass {
 				/*********************************************************************
 				* ********************** Rawdata (Base64) ***************************
 				* ******************************************************************/
-
 				// check for frm payload
 				if(message.uplink_message.frm_payload){
 					// wite base64 data
@@ -354,7 +351,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 = this.directoryhandler.getObjectDirectory(topic,message,this.directoryhandler.searchableAttributeNames.deviceId);
+			const deviceStartdirectory = await this.directoryhandler.getObjectDirectory(topic,message,this.directoryhandler.searchableAttributeNames.deviceId);
 			this.adapter.log.silly(`the startdirectory ${deviceStartdirectory} was determined`);
 
 			/*********************************************************************
@@ -397,7 +394,6 @@ class messagehandlerClass {
 				/*********************************************************************
 				* ********************** Rawdata (Base64) ***************************
 				* ******************************************************************/
-
 				// check for data
 				if(message.data){
 					// wite base64 data
@@ -452,7 +448,6 @@ class messagehandlerClass {
 				/*********************************************************************
 				 * ****************** decoded payload (Object) ***********************
 				 * ******************************************************************/
-
 				startDirectory = `${deviceStartdirectory}.${this.directoryhandler.reachableSubfolders.uplinkDecoded}`;
 				this.adapter.log.silly(`write decoded payload (Object)`);
 				await this.directoryhandler.generateRekursivObjects(message.object,startDirectory,topic,message);
@@ -554,12 +549,12 @@ class messagehandlerClass {
 				 * ******************************************************************/
 
 			}
-
 			/*********************************************************************
 			 * ********************** downlinkConfigs ****************************
 			 * ******************************************************************/
 			this.adapter.log.silly(`check configed downlinks`);
 			await this.fillWithDownlinkConfig(deviceStartdirectory);
+
 		}
 		catch(error){
 			this.adapter.log.error(`error at ${activeFunction}: ` + error);

package/main.js

@@ -53,12 +53,23 @@ class Lorawan extends utils.Adapter {
 			this.subscribeStatesAsync("*.configuration.*");
 			this.subscribeStatesAsync("*downlink.control.*");
 			this.log.debug(`the adapter start with the config: ${JSON.stringify(this.config)}.`);
+
+			/*setTimeout(async () => {
+				await this.startSimulation();
+			}, 5000);*/
 		}
 		catch(error){
 			this.log.error(`error at ${activeFunction}: ` + error);
 		}
 	}
 
+	async startSimulation(){
+
+		const topic = "application/d63c10b6-9263-4ab3-9299-4308fa19a2ad/device/a84041f621857cd2/event/up";
+		const message = {"deduplicationId":"96e4a065-ad5e-402d-a997-7b261072a33c","time":"2024-01-21T17:01:36.641008+00:00","deviceInfo":{"tenantId":"52f14cd4-c6f1-4fbd-8f87-4025e1d49242","tenantName":"ChirpStack","applicationId":"d63c10b6-9263-4ab3-9299-4308fa19a2ad","applicationName":"Benjamin Schmidt","deviceProfileId":"0b46400f-37ec-4f17-8005-168b06159347","deviceProfileName":"Dragino Feuchtesenor","deviceName":"Skimmer","devEui":"a84041f621857cd2","deviceClassEnabled":"CLASS_A","tags":{}},"devAddr":"01fd9738","adr":true,"dr":5,"fCnt":2,"fPort":2,"confirmed":false,"data":"DPYBAAD//wAA","object":{"soilconductivity":0.0,"soiltemperature":-0.1,"volt":3.318,"soilmoisture":0.0},"rxInfo":[{"gatewayId":"50303541b0344750","uplinkId":39169,"gwTime":"2024-01-21T17:01:36.641008+00:00","nsTime":"2024-01-21T17:01:37.695656999+00:00","rssi":-89,"snr":6.25,"rfChain":1,"location":{"latitude":50.69344693065449,"longitude":8.476783633232118},"context":"qESemw==","metadata":{"region_config_id":"eu868","region_common_name":"EU868"},"crcStatus":"CRC_OK"}],"txInfo":{"frequency":868100000,"modulation":{"lora":{"bandwidth":125000,"spreadingFactor":7,"codeRate":"CR_4_5"}}}};
+
+		await this.messagehandler?.handleMessage(topic, message);
+	}
 	/**
 	 * Is called when adapter shuts down - callback has to be called under any circumstances!
 	 * @param {() => void} callback
@@ -176,7 +187,6 @@ class Lorawan extends utils.Adapter {
 
 	async writeNextSend(startDirectory,payloadInHex){
 		const idFolder = `${startDirectory}.${this.messagehandler?.directoryhandler.directoryStructur.downlinkNextSend}`;
-		this.log.warn(payloadInHex);
 		await this.setStateAsync(`${idFolder}.hex`,payloadInHex,true);
 	}
 

package/package.json

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