@signalk/vedirect-serial-usb 1.5.0 → 1.6.0

package/lib/tcp.js

@@ -1,53 +0,0 @@
-const Net = require('net');
-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]
-}
-
-function onData(msg, parser, debug, items) {
-  parser[items].addChunk(msg, items);
-  debug(`${msg}`);
-}
-
-function onClose(host, port, parser, debug, items) {
-  if(client[items]) {
-    setTimeout(() => {
-      debug('Trying to reconnect');
-      module.exports.connect(host, port, parser, debug, items);
-    }, 10000);
-  }
-}
-
-module.exports = {
-  connect: (host, port, parser, debug, items) => {
-    client[items] = makeConnection(host, port, debug, items);
-    client[items].on('data', (msg) => {
-      onData(msg, parser, debug, items);
-    });
-    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]) {
-      client[items].destroy();
-      client[items] = null;
-      debug(`TCP port closed`);
-    }
-  }  
-}

package/lib/udp.js

@@ -1,26 +0,0 @@
-const dgram = require('dgram');
-let socket = [];
-
-module.exports = {
-  listen: (port, parser, debug, items) => {
-    socket[items] = dgram.createSocket({ type: 'udp4', reuseAddr: true });
-
-    socket[items].on('listening', () => {
-      debug(`listening on UDP ${port}`);
-    })
-
-    socket[items].on('message', (msg, rinfo) => {
-      debug(`${rinfo.address}:${rinfo.port}:${msg}`);
-      parser[items].addChunk(msg, items);
-    })
-
-    socket[items].bind(port);
-  },
-  close: (debug, items) => {
-    if (socket[items]) {
-      socket[items].close();
-      socket[items] = null;
-      debug(`UDP port closed`);
-    }
-  }
-}

package/log/one.txt

@@ -1,18 +0,0 @@
-PID	0xA04C
-FW	127
-SER#	HQ1621FRG7Z
-V	14990
-I	2770
-VPV	20450
-PPV	42
-CS	4
-ERR	0
-LOAD	OFF
-IL	0
-H19	6078
-H20	14
-H21	100
-H22	52
-H23	148
-HSDS	208
-Checksum	⸮

package/log/run-log.js

@@ -1,7 +0,0 @@
-const join = require('path').join
-const stream = require('../lib/filestream')
-const Parser = require('../lib/Parser')
-const PATH = join(__dirname, './sampleOutput.txt')
-const parser = new Parser()
-
-stream.open(PATH, parser)

package/log/sampleOutput.txt

@@ -1,297 +0,0 @@
-VS	5
-I	0
-P	0
-CE	0
-
-H5	0
-H6	0
-H7	7
-H8	12184
-V	12140TTG	-1
-Alarm	OFF
-Relay	OFF
-	⸮
-H1	-1
-H2	0
-H3	0
-H4	0
-H50
-H10	0
-H11	0
-H12	0
-H15	3
-Relay	OFF
-AR	0
-BMV	702
-FWH3	0
-H4	0
-H5	0
-H6	0
-H7	7
-8	0
-Checksum	⸮
-PID	0x204
-V	
-H1	-1
-H2	0
-H3	0
-H4	0
-H5	0
-PID	0x204
-V	12140
-VS	5
-IRelay	OFF
-AR	0
-BMV	702
-FW	0308
-Checksum	⸮	0
-H4	0
-H5	0
-H2	0
-H15	3
-H16	7
-H17	0
-H18	0
-Checksum	⸮0
-P	0
-CE	0
-SOC	1000
-TTG	-
-H1	-1
-H2	0
-H3	0
-H4	0
-H0	0
-H11	0
-H12	0
-H15	3
-H16
-H1	-1
-H2	0
-H7	7
-H8	12180
-H9	0
-H10	0
-40
-VS	5
-I	0
-P	0	1000
-TTG	-1
-Alarm	OFF
-Relay
-H1	-1
-
-PID	0
-H7	7
-H8	12180
-H9	0
-H10	0
-cksum	⸮
-H1	-1
-H2	0
-H3	0
-H4	
-H9	0
-H10	0
-H11	0
-H12	0
-
-CE	0
-SOC	1000
-TTG	-1
-Alar
-FW	0308
-Checksum	⸮
-H1	-1
-H	7
-H8	12180
-H9	0
-H10	0
-H11	S	5
-I	0
-P	0
-CE	0
-SO
-AR	0
-BMV	702
-FW	0308
-Checks9	0
-H10	0
-H11	0
-H12	0
-H154
-V	12140FF
-Relay	OFF
-AR	0
-BMV	702
-0
-H3	0
-H4	0
-H12	0
-H15	3
-H16	7
-H17	0
-PID	0x204
-V	12140
-VS	TTG	-1
-Alarm	OFF
-Relay	OFF
-	0
-H6	0
-H7	7
-H8	12180
-H9	H16	7
-H17	0
-H18	0
-Checksum	⸮
-H1	-1
-H2	0
-H
-PID	0x204
-V		-1
-Alarm	OFF
-Relay	OFF
-AR		0
-H4	0
-H5	0
-H
-PID	0x204
-7
-H17	0
-H18	0
-Checksum	⸮
-POC	1000
-TTG	-1
-Alarm	OFF
-RelID	
-Alarm	OFF
-Relay	OFF
-AR	0
-V	702
-FW	0308
-Checksum	⸮H17	0
-H18	0
-Checksum	⸮
-PID	0ecksum	⸮
-PID	0x204
-V	12139
-702
-FW	0308
-Checksum	⸮
-PID	0x204
-V	12140
-FF
-AR	0
-BMV	702
-FW	0308
-Che
-H1	-15	3
-H16	7
-H17	0
-H18	0
-CheckH5	0
-H6	0
-H7	7
-H8	12180
-4
-V	12140E	0
-SOC	1000
-TTG	-1
-Alarm	O0
-H3	0
-H4	0
-H12	0
-H15	3
-H16	7
-H17	0
-PID	0x204
-V	12R	0
-BMV	702
-FW	0308
-Checksum
-H16	7
-H17	0
-H18	0
-Checksum	⸮
-V	12140
-0308
-Checksum	⸮
-H1	-1
-H2	0
-H12	0
-H15	3
-H16	7
-H17	0
-H18
-BMV	702
-FW	0308
-Checksum	⸮
-
-H6	0
-H7	7
-H8	12180
-H9	0
-08
-Checksum	⸮
-H1	-1
-H2	0
-H3
-PID	0x204
-1
-Alarm	OFF
-Relay	OFF
-AR	01	-
-H17	0
-H18	0
-Checksum	⸮
-PIDOC	1000
-TTG	-1
-Alarm	OFF
-Re
-H4	0
-H5	0
-H6	0
-H
-H15	3
-H16	7
-H17	0
-H18	0
-CID	Alarm	OFF
-Relay	OFF
-AR	0
-BM	1000
-TTG	-1
-Alarm	OFF
-Rel80
-H9	0
-H10	0
-H11	0
-H12	0H15	3
-H16	7
-H17	0
-H18	0
-Che	0x20
-H1	-1
-H2	0
-H3	0
-H4H11	0
-H12	0
-H15	3
-H16	7
-H
-VS	5
-I	0
-P	0
-CE
-H9	0
-H10	0
-H11	0
-H12	0
-H1
-PID
-CE	0
-SOC	1000
-TTG	-1
-Alar
-FW	0308
-Checksum	⸮

package/migration.js

@@ -1,57 +0,0 @@
-const fs = require('fs')
-const path = require('path');
-
-jsonPath = __dirname + '/../../../plugin-config-data';
-fs.readFile(path.resolve(jsonPath, 'vedirect-signalk.json'), 'UTF-8', (err, data) => {
-  if (err) {
-    console.error(err)
-    return
-  }
-
-  let obj = JSON.parse(data);
-
-  if (typeof obj.configuration.vedirect == 'undefined' ) {
-    if (obj.configuration.device) {
-      obj.configuration.vedirect = [{
-        'device':'Serial',
-        'connection': obj.configuration.device,
-        'port': '',
-        '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) {
-      obj.configuration.vedirect = [{
-        'device':'UDP',
-        'connection': 'localhost',
-        'port': obj.configuration.udpPort,
-        '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) {
-      obj.configuration.vedirect = [{
-        'device':'TCP',
-        'connection': obj.configuration.host,
-        'port': obj.configuration.tcpPort,
-        'ignoreChecksum': obj.configuration.ignoreChecksum,
-        'mainBatt': obj.configuration.mainBatt,
-        'auxBatt': obj.configuration.auxBatt,
-        'bmv': obj.configuration.bmv,
-        'solar': obj.configuration.solar
-      }]
-    }
-
-    let dataOut = JSON.stringify(obj, null, 2)
-    fs.writeFile(path.resolve(jsonPath, 'vedirect-signalk.json'), dataOut, 'utf8', function(err) {
-      if (err) {
-        console.error(err)
-        return
-      }
-    });
-  }
-});

package/run.js

@@ -1,10 +0,0 @@
-const app = {
-  debug: (msg) => console.log(msg),
-  handleMessage: (id, delta) => console.log(JSON.stringify(delta, null, 2))
-}
-
-const plugin = require('./')(app)
-plugin.start({
-  udpPort: 7878,
-  ignoreChecksum: true
-})

package/standalone.js

@@ -1,68 +0,0 @@
-/**
- * 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

package/test/index.js

@@ -1,52 +0,0 @@
-const fs = require('fs')
-const join = require('path').join
-const chai = require('chai')
-const Parser = require('../lib/Parser')
-const expect = chai.expect
-
-const parser = new Parser({
-  vedirect: [ { device: 'UDP', connection: 'localhost', port: 7878, ignoreChecksum: true, mainBatt: 'House', auxBatt: 'Starter', solar: 'Main' } ]
-})
-
-let lines = []
-
-describe('VE.Direct parser', () => {
-  before(done => {
-    try {
-      const text = fs.readFileSync(join(__dirname, '../log/sampleOutput.txt'), 'utf-8')
-      lines = text.split('\n').map(line => `\n${line}`)
-      done()
-    } catch (err) {
-      done(err)
-    }
-  })
-
-  it('Reads the log file and finds multiple lines', done => {
-    expect(lines.length).to.be.a('number')
-    expect(lines.length).to.be.above(1)
-    done()
-  })
-
-  it('Parses each line that has a Signal K representation withouth error', done => {
-    try {
-      let parsed = []
-      
-      const listener = delta => {
-        parsed.push(delta)
-      }
-
-      parser.on('delta', listener)
-
-      lines.forEach(line => {
-        parser.addChunk(Buffer.from(line), 0)
-      })
-
-      parser.removeListener('delta', listener)
-      expect(parsed.length).to.be.a('number')
-      expect(parsed.length).to.equal(16)
-      done()
-    } catch (err) {
-      done(err)
-    }
-  })
-})

package/todo.md

@@ -1,14 +0,0 @@
-# TODO
-
-- [x] Reformat code into a Parser class with separate field and product definition
-- [x] Make start on unit tests (WIP)
-- [x] Include log file for testing
-- [x] Expand list of product IDs/devices
-- [x] Implement all enums in the VE.direct spec
-- [x] Make parser run on entire block, and check checksum for each block
-- [x] Test checksum implementation with real Victron device (help needed)
-- [x] Emit deltas for entire block, if checksum checks out
-- [x] Pass delta on to SK server
-- [ ] Test on more Victron devices (help needed)
-- [ ] Add more unit tests
-- [x] Create back door to allow CI tests to complete without failing checksum