iobroker.lorawan 0.0.2

package/lib/modules/directorieshandler.js

@@ -0,0 +1,312 @@
+class messagehandlerClass {
+	constructor(adapter) {
+		this.adapter = adapter;
+
+		// used dataentries in directory structurt
+		this.elementDeclaration = {
+			objectStateName: "objectStateName",
+			objectCommonName: "objectCommonName",
+			moreDirectories: "moreDirectories"
+		};
+
+		this.searchableAttributeNames = {
+			apllicationId: "applicationId",
+			deviceUid: "devEui",
+			deviceId: "deviceId"
+		};
+
+		this.safeableDirectories = {
+			uplinkDecoded: "uplinkDecoded",
+			uplinkRaw: "uplinkRaw",
+			uplinkRemaining: "uplinkRemaining",
+			downlinkRaw: "downlinkRaw",
+			downlinkConfiguration: "downlinkConfiguration",
+			downlinkControl: "downlinkControl",
+			downlinkRemaining: "downlinkRemaining"
+		};
+
+		this.reachableDirectories = {};
+
+		this.units = {
+			"pressure": "mBar",
+			"battery": "V",
+			"battery_level": "%",
+			"humidity": "%",
+			"Batterie": "V",
+			"Temperatur": "°C",
+			"airhumidity": "%",
+			"volt": "V",
+			"temperatur" : "°C",
+			"airtemperature" : "°C"
+		};
+
+		// declare the directory structre
+		this.directories = {
+			application:{
+				objectStateName : (message) =>{
+					return this.getAttributValue(message,this.searchableAttributeNames.apllicationId);
+				},
+				objectCommonName: "application",
+				devices:{
+					deviceUid:{
+						objectStateName : (message) =>{
+							return this.getAttributValue(message,this.searchableAttributeNames.deviceUid);
+						},
+						objectCommonName: "device UID",
+						deviceId:{
+							objectStateName : (message) =>{
+								return this.getAttributValue(message,this.searchableAttributeNames.deviceId);
+							},
+							objectCommonName: "device ID",
+							objectType:"channel",
+							uplink:{
+								raw:{
+									safeDirectory: this.safeableDirectories.uplinkRaw
+								},
+								decoded:{
+									safeDirectory: this.safeableDirectories.uplinkDecoded
+								},
+								remaining:{
+									safeDirectory: this.safeableDirectories.uplinkRemaining
+								}
+							},
+							downlink:{
+								raw:{
+									safeDirectory: this.safeableDirectories.downlinkRaw
+								},
+								control:{
+									safeDirectory: this.safeableDirectories.downlinkControl,
+									push: {
+										isState: true,
+										stateVal: {
+											downlinks: [{
+												f_port: 128,
+												frm_payload: "Pw==",
+												priority: "NORMAL"
+											}]
+										},
+										stateCommonType: "json",
+										subscribe: true,
+										stateCommonWrite: true
+									},
+									replace: {
+										isState: true,
+										stateVal: {
+											downlinks: [{
+												f_port: 128,
+												frm_payload: "Pw==",
+												priority: "NORMAL"
+											}]
+										},
+										stateCommonType: "json",
+										subscribe: true,
+										stateCommonWrite: true
+									}
+								},
+								configuration:{
+									safeDirectory: this.safeableDirectories.downlinkConfiguration,
+									refreshRate:{
+										isState: true,
+										stateVal: 2,
+										stateCommonType: "number",
+										stateFactor: 60,
+										stateCommonWrite: true,
+									}
+								},
+								remaining:{
+									safeDirectory: this.safeableDirectories.downlinkRemaining
+								}
+							},
+						},
+					}
+				}
+			}
+		};
+		this.ignoredElementNames ={
+			objectStateName: "objectStateName",
+			objectCommonName: "objectCommonName",
+			objectType: "objectType",
+			stateVal: "stateVal",
+			stateFactor: "stateFactor",
+			stateCommonType: "stateCommonType",
+			stateCommonWrite: "stateCommonWrite",
+			stateCommonUnit: "stateCommonUnit",
+			isState: "isState",
+			safeDirectory: "safeDirectory",
+			subscribe: "subscribe"
+		};
+	}
+
+	/*********************************************************************
+	 * ************************ Objectstring *****************************
+	 * ******************************************************************/
+
+	async generateRekursivObjects(obj,startDirectory,message,options = undefined){
+		// just proceed with ojects
+		if(typeof obj === "object"){
+			// go to every element in the object
+			for(const elementName in obj){
+				// Check the the elementname is not in ignored object
+				// @ts-ignore
+				if(!this.ignoredElementNames[elementName] && !options?.ignoredElementNames[elementName]){
+					// Check if the element is an object
+					if(typeof obj[elementName] === "object" && !obj[elementName].isState){
+						// if there is an declared ObjectStateName (must be a function)=> take it
+						let objectId = `${startDirectory}.${elementName}`;
+						let internalObjectId = elementName;
+						if(obj[elementName][this.elementDeclaration.objectStateName]){
+							internalObjectId = `${obj[elementName][this.elementDeclaration.objectStateName](message)}`;
+							objectId = `${startDirectory}.${internalObjectId}`;
+						}
+						if(objectId.indexOf(".") === 0){
+							objectId = objectId.substring(1,objectId.length);
+						}
+						if(obj[elementName].safeDirectory){
+							if(!this.reachableDirectories){
+								this.reachableDirectories = {};
+							}
+							if(!this.reachableDirectories[this.getObjectDirectory(message,this.searchableAttributeNames.deviceId)]){
+								this.reachableDirectories[this.getObjectDirectory(message,this.searchableAttributeNames.deviceId)] = {};
+							}
+							this.reachableDirectories[this.getObjectDirectory(message,this.searchableAttributeNames.deviceId)][obj[elementName].safeDirectory] = objectId;
+						}
+						await this.adapter.setObjectNotExistsAsync(objectId,{
+							// @ts-ignore
+							type: obj[elementName][this.elementDeclaration.objectType]? obj[elementName][this.elementDeclaration.objectType] : "folder",
+							common: {
+								name: obj[elementName][this.elementDeclaration.objectCommonName]? obj[elementName][this.elementDeclaration.objectCommonName] : ""
+							},
+							native : {},
+						});
+						await this.generateRekursivObjects(obj[elementName],objectId,message);
+					}
+					else{
+						let stateCommonType = typeof obj[elementName];
+						let stateCommonName = "";
+						let stateCommonWrite = false;
+						let stateVal = obj[elementName];
+						if(obj[elementName].isState){
+							stateVal = obj[elementName].stateVal? obj[elementName].stateVal : undefined;
+							stateCommonType = obj[elementName].stateCommonType? obj[elementName].stateCommonType : typeof stateVal;
+							stateCommonName = obj[elementName].stateCommonName ? obj[elementName].stateCommonName : stateCommonName;
+							stateCommonWrite = obj[elementName].stateCommonWrite ? obj[elementName].stateCommonWrite : stateCommonWrite;
+						}
+						let objectId = `${startDirectory}.${elementName}`;
+						let internalObjectId = elementName;
+						if(obj[elementName][this.elementDeclaration.objectStateName]){
+							internalObjectId = `${obj[elementName][this.elementDeclaration.objectStateName](message)}`;
+							objectId = `${startDirectory}.${internalObjectId}`;
+						}
+						if(objectId.indexOf(".") === 0){
+							objectId.substring(1,objectId.length);
+						}
+						await this.adapter.setObjectNotExistsAsync(objectId,{
+							type: "state",
+							common: {
+								type: stateCommonType,
+								name: stateCommonName,
+								role: "value",
+								read: true,
+								unit: obj[elementName].CommonStateUnit? obj[elementName].CommonStateUnit : this.units[internalObjectId]? this.units[internalObjectId] : "",
+								write: stateCommonWrite
+							},
+							native: {},
+						});
+						if(typeof stateVal === "object"){
+							stateVal = JSON.stringify(stateVal);
+						}
+						await this.adapter.setStateAsync(`${objectId}`,stateVal,true);
+						if(obj[elementName].subscribe){
+							this.adapter.subscribeStatesAsync(objectId);
+						}
+					}
+				}
+			}
+		}
+	}
+
+	/*********************************************************************
+	 * ************************ Objectstring *****************************
+	 * ******************************************************************/
+
+	attributPresentInMessage(message,resolvetype){
+		// Select search in case of origin
+		if(this.adapter.config.ttn){
+			return this.attributPresentInTtnMessage(message,resolvetype);
+		}
+		else if(this.adapter.config.chirpstack){
+			//	 this.handleChirpstack(topic,message);
+		}
+	}
+
+	attributPresentInTtnMessage(message,resolvetype){
+		switch(resolvetype){
+			case this.searchableAttributeNames.apllicationId:
+				return message.end_device_ids.application_ids.application_id? true: false;
+
+			case this.searchableAttributeNames.deviceUid:
+				return message.end_device_ids.dev_eui? true: false;
+
+			case this.searchableAttributeNames.deviceId:
+				return message.end_device_ids.device_id? true: false;
+
+			default:
+				this.adapter.log.warn(`No attribute with the name ${resolvetype} found.`);
+				return "";
+		}
+	}
+
+	getAttributValue(message,resolvetype){
+		// Select search in case of origin
+		if(this.adapter.config.ttn){
+			return this.getTtnAttributValue(message,resolvetype);
+		}
+		else if(this.adapter.config.chirpstack){
+			//	 this.handleChirpstack(topic,message);
+		}
+	}
+
+	getTtnAttributValue(message,resolvetype){
+		switch(resolvetype){
+			case this.searchableAttributeNames.apllicationId:
+				return message.end_device_ids.application_ids.application_id;
+
+			case this.searchableAttributeNames.deviceUid:
+				return message.end_device_ids.dev_eui;
+
+			case this.searchableAttributeNames.deviceId:
+				return message.end_device_ids.device_id;
+
+			default:
+				this.adapter.log.warn(`No attribute with the name ${resolvetype} found.`);
+				return "";
+		}
+	}
+
+	getObjectDirectory(message,resolvetype){
+		// Select search in case of origin
+		if(this.adapter.config.ttn){
+			return this.getTtnObjectDirectory(message,resolvetype);
+		}
+		else if(this.adapter.config.chirpstack){
+			//	 this.handleChirpstack(topic,message);
+		}
+	}
+
+	getTtnObjectDirectory(message,resolvetype){
+		if(typeof message !== "string"){
+			switch(resolvetype){
+				case this.searchableAttributeNames.deviceId:
+					return `${message.end_device_ids.application_ids.application_id}.${message.end_device_ids.dev_eui}.${message.end_device_ids.device_id}`;
+
+				default:
+					return message;
+			}
+		}
+		else{
+			return message;
+		}
+	}
+}
+
+module.exports = messagehandlerClass;

package/lib/modules/messagehandler.js

@@ -0,0 +1,291 @@
+
+const directorieshandlerClass = require("./directorieshandler");
+
+class messagehandlerClass {
+	constructor(adapter) {
+		this.adapter = adapter;
+		this.directoryhandler = new directorieshandlerClass(this.adapter);
+	}
+
+	async handleMessage(topic,message){
+		// Select datahandling in case of origin
+		if(this.adapter.config.ttn){
+			await this.handleTtnMessage(topic,message);
+		}
+		else if(this.adapter.config.chirpstack){
+			//	await this.handleChirpstackMessage(topic,message);
+		}
+	}
+
+	async handleTtnMessage(topic,message){
+
+		// generate startdorectory of device
+		const deviceStartdirectory = this.directoryhandler.getTtnObjectDirectory(message,this.directoryhandler.searchableAttributeNames.deviceId);
+		/*********************************************************************
+		 * ************************ Main directories *************************
+		 * ******************************************************************/
+		/*	if(message.end_device_ids.device_id !== "eui-lobaro-modbus"){
+			return;
+		}*/
+		try{
+			await this.directoryhandler.generateRekursivObjects(this.directoryhandler.directories,"",message);
+			/*********************************************************************
+			 * ************************* Infodata ********************************
+			 * ******************************************************************/
+			/*
+			if(message[this.ttn.dataEntries.uplink_message]){
+				if(message[this.ttn.dataEntries.uplink_message][this.ttn.dataEntries.f_port] === this.ttn.writeableData.firmware.port){
+					const stringdata = Buffer.from(message[this.ttn.dataEntries.uplink_message][this.ttn.dataEntries.frm_payload], "base64").toString();
+					await this.adapter.setStateAsync(`${stateId}.${this.ttn.writeableData.firmware.name}`,stringdata,true);
+				}
+			}
+			else if(message[this.ttn.dataEntries.downlink_queued]){
+				if(message[this.ttn.dataEntries.downlink_queued][this.ttn.dataEntries.f_port] === this.ttn.writeableData.firmware.port){
+					await this.adapter.setStateAsync(`${stateId}.${this.ttn.writeableData.firmware.name}`,this.ttn.writeableData.firmware.downlink_queued,true);
+				}
+			}
+			else if(message[this.ttn.dataEntries.downlink_sent]){
+				if(message[this.ttn.dataEntries.downlink_sent][this.ttn.dataEntries.f_port] === this.ttn.writeableData.firmware.port){
+					await this.adapter.setStateAsync(`${stateId}.${this.ttn.writeableData.firmware.name}`,this.ttn.writeableData.firmware.downlink_sent,true);
+				}
+			}
+			*/
+			/*********************************************************************
+			 * ********************** Uplink data ********************************
+			 * ******************************************************************/
+
+			// check for uplink message
+			if(message.uplink_message){
+
+				/*********************************************************************
+				 * ************************ Rawdata json *****************************
+				 * ******************************************************************/
+
+				if(this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.uplinkRaw]){
+					const startDirectory = this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.uplinkRaw];
+					// write json
+					await this.adapter.setObjectNotExistsAsync(`${startDirectory}.json`,{
+						type: "state",
+						common: {
+							name: "last recieved message",
+							type: "json",
+							role: "value",
+							read: true,
+							write: false
+						},
+						native: {},
+					});
+					await this.adapter.setStateAsync(`${startDirectory}.json`,JSON.stringify(message),true);
+
+					/*********************************************************************
+				 	* ********************** Rawdata (Base64) ***************************
+				 	* ******************************************************************/
+
+					// check for frm payload
+					if(message.uplink_message.frm_payload){
+						// wite base64 data
+						await this.adapter.setObjectNotExistsAsync(`${startDirectory}.base64`,{
+							type: "state",
+							common: {
+								name: "last recieved data as base64",
+								type: "string",
+								role: "value",
+								read: true,
+								write: false
+							},
+							native: {},
+						});
+						const writedata = message.uplink_message.frm_payload;
+						await this.adapter.setStateAsync(`${startDirectory}.base64`,writedata,true);
+
+						// write base64 data in hex data
+						await this.adapter.setObjectNotExistsAsync(`${startDirectory}.hex`,{
+							type: "state",
+							common: {
+								name: "last recieved data as hex",
+								type: "string",
+								role: "value",
+								read: true,
+								write: false
+							},
+							native: {},
+						});
+						const hexdata = Buffer.from(message.uplink_message.frm_payload, "base64").toString("hex");
+						await this.adapter.setStateAsync(`${startDirectory}.hex`,hexdata,true);
+
+						// write base64 data in string data
+						await this.adapter.setObjectNotExistsAsync(`${startDirectory}.string`,{
+							type: "state",
+							common: {
+								name: "last recieved data as string",
+								type: "string",
+								role: "value",
+								read: true,
+								write: false
+							},
+							native: {},
+						});
+						const stringdata = Buffer.from(message.uplink_message.frm_payload, "base64").toString();
+						await this.adapter.setStateAsync(`${startDirectory}.string`,stringdata,true);
+					}
+				}
+
+				/*********************************************************************
+				 * ********************** decoded payload ****************************
+				 * ******************************************************************/
+
+				if(this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.uplinkDecoded]){
+					const startDirectory = this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.uplinkDecoded];
+					await this.directoryhandler.generateRekursivObjects(message.uplink_message.decoded_payload,startDirectory,message);
+				}
+
+				/*********************************************************************
+				 * ************************* remaining *******************************
+				 * ******************************************************************/
+
+				if(this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.uplinkRemaining]){
+					const startDirectory = this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.uplinkRemaining];
+					// @ts-ignore
+					await this.directoryhandler.generateRekursivObjects(message.uplink_message,startDirectory,message,{ignoredElementNames:{decoded_payload:{},frm_payload:{}}});
+				}
+			}
+
+			/*********************************************************************
+			 * ************************* Downlink data ***************************
+			 * ******************************************************************/
+
+			// check for uplink message
+			if(message.downlink_queued || message.downlink_sent){
+				// Check wich downlink was recieved
+				let downlinkType = "downlink_queued";
+				if(message.downlink_sent){
+					downlinkType = "downlink_sent";
+				}
+				/*********************************************************************
+				 * ************************ Rawdata json *****************************
+				 * ******************************************************************/
+
+				if(this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.downlinkRaw]){
+					const startDirectory = this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.downlinkRaw];
+					// write json
+					await this.adapter.setObjectNotExistsAsync(`${startDirectory}.json`,{
+						type: "state",
+						common: {
+							name: "last recieved message",
+							type: "json",
+							role: "value",
+							read: true,
+							write: false
+						},
+						native: {},
+					});
+					await this.adapter.setStateAsync(`${startDirectory}.json`,JSON.stringify(message),true);
+
+					/*********************************************************************
+				 	* ********************** Rawdata (Base64) ***************************
+				 	* ******************************************************************/
+
+					// check for frm payload
+					if(message[downlinkType].frm_payload){
+						// wite base64 data
+						await this.adapter.setObjectNotExistsAsync(`${startDirectory}.base64`,{
+							type: "state",
+							common: {
+								name: "last recieved data as base64",
+								type: "string",
+								role: "value",
+								read: true,
+								write: false
+							},
+							native: {},
+						});
+						const writedata = message[downlinkType].frm_payload;
+						await this.adapter.setStateAsync(`${startDirectory}.base64`,writedata,true);
+
+						// write base64 data in hex data
+						await this.adapter.setObjectNotExistsAsync(`${startDirectory}.hex`,{
+							type: "state",
+							common: {
+								name: "last recieved data as hex",
+								type: "string",
+								role: "value",
+								read: true,
+								write: false
+							},
+							native: {},
+						});
+						const hexdata = Buffer.from(message[downlinkType].frm_payload,"base64").toString("hex");
+						await this.adapter.setStateAsync(`${startDirectory}.hex`,hexdata,true);
+
+						// write base64 data in string data
+						await this.adapter.setObjectNotExistsAsync(`${startDirectory}.string`,{
+							type: "state",
+							common: {
+								name: "last recieved data as string",
+								type: "string",
+								role: "value",
+								read: true,
+								write: false
+							},
+							native: {},
+						});
+						const stringdata = Buffer.from(message[downlinkType].frm_payload,"base64").toString();
+						await this.adapter.setStateAsync(`${startDirectory}.string`,stringdata,true);
+					}
+				}
+
+				/*********************************************************************
+				 * ************************* remaining *******************************
+				 * ******************************************************************/
+
+				if(this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.downlinkRemaining]){
+					const startDirectory = this.directoryhandler.reachableDirectories[deviceStartdirectory][this.directoryhandler.safeableDirectories.downlinkRemaining];
+					// @ts-ignore
+					await this.directoryhandler.generateRekursivObjects(message[downlinkType],startDirectory,message,{ignoredElementNames:{frm_payload:{}}});
+				}
+			}
+		}
+		catch(error){
+			this.adapter.log.warn("check: " + error);
+			this.adapter.log.warn("Message: " + JSON.stringify(message));
+		}
+	}
+
+
+	/*********************************************************************
+	 * *********************** Downlinktopic *****************************
+	 * ******************************************************************/
+
+	getDownlinkTopic(id,suffix){
+		// Select datahandling in case of origin
+		if(this.adapter.config.ttn){
+			return this.getTtnDownlinkTopicFromDirektory(id,suffix);
+		}
+		else if(this.adapter.config.chirpstack){
+			//	 this.handleChirpstack(topic,message);
+		}
+	}
+
+	getTtnDownlinkTopicFromDirektory(changeInfo,suffix){
+		const topicElements = {
+			Version : "v3",
+			applicationId : `/${changeInfo.applicationId}`,
+			applicationFrom : "@ttn",
+			devices : `/devices`,
+			dev_uid : `/${changeInfo.dev_uid}`,
+			suffix : suffix
+		};
+		let downlink = "";
+		for(const stringelement of Object.values(topicElements)){
+			downlink += stringelement;
+		}
+		return downlink;
+	}
+
+	/*****************************************************************************************************************
+	 * ***************************************************************************************************************
+	 * **************************************************************************************************************/
+
+}
+
+module.exports = messagehandlerClass;

package/lib/modules/mqttclient.js

@@ -0,0 +1,52 @@
+const mqtt = require("mqtt");
+
+class mqttClientClass {
+	constructor(adapter, settings) {
+		this.adapter = adapter;
+		this.mqttprefix = settings.ssl ? "mqtts://" : "mqtt://";
+		this.client = mqtt.connect(`${this.mqttprefix}${settings.ipUrl}`, {
+			port: settings.port,
+			username: settings.username,
+			password: settings.password,
+			clientId: `iobroker_${this.adapter.namespace}`,
+		});
+		this.client.on("connect", () => {
+			this.adapter.log.info(`Connection is active.`);
+			this.adapter.setState("info.connection", true, true);
+			this.client.subscribe("#", (err) => {
+				if (err) {
+					this.adapter.log.error(`On subscribe: ${err}`);
+				}
+			});
+		});
+		this.client.on("disconnect", () => {
+			this.adapter.setState("info.connection", false, true);
+			this.adapter.log.debug(`disconnected`);
+		});
+		this.client.on("error", (err) => {
+			this.adapter.log.error(`${err}`);
+		});
+
+		this.client.on("close", () => {
+			this.adapter.setState("info.connection", false, true);
+			this.adapter.log.info(`Connection is closed.`);
+		});
+
+		this.client.on("message", async (topic, message) => {
+			// @ts-ignore
+			message = JSON.parse(message);
+
+			await this.adapter.messagehandler.handleMessage(topic, message);
+		});
+	}
+	async publish(topic, message, opt) {
+		this.adapter.log.debug(`Publishing topic: ${topic} with message: ${message}.`);
+		await this.client.publishAsync(topic, message, opt);
+	}
+
+	destroy(){
+		this.client.end();
+	}
+}
+
+module.exports = mqttClientClass;