iobroker.lorawan 0.6.1 → 0.6.3

package/README.md

@@ -15,13 +15,19 @@ The adapter communicates bidirectionally with LoraWan devices via LoRaWAN Networ
 Adapter was created in collaboration with Joerg Froehner LoraWan@hafenmeister.com
 
 For Documentation use the doc folder.
-For now there is documentation in English here: http://www.hafenmeister.com/LoraWan/Iobroker-Adapter.pdf
+For now there is documentation in English here: https://wiki.hafenmeister.de
 
 ## Changelog
 <!--
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 0.6.3 (2024-03-05)
+* (BenAhrdt) def of deviceinformations changed
+
+### 0.6.2 (2024-03-05)
+* (BenAhrdt) seperate dp for deviceinformations
+
 ### 0.6.1 (2024-03-02)
 * (BenAhrdt) better concept to write values and change setObjectNotExists to extendObject
 

package/io-package.json

@@ -1,8 +1,34 @@
 {
   "common": {
     "name": "lorawan",
-    "version": "0.6.1",
+    "version": "0.6.3",
     "news": {
+      "0.6.3": {
+        "en": "def of deviceinformations changed",
+        "de": "def von geräteinformationen geändert",
+        "ru": "изменена дефабрикация устройств",
+        "pt": "def das informações do dispositivo alteradas",
+        "nl": "de def van apparaatinformatie gewijzigd",
+        "fr": "def des informations de l'appareil changé",
+        "it": "def delle informazioni sui dispositivi modificate",
+        "es": "def de las desinformaciones de dispositivo cambiadas",
+        "pl": "def deviceinformations changed",
+        "uk": "змінено деф приладів",
+        "zh-cn": "设备信息已更改"
+      },
+      "0.6.2": {
+        "en": "seperate dp for deviceinformations",
+        "de": "seperate dp für geräteinformationen",
+        "ru": "seperate dp for deviceinformations",
+        "pt": "seperar dp para informações do dispositivo",
+        "nl": "aparte dp voor apparaatinformatie",
+        "fr": "seperate dp pour les informations de l'appareil",
+        "it": "seperate dp per informazioni sui dispositivi",
+        "es": "dp de seperato para desinformaciones de dispositivo",
+        "pl": "seperate dp for deviceinformations",
+        "uk": "seperate dp для пристроюінформаційних систем",
+        "zh-cn": "设备信息的 seperate dp"
+      },
       "0.6.1": {
         "en": "better concept to write values and change setObjectNotExists to extendObject",
         "de": "besseres Konzept zum Schreiben von Werten und Änderungsset ObjectNotExists to erweitern Gegenstand",
@@ -67,32 +93,6 @@
         "pl": "zmień folder dla pisarzy",
         "uk": "змінити папку для запису",
         "zh-cn": "更改写入文件夹"
-      },
-      "0.5.2": {
-        "en": "make writetrigger more flexible",
-        "de": "schreibtrigger flexibler gestalten",
-        "ru": "сделать пишущее устройство более гибким",
-        "pt": "fazer writetrigger mais flexível",
-        "nl": "schrijftrigger flexibeler maken",
-        "fr": "rendre le trigger plus flexible",
-        "it": "rendere writetrigger più flessibile",
-        "es": "hacer la escritura más flexible",
-        "pl": "uczynić pisarkę bardziej elastyczną",
-        "uk": "зробити напилення більш гнучким",
-        "zh-cn": "使写入器更加灵活"
-      },
-      "0.5.1": {
-        "en": "detecting of triggerwords changed",
-        "de": "erkennung von triggerworten geändert",
-        "ru": "изменено обнаружение триггеров",
-        "pt": "detecção de palavras de gatilho alteradas",
-        "nl": "detectie van gewijzigde triggerwoorden",
-        "fr": "la détection des mots-clés a changé",
-        "it": "rilevazione delle parole d'innesco modificate",
-        "es": "detección de palabras de disparador cambiadas",
-        "pl": "wykrywanie zmienionych tryggerwords",
-        "uk": "виявлення змінених фраз",
-        "zh-cn": "检测触发词已更改"
       }
     },
     "title": "LoRaWAN",
@@ -195,6 +195,19 @@
         "def": false
       },
       "native": {}
+    },
+    {
+      "_id": "info.deviceinformations",
+      "type": "state",
+      "common": {
+        "role": "json",
+        "name": "Information of all devices",
+        "type": "json",
+        "read": true,
+        "write": false,
+        "def": ""
+      },
+      "native": {}
     }
   ]
 }

package/lib/modules/directorieshandler.js

@@ -180,7 +180,7 @@ class directorieshandlerClass {
 				// go to every element in the object
 				for(const elementName in obj){
 					// Check the the elementname is not in ignored object
-					if(!this.ignoredElementNames[elementName] && !options?.ignoredElementNames[elementName]){
+					if(!this.ignoredElementNames[elementName] && (!options || !options.ignoredElementNames || !options.ignoredElementNames[elementName])){
 						// Check if the element is an object
 						if(typeof obj[elementName] === "object" && obj[elementName] && !obj[elementName].isState){
 							// Generate the desired id
@@ -265,7 +265,7 @@ class directorieshandlerClass {
 								await this.adapter.setObject(objectId,myObject);
 							}
 							// Jump into next step (next directory / attribute)
-							await this.generateRekursivObjects(obj[elementName],objectId,topic,message);
+							await this.generateRekursivObjects(obj[elementName],objectId,topic,message,options);
 						}
 						else{
 							const common = {
@@ -296,7 +296,8 @@ class directorieshandlerClass {
 								objectId.substring(1,objectId.length);
 							}
 							// Check for an assign definition (calculation and / or role assignment)
-							if(this.assigns[elementName]){
+							if(this.assigns[elementName] && !options?.dontAssign){
+								this.adapter.log.debug(`the state with th id ${objectId} will be assigned by internal function`);
 								stateVal = this.assigns[elementName](stateVal,common);
 							}
 							common.read = common.role !== "button";

package/lib/modules/messagehandler.js

@@ -15,6 +15,10 @@ class messagehandlerClass {
 			boolean: "switch",
 			json: "json"
 		};
+
+		// Define present devices for general datainfo via jsonformat in infor folder
+		this.idDeviceinformations = "info.deviceinformations";
+		this.deviceinformations = {};
 	}
 
 
@@ -62,6 +66,62 @@ class messagehandlerClass {
 		}
 	}
 
+	async generateDeviceinfosAtStartup(){
+		const activeFunction = "generateDeviceinfosAtStartup";
+		try{
+			const adapterObjectsAtStart = await this.adapter.getAdapterObjectsAsync();
+			// Generate Infos of all defices and decoded folders
+			for(const adapterObject of Object.values(adapterObjectsAtStart)){
+				if(adapterObject._id.endsWith(`${this.directoryhandler.reachableSubfolders.uplinkRaw}.json`)){
+					const uplinkState = await this.adapter.getStateAsync(adapterObject._id);
+					await this.assignDeviceInformation(adapterObject._id,JSON.parse(uplinkState.val));
+				}
+			}
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+		}
+	}
+
+	// Assign base information to presentDevices
+	async assignDeviceInformation(id,message){
+		const activeFunction = "assignDeviceInformation";
+		try{
+			const changeInfo = await this.adapter.getChangeInfo(id);
+			// Create Attribute for application id
+			if(!this.deviceinformations[changeInfo.deviceEUI]){
+				this.deviceinformations[changeInfo.deviceEUI] = {};
+				this.deviceinformations[changeInfo.deviceEUI].uplink = {};
+				this.deviceinformations[changeInfo.deviceEUI].uplink.decoded = {};
+			}
+			this.deviceinformations[changeInfo.deviceEUI].applicationId = changeInfo.applicationId;
+			this.deviceinformations[changeInfo.deviceEUI].applicationName = changeInfo.applicationName;
+			this.deviceinformations[changeInfo.deviceEUI].usedApplicationName = changeInfo.usedApplicationName;
+			this.deviceinformations[changeInfo.deviceEUI].deviceId = changeInfo.deviceId;
+			this.deviceinformations[changeInfo.deviceEUI].usedDeviceId = changeInfo.usedDeviceId;
+
+			// Check origin
+			switch(this.adapter.config.origin){
+				case this.adapter.origin.ttn:
+					if(message.uplink_message && message.uplink_message.decoded_payload){
+						this.deviceinformations[changeInfo.deviceEUI].uplink.decoded = message.uplink_message.decoded_payload;
+						this.deviceinformations[changeInfo.deviceEUI].uplink.time = message.rx_metadata.time;
+					}
+					break;
+				case this.adapter.origin.chirpstack:
+					if(message.object){
+						this.deviceinformations[changeInfo.deviceEUI].uplink.decoded = message.object;
+						this.deviceinformations[changeInfo.deviceEUI].uplink.time = message.rxInfo[0].nsTime;
+					}
+					break;
+			}
+			await this.adapter.setStateAsync(this.idDeviceinformations,JSON.stringify(this.deviceinformations),true);
+		}
+		catch(error){
+			this.adapter.log.error(`error at ${activeFunction}: ` + error);
+		}
+	}
+
 	//Add directories at startup (so theyare present before next upload)
 	async addDirectoriesToPresentDirectory(startDirectory){
 		await this.directoryhandler.generateRekursivObjects(this.directoryhandler.directories.application.devices.deviceEUI.downlink.nextSend,`${startDirectory}.${this.directoryhandler.reachableSubfolders.downlinkNextSend}`,"","");
@@ -230,7 +290,7 @@ class messagehandlerClass {
 					common: {
 						name: "last recieved message",
 						type: "json",
-						role: "value",
+						role: "json",
 						read: true,
 						write: false
 					},
@@ -314,6 +374,12 @@ class messagehandlerClass {
 				* ******************************************************************/
 
 				await this.adapter.checkSendDownlinkWithUplink(`${deviceStartdirectory}.downlink.control.push`);
+
+				/*********************************************************************
+			 	* ******************* assign deviceinformations **********************
+				* ******************************************************************/
+
+				await this.assignDeviceInformation(deviceStartdirectory,message);
 			}
 
 			/*********************************************************************
@@ -336,7 +402,7 @@ class messagehandlerClass {
 					common: {
 						name: "last recieved message",
 						type: "json",
-						role: "value",
+						role: "json",
 						read: true,
 						write: false
 					},
@@ -429,7 +495,7 @@ class messagehandlerClass {
 					common: {
 						name: "last recieved message",
 						type: "json",
-						role: "value",
+						role: "json",
 						read: true,
 						write: false
 					},
@@ -516,7 +582,7 @@ class messagehandlerClass {
 					common: {
 						name: "last recieved message",
 						type: "json",
-						role: "value",
+						role: "json",
 						read: true,
 						write: false
 					},
@@ -584,6 +650,7 @@ class messagehandlerClass {
 				startId = `${deviceStartdirectory}.${this.directoryhandler.reachableSubfolders.uplinkDecoded}`;
 				this.adapter.log.silly(`write decoded payload (Object)`);
 				await this.directoryhandler.generateRekursivObjects(message.object,startId,topic,message);
+
 				/*********************************************************************
 				 * ************************* remaining *******************************
 				 * ******************************************************************/
@@ -597,6 +664,12 @@ class messagehandlerClass {
 				* ******************************************************************/
 
 				await this.adapter.checkSendDownlinkWithUplink(`${deviceStartdirectory}.downlink.control.push`);
+
+				/*********************************************************************
+			 	* ******************* assign deviceinformations **********************
+				* ******************************************************************/
+
+				await this.assignDeviceInformation(deviceStartdirectory,message);
 			}
 
 			/*********************************************************************
@@ -618,7 +691,7 @@ class messagehandlerClass {
 					common: {
 						name: "last recieved message",
 						type: "json",
-						role: "value",
+						role: "json",
 						read: true,
 						write: false
 					},
@@ -707,7 +780,7 @@ class messagehandlerClass {
 					common: {
 						name: "last recieved message",
 						type: "json",
-						role: "value",
+						role: "json",
 						read: true,
 						write: false
 					},

package/main.js

@@ -55,6 +55,9 @@ class Lorawan extends utils.Adapter {
 			// generate new configed downlinkstates on allready existing devices at adapter startup
 			await this.messagehandler.generateDownlinksAndRemoveStatesAtStatup();
 
+			// generate deviceinfo of all devices in info folder
+			await this.messagehandler.generateDeviceinfosAtStartup();
+
 			//Subscribe all configuration and control states
 			this.subscribeStatesAsync("*");
 			this.log.silly(`the adapter starts with downlinkconfigs: ${JSON.stringify(this.config.downlinkConfig)}.`);
@@ -326,10 +329,13 @@ class Lorawan extends utils.Adapter {
 			// Check for changeInfo
 			if(changeInfo){
 				// Get Obect from startdirectory
+				const applicationDirectoryObject = await this.getObjectAsync(changeInfo.applicationId);
 				const startDirectoryObject = await this.getObjectAsync(changeInfo.objectStartDirectory);
-				if(startDirectoryObject){
-					changeInfo.applicationName = startDirectoryObject.native.applicationName;
+				if(applicationDirectoryObject && startDirectoryObject){
+					changeInfo.applicationName = applicationDirectoryObject.native.applicationName;
+					changeInfo.usedApplicationName = applicationDirectoryObject.common.name;
 					changeInfo.deviceId = startDirectoryObject.native.deviceId;
+					changeInfo.usedDeviceId = startDirectoryObject.common.name;
 				}
 				// Get deviceType
 				const deviceTypeIdState = await this.getStateAsync(myId);
@@ -396,7 +402,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, applicationName: changeInfo.applicationName, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, received:obj.message};
+							result = {applicationId: changeInfo.applicationId, applicationName: changeInfo.applicationName, usedApplicationName: changeInfo.usedApplicationName, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, usedDeviceId: changeInfo.usedDeviceId, deviceType: changeInfo.deviceType, received:obj.message};
 						}
 						else{
 							result = {error:true, message:"No device found", received:obj.message};
@@ -417,7 +423,7 @@ class Lorawan extends utils.Adapter {
 							if(await this.objectExists(uplinkId)){
 								const stateResult = await this.getStateAsync(changeInfo.id);
 								if(stateResult){
-									result = {applicationId: changeInfo.applicationId, applicationName: changeInfo.applicationName, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, deviceType: changeInfo.deviceType, value: stateResult.val, received:obj.message};
+									result = {applicationId: changeInfo.applicationId, applicationName: changeInfo.applicationName, usedApplicationName: changeInfo.usedApplicationName, deviceEUI: changeInfo.deviceEUI, deviceId: changeInfo.deviceId, usedDeviceId: changeInfo.usedDeviceId, deviceType: changeInfo.deviceType, value: stateResult.val, received:obj.message};
 								}
 							}
 							else{
@@ -449,7 +455,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, applicationName: changeInfo.applicationName, 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, usedApplicationName: changeInfo.usedApplicationName, 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};

package/package.json

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