osiota-app-modbus 1.0.7 → 1.0.9

package/README.md

@@ -16,19 +16,19 @@ Please edit schema.json or
 
 This application connects devices via Modbus.
 
-**Additional Properties:** `false`<br/>
+**Additional Properties:** not allowed<br/>
 <br>**Option 1 (alternative):** 
 Modbus Serial Interface
 
 
 **Properties**
 
-|Name|Description|Type|
-|----|-----------|----|
-|`connect_type` (Connection Type)|Enum: `["RTU","C701","RTUBuffered","AsciiSerial"]`<br/>|string|
-|`connect_path`|i.e. device path<br/>|string|
-|[`connect_options`](#option1connect_options) (Serial Connect Options)||object|
-|[`map`](#definitionsmap) (Modbus devices)||object\[\]|
+|Name|Type|Description|Required|
+|----|----|-----------|--------|
+|**connect\_type**<br/>(Connection Type)|`string`|Enum: `"RTU"`, `"C701"`, `"RTUBuffered"`, `"AsciiSerial"`<br/>|yes|
+|**connect\_path**|`string`|i.e. device path<br/>|yes|
+|[**connect\_options**](#option1connect_options)<br/>(Serial Connect Options)|`object`|Additional options for connecting to modbus, i.e. the baud rate settings<br/>|no|
+|[**map**](#option1map)<br/>(Modbus devices)|`object[]`||no|
 
 **Example**
 
@@ -49,12 +49,12 @@ Modbus Network Interface
 
 **Properties**
 
-|Name|Description|Type|
-|----|-----------|----|
-|`connect_type` (Connection Type)|Enum: `["TCP","Telnet"]`<br/>|string|
-|`connect_path` (Host)|i.e. an IP address or host name<br/>|string|
-|[`connect_options`](#option2connect_options) (Network Connect Options)||object|
-|[`map`](#definitionsmap) (Modbus devices)||object\[\]|
+|Name|Type|Description|Required|
+|----|----|-----------|--------|
+|**connect\_type**<br/>(Connection Type)|`string`|Enum: `"TCP"`, `"Telnet"`<br/>|yes|
+|**connect\_path**<br/>(Host)|`string`|i.e. an IP address or host name<br/>|yes|
+|[**connect\_options**](#option2connect_options)<br/>(Network Connect Options)|`object`|Additional options for connecting to modbus, i.e. the port settings<br/>|no|
+|[**map**](#option2map)<br/>(Modbus devices)|`object[]`||no|
 
 **Example**
 
@@ -72,29 +72,33 @@ Modbus Network Interface
 <a name="option1connect_options"></a>
 ### Option 1: connect\_options: Serial Connect Options
 
+Additional options for connecting to modbus, i.e. the baud rate settings
+
+See [SerialPort options](https://serialport.io/docs/api-stream#openoptions)
+
+
 **Properties**
 
-|Name|Description|Type|
-|----|-----------|----|
-|`baudRate` (Baud rate)||number|
+|Name|Type|Description|Required|
+|----|----|-----------|--------|
+|**baudRate**<br/>(Baud rate)|`number`||no|
 
-<a name="definitionsmap"></a>
-### definitions/map: Modbus devices
+<a name="option1map"></a>
+### Option 1: map: Modbus devices
 
-**Items**
+**Items: Modbus device**
 
 **Item Properties**
 
-|Name|Description|Type|
-|----|-----------|----|
-|`node` (Node to map to)||string|
-|`id` (Modbus Client ID)|Minimum: `0`<br/>|number|
-|`address` (Modbus Field Address)|Minimum: `0`<br/>|number|
-|`type` (Modbus Field Type)|Enum: `["input boolean","input register","output boolen","output register"]`<br/>|string|
-|`datatype` (Field Data Type)|Default: `"uint16"`<br/>Enum: `["boolean","uint16"]`<br/>|string|
-|[`metadata`](#definitionsmapmetadata) (Node Metadata)||object|
+|Name|Type|Description|Required|
+|----|----|-----------|--------|
+|**node**<br/>(Node to map to)|`string`||no|
+|**id**<br/>(Modbus Client ID)|`number`|Minimum: `0`<br/>|yes|
+|**address**<br/>(Modbus Field Address)|`number`|Minimum: `0`<br/>|yes|
+|**type**<br/>(Modbus Field Type)|`string`|Enum: `"input boolean"`, `"input register"`, `"output boolen"`, `"output register"`<br/>|no|
+|**datatype**<br/>(Field Data Type)|`string`|Default: `"uint16"`<br/>Enum: `"boolean"`, `"uint16"`<br/>|yes|
+|[**metadata**](#option1mapmetadata)<br/>(Node Metadata)|`object`||no|
 
-**Item Required Properties:** id,address,datatype<br/>
 **Example**
 
 ```json
@@ -112,19 +116,69 @@ Modbus Network Interface
 ]
 ```
 
-<a name="definitionsmapmetadata"></a>
-#### definitions/map\.metadata: Node Metadata
+<a name="option1mapmetadata"></a>
+#### Option 1: map\.metadata: Node Metadata
 
-**Additional Properties:** `true`<br/>
+**Additional Properties:** allowed<br/>
 <a name="option2connect_options"></a>
 ### Option 2: connect\_options: Network Connect Options
 
+Additional options for connecting to modbus, i.e. the port settings
+
+See [Connect options](https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener)
+
+
 **Properties**
 
-|Name|Description|Type|
-|----|-----------|----|
-|`port`||number|
+|Name|Type|Description|Required|
+|----|----|-----------|--------|
+|**port**|`number`|Modbus Port<br/>Default: `502`<br/>|no|
+
+**Example**
+
+```json
+{
+    "port": 502
+}
+```
+
+<a name="option2map"></a>
+### Option 2: map: Modbus devices
+
+**Items: Modbus device**
+
+**Item Properties**
+
+|Name|Type|Description|Required|
+|----|----|-----------|--------|
+|**node**<br/>(Node to map to)|`string`||no|
+|**id**<br/>(Modbus Client ID)|`number`|Minimum: `0`<br/>|yes|
+|**address**<br/>(Modbus Field Address)|`number`|Minimum: `0`<br/>|yes|
+|**type**<br/>(Modbus Field Type)|`string`|Enum: `"input boolean"`, `"input register"`, `"output boolen"`, `"output register"`<br/>|no|
+|**datatype**<br/>(Field Data Type)|`string`|Default: `"uint16"`<br/>Enum: `"boolean"`, `"uint16"`<br/>|yes|
+|[**metadata**](#option2mapmetadata)<br/>(Node Metadata)|`object`||no|
+
+**Example**
+
+```json
+[
+    {
+        "node": "/Lamp Switch",
+        "id": 0,
+        "address": 10,
+        "type": "output boolean",
+        "datatype": "boolean",
+        "metadata": {
+            "power": 60
+        }
+    }
+]
+```
+
+<a name="option2mapmetadata"></a>
+#### Option 2: map\.metadata: Node Metadata
 
+**Additional Properties:** allowed<br/>
 
 ## How to setup
 

package/busscan.js

@@ -15,13 +15,19 @@ var app_config = {
 var m = new modbus.modbus(app_config);
 m.onerror = function(err) {
 	if (err.name === "TransactionTimedOutError") {
+		m.client._port.openFlag = true;
 		return;
 	}
 	console.log("modbus, error:", err.stack || err);
 };
 
 
-m.connect(app_config.connect_type, app_config.connect_path, app_config.connect_options, function() {
+m.connect(app_config.connect_type, app_config.connect_path, app_config.connect_options, function(err) {
+	if (err) {
+		console.error("Error:", err);
+		return;
+	}
+	console.log("Connected");
 	scan();
 });
 

package/busscan_tcp.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+
+var modbus = require("./helper_modbus.js");
+
+
+var app_config = {
+	"connect_type": "Telnet",
+	"connect_path": "192.168.2.111",
+	"connect_options": {
+		"port": 12345
+	},
+	"packet_timeout": 200
+};
+
+var m = new modbus.modbus(app_config);
+m.onerror = function(err) {
+	if (err.name === "TransactionTimedOutError") {
+		m.client._port.openFlag = true;
+		//m.client.openFlag = true;
+		return;
+	}
+	console.log("modbus, error:", err.stack || err);
+};
+
+
+m.connect(app_config.connect_type, app_config.connect_path, app_config.connect_options, function(err) {
+	if (err) {
+		console.error("Error:", err);
+		return;
+	}
+	console.log("Connected");
+	scan();
+});
+
+var cid = 1;
+var scan = function() {
+	if (cid > 255) {
+		m.close();
+		return;
+	}
+
+	m.send_set("writeFC1", cid, 0, 1, function(err) {
+		if (err) {
+			console.log(cid, "No Client");
+		}
+		else {
+			console.log(cid, "Found");
+		}
+		cid++;
+		scan();
+	});
+};

package/helper_modbus.js

@@ -1,10 +1,12 @@
 
 var ModbusRTU = require("modbus-serial");
 
-var read_data = function(client_items, address_min, data) {
+var read_data = function(client_items, address_min, data, buffer) {
 	client_items.forEach(function(c) {
 		c.callback(data.slice(c.address-address_min,
-				c.address-address_min+c.length));
+				c.address-address_min+c.length),
+			buffer.slice(2*(c.address-address_min),
+				2*(c.address-address_min+c.length)));
 	});
 };
 
@@ -28,6 +30,10 @@ exports.modbus = function(config) {
 	this.packet_delay = config.packet_delay;
 	this.circle_delay = config.circle_delay;
 	this.client.setTimeout(config.packet_timeout);
+	this.max_payload = 60;
+	if (typeof config.max_payload === "number") {
+		this.max_payload = config.max_payload;
+	}
 
 	this.commands = {
 		"output boolean": {
@@ -54,7 +60,7 @@ exports.modbus = function(config) {
 	this.set_commands = [];
 
 	this.onerror = function(err) {
-		console.log("modbus, run:", err.stack || err);
+		console.error("modbus, run:", err.stack || err);
 		return false;
 	};
 
@@ -95,12 +101,16 @@ exports.modbus.prototype.client_add = function(type, cid, config) {
 		throw new Error("type undefined: " + type);
 		return;
 	}
+	var gid = config.address - (config.address % this.max_payload);
 	if (typeof this.commands[type].clients[cid] !== "object" ||
-			!Array.isArray(this.commands[type].clients[cid])) {
-		this.commands[type].clients[cid] = [];
+			this.commands[type].clients[cid] === null) {
+		this.commands[type].clients[cid] = {"groups": []};
+	}
+	if (!Array.isArray(this.commands[type].clients[cid].groups[gid])) {
+		this.commands[type].clients[cid].groups[gid] = [];
 	}
 
-	this.commands[type].clients[cid].push(config);
+	this.commands[type].clients[cid].groups[gid].push(config);
 };
 
 exports.modbus.prototype.client_can_set = function(type) {
@@ -146,7 +156,7 @@ exports.modbus.prototype.send_poll = function(command, cid, address, length, cli
 			length,
 		function(err, data) {
 			if (already_called) {
-				console.log("Warn: Called callback twice. Command: POLL", command, cid, address, data, "\nThis happens after a timeout. Please increase the packet timeout.");
+				console.warn("Warn: Called callback twice. Command: POLL", command, cid, address, data, "\nThis happens after a timeout. Please increase the packet timeout.");
 				return;
 			}
 			already_called = true;
@@ -161,11 +171,11 @@ exports.modbus.prototype.send_poll = function(command, cid, address, length, cli
 				if (_this.onerror(err))
 					return;
 			} else {
-				read_data(client_items, address, data.data);
+				read_data(client_items, address, data.data, data.buffer);
 			}
 			callback();
 		}
-       );
+	);
 };
 exports.modbus.prototype.send_set = function(command, cid, address, data, callback) {
 	var _this = this;
@@ -179,7 +189,7 @@ exports.modbus.prototype.send_set = function(command, cid, address, data, callba
 			data,
 		function(err, new_data) {
 			if (already_called) {
-				console.log("Warn: Called callback twice. Command: SET", command, cid, address, data, "\nThis happens after a timeout. Please increase the packet timeout.");
+				console.warn("Warn: Called callback twice. Command: SET", command, cid, address, data, "\nThis happens after a timeout. Please increase the packet timeout.");
 				return;
 			}
 			already_called = true;
@@ -222,11 +232,14 @@ exports.modbus.prototype.connect = function(connect_type, path, options,
 		}
 	});
 
-	for (var type in this.commands) {
-	for (var cid in this.commands[type].clients) {
-		var address_min = null;
-		var address_max = null;
-		this.commands[type].clients[cid].forEach(function(c) {
+	this.poll_commands = [];
+	for (let type in this.commands) {
+	for (let cid in this.commands[type].clients) {
+	for (let gid in this.commands[type].clients[cid].groups) {
+		let address_min = null;
+		let address_max = null;
+		this.commands[type].clients[cid].groups[gid].
+				forEach(function(c) {
 			if (address_min === null || c.address < address_min) {
 				address_min = c.address;
 			}
@@ -238,13 +251,22 @@ exports.modbus.prototype.connect = function(connect_type, path, options,
 		//commands[type].clients[cid].address = address_min;
 		//commands[type].clients[cid].length = address_max-address_min;
 
-		(function(_this, command, cid, address, length, client_items) {
-			_this.poll_commands.push(function(next) {
-				_this.send_poll(command, +cid, address, length, client_items, next);
-			});
-		})(this, this.commands[type].command_poll, cid, address_min,
-				address_max-address_min,
-				this.commands[type].clients[cid]);
+		let command = this.commands[type].command_poll;
+		let address = address_min;
+		let length = address_max-address_min;
+		let client_items = this.commands[type].clients[cid].groups[gid];
+
+		this.poll_commands.push(function(next) {
+			_this.send_poll(
+				command,
+				+cid,
+				address_min,
+				length,
+				client_items,
+				next
+			);
+		});
+	}
 	}
 	}
 

package/index.js

@@ -1,10 +1,25 @@
 
 var modbus = require("./helper_modbus.js");
 
-var map_value = function(datatype, data) {
+var map_value = function(datatype, data, buffer) {
 	if (datatype == "uint16") {
+		//return buffer.readUInt16BE(0);
 		return data[0];
 	}
+	else if (datatype == "floatBE") {
+		return buffer.readFloatBE(0);
+	}
+	else if (datatype == "floatLE") {
+		return buffer.readFloatLE(0);
+	}
+	else if (datatype == "floatBE-swap") {
+		buffer.swap16();
+		return buffer.readFloatBE(0);
+	}
+	else if (datatype == "floatLE-swap") {
+		buffer.swap16();
+		return buffer.readFloatLE(0);
+	}
 	else if (datatype == "boolean") {
 		return data[0] != 0;
 	}
@@ -15,6 +30,30 @@ var remap_value = function(datatype, value) {
 	if (datatype == "uint16") {
 		return [ value*1 ];
 	}
+	if (datatype == "floatBE") {
+		let buffer = Buffer.alloc(4);
+		buffer.writeFloatBE(value);
+		return buffer;
+		//return new Uint16Array(buffer.buffer,buffer.byteOffset,buffer.length/2);
+		//return [ buffer.readUInt16BE(0), buffer.readUInt16BE(2) ];
+	}
+	else if (datatype == "floatLE") {
+		let buffer = Buffer.alloc(4);
+		buffer.writeFloatLE(value);
+		return buffer;
+	}
+	else if (datatype == "floatBE-swap") {
+		let buffer = Buffer.alloc(4);
+		buffer.writeFloatBE(value);
+		buffer.swap16();
+		return buffer;
+	}
+	else if (datatype == "floatLE-swap") {
+		let buffer = Buffer.alloc(4);
+		buffer.writeFloatLE(value);
+		buffer.swap16();
+		return buffer;
+	}
 	else if (datatype == "boolean") {
 		return [ value*1 ];
 	}
@@ -22,11 +61,6 @@ var remap_value = function(datatype, value) {
 };
 
 exports.init = function(node, app_config, main, host_info) {
-
-	var baudrate = 38400;
-
-	var models = {};
-
 	if (typeof app_config !== "object") {
 		app_config = {};
 	}
@@ -41,7 +75,7 @@ exports.init = function(node, app_config, main, host_info) {
 
 	var m = new modbus.modbus(app_config);
 	m.onerror = function(err) {
-		console.log("modbus, error:", err.stack || err);
+		console.error("modbus, error:", err.stack || err);
 
 		if (typeof err.message === "string" &&
 				err.message.match(/^Timed out/))
@@ -52,7 +86,7 @@ exports.init = function(node, app_config, main, host_info) {
 		if (this.close)
 			this.close();
 
-		console.log("modbus, restarting ...");
+		console.info("modbus, restarting ...");
 		_this._reinit_delay(5000);
 		return true;
 	};
@@ -60,13 +94,13 @@ exports.init = function(node, app_config, main, host_info) {
 	var map_itemtype = function(type) {
 		if (typeof type !== "string")
 			return "output boolean";
-		if (type.match(/FC1/i))
+		if (type.match(/^FC(1|5|15)$/i))
 			return "output boolean";
-		if (type.match(/FC2/i))
+		if (type.match(/^FC2$/i))
 			return "input boolean";
-		if (type.match(/FC3/i))
+		if (type.match(/^FC(3|6|16)$/i))
 			return "output register";
-		if (type.match(/FC4/i))
+		if (type.match(/^FC4$/i))
 			return "input register";
 
 		if (type.match(/coil/))
@@ -84,6 +118,10 @@ exports.init = function(node, app_config, main, host_info) {
 		return "output boolean";
 	};
 
+	node.announce({
+		"type": "modbus.app"
+	});
+
 	var map = node.map(app_config.map, null, true, null,
 		function(n,metadata,config) {
 		var command = map_itemtype(config.type);
@@ -92,7 +130,11 @@ exports.init = function(node, app_config, main, host_info) {
 		var length = config.length;
 		if (typeof length !== "number") {
 			var tmp = remap_value(config.datatype, 0);
-			length = tmp.length;
+			if (Buffer.isBuffer(tmp)) {
+				length = tmp.length / 2;
+			} else {
+				length = tmp.length;
+			}
 		}
 
 		var type = "number";
@@ -104,8 +146,8 @@ exports.init = function(node, app_config, main, host_info) {
 			m.client_add(command, cid, {
 				"address": config.address || 0,
 				"length": length || 1,
-				"callback": function(data) {
-					var value = map_value(config.datatype, data);
+				"callback": function(data, buffer) {
+					var value = map_value(config.datatype, data, buffer);
 					// better name: reset
 					if (config.erase && value) {
 						// uninitialized?
@@ -141,6 +183,9 @@ exports.init = function(node, app_config, main, host_info) {
 					}
 				});
 			};
+			n.rpc_toggle = function(reply, time) {
+				return n.rpc_set(reply, !n.value, time);
+			};
 			n.rpc_publish = function(reply, time, value) {
 				return n.rpc_set(reply, value, time);
 			};
@@ -163,7 +208,8 @@ exports.init = function(node, app_config, main, host_info) {
 	});
 
 	// open connection to a port
-	m.connect(app_config.connect_type, app_config.connect_path, app_config.connect_options);
+	m.connect(app_config.connect_type, app_config.connect_path,
+		JSON.parse(JSON.stringify(app_config.connect_options || {})));
 
-	return [map, m];
+	return [node, map, m];
 };

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "osiota-app-modbus",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "This application connects devices via Modbus",
   "main": "index.js",
   "dependencies": {
-    "modbus-serial": "^7.7.2",
-    "serialport": "^7.1.5"
+    "modbus-serial": "^8.0.23",
+    "serialport": "^13.0.0"
   },
   "devDependencies": {
-    "osiota-dev": "^1.1.6"
+    "osiota-dev": "^1.x"
   },
   "author": "Simon Walz and others",
   "license": "MIT",

package/schema.json

@@ -1,6 +1,6 @@
 {
 	"type": "object",
-	"title": "osiota application modbus",
+	"title": "osiota Application Modbus",
 	"description": "This application connects devices via Modbus.",
 	"oneOf": [{
 		"description": "Modbus Serial Interface",
@@ -17,18 +17,24 @@
 			},
 			"connect_options": {
 				"title": "Serial Connect Options",
+				"description": "Additional options for connecting to modbus, i.e. the baud rate settings\n\nSee [SerialPort options](https://serialport.io/docs/api-stream#openoptions)",
 				"type": "object",
 				"properties": {
 					"baudRate": {
 						"title": "Baud rate",
 						"type": "number"
 					}
-				}
+				},
+				"required": []
 			},
 			"map": {
 				"$ref": "#/definitions/map"
 			}
 		},
+		"required": [
+			"connect_type",
+			"connect_path"
+		],
 		"examples": [{
 			"connect_type": "RTUBuffered",
 			"connect_path": "/dev/ttyUSB0",
@@ -51,18 +57,26 @@
 			},
 			"connect_options": {
 				"title": "Network Connect Options",
+				"description": "Additional options for connecting to modbus, i.e. the port settings\n\nSee [Connect options](https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener)",
 				"type": "object",
 				"properties": {
 					"port": {
 						"title": "Port",
+						"description": "Modbus Port",
+						"default": 502,
 						"type": "number"
 					}
-				}
+				},
+				"required": []
 			},
 			"map": {
 				"$ref": "#/definitions/map"
 			}
 		},
+		"required": [
+			"connect_type",
+			"connect_path"
+		],
 		"examples": [{
 			"connect_type": "Telnet",
 			"connect_path": "192.168.1.101",
@@ -79,6 +93,7 @@
 			"title": "Modbus devices",
 			"items": {
 				"type": "object",
+				"title": "Modbus device",
 				"properties": {
 					"node": {
 						"title": "Node to map to",
@@ -97,7 +112,7 @@
 					"type": {
 						"title": "Modbus Field Type",
 						"type": "string",
-						"enum": [ "input boolean", "input register", "output boolen", "output register" ]
+						"enum": [ "input boolean", "input register", "output boolean", "output register" ]
 					},
 					"datatype": {
 						"title": "Field Data Type",
@@ -121,6 +136,7 @@
 						"power": 60
 					}
 				}],
+				"additionalProperties": false,
 				"required": [ "id", "address", "datatype" ]
 			}
 		}