@canboat/canboatjs 2.1.1 → 2.3.0

package/bin/analyzerjs

@@ -1,9 +1,25 @@
 #!/usr/bin/env node
 
-const argv = require('minimist')(process.argv.slice(2))
+const argv = require('minimist')(process.argv.slice(2), {
+  alias: { h: 'help' },
+  boolean: ['n']
+})
+
+if ( argv['help'] ) {
+  console.error(`Usage: ${process.argv[1]} [options]
+
+Options:
+  -c                  don't check for invalid values
+  -n                  output null values
+  -h, --help          output usage information`)
+  process.exit(1)
+}
 
 const Parser = require('../index').FromPgn
-var parser = new Parser()
+var parser = new Parser( {
+  returnNulls: argv['n'] === true,
+  checkForInvalidFields: argv['n']
+})
 
 parser.on('error', (pgn, error) => {
   console.error(`Error parsing ${pgn.pgn} ${error}`)

package/index.js

@@ -39,7 +39,7 @@ module.exports = {
   VenusMQTT: require('./lib/venus-mqtt'),
   discover: require('./lib/discovery'),
   SimpleCan: require('./lib/simpleCan'),
-  addCustomPgn: pgns.addCustomPgn,
+  addCustomPgns: pgns.addCustomPgns,
   lookupEnumerationValue: pgns.lookupEnumerationValue,
   lookupEnumerationName: pgns.lookupEnumerationName
 }

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, getCustomPgn, addCustomPgn, lookupEnumNameForField } = require('./pgns')
+const { pgns, getCustomPgn, addCustomPgns, lookupEnumerationName, lookupBitEnumerationName } = require('./pgns')
 const BitStream = require('bit-buffer').BitStream
 const BitView = require('bit-buffer').BitView
 const Int64LE = require('int64-buffer').Int64LE
@@ -60,6 +60,10 @@ class Parser extends EventEmitter {
     super()
     this.options = _.isUndefined(opts) ? {} : opts
 
+    if ( this.options.returnNulls === undefined ) {
+      this.options.returnNulls = false
+    }
+    
     this.name = pkg.name
     this.version = pkg.version
     this.author = pkg.author
@@ -71,12 +75,7 @@ class Parser extends EventEmitter {
     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)
-          })
+          addCustomPgns(pv.value, pv.setter)
         })
       })
     }
@@ -221,7 +220,7 @@ class Parser extends EventEmitter {
               pgnList = [ nonMatch ]
               pgnData = pgnList[0]
               fields = pgnData.Fields
-              var postProcessor = fieldTypePostProcessors[field.Type]
+              var postProcessor = fieldTypePostProcessors[field.FieldType]
               if ( postProcessor ) {
                 value = postProcessor(pgnData.Fields[i], value)
               }
@@ -240,7 +239,8 @@ class Parser extends EventEmitter {
           }
         }
 
-        if ( !_.isUndefined(value) && value != null ) {
+        if ( !_.isUndefined(value) && (value != null  ||
+                                       this.options.returnNulls) ) {
           pgn.fields[field.Name] = value
         }
       }
@@ -543,29 +543,18 @@ function pad(n, p, c)
 }
 
 function lookup(field, value) {
-  var name = lookupEnumNameForField(field, value)
+  var name = lookupEnumerationName(field.LookupEnumeration, value)
   return name ? name : value
 }
 
-function lookupBitField(field, value) {
-  if (!field.value2name) {
-    field.value2name = {};
-    field.EnumBitValues.forEach(function(enumPair) {
-      var key = _.keys(enumPair)[0]
-      field.value2name[Number(key)] = enumPair[key]
-    })
-  }
-  return (field.value2name[value]);
-}
-
 function readField(options, runPostProcessor, pgn, field, bs) {
   var value
 
-  var reader = fieldTypeReaders[field.Type]
+  var reader = fieldTypeReaders[field.FieldType]
   if ( reader ) {
     value = reader(pgn, field, bs)
   } else {
-    if ( field.Type !== RES_BINARY  && bs.bitsLeft < field.BitLength ) {
+    if ( field.FieldType !== RES_BINARY  && bs.bitsLeft < field.BitLength ) {
       //no more data
       bs.readBits(bs.bitsLeft, false)
       return
@@ -576,7 +565,7 @@ function readField(options, runPostProcessor, pgn, field, bs) {
   //console.log(`${field.Name} ${value} ${field.Resolution}`)
 
   if ( value != null && !_.isUndefined(value) ) {
-    let type = field.Type //hack, missing type
+    let type = field.FieldType //hack, missing type
     var postProcessor = fieldTypePostProcessors[type]
     if ( postProcessor ) {
       if ( runPostProcessor ) {
@@ -586,7 +575,18 @@ function readField(options, runPostProcessor, pgn, field, bs) {
       if ( field.Offset ) {
         value += field.Offset
       }
-      if ( field.Resolution && typeof value === 'number' ) {
+      let max
+      if ( typeof field.RangeMax !== 'undefined'
+           && field.Resolution ) {
+        max = field.RangeMax / field.Resolution
+      }
+      if ( options.checkForInvalidFields !== false && max !== 'undefined' &&
+           field.FieldType !== 'LOOKUP' &&
+           field.BitLength > 1 &&
+           max - value <= 0 ) {
+        //console.log(`Bad field ${field.Name} ${max - value}`)
+        value = null
+      } if ( field.Resolution && typeof value === 'number' ) {
         var resolution = field.Resolution
 
         if ( _.isString(resolution) ) {
@@ -602,16 +602,10 @@ function readField(options, runPostProcessor, pgn, field, bs) {
         }
         
         value = Number.parseFloat(value.toFixed(precision))
-
-        /*
-        if ( resolution === 3.125e-8 ) {
-          //yes. hack.
-          resolution = "0.0000000001"
-        }
-        */
       }
 
-      if (field.EnumValues &&
+      if (field.FieldType === 'LOOKUP' &&
+          runPostProcessor &&
           (_.isUndefined(options.resolveEnums) ||
            options.resolveEnums)) {
         if (field.Id === "timeStamp" && value < 60) {
@@ -628,9 +622,9 @@ function readField(options, runPostProcessor, pgn, field, bs) {
         }
       }
 
-      if ( field.Units === "kWh" ) {
+      if ( field.Unit === "kWh" ) {
         value *= 3.6e6; // 1 kWh = 3.6 MJ.
-      } else if (field.Units === "Ah") {
+      } else if (field.Unit === "Ah") {
         value *= 3600.0; // 1 Ah = 3600 C.
       }
     }
@@ -643,7 +637,7 @@ function readValue(options, pgn, field, bs, bitLength) {
   if ( _.isUndefined(bitLength) ) {
     bitLength = field.BitLength
   }
-  if ( !field.Type && field.BitLengthVariable ) { ///hack for missing FieldType
+  if ( field.FieldType == 'VARIABLE' ) {
     return readVariableLengthField(options, pgn, field, bs)
   } else if (bitLength === 8) {
     if ( field.Signed ) {
@@ -713,6 +707,7 @@ function readValue(options, pgn, field, bs, bitLength) {
       }, [])
       .map(x => (x.length === 1 ? "0" + x : x))
       .join(" ")
+
     return value
   }
   
@@ -767,7 +762,10 @@ function readVariableLengthField(options, pgn, field, bs) {
   }
 }
 
-fieldTypeReaders['ASCII or UNICODE string starting with length and control byte'] = (pgn, field, bs) => {
+fieldTypeReaders[
+  'STRING_LAU'
+  //'ASCII or UNICODE string starting with length and control byte'
+] = (pgn, field, bs) => {
 
   if ( bs.bitsLeft >= 16 ) {
     const len = bs.readUint8()-2
@@ -797,7 +795,10 @@ fieldTypeReaders['ASCII or UNICODE string starting with length and control byte'
   }
 }
 
-fieldTypeReaders['ASCII string starting with length byte'] = (pgn, field, bs) => {
+fieldTypeReaders[
+  'STRING_LZ'
+  //'ASCII string starting with length byte'
+] = (pgn, field, bs) => {
   var len = bs.readUint8()
 
   var buf = Buffer.alloc(len)
@@ -842,7 +843,7 @@ fieldTypeReaders["String with start/stop byte"] = (pgn, field, bs) => {
   }
 }
 
-fieldTypeReaders['ASCII text'] = (pgn, field, bs) => {
+fieldTypeReaders['STRING_FIX'] = (pgn, field, bs) => {
   var len = field.BitLength / 8
   var buf = Buffer.alloc(len)
 
@@ -865,17 +866,19 @@ fieldTypeReaders['ASCII text'] = (pgn, field, bs) => {
   return buf.toString('ascii', 0, len)
 }
 
-fieldTypeReaders['Bitfield'] = (pgn, field, bs) => {
+fieldTypeReaders['BITLOOKUP'] = (pgn, field, bs) => {
   var value = []
   for ( var i = 0; i < field.BitLength; i++ ) {
     if ( bs.readBits(1, 0) ) {
-      value.push(lookupBitField(field, i))
+      value.push(
+        lookupBitEnumerationName(field.LookupBitEnumeration, i)
+      )
     }
   }
   return value
 }
 
-fieldTypePostProcessors['Date'] = (field, value) => {
+fieldTypePostProcessors['DATE'] = (field, value) => {
   if ( value >= 0xfffd ) {
     value = undefined
   } else {
@@ -886,7 +889,7 @@ fieldTypePostProcessors['Date'] = (field, value) => {
   return value
 }
 
-fieldTypePostProcessors['Time'] = (field, value) => {
+fieldTypePostProcessors['TIME'] = (field, value) => {
   if (value >= 0xfffffffd) {
     value = undefined
   } else {
@@ -906,9 +909,9 @@ fieldTypePostProcessors['Time'] = (field, value) => {
 }
 
 fieldTypePostProcessors['Pressure'] = (field, value) => {
-  if (field.Units)
+  if (field.Unit)
   {
-    switch (field.Units[0]) {
+    switch (field.Unit[0]) {
     case 'h':
     case 'H':
       value *= 100;
@@ -929,10 +932,12 @@ fieldTypePostProcessors[RES_BINARY] = (field, value) => {
   return value.toString()
 }
 
+/*
 fieldTypePostProcessors['Manufacturer code'] = (field, value) => {
   var manufacturer = getManufacturerName(value)
   return manufacturer ? manufacturer : value
-}
+  }
+  */
 
 module.exports = {
   Parser: Parser,

package/lib/pgns.js

@@ -1,8 +1,9 @@
 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 pgnsIK = { PGNs: [] } //require('@canboat/pgns/pgns-ik')
+const pgnsNGT = { PGNs: [] } //require('@canboat/pgns/pgns-ngt')
 const _ = require('lodash')
+const debug = require('debug')('canboatjs:pgns')
 
 function organizePGNs() {
   const res = {}
@@ -35,10 +36,6 @@ function organizePGNs() {
   return res
 }
 
-function getField(pgn, name) {
-  return pgn.Fields.find(f => f.Name === name)
-}
-
 function getEnumeration(name) {
   const enumeration = lookupEnumerations[name]
   if ( enumeration ) {
@@ -57,48 +54,45 @@ function getEnumeration(name) {
   return enumeration
 }
 
+function getBitEnumeration(name) {
+  const enumeration = lookupBitEnumerations[name]
+  if ( enumeration ) {
+    if ( !enumeration.value2name ) {
+      enumeration.value2name = {}
+      enumeration.EnumBitValues.forEach((enumPair) => {
+        enumeration.value2name[Number(enumPair.Bit)] = enumPair.Name
+      })
+      
+      enumeration.name2value = {}
+      enumeration.EnumBitValues.forEach((enumPair) => {
+        enumeration.name2value[enumPair.Name] = Number(enumPair.Bit)
+      })
+    }
+  }
+  return enumeration
+}
+
 function lookupEnumerationName(enumName, value) {
   const enumeration = getEnumeration(enumName)
-  return enumeration.value2name[value]
+  return enumeration && enumeration.value2name[value]
 }
 
 function lookupEnumerationValue(enumName, name) {
   const enumeration = getEnumeration(enumName)
-  return enumeration.name2value[name]
+  return enumeration && enumeration.name2value[name]
 }
 
-function getValue2Name(field) {
-  if (!field.value2name && field.EnumValues) {
-    field.value2name = {};
-    field.EnumValues.forEach(function(enumPair) {
-      field.value2name[Number(enumPair.value)] = enumPair.name
-    })
-  }
-  return field.value2name
+function lookupBitEnumerationName(enumName, value) {
+  const enumeration = getBitEnumeration(enumName)
+  return enumeration && enumeration.value2name[value]
 }
 
-function getName2Value(field) {
-  if (!field.name2value && field.EnumValues) {
-    field.name2value = {};
-    field.EnumValues.forEach(function(enumPair) {
-      field.name2value[enumPair.name] = Number(enumPair.value)
-    })
-  }
-  return field.name2value
-}
-
-function lookupEnumNameForField(field, value) {
-  let value2name = getValue2Name(field)
-  return value2name && value2name[value]
-}
-
-function lookupEnumValueForField(field, stringValue) {
-  let name2value = getName2Value(field)
-  return name2value && name2value[stringValue]
+function lookupBitEnumerationValue(enumName, name) {
+  const enumeration = getBitEnumeration(enumName)
+  return enumeration.name2value[name]
 }
 
-function organizeEnumerations() {
-  let enums = require('@canboat/pgns/canboat').LookupEnumerations
+function organizeEnumerations(enums) {
   let map = {}
   enums.forEach(e => {
     map[e.Name] = e
@@ -106,7 +100,8 @@ function organizeEnumerations() {
   return map
 }
 
-const lookupEnumerations = organizeEnumerations()
+const lookupEnumerations = organizeEnumerations(pgns.LookupEnumerations)
+const lookupBitEnumerations = organizeEnumerations(pgns.LookupBitEnumerations)
 const organizedPGNs = organizePGNs()
 const getPgn = pgn => organizedPGNs[pgn]
 const getPgn0 = flow(getPgn, first)
@@ -116,26 +111,39 @@ module.exports = {
   getPgn,
   getPgn0,
   pgns: organizedPGNs,
-  lookupEnumValueForField,
-  lookupEnumNameForField,
   lookupEnumerationName,
   lookupEnumerationValue,
-  addCustomPgn: (pgn) => {
-    if ( !customPgns[pgn.PGN] ) {
-      customPgns[pgn.PGN] = {
-        definitions: [],
-        callbacks: []
+  lookupBitEnumerationName,
+  lookupBitEnumerationValue,
+  addCustomPgns: (pgns, setter) => {
+    pgns.PGNs.forEach(pgn => {
+      if ( !customPgns[pgn.PGN] ) {
+        customPgns[pgn.PGN] = {
+          definitions: [],
+          callbacks: []
+        }
       }
+      
+      customPgns[pgn.PGN].definitions.push(pgn)
+      
+      /*
+        if ( pgn.calllback ) {
+        customPgns[pgn.PGN].callbacks.push()
+        }
+      */        
+      
+      debug('registered custom pgn %d by %s', pgn.PGN, setter)
+    })
+
+    if ( pgns.LookupEnumerations ) {
+      pgns.LookupEnumerations.forEach(e => {
+        if ( !lookupEnumerations[e.Name] ) {
+          lookupEnumerations[e.Name] = e
+        } else {
+          debug(`enumeration ${e.Name} already exists`)
+        }
+      })
     }
-    
-    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/toPgn.js

@@ -15,7 +15,7 @@
  */
 
 const { getField } = require('./fromPgn')
-const { pgns, getCustomPgn, lookupEnumValueForField } = require('./pgns')
+const { pgns, getCustomPgn, lookupEnumerationValue, lookupBitEnumerationName } = require('./pgns')
 const _ = require('lodash')
 const BitStream = require('bit-buffer').BitStream
 const Int64LE = require('int64-buffer').Int64LE
@@ -27,8 +27,8 @@ const { encodeCanId } = require('./canId')
 const { getIndustryCode, getManufacturerCode } = require('./codes')
 const debug = require('debug')('canboatjs:toPgn')
 
-const RES_STRINGLAU = 'ASCII or UNICODE string starting with length and control byte'
-const RES_STRINGLZ = 'ASCII string starting with length byte'
+const RES_STRINGLAU = 'STRING_LAU' //'ASCII or UNICODE string starting with length and control byte'
+const RES_STRINGLZ = 'STRING_LZ' //'ASCII string starting with length byte'
 
 
 var fieldTypeWriters = {}
@@ -117,8 +117,8 @@ function toPgn(data) {
   }
 
   if ( pgnData.Length != 0xff
-       && fields[fields.length-1].Type != RES_STRINGLAU
-       && fields[fields.length-1].Type != RES_STRINGLZ
+       && fields[fields.length-1].FieldType != RES_STRINGLAU
+       && fields[fields.length-1].FieldType != RES_STRINGLZ
        && !RepeatingFields ) {
 
     var len = lengthsOff[pgnData.PGN] || pgnData.Length
@@ -156,8 +156,8 @@ function writeField(bs, pgn_number, field, data, value, bitLength) {
 
   // console.log(`${field.Name}:${value}(${bitLength}-${field.Resolution})`)
   if ( _.isUndefined(value) || value === null) {
-    if ( field.Type && fieldTypeWriters[field.Type] ) {
-      fieldTypeWriters[field.Type](pgn_number, field, value, bs)
+    if ( field.FieldType && fieldTypeWriters[field.FieldType] ) {
+      fieldTypeWriters[field.FieldType](pgn_number, field, value, bs)
     } else if ( bitLength % 8  == 0 ) {
       var bytes = bitLength/8
       var lastByte = field.Signed ? 0x7f : 0xff
@@ -170,14 +170,14 @@ function writeField(bs, pgn_number, field, data, value, bitLength) {
       bs.writeBits(0xffffffff, bitLength)
     }
   } else {
-    let type = field.Type
+    let type = field.FieldType
     if ( field.Name === 'Industry Code' ) {
       if ( _.isString(value) ) {
         value = Number(getIndustryCode(value))
       }
     } else if ( type && fieldTypeMappers[type] ) {
       value = fieldTypeMappers[type](field, value)
-    } else if (field.EnumValues && _.isString(value)) {
+    } else if (field.FieldType === 'LOOKUP' && _.isString(value)) {
       if (!(field.Id === "timeStamp" && value < 60)) {
         value = lookup(field, value)
       }
@@ -187,23 +187,23 @@ function writeField(bs, pgn_number, field, data, value, bitLength) {
       value = Number((value / field.Resolution).toFixed(0))
     }
 
-    if ( field.Type && fieldTypeWriters[field.Type] ) {
-      fieldTypeWriters[field.Type](pgn_number, field, value, bs)
+    if ( field.FieldType && fieldTypeWriters[field.FieldType] ) {
+      fieldTypeWriters[field.FieldType](pgn_number, field, value, bs)
     } else {
       if ( _.isString(value) && typeof bitLength !== 'undefined' && bitLength !== 0 ) {
         value = Number(value)
       }
 
-      if ( field.Units === "kWh" ) {
+      if ( field.Unit === "kWh" ) {
         value /= 3.6e6; // 1 kWh = 3.6 MJ.
-      } else if (field.Units === "Ah") {
+      } else if (field.Unit === "Ah") {
         value /= 3600.0; // 1 Ah = 3600 C.
       }
       if ( field.Offset ) {
         value -= field.Offset
       }
 
-      if ( !field.Type && field.BitLengthVariable ) { 
+      if ( field.FieldType === 'VARIABLE' ) { 
         writeVariableLengthField(bs, pgn_number, data, field, value)
       } else if ( _.isBuffer(value) ) {
         value.copy(bs.view.buffer, bs.byteIndex)
@@ -270,7 +270,7 @@ function writeVariableLengthField(bs, pgn_number, pgn, field, value) {
 }
 
 function lookup(field, stringValue) {
-  var res = lookupEnumValueForField(field, stringValue)
+  var res = lookupEnumerationValue(field.LookupEnumeration, stringValue)
   return _.isUndefined(res) ? stringValue : res
 }
 
@@ -326,17 +326,10 @@ const actisenseToN2KAsciiFormat = _.flow(parseActisense, encodeActisenseN2KACSII
 const actisenseToN2KActisenseFormat = _.flow(parseActisense, encodeN2KActisense)
 
 function bitIsSet(field, index, value) {
-  if (!field.value2name) {
-    field.value2name = {};
-    field.EnumBitValues.forEach(function(enumPair) {
-      var key = _.keys(enumPair)[0]
-      field.value2name[Number(key)] = enumPair[key]
-    })
-  }
-  return value.indexOf(field.value2name[index]) != -1
+  return value.indexOf(lookupBitEnumerationName(field.LookupBitEnumeration, index)) != -1
 }
 
-fieldTypeWriters['Bitfield'] = (pgn, field, value, bs) => {
+fieldTypeWriters['BITLOOKUP'] = (pgn, field, value, bs) => {
   if ( _.isUndefined(value) || value.length === 0 ) {
     if ( field.BitLength % 8  == 0 ) {
       var bytes = field.BitLength/8
@@ -355,7 +348,7 @@ fieldTypeWriters['Bitfield'] = (pgn, field, value, bs) => {
   }
 }
 
-fieldTypeWriters['ASCII text'] = (pgn, field, value, bs) => {
+fieldTypeWriters['STRING_FIX'] = (pgn, field, value, bs) => {
 
   let fill = 0xff
   if ( (pgn === 129810 && (field.Name === "Vendor ID" || field.Name === "Callsign")) || (pgn === 129809 && field.Name === 'Name') ) {
@@ -422,7 +415,7 @@ fieldTypeWriters[RES_STRINGLAU] = (pgn, field, value, bs) => {
   }
 }
 
-fieldTypeMappers['Date'] = (field, value) => {
+fieldTypeMappers['DATE'] = (field, value) => {
   //console.log(`Date: ${value}`)
   if ( _.isString(value) ) {
     var date = new Date(value)
@@ -432,7 +425,7 @@ fieldTypeMappers['Date'] = (field, value) => {
   return value
 }
 
-fieldTypeMappers['Time'] = (field, value) => {
+fieldTypeMappers['TIME'] = (field, value) => {
   if ( _.isString(value) ) {
     var split = value.split(':')
 
@@ -445,18 +438,19 @@ fieldTypeMappers['Time'] = (field, value) => {
   return value
 }
 
-
+/*
 fieldTypeMappers['Manufacturer code'] = (field, value) => {
   if ( _.isString(value) ) {
     value = getManufacturerCode(value)
   }
   return Number(value)
-}
+  }
+*/
 
 fieldTypeMappers['Pressure'] = (field, value) => {
-  if (field.Units)
+  if (field.Unit)
   {
-    switch (field.Units[0]) {
+    switch (field.Unit[0]) {
     case 'h':
     case 'H':
       value /= 100;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canboat/canboatjs",
-  "version": "2.1.1",
+  "version": "2.3.0",
   "description": "Native javascript version of canboat",
   "main": "index.js",
   "scripts": {
@@ -53,7 +53,7 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@canboat/pgns": "2.x.x",
+    "@canboat/pgns": "3.x.x",
     "bit-buffer": "0.2.3",
     "date-fns": "2.0.0-alpha.27",
     "debug": "^4.3.4",