@signalk/vedirect-serial-usb 1.4.0 → 1.6.0

package/lib/fields.js

@@ -1,501 +0,0 @@
-const common = {
-  number (value) {
-    if (typeof value !== 'number') {
-      value = parseInt(value, 10)
-    }
-
-    if (isNaN(value)) {
-      return null
-    }
-
-    return value
-  },
-
-  // 0.01 kWh
-  kWh (value) {
-    if (typeof value !== 'number') {
-      value = parseInt(value, 10)
-    }
-
-    if (isNaN(value)) {
-      return null
-    }
-
-    // value is in units of 0.01 kWh each
-    return value / 100
-  },
-
-  mV (value) {
-    if (typeof value !== 'number') {
-      value = parseInt(value, 10)
-    }
-
-    if (isNaN(value)) {
-      return null
-    }
-
-    return value / 1000
-  },
-
-  mA (value) {
-    if (typeof value !== 'number') {
-      value = parseInt(value, 10)
-    }
-
-    if (isNaN(value)) {
-      return null
-    }
-
-    return Math.floor(value / 10) / 100
-  },
-
-  mAh (value) {
-    if (typeof value !== 'number') {
-      value = parseInt(value, 10)
-    }
-
-    if (isNaN(value)) {
-      return null
-    }
-
-    return Math.floor(value / 10) / 100 * 3600
-  },
-
-  promille (value) {
-    if (typeof value !== 'number') {
-      value = parseInt(value, 10)
-    }
-
-    if (isNaN(value)) {
-      return null
-    }
-
-    return value / 1000
-  }
-}
-
-module.exports = {
-  V: {
-    name: 'mainBattVoltage',
-    path: 'electrical.batteries.*.voltage',
-    unitId: 'mainBatt',
-    value: common.mV,
-    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',
-    unitId: 'auxBatt',
-    value: common.mV,
-    units: 'V',
-    type: 'metric'
-  },
-  VM: {
-    name: 'midPointVoltage',
-    value: common.mV,
-    units: 'V',
-    type: 'metric'
-  },
-  DM: {
-    name: 'midPointDeviation',
-    value: common.promille,
-    type: 'ratio'
-  },
-  VPV: {
-    name: 'panelVoltage',
-    path: 'electrical.solar.*.panelVoltage',
-    unitId: 'solar',
-    value: common.mV,
-    units: 'V',
-    type: 'metric'
-  },
-  PPV: {
-    name: 'panelPower',
-    path: 'electrical.solar.*.panelPower',
-    unitId: 'solar',
-    value: common.number,
-    units: 'W',
-    type: 'metric'
-  },
-  I: {
-    name: 'batteryCurrent',
-    path: 'electrical.batteries.*.current',
-    unitId: 'mainBatt',
-    value: common.mA,
-    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',
-    unitId: 'solar',
-    value: common.mA,
-    units: 'A',
-    type: 'metric'
-  },
-  LOAD: {
-    name: 'loadOutputState',
-    path: 'electrical.solar.*.load',
-    unitId: 'solar',
-    type: 'text',
-    value (value) {
-      value = value.toLowerCase()
-      return value
-    }
-  },
-  T: {
-    name: 'batteryTemperature',
-    path: 'electrical.batteries.*.temperature',
-    unitId: 'mainBatt',
-    units: 'K',
-    type: 'metric',
-    value (value, instance) {
-      if (typeof value !== 'number') {
-        value = parseInt(value, 10)
-      }
-
-      if (isNaN(value)) {
-        return null
-      }
-
-      return (value + 273.15)
-    }
-  },
-  P: {
-    name: 'instantPower',
-    value: common.number,
-    units: 'W',
-    type: 'metric'
-  },
-  CE: {
-    name: 'consumedAh',
-    path: 'electrical.batteries.*.capacity.consumedCharge',
-    unitId: 'mainBatt',
-    value: common.mAh,
-    units: 'C',
-    type: 'metric'
-  },
-  SOC: {
-    name: 'stateOfCharge',
-    path: 'electrical.batteries.*.capacity.stateOfCharge',
-    unitId: 'mainBatt',
-    value: common.promille,
-    type: 'ratio'
-  },
-  TTG: {
-    name: 'timeToGo',
-    path: 'electrical.batteries.*.capacity.timeRemaining',
-    unitId: 'mainBatt',
-    value: value => {
-      value = common.number(value)
-      if (value === null) {
-        return null
-      }
-      // value is minutes
-      return value * 60
-    },
-    units: 's',
-    type: 'metric'
-  },
-  ALARM: {
-    name: 'alarm',
-    type: 'boolean',
-    value (value) {
-      value = value.toUpperCase()
-      return value === 'ON' ? 1 : 0
-    }
-  },
-  RELAY: {
-    name: 'relay',
-    type: 'boolean',
-    value (value) {
-      value = value.toUpperCase()
-      return value === 'ON' ? 1 : 0
-    }
-  },
-  AR: {
-    name: 'alarmReason',
-    type: 'text',
-    value (value, instance) {
-      return instance.getAlarmReason(value)
-    }
-  },
-  H1: {
-    name: 'depthOfDeepestDischarge',
-    value: common.mAh,
-    units: 'C',
-    type: 'metric'
-  },
-  H2: {
-    name: 'depthOfLastDischarge',
-    value: common.mAh,
-    units: 'C',
-    type: 'metric'
-  },
-  H3: {
-    name: 'depthOfAverageDischarge',
-    value: common.mAh,
-    units: 'C',
-    type: 'metric'
-  },
-  H4: {
-    name: 'numberOfChargeCycles',
-    value: common.number,
-    type: 'count'
-  },
-  H5: {
-    name: 'numberOfFullDischarges',
-    value: common.number,
-    type: 'count'
-  },
-  H6: {
-    name: 'cumulativeAhDrawn',
-    path: 'electrical.batteries.*.lifetimeDischarge',
-    unitId: 'mainBatt',
-    value: common.mAh,
-    units: 'C',
-    type: 'metric'
-  },
-  H7: {
-    name: 'minimumMainBattVoltage',
-    value: common.mV,
-    units: 'V',
-    type: 'metric'
-  },
-  H8: {
-    name: 'maximumMainBattVoltage',
-    value: common.mV,
-    units: 'V',
-    type: 'metric'
-  },
-  H9: {
-    name: 'secondsSinceLastFullCharge',
-    value: common.number,
-    units: 's',
-    type: 'metric'
-  },
-  H10: {
-    name: 'numberOfAutoSync',
-    value: common.number,
-    type: 'count'
-  },
-  H11: {
-    name: 'numberOfLowMainVoltageAlarms',
-    value: common.number,
-    type: 'count'
-  },
-  H12: {
-    name: 'numberOfHighMainVoltageAlarms',
-    value: common.number,
-    type: 'count'
-  },
-  H13: {
-    name: 'numberOfLowAuxVoltageAlarms',
-    value: common.number,
-    type: 'count'
-  },
-  H14: {
-    name: 'numberOfHighAuxVoltageAlarms',
-    value: common.number,
-    type: 'count'
-  },
-  H15: {
-    name: 'minimumAuxBattVoltage',
-    value: common.mV,
-    units: 'V',
-    type: 'metric'
-  },
-  H16: {
-    name: 'maximumAuxBattVoltage',
-    value: common.mV,
-    units: 'V',
-    type: 'metric'
-  },
-  H17: {
-    name: 'dischargedEnergy',
-    value: common.kWh,
-    units: 'J',
-    type: 'metric'
-  },
-  H18: {
-    name: 'chargedEnergy',
-    value: common.kWh,
-    units: 'J',
-    type: 'metric'
-  },
-  H19: {
-    name: 'yieldTotal',
-    path: 'electrical.solar.*.yieldTotal',
-    unitId: 'solar',
-    value: common.kWh,
-    units: 'J',
-    type: 'metric'
-  },
-  H20: {
-    name: 'yieldToday',
-    path: 'electrical.solar.*.yieldToday',
-    unitId: 'solar',   
-    value: common.kWh,
-    units: 'J',
-    type: 'metric'
-  },
-  H21: {
-    name: 'maximumPowerToday',
-    path: 'electrical.solar.*.maximumPowerToday',
-    unitId: 'solar',  
-    value: common.number,
-    units: 'W',
-    type: 'metric'
-  },
-  H22: {
-    name: 'yieldYesterday',
-    path: 'electrical.solar.*.yieldYesterday',
-    unitId: 'solar', 
-    value: common.kWh,
-    units: 'J',
-    type: 'metric'
-  },
-  H23: {
-    name: 'maximumPowerYesterday',
-    path: 'electrical.solar.*.maximumPowerYesterday',
-    unitId: 'solar',
-    value: common.number,
-    units: 'W',
-    type: 'metric'
-  },
-  ERR: {
-    name: 'errorCode',
-    path: 'electrical.batteries.*.errorCode',
-    unitId: 'mainBatt',
-    type: 'text',
-    value (value, instance) {
-      return instance.getErrorString(value)
-    }
-  },
-  CS: {
-    name: 'stateOfOperation',
-    path: 'electrical.charger.*.chargingMode',
-    unitId: 'mainBatt',
-    type: 'text',
-    value (value, instance) {
-      return instance.getStateOfOperation(value)
-    }
-  },
-  FW: {
-    name: 'firmwareVersion',
-    type: 'text'
-  },
-  PID: {
-    name: 'productId',
-    value (value, instance) {
-      value = String(value)
-      if (!value.includes('0x')) {
-        value = `0x${value}`
-      }
-
-      instance.set('productId', { name: 'productId', value })
-      instance.set('productName', { name: 'productId', value: instance.getProductLongname(value) })
-      return null
-    }
-  },
-  'SER#': {
-    name: 'serialNumber',
-    type: 'text'
-  },
-  HSDS: {
-    name: 'daySequenceNumber',
-    value: common.number,
-    type: 'count'
-  },
-  MODE: {
-    name: 'deviceMode',
-    type: 'text',
-    value (value, instance) {
-      return instance.getMode(value)
-    }
-  },
-  AC_OUT_V: {
-    name: 'acOutputVoltage',
-    path: 'electrical.ac.*.phase.A.lineLineVoltage',
-    unitId: 'inverter',
-    units: 'V',
-    type: 'metric',
-    value (value, instance) {
-      value = common.number(value)
-
-      if (value === null) {
-        return
-      }
-
-      // AC OUT V is reported in units of 0.01 V each.
-      return value / 100
-    }
-  },
-  AC_OUT_I: {
-    name: 'acOutputCurrent',
-    path: 'electrical.ac.*.phase.A.current',
-    unitId: 'inverter',
-    units: 'A',
-    type: 'metric',
-    value (value, instance) {
-      value = common.number(value)
-
-      if (value === null) {
-        return
-      }
-
-      // AC OUT I is reported in units of 0.1 A each.
-      return value / 10
-    }
-  },
-  WARN: {
-    name: 'warningReason',
-    type: 'text'
-  },
-  BMV: {
-    name: 'batteryMonitorName',
-    type: 'text'
-  },
-  MPPT: {
-    name: 'trackerOperationMode',
-    path: 'electrical.solar.*.trackerOperationMode',
-    unitId: 'solar',
-    type: 'text',
-    value (value, instance) {
-      return instance.getTrackerOperationMode(value)
-    }
-  },
-}

package/lib/filestream.js

@@ -1,38 +0,0 @@
-const fs = require('fs')
-const debug = require('debug')('signalk-vedirect-parser')
-let port = null
-
-exports.open = function openFileStream (path, parser) {
-  if (port !== null) {
-    try {
-      port.close()
-      port = null
-    } catch (e) {}
-  }
-
-  port = fs.createReadStream(path, 'ascii')
-
-  port.on('data', chunk => {
-    if (Buffer.isBuffer(chunk)) {
-      chunk = chunk.toString('ascii')
-    }
-
-    parser.addChunk(chunk)
-  })
-
-  // @NOTE FT: should we implement reconenct/back-off code like TCP wrappers?
-  //        I assume the serial port only closes if the physical line is broken/disconnected?
-
-  port.on('error', err => {
-    debug('file stream error: ' + err.message)
-  })
-}
-
-exports.close = function (device) {
-  if (port !== null) {
-    try {
-      port.close()
-      port = null
-    } catch (e) {}
-  }
-}

package/lib/productIds.json

@@ -1,84 +0,0 @@
-{
-  "0x203": "BMV-700",
-  "0x204": "BMV-702",
-  "0x205": "BMV-700H",
-  "0x300": "BlueSolar MPPT 70/15",
-  "0xA040": "BlueSolar MPPT 75/50",
-  "0xA041": "BlueSolar MPPT 150/35",
-  "0xA042": "BlueSolar MPPT 75/15",
-  "0xA043": "BlueSolar MPPT 100/15",
-  "0xA044": "BlueSolar MPPT 100/30",
-  "0xA045": "BlueSolar MPPT 100/50",
-  "0xA046": "BlueSolar MPPT 150/70",
-  "0xA047": "BlueSolar MPPT 150/100",
-  "0xA049": "BlueSolar MPPT 100/50 rev2",
-  "0xA04A": "BlueSolar MPPT 100/30 rev2",
-  "0xA04B": "BlueSolar MPPT 150/35 rev2",
-  "0xA04C": "BlueSolar MPPT 75/10",
-  "0xA04D": "BlueSolar MPPT 150/45",
-  "0xA04E": "BlueSolar MPPT 150/60",
-  "0xA04F": "BlueSolar MPPT 150/85",
-  "0xA050": "SmartSolar MPPT 250/100",
-  "0xA051": "SmartSolar MPPT 150/100*",
-  "0xA052": "SmartSolar MPPT 150/85*",
-  "0xA053": "SmartSolar MPPT 75/15",
-  "0xA054": "SmartSolar MPPT 75/10",
-  "0xA055": "SmartSolar MPPT 100/15",
-  "0xA056": "SmartSolar MPPT 100/30",
-  "0xA057": "SmartSolar MPPT 100/50",
-  "0xA058": "SmartSolar MPPT 150/35",
-  "0xA059": "SmartSolar MPPT 150/100 rev2",
-  "0xA05A": "SmartSolar MPPT 150/85 rev2",
-  "0xA05B": "SmartSolar MPPT 250/70",
-  "0xA05C": "SmartSolar MPPT 250/85",
-  "0xA05D": "SmartSolar MPPT 250/60",
-  "0xA05E": "SmartSolar MPPT 250/45",
-  "0xA05F": "SmartSolar MPPT 100/20",
-  "0xA060": "SmartSolar MPPT 100/20 48V",
-  "0xA061": "SmartSolar MPPT 150/45",
-  "0xA062": "SmartSolar MPPT 150/60",
-  "0xA063": "SmartSolar MPPT 150/70",
-  "0xA064": "SmartSolar MPPT 250/85 rev2",
-  "0xA065": "SmartSolar MPPT 250/100 rev2",
-  "0xA201": "Phoenix Inverter 12V 250VA 230V*",
-  "0xA202": "Phoenix Inverter 24V 250VA 230V*",
-  "0xA204": "Phoenix Inverter 48V 250VA 230V*",
-  "0xA211": "Phoenix Inverter 12V 375VA 230V*",
-  "0xA212": "Phoenix Inverter 24V 375VA 230V*",
-  "0xA214": "Phoenix Inverter 48V 375VA 230V*",
-  "0xA221": "Phoenix Inverter 12V 500VA 230V*",
-  "0xA222": "Phoenix Inverter 24V 500VA 230V*",
-  "0xA224": "Phoenix Inverter 48V 500VA 230V*",
-  "0xA231": "Phoenix Inverter 12V 250VA 230V",
-  "0xA232": "Phoenix Inverter 24V 250VA 230V",
-  "0xA234": "Phoenix Inverter 48V 250VA 230V",
-  "0xA239": "Phoenix Inverter 12V 250VA 120V",
-  "0xA23A": "Phoenix Inverter 24V 250VA 120V",
-  "0xA23C": "Phoenix Inverter 48V 250VA 120V",
-  "0xA241": "Phoenix Inverter 12V 375VA 230V",
-  "0xA242": "Phoenix Inverter 24V 375VA 230V",
-  "0xA244": "Phoenix Inverter 48V 375VA 230V",
-  "0xA249": "Phoenix Inverter 12V 375VA 120V",
-  "0xA24A": "Phoenix Inverter 24V 375VA 120V",
-  "0xA24C": "Phoenix Inverter 48V 375VA 120V",
-  "0xA251": "Phoenix Inverter 12V 500VA 230V",
-  "0xA252": "Phoenix Inverter 24V 500VA 230V",
-  "0xA254": "Phoenix Inverter 48V 500VA 230V",
-  "0xA259": "Phoenix Inverter 12V 500VA 120V",
-  "0xA25A": "Phoenix Inverter 24V 500VA 120V",
-  "0xA25C": "Phoenix Inverter 48V 500VA 120V",
-  "0xA261": "Phoenix Inverter 12V 800VA 230V",
-  "0xA262": "Phoenix Inverter 24V 800VA 230V",
-  "0xA264": "Phoenix Inverter 48V 800VA 230V",
-  "0xA269": "Phoenix Inverter 12V 800VA 120V",
-  "0xA26A": "Phoenix Inverter 24V 800VA 120V",
-  "0xA26C": "Phoenix Inverter 48V 800VA 120V",
-  "0xA271": "Phoenix Inverter 12V 1200VA 230V",
-  "0xA272": "Phoenix Inverter 24V 1200VA 230V",
-  "0xA274": "Phoenix Inverter 48V 1200VA 230V",
-  "0xA279": "Phoenix Inverter 12V 1200VA 120V",
-  "0xA27A": "Phoenix Inverter 24V 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,48 +0,0 @@
-const { SerialPort } = require('serialport')
-const { DelimiterParser } = require('@serialport/parser-delimiter')
-let port = []
-let delim = []
-
-module.exports = {
-  open: (device, parser, debug, items) => {
-    if (typeof port[items] !== 'undefined' ) {
-      try {
-        port[items].close()
-        port[items] = undefined
-      } catch (e) {}
-    }
-
-    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}`)
-    })
-
-    port[items].on('data', chunk => {
-      debug(`${chunk}`)
-    })
-
-    delim[items] = port[items].pipe(new DelimiterParser({ delimiter: '\r', includeDelimiter: true }))
-
-    delim[items].on('data', chunk => {
-      // Chunk is a node.js Buffer
-      parser[items].addChunk(chunk, items)
-      debug(`${chunk}`)
-    })
-
-    port[items].on('error', err => {
-      debug(`SerialPort error: ` + err.message)
-    })
-  },
-  close: (debug, items) => {
-    if (port[items]) {
-      try {
-        port[items].close()
-        port[items] = undefined
-        debug(`Serial port closed`);
-      } catch (e) {}
-    }
-  }
-}

package/lib/tcp.js

@@ -1,47 +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 });
-  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');
-      client[items].destroy();
-      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');
-      onClose(host, port, parser, debug, items);
-    });
-    client[items].on('error', () => {
-      debug('TCP connection error');
-    });
-  },
-  close: (debug, items) => {
-    if (client[items]) {
-      client[items].destroy();
-      client[items] = null;
-      debug(`TCP port closed`);
-    }
-  }  
-}