signalk-rec-bms 1.0.1 → 1.1.0

package/README.md

@@ -1,4 +1,46 @@
 # signalk-rec-bms
-SignalK plugin for REC-BMS
 
-Requires WiFi module with firmware >= SW164_2
+![alt text](https://github.com/ofernander/signalk-rec-bms/blob/main/public/assets/images/rec-sk.png)
+
+## Features
+
+- Reads all avabile data streams from BMS and publishes to SignalK
+- Supports Websocket connection from the REC WiFi module with firmare >= SW164_2
+- Supports serial connection directly from BMS
+- Can set BMS settings when using serial connection
+- Live status & settings page within SignalK 
+
+## Notes
+
+Tested with the 4 cell ABMS model only
+
+## Requirements
+
+#### Websocket connection (WiFi):
+
+- A REC WiFi module with firmware >= SW164_2, which enables websockets  
+
+[Firmware SW164_2](https://www.rec-bms.com/wp-content/uploads/2025/01/Wi-Fi-FW-Update_SW164_2.zip)
+  
+#### Serial connection:
+
+- RS485 to USB adapter with 5v output. The REC-BMS serial chip is not powered internally and you must supply 5v to power it. 
+
+![alt text](https://github.com/ofernander/signalk-rec-bms/blob/main/public/assets/images/rs485.jpg)
+
+![alt text](https://github.com/ofernander/signalk-rec-bms/blob/main/public/assets/images/bms_serial.png)
+
+## Dependencies
+
+- npm package: [websocket](https://www.npmjs.com/package/websocket)
+- npm package: [serialport](https://www.npmjs.com/package/serialport)
+- npm package: [crc](https://www.npmjs.com/package/crc)
+
+## Installation (choose one)
+
+Use the SignalK application store (preferred)
+
+Run the following command:
+   ```bash
+   npm install signalk-rec-bms
+   ```

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "signalk-rec-bms",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "SignalK plugin for REC-BMS",
-  "main": "index.js",
+  "main": "plugin/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
+    "signalk-webapp",
     "signalk-node-server-plugin",
     "signalk-category-hardware"
   ],
@@ -16,7 +17,9 @@
   },
   "license": "ISC",
   "dependencies": {
-    "ws": "^8.18.1"
+    "ws": "^8.18.1",
+    "serialport": "^13.0.0",
+    "crc": "^4.3.2"
   },
   "repository": {
     "type": "git",
@@ -24,5 +27,9 @@
   },
   "engines": {
     "node": ">=10"
+  },
+  "signalk": {
+    "appIcon": "./assets/icons/rec_ball-72x72.png",
+    "displayName": "SignalK-REC-BMS"
   }
-}
+}

package/plugin/index.js

@@ -0,0 +1,67 @@
+"use strict";
+
+const schema = require('./lib/schema');
+const connection = require('./lib/connection');
+
+module.exports = function(app) {
+  let conn;
+  let pluginOptions;
+  let commsHandler;
+
+  function publishDelta(delta) {
+    let mergedConfig = {};
+    if (pluginOptions && pluginOptions.deltas) {
+      if (pluginOptions.deltas.common) {
+        Object.assign(mergedConfig, pluginOptions.deltas.common);
+      }
+      if (pluginOptions.deltas.ws) {
+        Object.assign(mergedConfig, pluginOptions.deltas.ws);
+      }
+      if (pluginOptions.deltas.serial) {
+        Object.assign(mergedConfig, pluginOptions.deltas.serial);
+      }
+    }
+  
+    const precision = 5;
+    const factor = Math.pow(10, precision);
+  
+    delta.updates.forEach(update => {
+      update.values.forEach(item => {
+        if (typeof item.value === "number") {
+          item.value = Math.round(item.value * factor) / factor;
+        }
+      });
+    });
+  
+    if (delta && delta.updates && delta.updates.some(u => u.values.length > 0)) {
+      app.debug(`[INDEX] Publishing delta: ${JSON.stringify(delta)}`);
+      app.handleMessage("signalk-rec-bms", delta, "v1");
+    } else {
+      app.debug("[INDEX] Delta empty after processing, not publishing.");
+    }
+  }
+  
+  var plugin = {
+    id: "signalk-rec-bms",
+    name: "SignalK-REC-BMS",
+    description: "SignalK plugin for REC-BMS",
+    schema: schema,
+    start: function(options) {
+      pluginOptions = options;
+      app.debug(`[INDEX] START invoked with options: ${JSON.stringify(options)}`);
+      app.setPluginStatus("Connecting to BMS…");
+      conn = connection(options, app, publishDelta);
+      conn.start(options);
+    },
+    stop: function() {
+      if (conn) {
+        conn.stop();
+        conn = null;
+      }
+      app.debug("[INDEX] Plugin stopped");
+      app.setPluginStatus("Stopped");
+    },
+  };
+
+  return plugin;
+};

package/plugin/lib/connection.js

@@ -0,0 +1,19 @@
+"use strict";
+
+module.exports = function(options, app, publishDelta) {
+  let connModule;
+  const connectionType = options.connection && options.connection.connectionType;
+  app.debug(`[CONNECTION] connectionType is: ${connectionType}`);
+  
+  if (connectionType === "websocket") {
+    app.debug("[CONNECTION] Loading websocket connection module");
+    connModule = require('./websocket/ws')(app, publishDelta);
+  } else if (connectionType === "serial") {
+    app.debug("[CONNECTION] Loading serial connection module");
+    connModule = require('./serial/serial')(app, publishDelta);
+  } else {
+    throw new Error("Unsupported connection type: " + connectionType);
+  }
+  
+  return connModule;
+};

package/plugin/lib/schema.js

@@ -0,0 +1,59 @@
+module.exports = {
+  type: "object",
+  properties: {
+    connection: {
+      title: "Connection Settings",
+      type: "object",
+      properties: {
+        connectionType: {
+          title: "Connection Type",
+          type: "string",
+          enum: ["websocket", "serial"],
+          default: "websocket"
+        }
+      }
+    },
+    websocket: {
+      title: "WebSocket Connection Settings",
+      type: "object",
+      properties: {
+        websocketURL: {
+          title: "WebSocket URL",
+          type: "string",
+          default: "ws://192.168.88.10/ws"
+        }
+      }
+    },
+    serial: {
+      title: "Serial Connection Settings",
+      type: "object",
+      properties: {
+        device: { 
+          title: "Serial Device", 
+          type: "string", 
+          default: "/dev/ttyUSB0" 
+        },
+        baudRate: { 
+          title: "Baud Rate", 
+          type: "number", 
+          default: 115200 
+        },
+        targetAddress: { 
+          title: "Target (Destination) Address", 
+          type: "number", 
+          default: 2 
+        },
+        senderAddress: { 
+          title: "Sender Address", 
+          type: "number", 
+          default: 0 
+        }
+      }
+    },
+    deltaPrefix: {
+      title: "Delta Path Prefix",
+      type: "string",
+      default: "electrical.batteries.bms"
+    }
+  }
+};

package/plugin/lib/serial/Layer2.js

@@ -0,0 +1,69 @@
+"use strict";
+const { crc16 } = require('crc');
+
+class Layer2 {
+	constructor() {
+		this.buffer = [];
+		this.stats = {
+			tx: 0,
+			txBytes: 0,
+			rx: 0,
+			rxBytes: 0,
+			badCRC: 0
+		};
+		this.hooks = {
+			"data": () => {}
+		};
+	}
+
+	on(hook, callback) {
+		this.hooks[hook] = callback;
+	}
+
+	push(block) {
+		for (let i = 0; i < block.length; i++) {
+			this.stats.rxBytes++;
+			this.buffer.push(block.readUInt8(i));
+		}
+		while (this.packetForward());
+	}
+
+	packetForward() {
+		while (this.buffer.length > 0 && this.buffer[0] !== 0x55) {
+			this.buffer.shift();
+		}
+		if (this.buffer.length >= 7) {
+			let length = this.buffer[3];
+			let packet = [];
+			if (this.buffer.length < length + 7) {
+				return false;
+			}
+			for (let i = 0; i < length + 7; i++)
+				packet.push(this.buffer[i]);
+			packet = Buffer.from(packet);
+			if (packet.readUInt8(packet.length - 1) !== 0xAA) {
+				this.buffer.shift();
+				return true;
+			}
+			let packetCRC = packet.readUInt16BE(packet.length - 3);
+			let crc = crc16(packet.slice(1, packet.length - 3));
+			this.stats.rx++;
+			if (crc !== packetCRC) {
+				this.stats.badCRC++;
+				for (let i = 0; i < packet.length; i++)
+					this.buffer.shift();
+				return true;
+			}
+			try {
+				this.hooks["data"](packet);
+			} catch (err) {
+			}
+			for (let i = 0; i < length + 7; i++)
+				this.buffer.shift();
+			return true;
+		}
+		return false;
+	}
+}
+
+module.exports = Layer2;