@signalk/vedirect-serial-usb 1.3.0 → 1.5.0

package/README.md

@@ -9,13 +9,13 @@ Alternatively, this plugin also supports receiving the data via UDP and on a TCP
 
 Compatible Victron products:
 
-- BMV-700 series of Battery Monitors
+- BMV-700 series of Battery Monitors (reported to work also on the BMV-600)
 - SmartShunt series of Battery Monitors
 - SmartSolar Chargers
 - BlueSolar Chargers
 - Phoenix Inverters, including the Smarts, having a VE.Direct comms port
 
-Note that above list may not be complete. 
+Note that above list may not be complete.
 
 The TCP and UDP connection methods are to allow connecting to a Victron product
 too far away to run a serial cable. Ie. using a bridge to LAN/Wi-Fi that takes
@@ -31,34 +31,58 @@ plugin. Details for that [here](https://github.com/sbender9/signalk-venus-plugin
 
 Use the Signal K app store or install via NPM in the Signal K server root directory: `npm install @signalk/vedirect-serial-usb`
 
-
 ### Usage
 
 Set up the appropiate device on the settings page of this plugin in the Signal K server admin UI, for instance to `/dev/ttyUSB0` and enable the plugin. Your VE.Direct data will be available in Signal K format via various clients and apps.
 
 ### Connections
+
 **Select device**
+
 - Serial, UDP or TCP
 
 **Connection details**
+
 - Serial: Enter device path e.g `/dev/ttyUSB0`
-- UDP: *`ignored`*
+- UDP: _`ignored`_
 - TCP: Enter host `IP address`
 
 **Port**
-- Serial: *`ignored`*
+
+- Serial: _`ignored`_
 - UDP/TCP: `port`
 
 **Ignore Checksum**
+
 - If you want to ignore checksum, use this option. Default `ON`
 
 **SK Paths**
-- Give each device unique SK paths 
+
+- Give each device unique SK paths
+
+### Usage as a library
+
+It's possible to use this plugin as a library, in other Node.js code. This feature simply wraps the plugin in an easy-to-consume manner, so functionality is identical. Example:
+
+```javascript
+const VEDirect = require('@signalk/vedirect-serial-usb/standalone')
+const consumer = new VEDirect({
+  device: '/dev/ttyUSB0',
+  ignoreChecksum: true,
+  mainBatt: 'House',
+  auxBatt: 'Starter',
+  solar: 'Main',
+})
+
+consumer.on('delta', (delta) => console.log('[onDelta]', delta))
+consumer.stop() // stop the plugin, destruct the connections
+consumer.start() // (re-)start the plugin
+```
 
 ### License
 
 ```
-Copyright 2018 Joachim Bakke <github@heiamoss.com>, Fabian Tollenaar <fabian@decipher.industries> and 
+Copyright 2018 Joachim Bakke <github@heiamoss.com>, Fabian Tollenaar <fabian@decipher.industries> and
 Karl-Erik Gustafsson <ke.gustafsson@gmail.com>
 
 Licensed under the Apache License, Version 2.0 (the "License");

package/index.js

@@ -2,6 +2,7 @@ const serial = require('./lib/serial')
 const udp = require('./lib/udp')
 const tcp = require('./lib/tcp')
 const Parser = require('./lib/Parser')
+const VEDirect = require('./standalone')
 
 module.exports = function (app) {
   let parser = []
@@ -36,13 +37,13 @@ module.exports = function (app) {
     } else {
       if (options.device) {
         oldConfig = {vedirect: [{device: 'Serial', connection: options.device, ignoreChecksum: options.ignoreChecksum,
-          mainBatt: options.mainBatt, auxBatt: options.auxBatt, solar: options.solar}]}
+          mainBatt: options.mainBatt, auxBatt: options.auxBatt, bmv: options.bmv, solar: options.solar}]}
       } else if (options.udpPort) {
         oldConfig = {vedirect: [{device: 'UDP', port: options.udpPort, ignoreChecksum: options.ignoreChecksum,
-          mainBatt: options.mainBatt, auxBatt: options.auxBatt, solar: options.solar}]}
+          mainBatt: options.mainBatt, auxBatt: options.auxBatt, bmv: options.bmv, solar: options.solar}]}
       } else if (options.host) {
         oldConfig = {vedirect: [{device: 'TCP', connection: options.host, port: options.tcpPort, ignoreChecksum: options.ignoreChecksum,
-          mainBatt: options.mainBatt, auxBatt: options.auxBatt, solar: options.solar}]}
+          mainBatt: options.mainBatt, auxBatt: options.auxBatt, bmv: options.bmv, solar: options.solar}]}
       }
       parser[0] = new Parser(oldConfig)
 
@@ -138,6 +139,11 @@ module.exports = function (app) {
               title: 'Aux Battery name in SK path',
               default: 'Starter'
             },
+            bmv: {
+              type: 'string',
+              title: 'BMV name in SK path',
+              default: 'bmv'
+            },
             solar: {
               type: 'string',
               title: 'Solar name in SK path',

package/lib/Parser.js

@@ -7,6 +7,7 @@ const defaults = {
   defaultUnitId: 'victronDevice',
   mainBatt: 'house',
   auxBatt: 'starter',
+  bmv: 'bmv',
   solar: 'solar'
 }
 
@@ -358,6 +359,10 @@ class VEDirectParser extends EventEmitter {
             unitID = this.options.vedirect[items].auxBatt
           }
 
+          if (field.unitId === 'bmv' && this.options.hasOwnProperty('bmv')) {
+            unitID = this.options.vedirect[items].bmv
+          }
+
           if (field.unitId === 'solar' && this.options.hasOwnProperty('solar')) {
             unitID = this.options.vedirect[items].solar
           }

package/lib/fields.js

@@ -83,6 +83,22 @@ module.exports = {
     units: 'V',
     type: 'metric'
   },
+  V2: {
+    name: 'auxBattVoltage',
+    path: 'electrical.batteries.*.voltage',
+    unitId: 'auxBatt',
+    value: common.mV,
+    units: 'V',
+    type: 'metric'
+  },
+  V3: {
+    name: 'aux2BattVoltage',
+    path: 'electrical.batteries.*.voltage',
+    unitId: 'aux2Batt',
+    value: common.mV,
+    units: 'V',
+    type: 'metric'
+  },
   VS: {
     name: 'auxBatteryVoltage',
     path: 'electrical.batteries.*.voltage',
@@ -126,6 +142,22 @@ module.exports = {
     units: 'A',
     type: 'metric'
   },
+  I2: {
+    name: 'auxbatteryCurrent',
+    path: 'electrical.batteries.*.current',
+    unitId: 'auxBatt',
+    value: common.mA,
+    units: 'A',
+    type: 'metric'
+  },
+  I3: {
+    name: 'aux2batteryCurrent',
+    path: 'electrical.batteries.*.current',
+    unitId: 'aux2Batt',
+    value: common.mA,
+    units: 'A',
+    type: 'metric'
+  },
   IL: {
     name: 'loadCurrent',
     path: 'electrical.solar.*.loadCurrent',
@@ -209,6 +241,8 @@ module.exports = {
   RELAY: {
     name: 'relay',
     type: 'boolean',
+    path: 'electrical.batteries.*.relay',
+    unitId: 'bmv',
     value (value) {
       value = value.toUpperCase()
       return value === 'ON' ? 1 : 0

package/lib/productIds.json

@@ -78,5 +78,7 @@
   "0xA274": "Phoenix Inverter 48V 1200VA 230V",
   "0xA279": "Phoenix Inverter 12V 1200VA 120V",
   "0xA27A": "Phoenix Inverter 24V 1200VA 120V",
-  "0xA27C": "Phoenix Inverter 48V 1200VA 120V"
+  "0xA27C": "Phoenix Inverter 48V 1200VA 120V",
+  "0xA345": "Phoenix Smart Charger 12V 30A 3 rev2",
+  "0xA381": "BMV-712 Smart"
 }

package/lib/serial.js

@@ -1,11 +1,10 @@
-const SerialPort = require('serialport')
-const Delimiter = require('@serialport/parser-delimiter')
+const { SerialPort } = require('serialport')
+const { DelimiterParser } = require('@serialport/parser-delimiter')
 let port = []
 let delim = []
 
 module.exports = {
   open: (device, parser, debug, items) => {
-    console.log(port[items])
     if (typeof port[items] !== 'undefined' ) {
       try {
         port[items].close()
@@ -13,7 +12,9 @@ module.exports = {
       } catch (e) {}
     }
 
-    port[items] = new SerialPort(device, { baudRate: 19200 }) // @NOTE FT: should this be configurable?
+    debug(`Serial: connecting to ${device}`)
+
+    port[items] = new SerialPort({ path: device, baudRate: 19200 }) // @NOTE FT: should this be configurable?
 
     port[items].on('open', function() {
       debug(`Connected to ${device}`)
@@ -23,7 +24,7 @@ module.exports = {
       debug(`${chunk}`)
     })
 
-    delim[items] = port[items].pipe(new Delimiter({delimiter: '\r' , includeDelimiter: true}))
+    delim[items] = port[items].pipe(new DelimiterParser({ delimiter: '\r', includeDelimiter: true }))
 
     delim[items].on('data', chunk => {
       // Chunk is a node.js Buffer

package/lib/tcp.js

@@ -4,6 +4,7 @@ let client = [];
 function makeConnection(host, port, debug, items) {
   client[items] = new Net.Socket();
   client[items].connect({ port: port, host: host });
+  client[items].setTimeout(5000);
   debug(`Connection to ${host}:${port}`);
   return client[items]
 }
@@ -17,9 +18,8 @@ function onClose(host, port, parser, debug, items) {
   if(client[items]) {
     setTimeout(() => {
       debug('Trying to reconnect');
-      client[items].destroy();
       module.exports.connect(host, port, parser, debug, items);
-    }, 10000)
+    }, 10000);
   }
 }
 
@@ -31,11 +31,17 @@ module.exports = {
     });
     client[items].on('close', () => {
       debug('TCP connection closed');
+      client[items].destroy();
       onClose(host, port, parser, debug, items);
     });
     client[items].on('error', () => {
       debug('TCP connection error');
+      client[items].destroy();
     });
+    client[items].on('timeout', () => {
+      debug('TCP connection timeout');
+      client[items].destroy();
+    }); 
   },
   close: (debug, items) => {
     if (client[items]) {

package/migration.js

@@ -19,6 +19,7 @@ fs.readFile(path.resolve(jsonPath, 'vedirect-signalk.json'), 'UTF-8', (err, data
         'ignoreChecksum': obj.configuration.ignoreChecksum,
         'mainBatt': obj.configuration.mainBatt,
         'auxBatt': obj.configuration.auxBatt,
+        'bmv': obj.configuration.bmv,
         'solar': obj.configuration.solar
       }]
     } else if (obj.configuration.udpPort) {
@@ -29,6 +30,7 @@ fs.readFile(path.resolve(jsonPath, 'vedirect-signalk.json'), 'UTF-8', (err, data
         'ignoreChecksum': obj.configuration.ignoreChecksum,
         'mainBatt': obj.configuration.mainBatt,
         'auxBatt': obj.configuration.auxBatt,
+        'bmv': obj.configuration.bmv,
         'solar': obj.configuration.solar
       }]
     } else if (obj.configuration.host) {
@@ -39,6 +41,7 @@ fs.readFile(path.resolve(jsonPath, 'vedirect-signalk.json'), 'UTF-8', (err, data
         'ignoreChecksum': obj.configuration.ignoreChecksum,
         'mainBatt': obj.configuration.mainBatt,
         'auxBatt': obj.configuration.auxBatt,
+        'bmv': obj.configuration.bmv,
         'solar': obj.configuration.solar
       }]
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/vedirect-serial-usb",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Signal K Node.js server plugin to read VE.Direct data via serial USB",
   "main": "index.js",
   "scripts": {
@@ -25,7 +25,7 @@
   "dependencies": {
     "debug": "^4.0.1",
     "package-lock.json": "^1.0.0",
-    "serialport": "^9.0.0"
+    "serialport": "^11.0.0"
   },
   "standard": {
     "globals": [
@@ -38,6 +38,6 @@
   "devDependencies": {
     "chai": "^4.1.2",
     "chai-things": "^0.2.0",
-    "mocha": "^6.0.0"
+    "mocha": "^10.2.0"
   }
 }

package/standalone.js

@@ -0,0 +1,68 @@
+/**
+ * standalone.js
+ * 
+ * @description exports a class that shims the Signal K server, in order to make this plugin available as a library in other software
+ * @module @signalk/vedirect-serial-usb
+ * @author Fabian Tollenaar <fabian@essense.ai> (https://essense.ai)
+ * @license Apache_2.0
+ */
+
+const EventEmitter = require('events')
+const SKPlugin = require('./index')
+class VEDirect extends EventEmitter {
+  constructor (config = {}, _debug = false) {
+    super()
+
+    this._debug = _debug
+    this.app = {
+      handleMessage: (kind, data) => {
+        if (kind === 'pluginId') {
+          this.emit('delta', data)
+          return
+        }
+        this.emit(kind, data)
+      },
+      debug: (args) => this.debug(args),
+      options: {
+        device: 'Serial',
+        connection: '/dev/ttyUSB0',
+        port: 7878,
+        ignoreChecksum: true,
+        mainBatt: 'House',
+        auxBatt: 'Starter',
+        bmv: 'bmv',
+        solar: 'Main',
+        ...(config || {}),
+      }
+    }
+
+    this.plugin = SKPlugin(this.app)
+    this.start()
+  }
+
+  start () {
+    if (!this.plugin || !this.plugin.hasOwnProperty('start')) {
+      this.debug(`Plugin not initialised, can't start`)
+      return
+    }
+
+    this.plugin.start(this.app.options)
+  }
+
+  stop () {
+    if (!this.plugin || !this.plugin.hasOwnProperty('stop')) {
+      this.debug(`Plugin not initialised, can't stop`)
+      return
+    }
+
+    this.plugin.stop()
+  }
+
+  debug (...args) {
+    if (this._debug) {
+      console.log.apply(console, args)
+    }
+  }
+}
+
+module.exports = VEDirect