@canboat/canboatjs 2.6.0 → 2.8.0

package/bin/analyzerjs

@@ -2,7 +2,8 @@
 
 const argv = require('minimist')(process.argv.slice(2), {
   alias: { h: 'help' },
-  boolean: ['n']
+  boolean: ['n'],
+  boolean: ['r']
 })
 
 if ( argv['help'] ) {
@@ -11,6 +12,7 @@ if ( argv['help'] ) {
 Options:
   -c                  don't check for invalid values
   -n                  output null values
+  -r                  parse $MXPGN as little endian
   -h, --help          output usage information`)
   process.exit(1)
 }
@@ -18,6 +20,7 @@ Options:
 const Parser = require('../index').FromPgn
 var parser = new Parser( {
   returnNulls: argv['n'] === true,
+  littleEndianMXPGN: argv['r'] === true,
   checkForInvalidFields: argv['c'] !== true
 })
 

package/lib/candevice.js

@@ -20,6 +20,13 @@ const _ = require('lodash')
 const Uint64LE = require('int64-buffer').Uint64LE
 const { defaultTransmitPGNs, getIndustryCode, getManufacturerCode, getDeviceClassCode } = require('./codes')
 const { toPgn } = require('./toPgn')
+let packageJson
+
+try
+{
+  packageJson = require('../' + 'package.json')
+} catch (ex) {
+}
 
 const deviceTransmitPGNs = [ 60928, 59904, 126996, 126464 ]
 
@@ -31,10 +38,12 @@ class CanDevice extends EventEmitter {
       this.addressClaim = options.addressClaim
       this.addressClaim.pgn = 60928
       this.addressClaim.dst = 255
+      this.addressClaim.prio = 6
     } else {
       this.addressClaim = {
         pgn: 60928,
         dst: 255,
+        prio:6,        
         "Unique Number": 1263,
         "Manufacturer Code": 999,
         "Device Function": 130,      // PC gateway
@@ -49,6 +58,8 @@ class CanDevice extends EventEmitter {
       this.addressClaim["Unique Number"] = options.uniqueNumber || Math.floor(Math.random() * Math.floor(2097151))
     }
 
+    let version = packageJson ? packageJson.version : "1.0"
+
     if ( options.productInfo ) {
       this.productInfo = options.productInfo
       this.productInfo.pgn = 126996
@@ -60,14 +71,25 @@ class CanDevice extends EventEmitter {
         "NMEA 2000 Version": 1300,
         "Product Code": 667,   // Just made up..
         "Model ID": "Signal K",
-        "Software Version Code": "1.0",
-        "Model Version": "canbusjs",
+        "Model Version": "canboatjs",
         "Model Serial Code": options.uniqueNumber ? options.uniqueNumber.toString() : "000001",
         "Certification Level": 0,
         "Load Equivalency": 1
       }
     }
 
+    this.productInfo["Software Version Code"] = version
+
+    if ( options.serverVersion && options.serverUrl ) {
+      this.configurationInfo = {
+        pgn: 126998,
+        dst: 255,
+        "Installation Description #1": options.serverUrl,
+        "Installation Description #2": options.serverDescription,
+        "Manufacturer Information": options.serverVersion
+      }
+    } 
+
     this.canbus = canbus
     this.options = _.isUndefined(options) ? {} : options
 
@@ -142,6 +164,9 @@ function handleISORequest(device, n2kMsg) {
   case 126996:  // Product Information request
     sendProductInformation(device)
     break;
+  case 126998:  // Config Information request
+    sendConfigInformation(device)
+    break;
   case 60928:   // ISO address claim request
     sendPGN(device, device.addressClaim)
     break;
@@ -290,6 +315,13 @@ function sendProductInformation(device) {
   sendPGN(device, device.productInfo)
 }
 
+function sendConfigInformation(device) {
+  if ( device.configurationInfo ) {
+    debug("Sending config info..")
+    sendPGN(device, device.configurationInfo)
+  }
+}
+
 function sendNAKAcknowledgement(device, src, requestedPGN) {
   const acknowledgement = {
     pgn: 59392,

package/lib/fromPgn.js

@@ -233,6 +233,10 @@ class Parser extends EventEmitter {
             } else {
               const ts = _.get(pgn, 'timestamp', new Date())
               pgn.timestamp = _.isDate(ts) ? ts.toISOString() : ts
+              if ( !_.isUndefined(value) && (value != null  ||
+                                       this.options.returnNulls) ) {
+                pgn.fields[field.Name] = value
+              }
               this.emit('pgn', pgn)
               cb && cb(undefined, pgn)
               return pgn
@@ -454,7 +458,7 @@ class Parser extends EventEmitter {
 
   parseString (pgn_data, cb) {
     try {
-      const { coalesced, data, error, len, ...pgn } = parseN2kString(pgn_data)
+      const { coalesced, data, error, len, ...pgn } = parseN2kString(pgn_data, this.options)
       if (error) {
         cb && cb(error)
         this.emit('error', pgn, error)

package/lib/stringMsg.js

@@ -19,13 +19,17 @@ const {
  * @param  {Object} [rest={}] Anything else to be added like len, timestamp, direction.
  * @return {Object}           All canId fields with format and data props added.
  */
-function buildMsg(canIdInfo, format, data, rest = {}) {
-  return {
-    ...canIdInfo,
+function buildMsg(_canIdInfo, format, data, rest = {}) {
+  const canIdInfo = Object.assign({}, _canIdInfo, {
     format,
-    data,
-    ...rest,
+    data
+  })
+  for (const property in rest) {
+    if (canIdInfo[property] === undefined) {
+      canIdInfo[property] = rest[property]
+    }
   }
+  return canIdInfo
 }
 function buildErrMsg(msg, input) {
   if (input && isString(input)) return `${msg} - ${input}`
@@ -41,7 +45,8 @@ function toPaddedHexString(num, len) {
 }
 
 // 2016-02-28T19:57:02.364Z,2,127250,7,255,8,ff,10,3b,ff,7f,ce,f5,fc
-exports.isActisense = input => input.charAt(10) === 'T' && input.charAt(23) === 'Z'
+exports.isActisense = input => (input.charAt(10) === 'T' && input.charAt(23) === 'Z') || (input.charAt(10) === '-' && input.charAt(23) === ',')
+
 exports.parseActisense = (input) => {
   const [ timestamp, prio, pgn, src, dst, len, ...data ] = input.split(',')
   return buildMsg(
@@ -151,12 +156,22 @@ exports.encodePCDIN = ({ prefix = '$PCDIN', pgn, data, dst = 255}) => {
   return sentence + compute0183Checksum(sentence)
 }
 
+const changeEndianness = (string) => {
+  const result = [];
+  let len = string.length - 2;
+  while (len >= 0) {
+    result.push(string.substr(len, 2));
+    len -= 2;
+  }
+  return result.join('');
+}
+
 // $MXPGN,01F801,2801,C1308AC40C5DE343*19
 exports.isMXPGN = (msg) => {
   const sentence = get0183Sentence(msg)
   return sentence.startsWith('$MXPGN,')
 }
-exports.parseMXPGN = (input) => {
+exports.parseMXPGN = (input, options) => {
   const sentence = get0183Sentence(input)
   const [ prefix, pgn, attr_word, data ] = sentence.split(',')
 
@@ -167,11 +182,18 @@ exports.parseMXPGN = (input) => {
   const len = parseInt(send_prio_len.substr(4,4), 2);
   let src, dst;
   send ? dst = addr: src = addr;
+
+  let reversed
+
+  if ( options && options.littleEndianMXPGN )
+    reversed = changeEndianness(rmChecksum(data))
+  else
+    reversed = data
   
   return buildMsg(
     buildCanId(0, parseInt(pgn, 16), 255, parseInt(src, 16)),
     'MXPGN',
-    Buffer.from(rmChecksum(data), 'hex'),
+    Buffer.from(reversed, 'hex'),
     { coalesced: true, prefix },
   )
 }

package/lib/toPgn.js

@@ -54,19 +54,6 @@ function toPgn(data) {
   const pgn_number = data.pgn
   var pgnData = pgnList[0]
 
-  if ( pgnList.length > 1 && data['Manufacturer Code'] ) {
-    pgnData = pgnList.find(pgn => {
-      let mc = pgn.Fields.find(field => (field.Name === 'Manufacturer Code'))
-      //console.log(`mc ${JSON.stringify(mc)}`)
-      return mc && mc.Match && mc.Match == data['Manufacturer Code']
-    })
-    if ( !pgnData )
-    {
-      debug("no pgn found: " + data.pgn)
-      return undefined
-    }
-  }
-  
   var bs = new BitStream(Buffer.alloc(500))
 
   if ( data.fields ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canboat/canboatjs",
-  "version": "2.6.0",
+  "version": "2.8.0",
   "description": "Native javascript version of canboat",
   "main": "index.js",
   "scripts": {
@@ -55,7 +55,7 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@canboat/pgns": "3.x.x",
+    "@canboat/pgns": "5.1.x",
     "bit-buffer": "0.2.3",
     "debug": "^4.3.4",
     "dnssd": "^0.4.1",