iobroker.lorawan 1.0.2 → 1.0.3

package/README.md

@@ -23,6 +23,10 @@ For now there is documentation in English here: https://wiki.hafenmeister.de
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 1.0.3 (2024-05-10)
+* (BenAhrdt) notifications for connection and disconnection LNS added
+* (BenAhrdt) notifiction for device offline added
+
 ### 1.0.2 (2024-03-27)
 * (BenAhrdt) change some comments and logging
 

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "lorawan",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "news": {
+      "1.0.3": {
+        "en": "notifications for connection and disconnection LNS added\nnotifiction for device offline added",
+        "de": "benachrichtigungen für Anschluss und Abschaltung LNS hinzugefügt\nnotification für gerät offline hinzugefügt",
+        "ru": "уведомления для подключения и отключения\nnotification for device offline added",
+        "pt": "notificações para conexão e desconexão LNS adicionado\nnotificação para dispositivo offline adicionado",
+        "nl": "meldingen voor verbinding en loskoppeling LNS toegevoegd\nnotatie voor apparaat offline toegevoegd",
+        "fr": "notifications pour connexion et déconnexion LNS ajoutées\nnotifition pour périphérique hors ligne ajouté",
+        "it": "notifiche per connessione e disconnessione LNS aggiunto\nnotifica per dispositivo offline aggiunto",
+        "es": "notificaciones para conexión y desconexión LNS añadido\nnotifiction para dispositivo offline añadido",
+        "pl": "powiadomienia o dodanych LNS podłączenia i odłączenia\nname",
+        "uk": "повідомлення про підключення та відключення LNS додано\nдодано невідповідність пристрою",
+        "zh-cn": "添加连接和断开LNS的通知\n设备下线通知已添加"
+      },
       "1.0.2": {
         "en": "change some comments and logging",
         "de": "einige kommentare und protokollierung ändern",
@@ -80,19 +93,6 @@
         "pl": "Zmień pisanie informacji na temat treści w Ttn",
         "uk": "Зміна письмової інформації про пристрій",
         "zh-cn": "在 Ttn 更改设备信息的写入"
-      },
-      "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": "设备信息已更改"
       }
     },
     "titleLang": {
@@ -157,6 +157,135 @@
       }
     ]
   },
+  "notifications": [
+    {
+      "scope": "lorawan",
+      "name": {
+        "en": "LoRaWAN",
+        "de": "LoRaWAN",
+        "ru": "LoRaWAN",
+        "pt": "LoRaWAN",
+        "nl": "LoRaWAN",
+        "fr": "LORAWAN",
+        "it": "LoRaWAN",
+        "es": "LoRaWAN",
+        "pl": "LoRaWAN",
+        "uk": "Лоравіан",
+        "zh-cn": "洛拉万语"
+      },
+      "description": {
+        "en": "These notifications represent news of devices, gateways or LoraWAN Network Services",
+        "de": "Diese Benachrichtigungen stellen Nachrichten von Geräten, Gateways oder LoraWAN Network Services dar",
+        "ru": "Эти уведомления представляют новости об устройствах, шлюзах или LoraWAN Network Services",
+        "pt": "Estas notificações representam notícias de dispositivos, gateways ou serviços de rede LoraWAN",
+        "nl": "Deze meldingen vertegenwoordigen nieuws van apparaten, gateways of LoraWAN Network Services",
+        "fr": "Ces notifications représentent des nouvelles d'appareils, passerelles ou services réseau LoraWAN",
+        "it": "Queste notifiche rappresentano notizie di dispositivi, gateway o LoraWAN Network Services",
+        "es": "Estas notificaciones representan noticias de dispositivos, portales o LoraWAN Network Services",
+        "pl": "Powiadomienia te stanowią wiadomości o urządzeniach, bramach lub usługach sieciowych LoraWAN",
+        "uk": "Ці повідомлення представляють новини пристроїв, шлюзу або LoraWAN",
+        "zh-cn": "这些通知代表设备、网关或LoraWAN网络服务的新闻"
+      },
+      "categories": [
+        {
+          "category": "LoRaWAN Network Service connected",
+          "name": {
+            "en": "The desired LoRaWAN Network service was connected",
+            "de": "Der gewünschte LoRaWAN Network Service wurde verbunden",
+            "ru": "Желаемый сервис LoRaWAN Network был подключен",
+            "pt": "O serviço de rede LoRaWAN desejado foi conectado",
+            "nl": "De gewenste LoRaWAN Network service was aangesloten",
+            "fr": "Le service de réseau LoRaWAN souhaité était connecté",
+            "it": "Il servizio LoRaWAN Network desiderato è stato collegato",
+            "es": "El servicio LoRaWAN Network deseado estaba conectado",
+            "pl": "Połączono żądaną usługę sieci LoRaWAN",
+            "uk": "З'єднано бажаний сервіс LoRaWAN",
+            "zh-cn": "所期望的LORAWAN网络服务已连接"
+          },
+          "severity": "info",
+          "description": {
+            "en": "The connection to the LoRaWAN Network service changed from disconnected to connected",
+            "de": "Die Verbindung zum LoRaWAN Network-Service hat sich von getrennt zu verbunden geändert",
+            "ru": "Соединение с сервисом LoRaWAN Network изменилось от отключенного к подключенному",
+            "pt": "A conexão com o serviço de rede LoRaWAN mudou de desconectado para conectado",
+            "nl": "De verbinding met de LoRaWAN Network service veranderde van losgekoppeld naar verbonden",
+            "fr": "La connexion au service réseau LoRaWAN est passée de déconnectée à connectée",
+            "it": "Il collegamento al servizio di rete LoRaWAN è cambiato da disconnesso a collegato",
+            "es": "La conexión con el servicio LoRaWAN Network cambió de desconectado a conectado",
+            "pl": "Połączenie z siecią LoRaWAN zmieniło się z odłączonego na podłączony",
+            "uk": "З'єднання до мережі LoRaWAN змінено з відключення",
+            "zh-cn": "连接 LoRAWAN 网络服务从断开到连接"
+          },
+          "regex": [],
+          "limit": 1
+        },
+        {
+          "category": "LoRaWAN Network Service disconnected",
+          "name": {
+            "en": "The desired LoRaWAN Network service was disconnected",
+            "de": "Der gewünschte LoRaWAN Network Service ist nicht mehr erreichbar",
+            "ru": "Желаемый сервис LoRaWAN Network был отключен",
+            "pt": "O serviço de rede LoRaWAN desejado foi desligado",
+            "nl": "De gewenste LoRaWAN Network service werd afgesloten",
+            "fr": "Le service de réseau LoRaWAN souhaité a été déconnecté",
+            "it": "Il servizio LoRaWAN Network desiderato è stato disconnesso",
+            "es": "El servicio LoRaWAN Network deseado fue desconectado",
+            "pl": "Wybrana usługa LoRaWAN Network została odłączona",
+            "uk": "Відключено бажаний сервіс мережі LoRaWAN",
+            "zh-cn": "想要的LORAWAN网络服务已断开"
+          },
+          "severity": "alert",
+          "description": {
+            "en": "The connection to the LoRaWAN Network service changed from connected to disconnected",
+            "de": "Die Verbindung zum LoRaWAN-Netzwerk-Service hat sich von verbunden zu getrennt geändert",
+            "ru": "Соединение с сервисом LoRaWAN Network изменилось от подключения к отключенному",
+            "pt": "A conexão com o serviço de rede LoRaWAN mudou de conectado para desconectado",
+            "nl": "De verbinding met de LoRaWAN Network service veranderde van verbonden naar losgekoppeld",
+            "fr": "La connexion au service réseau LoRaWAN a changé de connecté à déconnecté",
+            "it": "La connessione al servizio di rete LoRaWAN è cambiata da collegato a disconnesso",
+            "es": "La conexión con el servicio LoRaWAN Network cambió de conexión a desconexión",
+            "pl": "Połączenie z siecią LoRaWAN zmieniło się z podłączonego na odłączony",
+            "uk": "З'єднання до мережі LoRaWAN змінено з підключеного до відключення",
+            "zh-cn": "连接到 LoRAWAN 网络服务从连接到断开"
+          },
+          "regex": [],
+          "limit": 1
+        },
+        {
+          "category": "LoRaWAN device offline",
+          "name": {
+            "en": "A LoRaWAN device is offline",
+            "de": "Ein LoRaWAN Gerät ist offline",
+            "ru": "Устройство LoRaWAN отключено",
+            "pt": "Um dispositivo LoRaWAN está offline",
+            "nl": "Een LoRaWAN apparaat is offline",
+            "fr": "Un périphérique LoRaWAN est hors ligne",
+            "it": "Un dispositivo LoRaWAN è offline",
+            "es": "Un dispositivo LoRaWAN está fuera de línea",
+            "pl": "Urządzenie LoRaWAN jest wyłączone",
+            "uk": "Пристрій LoRaWAN автономний",
+            "zh-cn": "LORAWAN 设备已下线"
+          },
+          "severity": "notify",
+          "description": {
+            "en": "A LoraWAN device has not sended a message for a long time",
+            "de": "Ein LoraWAN-Gerät hat lange keine Nachricht gesendet",
+            "ru": "Устройство LoraWAN не посылало сообщения в течение длительного времени",
+            "pt": "Um dispositivo LoraWAN não enviou uma mensagem por muito tempo",
+            "nl": "Een LoraWAN-apparaat heeft al lange tijd geen bericht meer verstuurd",
+            "fr": "Un périphérique LoraWAN n'a pas envoyé de message depuis longtemps",
+            "it": "Un dispositivo LoraWAN non ha inviato un messaggio per molto tempo",
+            "es": "Un dispositivo LoraWAN no ha enviado un mensaje durante mucho tiempo",
+            "pl": "Urządzenie LoraWAN nie wysłało wiadomości przez długi czas",
+            "uk": "Пристрій LoraWAN не відправляє повідомлення тривалий час",
+            "zh-cn": "LoraWAN 设备已经很久没有固定消息了"
+          },
+          "regex": [],
+          "limit": 10
+        }
+      ]
+    }
+  ],
   "encryptedNative": [
     "password"
   ],

package/lib/modules/directorieshandler.js

@@ -331,7 +331,7 @@ class directorieshandlerClass {
 							}
 							// Check for an assign definition (calculation and / or role assignment)
 							if(this.assigns[elementName] && !options?.dontAssign){
-								this.adapter.log.debug(`the state with th id ${objectId} will be assigned by internal function`);
+								this.adapter.log.debug(`the state with the id ${objectId} will be assigned by internal function`);
 								stateVal = this.assigns[elementName](stateVal,common);
 							}
 							common.read = common.role !== "button";

package/lib/modules/messagehandler.js

@@ -105,7 +105,7 @@ class messagehandlerClass {
 				case this.adapter.origin.ttn:
 					if(message.uplink_message && message.uplink_message){
 						this.deviceinformations[changeInfo.deviceEUI].uplink.decoded = message.uplink_message.decoded_payload;
-						this.deviceinformations[changeInfo.deviceEUI].uplink.time = message.uplink_message.rx_metadata.time;
+						this.deviceinformations[changeInfo.deviceEUI].uplink.time = message.uplink_message.rx_metadata[0].time;
 					}
 					break;
 				case this.adapter.origin.chirpstack:

package/lib/modules/mqttclient.js

@@ -10,9 +10,20 @@ class mqttClientClass {
 			password: settings.password,
 			clientId: `iobroker_${this.adapter.namespace}`
 		});
+
+		// Variables for correct connection (disconnection) notification / logging
+		this.interanConnectionstate = false;
+		this.errorCountdown = 0;
+		this.numberOfErrorsToLog = 10;
+
 		this.client.on("connect", () => {
-			this.adapter.log.info(`Connection is active.`);
+			if(!this.interanConnectionstate){
+				this.adapter.log.info(`Connection is active.`);
+				this.adapter.registerNotification("lorawan", "LoRaWAN Network Service connected", `The LoRaWAN Network Service ${settings.ipUrl} was connected`);
+			}
 			this.adapter.setState("info.connection", true, true);
+			this.interanConnectionstate = true;
+			this.errorCountdown = this.numberOfErrorsToLog;
 			// @ts-ignore
 			this.client.subscribe(this.getSubscribtionArray(), (err) => {
 				if (err) {
@@ -21,16 +32,29 @@ class mqttClientClass {
 			});
 		});
 		this.client.on("disconnect", () => {
-			this.adapter.setState("info.connection", false, true);
-			this.adapter.log.info(`disconnected`);
+			if(this.interanConnectionstate){
+				this.adapter.setState("info.connection", false, true);
+				this.interanConnectionstate = false;
+				this.adapter.log.info(`disconnected`);
+			}
 		});
 		this.client.on("error", (err) => {
-			this.adapter.log.error(`${err}`);
+			if(this.errorCountdown === 0){
+				this.adapter.log.error(`${err}`);
+				this.errorCountdown = this.numberOfErrorsToLog;
+			}
+			else{
+				this.errorCountdown--;
+			}
 		});
 
 		this.client.on("close", () => {
+			if(this.interanConnectionstate){
+				this.adapter.log.info(`Connection is closed.`);
+				this.adapter.registerNotification("lorawan", "LoRaWAN Network Service disconnected", `The LoRaWAN Network Service ${settings.ipUrl} was disconnected`);
+			}
 			this.adapter.setState("info.connection", false, true);
-			this.adapter.log.info(`Connection is closed.`);
+			this.interanConnectionstate = false;
 		});
 
 		this.client.on("message", async (topic, message) => {

package/main.js

@@ -7,6 +7,7 @@
 // The adapter-core module gives you access to the core ioBroker functions
 // you need to create an adapter
 const utils = require("@iobroker/adapter-core");
+const schedule = require("node-schedule");
 const mqttClientClass = require("./lib/modules/mqttclient");
 const messagehandlerClass = require("./lib/modules/messagehandler");
 const downlinkConfighandlerClass = require("./lib/modules/downlinkConfighandler");
@@ -32,6 +33,14 @@ class Lorawan extends utils.Adapter {
 			chirpstack: "chirpstack"
 		};
 
+		this.cronJobs = {};
+		this.cronJobIds = {
+			checkTimestamp: "checkTimestamp"
+		};
+		this.cronJosValues = {
+			checkTimestamp: "* * * * *"//"0 * * * *"
+		};
+
 		// Simulation variables
 		this.simulation = {};
 	}
@@ -66,6 +75,9 @@ class Lorawan extends utils.Adapter {
 			this.log.silly(`the adapter starts with downlinkconfigs: ${JSON.stringify(this.config.downlinkConfig)}.`);
 			this.log.silly(`the active downlinkconfigs are: ${JSON.stringify(this.downlinkConfighandler.activeDownlinkConfigs)}`);
 
+			// Create cronjob to check timestamps (for device offline notification)
+			this.cronJobs[this.cronJobIds.checkTimestamp] = schedule.scheduleJob(this.cronJosValues.checkTimestamp,this.checkTimestamps.bind(this));
+
 			/*setTimeout(async () => {
 				await this.startSimulation();
 			}, 5000);*/
@@ -81,6 +93,36 @@ class Lorawan extends utils.Adapter {
 		}
 	}
 
+	async checkTimestamps(){
+		const activeFunction = "checkTimestamps";
+		try{
+			const adapterObjects = await this.getAdapterObjectsAsync();
+			// Generate Infos of all defices and decoded folders
+			for(const adapterObject of Object.values(adapterObjects)){
+				if(adapterObject._id.endsWith(`${this.messagehandler?.directoryhandler.reachableSubfolders.uplinkRaw}.json`)){
+					const uplinkState = await this.getStateAsync(adapterObject._id);
+					if(uplinkState){
+						const msInOneHour = 1000 * 60 * 60;
+						const maxDifferenceMin = 25 * msInOneHour;
+						const maxDifferenceMax = 26 * msInOneHour;
+						const timestampNow = Date.now();
+						const timestampData = uplinkState.ts;
+						const difference = timestampNow - timestampData;
+						if(difference >= maxDifferenceMin && difference <= maxDifferenceMax){
+							const changeInfo = await this.getChangeInfo(adapterObject._id);
+							if(changeInfo){
+								this.registerNotification("lorawan", "LoRaWAN device offline", `The LoRaWAN device ${changeInfo.usedDeviceId} in the application ${changeInfo.usedApplicationName} is offline`);
+							}
+						}
+					}
+				}
+			}
+		}
+		catch(error){
+			this.log.error(`error at ${activeFunction}: ` + error);
+		}
+	}
+
 	async startSimulation(){
 
 		// TTN
@@ -510,6 +552,15 @@ class Lorawan extends utils.Adapter {
 			this.log.error(`error at ${activeFunction}: ` + error);
 		}
 	}
+
+	// Clear all schedules, if there are some
+	clearAllSchedules(){
+		for(const cronJob in this.cronJobs)
+		{
+			schedule.cancelJob(this.cronJobs[cronJob]);
+			delete this.cronJobs[cronJob];
+		}
+	}
 }
 
 if (require.main !== module) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.lorawan",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "converts the desired lora gateway data to a ioBroker structure",
   "author": {
     "name": "BenAhrdt",
@@ -24,9 +24,10 @@
     "node": ">= 18"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^3.0.4",
+    "@iobroker/adapter-core": "^3.1.4",
     "easy-crc": "^1.1.0",
-    "mqtt": "^5.3.6"
+    "mqtt": "^5.5.5",
+    "node-schedule": "^2.1.1"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^3.7.0",
@@ -34,23 +35,23 @@
     "@alcalzone/release-script-plugin-license": "^3.7.0",
     "@alcalzone/release-script-plugin-manual-review": "^3.7.0",
     "@iobroker/adapter-dev": "^1.3.0",
-    "@iobroker/testing": "^4.1.0",
+    "@iobroker/testing": "^4.1.3",
     "@tsconfig/node18": "^18.2.2",
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.24",
+    "@types/node": "^20.12.2",
     "@types/proxyquire": "^1.3.31",
     "@types/sinon": "^17.0.3",
     "@types/sinon-chai": "^3.2.12",
     "chai": "^4.4.1",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.57.0",
-    "mocha": "^10.3.0",
+    "mocha": "^10.4.0",
     "proxyquire": "^2.1.3",
     "sinon": "^17.0.1",
     "sinon-chai": "^3.7.0",
-    "typescript": "~5.3.3"
+    "typescript": "~5.4.5"
   },
   "main": "main.js",
   "files": [