Merge branch 'master' of https://github.com/Batrium/WatchMonUdpListener

Conflicts:
	config.json_dist

Author: daromer2

.gitignore

@@ -1,4 +1,4 @@
-batrium_config.json
+config.json
 
 # Logs
 logs

README.md

@@ -7,9 +7,13 @@ WatchMon UDP Binary Listener translates to JSON and stores to influxdb or sends
 git clone https://github.com/Batrium/WatchMonUdpListener
 ```
 or
+```
+npm install watchmonudplistener
+```
+or
 
 Download premade Raspberry PI 3 ISO with everything built in:
-<--link-->
+http://diytechandrepairs.nu/raspberry-solar/
 
 
 ### Prerequisites
@@ -18,7 +22,7 @@ MQTT
 Binary-Parser
 Influx
 
-How to install them:
+How to install them: (If you clone from GitHub)
 ```
 npm install mqtt
 npm install binary-parser
@@ -27,11 +31,13 @@ npm install influx
 
 ### Installing
 
+Main install in "Get started"
+
 Start with copying the batrium_config.json_dist to batrium_config.json
 
 Example code in linux: 
 ```
-cp batrium_config.json_dist batrium_config.json
+cp config.json_dist config.json
 ```
 
 Edit the file to suit your needs. 
@@ -81,12 +87,32 @@ When all this is done its just a matter of running the application
 
 ## Automatic startup
 
-<- information about automatic start need to be added here and files added. 
+```
+cp systemctl/batrium.service /etc/systemd/system/
+```
+Be sure to update paths in the file acordingly to where you installed the Batrium UDP listener
 
+```
+systemctl --system daemon-reload
+```
 
+To enable:
+```
+systemctl enable batrium.service
+```
+To disable
+```
+systemctl disable batrium.service
+```
 ## Contributing
 
-For contributing to this project you can either add it up as an issue here on Github or to this page on the DIYPowerwalls forum:
+For contributing to this project you can support Batrium by getting HW from them. 
+Supporting the creator of this script by Patreon/Paypal/Subscribing to youtube channel.
+Patreon: https://www.patreon.com/diytech
+Youtube: https://www.youtube.com/user/daromeresperyd
+Webpage with more ways to contribute: http://diytechandrepairs.nu/
+And the most important is to report any issues/bugs or features that you want to see sorted or fixed. 
+All added contributions are much appreciated!
 
 
 ## Authors
@@ -95,7 +121,7 @@ For contributing to this project you can either add it up as an issue here on Gi
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details
 
 ## Acknowledgments
 

batrium_config.json_dist config.json_distbatrium_config.json_dist renamed to config.json_dist

@@ -6,45 +6,39 @@
 		"influxhost" : "localhost",
 		"influxdatabase" : "batrium"
 	},
-	"3e5a" : {
+	"3e" : {
 		"mqtt" : true,
 		"influx" : true,
 		"tag" : "general",
 		"serie" : "generic"
 	},
-	"3e32" : {
-		"mqtt" : true,
-		"influx" : true,
-		"tag" : "general",
-		"serie" : "generic"
-	},
-	"3f33" : {
-		"mqtt" : true,
-		"influx" : true,
-		"tag" : "general",
-		"serie" : "generic"
-	},
-	"7857" : {
+	"78" : {
 		"mqtt" : false,
 		"influx" : false, 
 		"info" : "Dont use influx on message 7857",
 		"tag" : "general",
 		"serie" : "generic"
 	},
-	"5732" : {
+	"57" : {
 		"mqtt" : false,
 		"influx" : false,
 		"tag" : "general",
 		"serie" : "generic"
 	},
-	"4232" : {
+	"42" : {
 		"mqtt" : false,
-		"influx" : true,
+		"influx" : false,
 		"tag" : "general",
 		"serie" : "nodes",
 		"tagID" : "ID"
 	},
-	"415a" : {
+	"54" : {
+		"mqtt" : false,
+		"influx" : true,
+		"tag" : "general",
+		"serie" : "daily"
+	},
+	"41" : {
 		"mqtt" : true,
 		"influx" : false,
 		"tag" : "general",

docs/WatchMon Wifi UDP protocol sw1.0.30 v1.0.pdf

@@ -4,7 +4,7 @@
 // http://diytechandrepairs.nu
 // https://www.youtube.com/user/daromeresperyd
 //
-//
+// MIT Licensed
 // creating a udp server
 var udp = require('dgram');
 var mqtt = require('mqtt')
@@ -18,10 +18,10 @@ var fs = require('fs');
 
 //Loading configuration file. 
 try {
-	var config = JSON.parse(fs.readFileSync('batrium_config.json', "utf8"));
+	var config = JSON.parse(fs.readFileSync('config.json', "utf8"));
 }
 catch (e) {
-	errorText('Could not load configuration file. Will therefore not send any data out. file missing is batrium_config.json. Perhaps copy the dist file?'); 
+	errorText('Could not load configuration file. Will therefore not send any data out. file missing is config.json. Perhaps copy the dist file?'); 
 	console.log(e);
 	var config = {'all':{'mqtt':{},'influx':{}}, 'hej': {}};
 }
@@ -90,7 +90,7 @@ function sendInflux(data, tag) {
 	tg = { systemId: data.SystemId, messageId: data.MessageId, messageType: (config[data.MessageId] && config[data.MessageId].tag  ) ? config[data.MessageId].tag: 'generic' };
 	// IF its node based we need to add the node-tag to it as well
 	(config[data.MessageId] && config[data.MessageId].tagID  ) ? tg['nodeID'] =  data[config[data.MessageId].tagID]  : '';
-		
+	
 	influx.writeMeasurement((config[data.MessageId] && config[data.MessageId].serie  ) ? config[data.MessageId].serie: 'generic', [
   	{
 	  tags: tg,
@@ -154,13 +154,17 @@ var tag;
 // Parse new messages incomming from Batrium 
 server.on('message',function(msg,info){
 	payload = getPayload(msg);
-	process.stdout.write("\x1b[34mData recieved from\x1b[0m " + payload.SystemId  + " \x1b[34mand message is:\x1b[0m " + payload.MessageId + " \r");
-
+	//process.stdout.write("\x1b[34mData recieved from\x1b[0m " + payload.SystemId  + " \x1b[34mand message is:\x1b[0m " + payload.MessageId + " \r");
+	messageID = payload.MessageId.substring(0,2);	// uggly but it just brings out the message id and removes the versiion
 	if(payload.MessageId in messages) {
 		// If error in message lets try/catch it so we dont rage quit
 		try {
 			obj = Object.assign(payload, eval(messages[payload.MessageId])(msg)); 
 			if (debug) console.log(obj);	
+			// check if the message id is present in the config. This dont care what version is there if file exist
+			if (config[messageID] && config[messageID].mqtt || config.all.mqtt) sendMqtt(payload.SystemId,payload.MessageId,obj);
+			if (config[messageID] && config[messageID].influx || config.all.influx) sendInflux(obj, tag);
+		 	// Below is used if you use messageid and version in the configuration file	
 			if (config[payload.MessageId] && config[payload.MessageId].mqtt || config.all.mqtt) sendMqtt(payload.SystemId,payload.MessageId,obj);
 			if (config[payload.MessageId] && config[payload.MessageId].influx || config.all.influx) sendInflux(obj, tag);
 		} catch (e) {

batrium.js index.jsbatrium.js renamed to index.js

@@ -0,0 +1,32 @@
+{
+  "name": "watchmonudplistener",
+  "version": "1.0.1",
+  "description": "UDP listener for the Batrium Watchmon BMS system",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+
+  "keywords": [
+    "solar",
+    "inverter",
+    "bms",
+    "batrium",
+    "watchmon"
+  ],
+  "author": "Batrium",
+  "contributors": 
+    { "name" : "Daniel Römer"
+    , "email" : "[email protected]"
+    , "url" : "http://diytechandrepairs.nu/"
+    },
+  "bugs": 
+    { "url" : "https://github.com/Batrium/WatchMonUdpListener/issues"
+    },
+  "license": "MIT",
+  "dependencies": {
+    "mqtt": "latest",
+    "binary-parser": "latest",
+    "influx": "latest"
+  }
+}

package.json

@@ -0,0 +1,50 @@
+module.exports = function() 
+{ 
+	var Parser = require('binary-parser').Parser;
+
+	// Category    = Aggregated telemetry
+	// Object      = Rapid
+	// Description = Combined status - Rapid
+	// MsgLength   = 50
+	// Version     = 2
+	// Frequency   = 300 mS
+	// Support     = Current
+	// Valid from  = SW 1.0.30
+	this.parse_3e32 = function(msg) 
+	{
+		var status = new Parser()
+		.skip(8)
+		.int16le('MinCellVolt',		{ formatter: (x) => {return x/1000;}})
+		.int16le('MaxCellVolt',		{ formatter: (x) => {return x/1000;}})
+		.uint8('MinCellVoltId')
+		.uint8('MaxCellVoltId')
+		.uint8('MinCellTemp',		{ formatter: (x) => {return x-40;}}) // temperature ºC
+		.uint8('MaxCellTemp',		{ formatter: (x) => {return x-40;}}) // temperature ºC
+		.uint8('MinCellTempId')
+		.uint8('MaxCellTempId')
+		.int16le('MinBypassAmp', 	{ formatter: (x) => {return x/1000;}})
+		.int16le('MaxBypassAmp', 	{ formatter: (x) => {return x/1000;}})
+		.uint8('MinBypassAmpId')
+		.uint8('MaxBypassAmpId')
+		.uint8('MinBypassTemp',		{ formatter: (x) => {return x-40;}}) // temperature ºC
+		.uint8('MaxBypassTemp',		{ formatter: (x) => {return x-40;}}) // temperature ºC
+		.uint8('MinBypassTempId',	{ formatter: (x) => {return x-40;}})
+		.uint8('MaxBypassTempId',	{ formatter: (x) => {return x-40;}})
+		.int16le('AvgCellVolt',   	{ formatter: (x) => {return x/1000;}})
+		.uint8('AvgCellTemp',    	{ formatter: (x) => {return x-40;}}) // temperature ºC
+		.uint8('NumOfCellsAboveInitialBypass')
+		.uint8('NumOfCellsAboveFinalBypass')
+		.uint8('NumOfCellsInBypass')
+		.uint8('NumOfCellsOverdue')
+		.uint8('NumOfCellsActive')
+		.uint8('NumOfCellsInSystem')
+		.uint8('CmuTxOpStatusId')
+		.uint8('CmuRxOpStatusId')
+		.uint8('CmuRxOpStatusUSN')
+		.int16le('ShuntVoltage',	{ formatter: (x) => {return x/100;}})  // voltage
+		.floatle('ShuntCurrent',	{ formatter: (x) => {return x/1000;}}) // amp
+		.floatle('ShuntPowerVA',	{ formatter: (x) => {return x/1000;}}) // kW 
+
+		return status.parse(msg);
+	}
+}

payload/Msg_3e32_StatusRapid.js

@@ -0,0 +1,33 @@
+module.exports = function() 
+{ 
+	var Parser = require('binary-parser').Parser;
+
+	// Category    = Hardware Configuration
+	// Object      = System
+	// MsgLength   = 76
+	// Description = System setup configuration
+	// Version     = 5
+	// Frequency   = 20 seconds
+	// Support     = Current
+	// Valid from  = SW 1.0.30
+	this.parse_4a35 = function(msg) 
+	{
+		var status = new Parser()
+		.skip(8)
+		.int16le('HwSystemSetupVers')
+		.string('SystemCode', 	{ encoding: 'ascii', length: 8 })
+		.string('SysName', 		{ encoding: 'ascii', length: 20 })
+		.string('AssetCode', 	{ encoding: 'ascii', length: 20 })
+		.uint8('AllowTechAuth') 		// boolean 0 = Off , 1 = On
+		.uint8('AllowQuickSession') 	// boolean 0 = Off , 1 = On
+		.uint32le('QuickSessionInterval', { formatter: (x) => {return x/1000;}})  // seconds
+		.int16le('SystemPresetId')
+		.int16le('SystemFirmwareVersion')
+		.int16le('SystemHardwareVersion')
+		.uint32le('SystemSerialNo')
+		.uint8('ShowScheduler') 		// boolean 0 = Off , 1 = On
+		.uint8('ShowStripCycle') 		// boolean 0 = Off , 1 = On
+		
+		return status.parse(msg);
+	}
+}

payload/Msg_4a35_HwSystemSetup.js

@@ -0,0 +1,66 @@
+module.exports = function() 
+{ 
+	var Parser = require('binary-parser').Parser;
+	
+	// Category    = Hardware Configuration
+	// Object      = Cellmon
+	// MsgLength   = 53
+	// Description = Hardware cellmon setup configuration
+	// Version     = 5
+	// Frequency   = 20 seconds
+	// Support     = Current
+	// Valid from  = SW 1.0.30
+	this.parse_4b35 = function(msg) 
+	{
+		var status = new Parser()
+		.skip(8)
+		.uint8('HwCellmonSetupVers')  
+		.uint8('HwCellmonBattTypeID')  /* BattTypes
+				Custom 				= 0,
+				Li-FePO4 Typical 	= 1,
+				Li-Ion Performance 	= 2,
+				Li-Ion LongLife 	= 3, 
+				Li-FePO4 Longlife 	= 4, */
+		.uint8(  'HwCellmonFirstID')  
+		.uint8(  'HwCellmonLastID')  	
+		.int16le('HwCellmonNomCellVolt', 		{ formatter: (x) => {return x/1000;}})
+		.int16le('HwCellmonLoCellVolt', 		{ formatter: (x) => {return x/1000;}})
+		.int16le('HwCellmonHiCellVolt',			{ formatter: (x) => {return x/1000;}})
+		.int16le('HwCellmonBypassVoltLevel',	{ formatter: (x) => {return x/1000;}})
+		.int16le('HwCellmonBypassAmpLimit', 	{ formatter: (x) => {return x/1000;}})
+		.uint8( 'HwCellmonBypassTempLimit',		{ formatter: (x) => {return x-40;}}) // temperature ºC
+		.uint8( 'HwCellmonLoCellTemp',			{ formatter: (x) => {return x-40;}}) // temperature ºC
+		.uint8( 'HwCellmonHiCellTemp',			{ formatter: (x) => {return x-40;}}) // temperature ºC
+		.uint8( 'HwCellmonDiffNomCellsInSeries')  	// Boolean 0 = Off , 1 = On
+		.uint8( 'HwCellmonNomCellsInSeries') 
+		.uint8( 'HwCellmonAllowEntireRange')  		// Boolean 0 = Off , 1 = On
+		.uint8( 'HwCellmonEntireFirstID')  
+		.uint8( 'HwCellmonEntireLastID')  
+		.uint8( 'HwCellmonBypassExtraMode')  /* BypassExtraModes
+				None 			= 0,
+				Idle Shunt 		= 1,
+				Same CellVolt 	= 2,
+				AutoLevel 		= 3, */
+		.int16le('HwCellmonBypassExtraInterval',		{ formatter: (x) => {return x/1000;}}) 	// seconds
+		.uint8(  'HwCellmonCellMonTypeID')  /* CellMonTypes
+				Custom 		= 0,
+				GenMon 2W 	= 1,
+				GenMon 8W 	= 2,
+				LongMon 	= 3,
+				BlockMonM8 	= 4,
+				BlockMonM14 = 5,
+				EndMon 		= 6,
+				ManyMon 	= 7, */
+		.floatle('HwCellmonBypassImpedance', 			{ formatter: (x) => {return x/1000;}})
+		.int16le('HwCellmonBypassLoVoltCutout', 		{ formatter: (x) => {return x/1000;}})
+		.int16le('HwCellmonBypassShuntChargeLimit', 	{ formatter: (x) => {return x/100;}}) 	// amps
+		.int16le('HwCellmonBypassShuntDischgLimit', 	{ formatter: (x) => {return x/100;}}) 	// amps
+		.uint8(  'HwCellmonBypassShuntSocLo', 			{ formatter: (x) => {return (x-5)/2;}}) // percent
+		.int16le('HwCellmonBypassCellVoltBanding', 		{ formatter: (x) => {return x/1000;}})
+		.int16le('HwCellmonBypassCellVoltDiff', 		{ formatter: (x) => {return x/1000;}})
+		.int16le('HwCellmonBypassStableInterval',		{ formatter: (x) => {return x/1000;}}) // seconds
+		.int16le('HwCellmonBypassExtraAmpLimit', 		{ formatter: (x) => {return x/1000;}}) // amps
+
+		return status.parse(msg);
+	}
+}