iobroker.lorawan 1.6.4 → 1.6.5

package/README.md

@@ -23,6 +23,9 @@ 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.6.5 (2025-01-26)
+* (BenAhrdt) export and import downlinkconmfigs with filemanager
+
 ### 1.6.4 (2025-01-21)
 * (BenAhrdt) Set decoded Structure in deviceInfos (with Merge)
 

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "lorawan",
-    "version": "1.6.4",
+    "version": "1.6.5",
     "news": {
+      "1.6.5": {
+        "en": "export and import downlinkconmfigs with filemanager",
+        "de": "export und import von downlinkconmfigs mit filemanager",
+        "ru": "экспортные и импортные скидки с файловым менеджером",
+        "pt": "exportação e importação downlinkconmfigs com filemanager",
+        "nl": "downlinkconfigs exporteren en importeren met filemanager",
+        "fr": "exporter et importer des liens vers le bas avec filemanager",
+        "it": "esportazione e importazione downlinkconmfig con filemanager",
+        "es": "exportar e importar downlinkconmfigs con filemanager",
+        "pl": "eksport i import downlinkconmfigs z fileman",
+        "uk": "експорт і імпорт sdlinkconmfigs з файловmanager",
+        "zh-cn": "以文件管理器导出和导入下行链路conmfigs"
+      },
       "1.6.4": {
         "en": "Set decoded Structure in deviceInfos (with Merge)",
         "de": "Set decodierte Struktur in deviceInfos (mit Verschmelzung)",
@@ -80,19 +93,6 @@
         "pl": "zmiana odpowiedzi nagłówka",
         "uk": "зміна спонтана",
         "zh-cn": "更改信头响应"
-      },
-      "1.5.6": {
-        "en": "add folder \"uplink.remaining.version_ids\" to writecommands",
-        "de": "ordner \"uplink.remaining.version_ids\" zu schreibenbefehlen hinzufügen",
-        "ru": "добавить папку \"uplink.remaining.version_ids\" в написание",
-        "pt": "adicionar pasta \"uplink.remaining.version_ids\" para writecommands",
-        "nl": "map \"uplink.resting.version_ids\" toevoegen aan schrijfopdrachten",
-        "fr": "ajouter le dossier \"uplink.remaining.version_ids\" aux commandes d'écriture",
-        "it": "aggiungere la cartella \"uplink.remaining.version_ids\" per scriverecomandi",
-        "es": "añadir carpeta \"uplink.remaining.version_ids\" para escribircommands",
-        "pl": "dodaj folder \"uplink.revening.version _ ids\" do writecommands",
-        "uk": "додати папку \"uplink.remaining.version_ids\" для записукоманд",
-        "zh-cn": "添加文件夹“ uplink. remaining.version_ ids” 以写入命令"
       }
     },
     "titleLang": {
@@ -349,6 +349,15 @@
       },
       "native": {}
     },
+    {
+      "_id": "",
+      "type": "meta",
+      "common": {
+        "name": "Downlink files",
+        "role": "meta.user"
+      },
+      "native": {}
+    },
     {
       "_id": "info.connection",
       "type": "state",

package/lib/modules/downlinkConfighandler.js

@@ -11,6 +11,7 @@ class downlinkConfighandlerClass {
     constructor(adapter) {
         this.adapter = adapter;
         this.activeDownlinkConfigs = {};
+        this.knownProfiles = [];
         this.deviceProfilesPath = '/lib/modules/deviceProfiles';
         this.internalDeviceProfilesPath = '/lib/modules/deviceProfiles/internal';
         this.internalDevices = {
@@ -39,6 +40,15 @@ class downlinkConfighandlerClass {
             swap: false,
             decimalPlaces: 0,
         };
+
+        this.metafolders = {
+            downlink: {
+                itself: 'downlink/',
+                uploads: 'downlink/uploads/',
+                current: 'downlink/current/',
+                knownProfiles: 'downlink/knownProfiles/',
+            },
+        };
     }
 
     /*********************************************************************
@@ -51,20 +61,21 @@ class downlinkConfighandlerClass {
     async addAndMergeDownlinkConfigs() {
         const activeFunction = 'addAndMergeDownlinkConfigs';
         this.adapter.log.silly(`the standard and configed downlinks will be merged`);
+        // Generate Metafolders
+        await this.generateFoldersFromObject(this.metafolders);
+
+        // Generate downlinks for known Profiles
+        this.generateKnownProfiesFromFiles();
+
         try {
             // Add user downlink config first
             for (const downlinkConfig of Object.values(this.adapter.config.downlinkConfig)) {
                 this.addDownlinkConfigByType(downlinkConfig, this.activeDownlinkConfigs);
             }
-            // Add standard downlink config if devices not present
-            const internalDownlinks = this.getJsonArrayFromDirectoryfiles(
-                `${this.adapter.adapterDir}${this.deviceProfilesPath}`,
-            );
-            if (Array.isArray(internalDownlinks)) {
-                for (const downlinkConfig of Object.values(internalDownlinks)) {
-                    this.addDownlinkConfigByType(downlinkConfig, this.activeDownlinkConfigs);
-                }
-            }
+
+            // check for uploads
+            await this.checkForUploads();
+
             // Check active userconfig
             const adapterId = `system.adapter.${this.adapter.namespace}`;
             const obj = await this.adapter.getForeignObjectAsync(adapterId);
@@ -90,19 +101,205 @@ class downlinkConfighandlerClass {
                 this.adapter.log.warn('Adapter restart, because of reinit configuration');
                 await this.adapter.setForeignObjectAsync(adapterId, obj);
             }
+            // write known Profiles
+            await this.writeknowsProfiles(this.knownProfiles);
+
+            // write downlinkconfig to current folder
+            await this.writeCurrentDownlinksconfigs(obj.native.downlinkConfig);
         } catch (error) {
             this.adapter.log.error(`error at ${activeFunction}: ${error}`);
             return undefined;
         }
     }
 
+    /**
+     * no Parameters needed
+     */
+    async generateKnownProfiesFromFiles() {
+        const activeFunction = 'generateStandardDownlinkConfigFromFiles';
+        try {
+            // Add standard downlink config if devices not present
+            const knownProfiles = this.getJsonArrayFromDirectoryfiles(
+                `${this.adapter.adapterDir}${this.deviceProfilesPath}`,
+            );
+            if (knownProfiles) {
+                this.knownProfiles = knownProfiles;
+            }
+            /*if (Array.isArray(knownProfiles)) {
+                for (const downlinkConfig of Object.values(knownProfiles)) {
+                    this.addDownlinkConfigByType(downlinkConfig, this.knownProfiles);
+                }
+            }*/
+        } catch (error) {
+            this.adapter.log.warn(`error in ${activeFunction}: ${error}`);
+        }
+    }
+
+    /**
+     * @param profiles known profiles to write (eg. from lib/module/deviceProfiles)
+     */
+    async writeknowsProfiles(profiles) {
+        const activeFunction = 'writeknowsProfiles';
+        try {
+            // Read all files in folder and delete them
+            let metadataOfFiles = await this.adapter.readDirAsync(
+                this.adapter.namespace,
+                this.metafolders.downlink.knownProfiles,
+            );
+            for (const element of Object.values(metadataOfFiles)) {
+                const filepath = `${this.metafolders.downlink.knownProfiles}${element.file}`;
+                //delete file from uploadfolder
+                this.adapter.delFileAsync(this.adapter.namespace, filepath);
+            }
+
+            // Write knwon profiles (in one file)
+            await this.adapter.writeFileAsync(
+                this.adapter.namespace,
+                `${this.metafolders.downlink.knownProfiles}KnownProfiles (all devicetypes).json`,
+                Buffer.from(JSON.stringify(profiles)),
+            );
+
+            // Write for known profile (separated by devicetypes)
+            for (const profile of Object.values(profiles)) {
+                await this.adapter.writeFileAsync(
+                    this.adapter.namespace,
+                    `${this.metafolders.downlink.knownProfiles}${profile.deviceType}.json`,
+                    Buffer.from(JSON.stringify(profile)),
+                );
+            }
+        } catch (error) {
+            this.adapter.log.warn(`error in ${activeFunction}: ${error}`);
+        }
+    }
+
+    /**
+     * @param downlinkConfig downlinkconfig to write (eg. from system.adapter.instance)
+     */
+    async writeCurrentDownlinksconfigs(downlinkConfig) {
+        const activeFunction = 'writeDownlinkconfigs';
+        try {
+            // Read all files in folder and delete them
+            let metadataOfFiles = await this.adapter.readDirAsync(
+                this.adapter.namespace,
+                this.metafolders.downlink.current,
+            );
+            for (const element of Object.values(metadataOfFiles)) {
+                const filepath = `${this.metafolders.downlink.current}${element.file}`;
+                //delete file from uploadfolder
+                this.adapter.delFileAsync(this.adapter.namespace, filepath);
+            }
+
+            //Write configs to directory
+            // Write whole config
+            await this.adapter.writeFileAsync(
+                this.adapter.namespace,
+                `${this.metafolders.downlink.current}CurrentConfigs (all devicetypes).json`,
+                Buffer.from(JSON.stringify(downlinkConfig)),
+            );
+            // Write for the devicetypes
+            for (const downlinkconfig of Object.values(downlinkConfig)) {
+                await this.adapter.writeFileAsync(
+                    this.adapter.namespace,
+                    `${this.metafolders.downlink.current}${downlinkconfig.deviceType}.json`,
+                    Buffer.from(JSON.stringify(downlinkconfig)),
+                );
+            }
+        } catch (error) {
+            this.adapter.log.warn(`error in ${activeFunction}: ${error}`);
+        }
+    }
+
+    /**
+     * @param folderObject object wich contains the folderstructure in its elements
+     */
+    async generateFoldersFromObject(folderObject) {
+        const activeFunction = 'generateFoldersFromObject';
+        try {
+            for (const folder of Object.values(folderObject)) {
+                if (typeof folder === 'object') {
+                    this.generateFoldersFromObject(folder);
+                } else {
+                    await this.adapter.mkdirAsync(this.adapter.namespace, `${folder}`);
+                }
+            }
+        } catch (error) {
+            this.adapter.log.warn(`error in ${activeFunction}: ${error}`);
+        }
+    }
+
+    /**
+     * no Parameters needed
+     */
+    async checkForUploads() {
+        const activeFunction = 'checkForUploads';
+        this.adapter.log.silly(`check the upload folder for files`);
+        let activeFile = '';
+        try {
+            let metadataOfFiles = await this.adapter.readDirAsync(
+                this.adapter.namespace,
+                this.metafolders.downlink.uploads,
+            );
+            for (const element of Object.values(metadataOfFiles)) {
+                activeFile = element.file;
+                const filepath = `${this.metafolders.downlink.uploads}${element.file}`;
+                let readedFileobject = await this.adapter.readFileAsync(this.adapter.namespace, filepath);
+                const downlinkConfig = JSON.parse(readedFileobject.file);
+                if (Array.isArray(downlinkConfig)) {
+                    for (const config of Object.values(downlinkConfig)) {
+                        if (this.plausibilityOfDownlinkconfigOk(config)) {
+                            this.addDownlinkConfigByType(config, this.activeDownlinkConfigs, { countDeviceType: true });
+                        }
+                    }
+                } else {
+                    if (this.plausibilityOfDownlinkconfigOk(downlinkConfig)) {
+                        this.addDownlinkConfigByType(downlinkConfig, this.activeDownlinkConfigs, {
+                            countDeviceType: true,
+                        });
+                    }
+                }
+                //delete file from uploadfolder
+                this.adapter.delFileAsync(this.adapter.namespace, filepath);
+            }
+        } catch (error) {
+            this.adapter.log.warn(
+                `error in ${activeFunction} at reading ${activeFile} from downlink uploadpath. Error: ${error}`,
+            );
+        }
+    }
+
+    /**
+     * @param downlinkconfig downlinkconfig to check for plausibility
+     */
+    plausibilityOfDownlinkconfigOk(downlinkconfig) {
+        const activeFunction = 'checkPlausibilityOfDownlinkconfig';
+        try {
+            if (downlinkconfig.deviceType && downlinkconfig.downlinkParameter) {
+                this.adapter.log.debug(
+                    `plausibility check for uploaded downlinkconfig of ${downlinkconfig.deviceType} ok.`,
+                );
+                return true;
+            }
+            this.adapter.log.debug(
+                `plausibility check for uploaded downlinkconfig of ${downlinkconfig.deviceType} not ok.`,
+            );
+            return false;
+        } catch (error) {
+            this.adapter.log.warn(`error in ${activeFunction}: ${error}`);
+        }
+    }
+
     /**
      * @param downlinkConfig downlinkconfig to add
      * @param config active downlinkConfig
+     * @param options countDeviceType: the deviceType in case of exists}
      */
-    addDownlinkConfigByType(downlinkConfig, config) {
+    addDownlinkConfigByType(downlinkConfig, config, options = {}) {
         const activeFunction = 'addDownlinkConfigByType';
         try {
+            if (options && options.countDeviceType) {
+                downlinkConfig.deviceType = this.addCountToElementname(config, downlinkConfig.deviceType);
+            }
+
             // Check for device not present
             if (!config[downlinkConfig.deviceType]) {
                 // override standard with userconfig
@@ -143,6 +340,27 @@ class downlinkConfighandlerClass {
         }
     }
 
+    /**
+     * @param objectToCHeck object to check and count the elementname
+     * @param name string of the name to check
+     */
+    addCountToElementname(objectToCHeck, name) {
+        const activeFunction = 'addCountToElementname';
+        try {
+            let count = 0;
+            const zeroDiggits = '00';
+            let countedName = name;
+            while (objectToCHeck[countedName] || count >= 99) {
+                count++;
+                const countPrefix = (zeroDiggits + count.toString()).slice(-zeroDiggits.length);
+                countedName = `${name}_${countPrefix}`;
+            }
+            return countedName;
+        } catch (error) {
+            this.adapter.log.warn(`error in ${activeFunction}: ${error}`);
+        }
+    }
+
     /**
      * @param directory directory of the file with the json array
      */

package/main.js

@@ -25,7 +25,6 @@ class Lorawan extends utils.Adapter {
         // this.on("objectChange", this.onObjectChange.bind(this));
         this.on('message', this.onMessage.bind(this));
         this.on('unload', this.onUnload.bind(this));
-
         this.origin = {
             ttn: 'ttn',
             chirpstack: 'chirpstack',
@@ -68,10 +67,11 @@ class Lorawan extends utils.Adapter {
             this.log.silly(
                 `the active downlinkconfigs are: ${JSON.stringify(this.downlinkConfighandler.activeDownlinkConfigs)}`,
             );
-
+            /*
             setTimeout(async () => {
                 await this.startSimulation();
             }, 5000);
+            */
             /*this.simulation.timeout = setTimeout(async () => {
 				const topic = "application/d63c10b6-9263-4ab3-9299-4308fa19a2ad/device/f1c0ae0e-b4a2-4547-b360-7cfa15e85734/command/down";
 				const message = {devEui:"f1c0ae0e-b4a2-4547-b360-7cfa15e85734",confirmed:false,fPort:1,data:"AAA"};

package/package.json

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