@canboat/canboatjs 3.2.4 → 3.3.1

package/lib/bin/candumpjs.ts

@@ -8,18 +8,25 @@ import { binToActisense } from '../utilities'
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const socketcan = require('socketcan')
 
-const parser = new FromPgn()
-
 const argv = minimist(process.argv.slice(2), {
-  alias: { h: 'help' }
+  alias: {
+    h: 'help',
+    boolean: ['n', 'r', 'camel', 'camel-compat', 'show-non-matches']
+  }
 })
 
 if (argv['help']) {
   console.error(`Usage: ${process.argv[0]} [options] candevice
 
 Options:
-  --format <format>    json, actisense
-  -h, --help           output usage information`)
+  --format <format>   json, actisense
+  -c                  don't check for invalid values
+  -n                  output null values
+  -r                  parse $MXPGN as little endian
+  --camel             output field names in camelCase
+  --camel-compat      output field names in camelCase and regular
+  --show-non-matches  show pgn data without any matches
+  -h, --help          output usage information`)
   process.exit(1)
 }
 
@@ -28,6 +35,15 @@ if (argv['_'].length === 0) {
   process.exit(1)
 }
 
+const parser = new FromPgn({
+  returnNulls: argv['n'] === true,
+  littleEndianMXPGN: argv['r'] === true,
+  checkForInvalidFields: argv['c'] !== true,
+  useCamel: argv['camel'],
+  useCamelCompat: argv['camel-compat'],
+  returnNonMatches: argv['show-non-matches']
+})
+
 const format = argv['format'] || 'json'
 
 /*

package/lib/fromPgn.ts

@@ -16,13 +16,7 @@
 
 // FIXME: MMSI sould be a string
 
-import {
-  Definition,
-  Field,
-  PGN,
-  FieldType,
-  getPGNClass
-} from '@canboat/ts-pgns'
+import { Definition, Field, PGN, FieldType, createPGN } from '@canboat/ts-pgns'
 import { createDebug } from './utilities'
 import { EventEmitter } from 'node:events'
 import pkg from '../package.json'
@@ -101,6 +95,10 @@ export class Parser extends EventEmitter {
       this.options.useCamelCompat = false
     }
 
+    if (this.options.returnNonMatches === undefined) {
+      this.options.returnNonMatches = false
+    }
+
     this.name = pkg.name
     this.version = pkg.version
     this.author = pkg.author
@@ -162,7 +160,6 @@ export class Parser extends EventEmitter {
     }
 
     let pgnData: Definition | undefined
-    const origPGNList = pgnList
 
     if (pgnList.length > 1) {
       pgnData = this.findMatchPgn(pgnList)
@@ -294,6 +291,7 @@ export class Parser extends EventEmitter {
     try {
       let fields = pgnData.Fields
 
+      let continueReading = true
       for (let i = 0; i < fields.length - RepeatingFields; i++) {
         const field = fields[i]
         const hasMatch = field.Match !== undefined
@@ -305,30 +303,13 @@ export class Parser extends EventEmitter {
           //console.log(JSON.stringify(pgnList, null, 2))
           pgnList = pgnList.filter((f) => f.Fields[i].Match == value)
           if (pgnList.length == 0) {
-            //this.emit('warning', pgn, `no conversion found for pgn`)
-            trace('warning no conversion found for pgn %j', pgn)
-
-            const nonMatch = this.findNonMatchPgn(origPGNList)
-            if (nonMatch) {
-              pgnList = [nonMatch]
-              pgnData = pgnList[0]
-              fields = pgnData.Fields
-              const postProcessor = fieldTypePostProcessors[field.FieldType]
-              if (postProcessor) {
-                value = postProcessor(pgnData.Fields[i], value)
-              }
+            if (this.options.returnNonMatches) {
+              //this.emit('warning', pgn, `no conversion found for pgn`)
+              trace('warning no conversion found for pgn %j', pgn)
+              continueReading = false
+              break
             } else {
-              const ts = _.get(pgn, 'timestamp', new Date())
-              pgn.timestamp = _.isDate(ts) ? ts.toISOString() : ts
-              if (
-                value === undefined &&
-                (value != null || this.options.returnNulls)
-              ) {
-                this.setField(pgn.fields, field, value)
-              }
-              this.emit('pgn', pgn)
-              cb && cb(undefined, pgn)
-              return pgn
+              return undefined
             }
           } else {
             pgnData = pgnList[0]
@@ -351,7 +332,7 @@ export class Parser extends EventEmitter {
           this.setField(pgn.fields, field, value)
         }
       }
-      if (RepeatingFields > 0) {
+      if (RepeatingFields > 0 && continueReading) {
         const repeating: Field[] = (fields as any).slice(
           fields.length - RepeatingFields
         )
@@ -399,24 +380,22 @@ export class Parser extends EventEmitter {
         }
       */
 
-      const cf = getPGNClass(pgnData.Id)
+      const res = createPGN(pgnData.Id, pgn.fields)
 
-      if (cf === undefined) {
+      if (res === undefined) {
         this.emit('error', pgn, 'no class')
         cb && cb('no class', undefined)
         return
       }
 
-      const res = cf(pgn.fields)
-
       res.description = pgnData.Description
       res.src = pgn.src
       res.dst = pgn.dst
       res.prio = pgn.prio
-      res.canId = (pgn as any).canId
-      res.time = (pgn as any).time
-      res.timer = (pgn as any).timer
-      res.direction = (pgn as any).direction
+      ;(res as any).canId = (pgn as any).canId
+      ;(res as any).time = (pgn as any).time
+      ;(res as any).timer = (pgn as any).timer
+      ;(res as any).direction = (pgn as any).direction
 
       // Stringify timestamp because SK Server needs it that way.
       const ts = _.get(pgn, 'timestamp', new Date())
@@ -512,6 +491,7 @@ export class Parser extends EventEmitter {
     return this.parseString(sentence, cb)
   }
 
+  /*
   // Venus MQTT-N2K
   parseVenusMQTT(pgn_data: any, cb: FromPgnCallback) {
     try {
@@ -534,7 +514,8 @@ export class Parser extends EventEmitter {
       cb && cb(error, undefined)
       this.emit('error', pgn_data, error)
     }
-  }
+    }
+    */
 
   //Yacht Devices NMEA2000 Wifi gateway
   parseYDGW02(pgn_data: any, cb: FromPgnCallback) {

package/lib/pgns.ts

@@ -1,5 +1,5 @@
 import {
-  getPGN,
+  getPGNWithNumber,
   EnumBase,
   Enumeration,
   BitEnumeration,
@@ -152,7 +152,7 @@ export const lookupFieldTypeEnumerations = organizeEnumerations(
   getFieldTypeEnumerations()
 )
 export const lookupBitEnumerations = organizeEnumerations(getBitEnumerations())
-export const getPgn = getPGN
+export const getPgn = getPGNWithNumber
 export const customPgns: any = {}
 
 export const addCustomPgns = (pgns: any, setter: any) => {

package/lib/ydvr.js

@@ -18,12 +18,12 @@ var sequencePgns = new Set([
   130577, 130578, 130816
 ])
 
-function YdvrStream() {
+function YdvrStream(options) {
   if (!(this instanceof YdvrStream)) {
-    return new YdvrStream()
+    return new YdvrStream(options)
   }
 
-  this.parser = new FromPgn()
+  this.parser = new FromPgn(options)
 
   this.messageCount = 0
   this.errorCount = 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canboat/canboatjs",
-  "version": "3.2.4",
+  "version": "3.3.1",
   "description": "Native javascript version of canboat",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",
@@ -74,7 +74,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@canboat/ts-pgns": "^1.0.0",
+    "@canboat/ts-pgns": "^1.6.0",
     "bit-buffer": "0.2.3",
     "debug": "^4.3.4",
     "dnssd": "^0.4.1",