@canboat/canboatjs 1.20.2 → 1.22.0

package/README.md

@@ -205,9 +205,9 @@ Output: `!PDGY,127245,255,/Pj/f/9///8=`
 ## Generate YDGW-02 format from canboat json
 
 ```js
-const pgnToYdwgRawFormat = require("./index").pgnToYdwgRawFormat;
+const pgnToYdgwRawFormat = require("./index").pgnToYdgwRawFormat;
 
-const array = pgnToYdwgRawFormat({
+const array = pgnToYdgwRawFormat({
   src: 127,
   prio: 3,
   dst: 255,

package/index.js

@@ -34,7 +34,8 @@ module.exports = {
   Venus: require('./lib/venus'),
   VenusMQTT: require('./lib/venus-mqtt'),
   discover: require('./lib/discovery'),
-  SimpleCan: require('./lib/simpleCan')
+  SimpleCan: require('./lib/simpleCan'),
+  addCustomPgn: require('./lib/pgns').addCustomPgn
 }
 
 try {

package/ios.js

@@ -1,6 +1,15 @@
 
 const FromPgn = require('./lib/fromPgn').Parser
-const { pgnToYdgwRawFormat, actisenseToYdgwRawFormat, pgnToPCDIN, actisenseToPCDIN} = require('./lib/toPgn')
+const {
+  pgnToYdgwRawFormat,
+  actisenseToYdgwRawFormat,
+  pgnToPCDIN,
+  actisenseToPCDIN,
+  pgnToiKonvertSerialFormat,
+  actisenseToiKonvert,
+  pgnToMXPGN,
+  actisenseToMXPGN
+} = require('./lib/toPgn')
 
 const parser = new FromPgn({})
 
@@ -19,6 +28,8 @@ global.pgnToPCDIN = pgnToPCDIN
 global.actisenseToPCDIN = actisenseToPCDIN
 global.pgnToMXPGN = pgnToMXPGN
 global.actisenseToMXPGN = actisenseToMXPGN
+global.pgnToiKonvertSerialFormat = pgnToiKonvertSerialFormat
+global.actisenseToiKonvert = actisenseToiKonvert
 
 global.parsePCDIN = (pcdin) => {
   return parser.parseN2KOver0183(pcdin)
@@ -30,6 +41,19 @@ global.parseMXPGN = (mxpgn) => {
 
 global.parseHelmSmart = global.parsePCDIN
 
+global.isN2KOver0183 = (msg) => {
+  return parser.isN2KOver0183(msg)
+}
+global.parseN2KOver0183 = (msg) => {
+  return parser.parseN2KOver0183(msg)
+}
+global.parsePDGY = (pdgy) => {
+  if ( !pdgy.startsWith('!PDGY') ) {
+    return
+  }
+  return parser.parsePDGY(pdgy)
+}
+
 //global.toPgn: require('./lib/toPgn').toPgn,
 
 //console.log(global.parseYDGW02('06:06:39.801 R 09F10DCC 00 FF FF 7F FF 7F FF FF'))

package/lib/canbus.js

@@ -120,7 +120,7 @@ function CanbusStream (options) {
     })
   } else {
     try {
-      this.channel = socketcan.createRawChannel(canDevice);
+      this.channel = socketcan.createRawChannelWithOptions(canDevice, { non_block_send: true} );
       this.channel.addListener('onMessage', (msg) => {
         var pgn = parseCanId(msg.id)
 

package/lib/candevice.js

@@ -177,7 +177,7 @@ function handleGroupFunction(device, n2kMsg) {
       const acknowledgement = {
         pgn: 126208,
         dst: n2kMsg.src,
-        "Function Code": 1,
+        "Function Code": 2,
         "PGN": n2kMsg.fields.PGN,
         "PGN error code": 4,
         "Transmission interval/Priority error code": 0,
@@ -195,7 +195,7 @@ function handleGroupFunction(device, n2kMsg) {
       const acknowledgement = {
         pgn: 126208,
         dst: n2kMsg.src,
-        "Function Code": 1,
+        "Function Code": 2,
         "PGN": n2kMsg.fields.PGN,
         "PGN error code": 4,
       "Transmission interval/Priority error code": 0,

package/lib/codes.test.js

@@ -4,6 +4,7 @@ describe('getManufacturerCode', () => {
   test('Return mfg number from name string', () => {
     expect(getManufacturerCode('Furuno')).toBe(1855)
     expect(getManufacturerCode('Yacht Devices')).toBe(717)
+    expect(getManufacturerCode('TJC Micro')).toBe(963)
   })
 })
 
@@ -11,5 +12,6 @@ describe('getManufacturerName', () => {
   test('Return name string from mfg number', () => {
     expect(getManufacturerName(1855)).toBe('Furuno')
     expect(getManufacturerName(717)).toBe('Yacht Devices')
+    expect(getManufacturerName(963)).toBe('TJC Micro')
   })
 })

package/lib/codesMfgs.json

@@ -136,6 +136,7 @@
   "Teleflex Marine (SeaStar Solutions)": 1850,
   "Thrane and Thrane": 351,
   "Tides Marine": 797,
+  "TJC Micro": 963,
   "Tohatsu Co, JP": 431,
   "Transas USA": 518,
   "Trimble": 1856,

package/lib/fromPgn.js

@@ -19,7 +19,7 @@ const trace = require('debug')('canboatjs:fromPgn:trace')
 const EventEmitter = require('events')
 const pkg = require('../package.json')
 const _ = require('lodash')
-const { pgns } = require('./pgns')
+const { pgns, getCustomPgn, addCustomPgn } = require('./pgns')
 const BitStream = require('bit-buffer').BitStream
 const BitView = require('bit-buffer').BitView
 const Int64LE = require('int64-buffer').Int64LE
@@ -29,7 +29,7 @@ const { parse: parseDate } = require('date-fns')
 const { getPGNFromCanId } = require('./utilities')
 const { getIndustryName, getManufacturerName } = require('./codes')
 const { parseCanId } = require('./canId')
-const { parseN2kString, parseYDRAW, isN2KOver0183, parseN2KOver0183 } = require('./stringMsg')
+const { parseN2kString, parseYDRAW, isN2KOver0183, parseN2KOver0183, parsePDGY } = require('./stringMsg')
 
 var fieldTypeReaders = {}
 var fieldTypePostProcessors = {}
@@ -66,6 +66,19 @@ class Parser extends EventEmitter {
     this.format = _.isUndefined(this.options.format) ? -1 : this.options.format
     this.devices = {}
     this.mixedFormat = this.options.mixedFormat || false
+
+    if ( this.options.onPropertyValues ) {
+      this.options.onPropertyValues('canboat-custom-pgns', values => {
+        values.filter(v => v != null).forEach(pv => {
+          pv.value.PGNs.forEach(pgn => {
+            if ( !addCustomPgn(pgn, pv.value.callback) ) {
+              this.emit('warning', pgn, `pgn ${pgn.PGN} can't be overwritten`)
+            }
+            debug('registered custom pgn %d by %s', pgn.PGN, pv.setter)
+          })
+        })
+      })
+    }
   }
 
   _parse(pgn, bs, len, coalesced, cb, sourceString) {
@@ -74,12 +87,18 @@ class Parser extends EventEmitter {
       return  undefined
     }
 
+    const customPgns = getCustomPgn(pgn.pgn)
     let pgnList = pgns[pgn.pgn]
-    if (!pgnList) {
+
+    if (!pgnList && !customPgns ) {
       this.emit('warning', pgn, `no conversion found for pgn ${JSON.stringify(pgn)}`)
       return undefined
     }
 
+    if ( customPgns ) {
+      pgnList = [ ...customPgns.definitions, ...(pgnList||[]) ]
+    }
+
     let pgnData = pgnList[0]
     let couldBeMulti = false;
 
@@ -92,14 +111,13 @@ class Parser extends EventEmitter {
     }
 
     trace(`${pgn.pgn} ${len} ${pgnData.Length} ${pgnData.RepeatingFields} ${couldBeMulti}`)
-    if ( len > 0x8 || (this.format == FORMAT_FAST && !this.mixedFormat) ) {
-    //if ( (len > 0x8 || pgnData.Type === 'Fast') && coalesced ) {
+    if ( coalesced || len > 0x8 || (this.format == FORMAT_FAST && !this.mixedFormat) ) {
       this.format = FORMAT_FAST
       if ( sourceString ) {
         pgn.input = [ sourceString ]
       }
-    } else if ( pgnData.Length > 0x8 || (len == 0x8 && (pgnData.RepeatingFields || couldBeMulti))) {
-    //} else if ( pgnData.Type === 'Fast' ) {
+    //} else if ( pgnData.Length > 0x8 || (len == 0x8 && (pgnData.RepeatingFields || couldBeMulti))) {
+    } else if ( pgnData.Type === 'Fast' ) {
       //partial packet
       this.format = FORMAT_PLAIN
 
@@ -133,13 +151,10 @@ class Parser extends EventEmitter {
             packet.buffer.copy(newBuf)
           }
           packet.buffer = newBuf
-        }
+       }
         bs.view.buffer.copy(packet.buffer, 0, FASTPACKET_BUCKET_0_OFFSET, 8)
         trace(`${pgn.pgn} targetStart: 0 sourceStart: ${FASTPACKET_BUCKET_0_OFFSET}`)
       } else {
-        if ( sourceString ) {
-          packet.src.push(sourceString)
-        }
         if (packet.lastPacket + 1 != packetIndex) {
           debug(`PGN ${pgn.pgn} malformed packet for ${pgn.src} received; expected ${packet.lastPacket+1} but got ${packetIndex}`)
           cb && cb(`Could not parse ${JSON.stringify(pgn)}`)
@@ -189,7 +204,11 @@ class Parser extends EventEmitter {
           if ( pgnList.length == 0 ) {
             //this.emit('warning', pgn, `no conversion found for pgn`)
             trace('warning no conversion found for pgn %j', pgn)
-            return
+            const ts = _.get(pgn, 'timestamp', new Date())
+            pgn.timestamp = _.isDate(ts) ? ts.toISOString() : ts
+            this.emit('pgn', pgn)
+            cb && cb(undefined, pgn)
+            return pgn
           }
           pgnData = pgnList[0]
           fields = pgnData.Fields
@@ -230,6 +249,9 @@ class Parser extends EventEmitter {
       pgn.timestamp = _.isDate(ts) ? ts.toISOString() : ts
       this.emit('pgn', pgn)
       cb && cb(undefined, pgn)
+      if ( pgnData.callback ) {
+        pgnData.callback(pgn)
+      }
       return pgn
     } catch ( error ) {
       this.emit('error', pgn, error)
@@ -326,6 +348,33 @@ class Parser extends EventEmitter {
     return undefined
   }
 
+  parsePDGY(pgn_data, cb) {
+    if ( pgn_data[0] != '!') {
+      return
+    }
+    try {
+      const { coalesced, data, error, len, ...pgn } = parsePDGY(pgn_data)
+      if (error) {
+        cb && cb(error)
+        this.emit('error', pgn, error)
+        return
+      }
+      
+      const bs = new BitStream(data)
+      delete pgn.format
+      delete pgn.type
+      delete pgn.prefix
+      const res = this._parse(pgn, bs, len || data.length, coalesced, cb, pgn_data)
+      if (res) {
+        debug('parsed pgn %j', pgn)
+      }
+      return res
+    } catch ( error ) {
+      cb && cb(error)
+      this.emit('error', pgn_data, error)
+    }
+  }
+
   parseString (pgn_data, cb) {
     try {
       const { coalesced, data, error, len, ...pgn } = parseN2kString(pgn_data)
@@ -467,17 +516,26 @@ function readField(options, runPostProcessor, pgn, field, bs) {
       if ( field.Resolution && typeof value === 'number' ) {
         var resolution = field.Resolution
 
+        if ( _.isString(resolution) ) {
+          resolution = Number.parseFloat(resolution)
+        }
+
         value = (value * resolution)
+        
+        let precision = 0;
+        for (let r = resolution; (r > 0.0) && (r < 1.0); r = r * 10.0)
+        {
+          precision++;
+        }
+        
+        value = Number.parseFloat(value.toFixed(precision))
 
+        /*
         if ( resolution === 3.125e-8 ) {
           //yes. hack.
           resolution = "0.0000000001"
         }
-
-        if ( _.isString(resolution) &&
-             resolution.indexOf('.') != -1 ) {
-          value = Number.parseFloat(value.toFixed(resolution.length-2))
-        }
+        */
       }
 
       if (field.EnumValues &&
@@ -655,7 +713,9 @@ fieldTypeReaders['ASCII string starting with length byte'] = (pgn, field, bs) =>
 fieldTypeReaders["String with start/stop byte"] = (pgn, field, bs) => {
   var len
   var first = bs.readUint8()
-  if ( first == 0x02 ) {
+  if ( first == 0xff ) { // no name, stop reading
+    return ''
+  } else if ( first == 0x02 ) {
     var buf = Buffer.alloc(255)
     var c
     var idx = 0

package/lib/ikonvert.js

@@ -82,6 +82,7 @@ function iKonvertStream (options) {
     })
 
     this.isSetup = false
+    //this.cansend = true
     this.state = 0
     this.setupCommands = this.getSetupCommands()
     this.expecting = false
@@ -116,7 +117,7 @@ iKonvertStream.prototype.sendPGN = function (pgn) {
 iKonvertStream.prototype.sendActisensePGN = function (msg) {
   if ( this.cansend ) {
     if ( !this.parser ) {
-      this.parser = new Parser()
+      this.parser = new Parser(this.options)
 
       let that = this
       this.parser.on('error', (pgn, error) => {

package/lib/pgns.js

@@ -2,6 +2,7 @@ const { flow, first, isArray, isEmpty, propertyOf } = require('lodash/fp')
 const pgns = require('@canboat/pgns')
 const pgnsIK = require('@canboat/pgns/pgns-ik')
 const pgnsNGT = require('@canboat/pgns/pgns-ngt')
+const _ = require('lodash')
 
 function organizePGNs() {
   const res = {}
@@ -36,9 +37,30 @@ function organizePGNs() {
 
 const organizedPGNs = organizePGNs()
 const getPgn = pgn => organizedPGNs[pgn]
+const customPgns = {}
 
 module.exports = {
   getPgn,
   getPgn0: flow(getPgn, first),
   pgns: organizedPGNs,
+  addCustomPgn: (pgn) => {
+    if ( !customPgns[pgn.PGN] ) {
+      customPgns[pgn.PGN] = {
+        definitions: [],
+        callbacks: []
+      }
+    }
+    
+    customPgns[pgn.PGN].definitions.push(pgn)
+    /*
+    if ( pgn.calllback ) {
+      customPgns[pgn.PGN].callbacks.push()
+    }
+    */
+    
+    return customPgns[pgn.PGN]
+  },
+  getCustomPgn: (pgnNum) => {
+    return customPgns[pgnNum]
+  }
 }

package/lib/simpleCan.js

@@ -27,9 +27,9 @@ SimpleCan.prototype.start = function () {
       
       pgn.timestamp = new Date().toISOString()
       if ( this.plainText ) {
-        messageCb(binToActisense(pgn, msg.data, msg.data.length))
+        this.messageCb(binToActisense(pgn, msg.data, msg.data.length))
       } else {
-        messageCb({ pgn, length: msg.data.length, data: msg.data })
+        this.messageCb({ pgn, length: msg.data.length, data: msg.data })
       }
     })
   }

package/lib/stringMsg.js

@@ -49,7 +49,7 @@ exports.parseActisense = (input) => {
     buildCanId(prio, pgn, dst, src),
     'Actisense',
     Buffer.from(data.join(''), 'hex'),
-    { len: Number(len), timestamp, coalesced: true },
+    { len: Number(len), timestamp },
   )
 }
 exports.encodeActisense = ({
@@ -153,12 +153,21 @@ exports.encodeMXPGN = ({ prefix = '$MXPGN', pgn, prio, src, data }) => {
 exports.isPDGY = startsWith('!PDGY,')
 exports.parsePDGY = (input) => {
   const parts = input.split(',')
-  if ( parts.length != 7 ) return buildErr('iKonvert', 'Invalid parts.', input)
-  const [ prefix, pgn, prio, src, dst, timer, data ] = parts
-  return buildMsg(
-    buildCanId(prio, pgn, dst, src), 'PDGY', Buffer.from(data, 'base64'),
-    { timer: Number(timer), prefix },
-  )
+  if ( parts.length === 7 ) {
+    const [ prefix, pgn, prio, src, dst, timer, data ] = parts
+    return buildMsg(
+      buildCanId(prio, pgn, dst, src), 'PDGY', Buffer.from(data, 'base64'),
+      { timer: Number(timer), prefix, coalesced: true },
+    )
+  } else if ( parts.length === 4 ) {
+    const [ prefix, pgn, dst, data ] = parts
+    return buildMsg(
+      buildCanId(0, pgn, dst, 0), 'PDGY', Buffer.from(data, 'base64'),
+      { coalesced: true }
+    )
+  } else {
+    return buildErr('iKonvert', 'Invalid parts.', input)
+  }
 }
 exports.encodePDGY = ({ prefix = '!PDGY', pgn, data, dst = 255}) => (
   [ prefix, pgn, dst, data.toString('base64')].join(',')

package/lib/stringMsg.test.js

@@ -65,7 +65,6 @@ describe('parseActisense', () => {
   test('basic msg', () => {
     const msg = '2016-04-09T16:41:09.078Z,3,127257,17,255,8,00,ff,7f,52,00,21,fe,ff'
     expect(parseActisense(msg)).toEqual({
-      coalesced: true,
       data: Buffer.from('00ff7f520021feff', 'hex'),
       dst: 255,
       len: 8,
@@ -99,6 +98,7 @@ describe('parsePDGY', () => {
       prio: 3,
       src: 2,
       timer: 0.563,
+      coalesced: true
     })
   })
   test('long msg', () => {
@@ -111,6 +111,7 @@ describe('parsePDGY', () => {
       prio: 3,
       src: 2,
       timer: 483.236,
+      coalesced: true
     })
   })
 })

package/lib/toPgn.js

@@ -15,13 +15,13 @@
  */
 
 const { getField } = require('./fromPgn')
-const { pgns } = require('./pgns')
+const { pgns, getCustomPgn } = require('./pgns')
 const _ = require('lodash')
 const BitStream = require('bit-buffer').BitStream
 const Int64LE = require('int64-buffer').Int64LE
 const Uint64LE = require('int64-buffer').Uint64LE
 const { getPlainPGNs } = require('./utilities')
-const { encodeActisense, encodeYDRAW, parseActisense, encodePCDIN, encodeMXPGN } = require('./stringMsg')
+const { encodeActisense, encodeYDRAW, parseActisense, encodePCDIN, encodeMXPGN, encodePDGY } = require('./stringMsg')
 const { encodeCanId } = require('./canId')
 const { getIndustryCode, getManufacturerCode } = require('./codes')
 const debug = require('debug')('canboatjs:toPgn')
@@ -35,12 +35,17 @@ var fieldTypeMappers = {}
 var lengthsOff = { 129029: 45, 127257:8, 127258:8, 127251:8 }
 
 function toPgn(data) {
-  var pgnList = pgns[data.pgn]
-  if (!pgnList) {
+  const customPgns = getCustomPgn(data.pgn)
+  let pgnList = pgns[data.pgn]
+  if (!pgnList && !customPgns ) {
     debug("no pgn found: " + data.pgn)
     return
   }
-
+  
+  if ( customPgns ) {
+    pgnList = [ ...customPgns.definitions, ...(pgnList || []) ]
+  }
+  
   const pgn_number = data.pgn
   var pgnData = pgnList[0]
 
@@ -309,6 +314,7 @@ function pgnToMXPGN(info) {
 const actisenseToYdgwRawFormat = _.flow(parseActisense, encodeYDRAW)
 const actisenseToPCDIN = _.flow(parseActisense, encodePCDIN)
 const actisenseToMXPGN = _.flow(parseActisense, encodeMXPGN)
+const actisenseToiKonvert = _.flow(parseActisense, encodePDGY)
 
 fieldTypeWriters['ASCII text'] = (pgn, field, value, bs) => {
 
@@ -429,3 +435,4 @@ module.exports.pgnToPCDIN = pgnToPCDIN
 module.exports.actisenseToPCDIN = actisenseToPCDIN
 module.exports.pgnToMXPGN = pgnToMXPGN
 module.exports.actisenseToMXPGN = actisenseToMXPGN
+module.exports.actisenseToiKonvert = actisenseToiKonvert

package/lib/ydgw02.js

@@ -40,7 +40,7 @@ function Ydgw02Stream (options, type) {
   this.fromPgn = new FromPgn(options)
 
   this.fromPgn.on('warning', (pgn, warning) => {
-    debug(`[warning] ${pgn.pgn} ${warning}`)
+    //debug(`[warning] ${pgn.pgn} ${warning}`)
   })
 
   this.fromPgn.on('error', (pgn, error) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canboat/canboatjs",
-  "version": "1.20.2",
+  "version": "1.22.0",
   "description": "Native javascript version of canboat",
   "main": "index.js",
   "scripts": {
@@ -63,6 +63,8 @@
   },
   "devDependencies": {
     "@signalk/github-create-release": "^1.0.1",
+    "@signalk/server-api": "^1.39.0",
+    "baconjs": "^1.0.1",
     "chai": "^4.1.2",
     "chai-json-equal": "0.0.1",
     "chai-string": "^1.5.0",
@@ -74,7 +76,7 @@
     "webpack-cli": "^3.3.10"
   },
   "optionalDependencies": {
-    "serialport": "^7.1.5",
+    "serialport": "^9.0.7",
     "socketcan": "^2.2.2"
   },
   "repository": {