@canboat/canboatjs 3.1.0 → 3.2.3

package/lib/n2kDevice.ts

@@ -18,13 +18,17 @@ import {
   PGN,
   PGN_60928,
   PGN_59904,
+  PGN_59904Defaults,
   PGN_126208,
   PGN_126208_Acknowledge,
+  PGN_126208_AcknowledgeDefaults,
   PGN_126208_Command,
   PGN_126996,
   PGN_126993,
   PGN_59392,
+  PGN_59392Defaults,
   PGN_126464,
+  PGN_126464Defaults,
   PgnListFunction,
   GroupFunction,
   PgnErrorCode,
@@ -32,15 +36,14 @@ import {
   ControllerState,
   IsoControl
 } from '@canboat/ts-pgns'
-import { createDebug } from './utilities'
 import { EventEmitter } from 'node:events'
 import _ from 'lodash'
 import { Uint64LE } from 'int64-buffer'
 import { defaultTransmitPGNs } from './codes'
 import { toPgn } from './toPgn'
 import packageJson from '../package.json'
-
-const debug = createDebug('canboatjs:n2kdevice')
+import { getPersistedData, savePersistedData } from './utilities'
+import { createDebug } from './utilities'
 
 const deviceTransmitPGNs = [60928, 59904, 126996, 126464]
 
@@ -60,10 +63,25 @@ export class N2kDevice extends EventEmitter {
   addressClaimSentAt?: number
   addressClaimChecker?: any
   heartbeatInterval?: any
+  debug: any
 
-  constructor(options: any) {
+  constructor(options: any, debugName: string) {
     super()
 
+    this.options = options === undefined ? {} : options
+    this.debug = createDebug(debugName, options)
+
+    let uniqueNumber: number
+    if (options.uniqueNumber !== undefined) {
+      uniqueNumber = options.uniqueNumber
+    } else {
+      uniqueNumber = this.getPersistedData('uniqueNumber')
+      if (uniqueNumber === undefined) {
+        uniqueNumber = Math.floor(Math.random() * Math.floor(2097151))
+        this.savePersistedData('uniqueNumber', uniqueNumber)
+      }
+    }
+
     if (options.addressClaim) {
       this.addressClaim = options.addressClaim
       this.addressClaim.pgn = 60928
@@ -74,7 +92,6 @@ export class N2kDevice extends EventEmitter {
         pgn: 60928,
         dst: 255,
         prio: 6,
-        'Unique Number': 1263,
         'Manufacturer Code': 999,
         'Device Function': 130, // PC gateway
         'Device Class': 25, // Inter/Intranetwork Device
@@ -85,8 +102,8 @@ export class N2kDevice extends EventEmitter {
         Reserved1: 1,
         Reserved2: 2
       }
-      this.addressClaim['Unique Number'] =
-        options.uniqueNumber || Math.floor(Math.random() * Math.floor(2097151))
+
+      this.addressClaim['Unique Number'] = uniqueNumber
     }
 
     const version = packageJson ? packageJson.version : '1.0'
@@ -102,10 +119,8 @@ export class N2kDevice extends EventEmitter {
         'NMEA 2000 Version': 1300,
         'Product Code': 667, // Just made up..
         'Model ID': 'Signal K',
-        'Model Version': 'canboatjs',
-        'Model Serial Code': options.uniqueNumber
-          ? options.uniqueNumber.toString()
-          : '000001',
+        'Model Version': getModelVersion(options),
+        'Model Serial Code': uniqueNumber.toString(),
         'Certification Level': 0,
         'Load Equivalency': 1
       }
@@ -123,11 +138,16 @@ export class N2kDevice extends EventEmitter {
       }
     }
 
-    this.options = _.isUndefined(options) ? {} : options
+    let address: number | undefined = undefined
+
+    address = this.getPersistedData('lastAddress')
 
-    this.address = _.isUndefined(options.preferredAddress)
-      ? 100
-      : options.preferredAddress
+    if (address === undefined) {
+      address = _.isUndefined(options.preferredAddress)
+        ? 100
+        : options.preferredAddress
+    }
+    this.address = address!
     this.cansend = false
     this.foundConflict = false
     this.heartbeatCounter = 0
@@ -156,12 +176,39 @@ export class N2kDevice extends EventEmitter {
     }, 1000)
   }
 
+  getPersistedData(key: string) {
+    try {
+      return getPersistedData(this.options, this.options.providerId, key)
+    } catch (err: any) {
+      this.debug('reading persisted data %o', err)
+      if (err.code !== 'ENOENT') {
+        console.error(err)
+        this.setError(err.message)
+      }
+    }
+  }
+
+  savePersistedData(key: string, value: any) {
+    try {
+      savePersistedData(this.options, this.options.providerId, key, value)
+    } catch (err: any) {
+      console.error(err)
+      this.setError(err.message)
+    }
+  }
+
   setStatus(msg: string) {
     if (this.options.app && this.options.app.setPluginStatus) {
       this.options.app.setProviderStatus(this.options.providerId, msg)
     }
   }
 
+  setError(msg: string) {
+    if (this.options.app && this.options.app.setPluginStatus) {
+      this.options.app.setProviderError(this.options.providerId, msg)
+    }
+  }
+
   n2kMessage(pgn: PGN) {
     if (pgn.dst == 255 || pgn.dst == this.address) {
       try {
@@ -193,8 +240,16 @@ export class N2kDevice extends EventEmitter {
   sendPGN(_pgn: PGN, _src: number | undefined = undefined) {}
 }
 
+function getModelVersion(options: any) {
+  if (options.app?.config?.getExternalHostname !== undefined) {
+    return `${options.app.config.ssl ? 'https' : 'http'}://${options.app.config.getExternalHostname()}:${options.app.config.getExternalPort()}`
+  } else {
+    return 'canboatjs'
+  }
+}
+
 function handleISORequest(device: N2kDevice, n2kMsg: PGN_59904) {
-  debug('handleISORequest %j', n2kMsg)
+  device.debug('handleISORequest %j', n2kMsg)
 
   const PGN = Number(n2kMsg.fields.pgn)
 
@@ -206,7 +261,7 @@ function handleISORequest(device: N2kDevice, n2kMsg: PGN_59904) {
       sendConfigInformation(device)
       break
     case 60928: // ISO address claim request
-      debug('sending address claim %j', device.addressClaim)
+      device.debug('sending address claim %j', device.addressClaim)
       device.sendPGN(device.addressClaim as PGN)
       break
     case 126464:
@@ -214,21 +269,21 @@ function handleISORequest(device: N2kDevice, n2kMsg: PGN_59904) {
       break
     default:
       if (!device.options.disableNAKs) {
-        debug(`Got unsupported ISO request for PGN ${PGN}. Sending NAK.`)
+        device.debug(`Got unsupported ISO request for PGN ${PGN}. Sending NAK.`)
         sendNAKAcknowledgement(device, n2kMsg.src!, PGN)
       }
   }
 }
 
 function handleGroupFunction(device: N2kDevice, n2kMsg: PGN_126208) {
-  debug('handleGroupFunction %j', n2kMsg)
+  device.debug('handleGroupFunction %j', n2kMsg)
   const functionCode = n2kMsg.fields.functionCode
   if (functionCode === 'Request') {
     handleRequestGroupFunction(device, n2kMsg)
   } else if (functionCode === 'Command') {
     handleCommandGroupFunction(device, n2kMsg)
   } else {
-    debug('Got unsupported Group Function PGN: %j', n2kMsg)
+    device.debug('Got unsupported Group Function PGN: %j', n2kMsg)
   }
 
   function handleRequestGroupFunction(device: N2kDevice, n2kMsg: PGN_126208) {
@@ -237,13 +292,13 @@ function handleGroupFunction(device: N2kDevice, n2kMsg: PGN_126208) {
 
       const PGN = n2kMsg.fields.pgn
 
-      debug(
+      device.debug(
         "Sending 'PGN Not Supported' Group Function response for requested PGN",
         PGN
       )
 
       const acknowledgement: PGN_126208_Acknowledge = {
-        pgn: 126208,
+        ...PGN_126208_AcknowledgeDefaults,
         dst: n2kMsg.src!,
         fields: {
           functionCode: GroupFunction.Acknowledge,
@@ -268,13 +323,13 @@ function handleGroupFunction(device: N2kDevice, n2kMsg: PGN_126208) {
 
       const PGN = n2kMsg.fields.pgn
 
-      debug(
+      device.debug(
         "Sending 'PGN Not Supported' Group Function response for commanded PGN",
         PGN
       )
 
       const acknowledgement: PGN_126208_Acknowledge = {
-        pgn: 126208,
+        ...PGN_126208_AcknowledgeDefaults,
         dst: n2kMsg.src!,
         fields: {
           functionCode: GroupFunction.Acknowledge,
@@ -294,7 +349,7 @@ function handleGroupFunction(device: N2kDevice, n2kMsg: PGN_126208) {
 function handleISOAddressClaim(device: N2kDevice, n2kMsg: PGN_60928) {
   if (n2kMsg.src != device.address) {
     if (!device.devices[n2kMsg.src!]) {
-      debug(`registering device ${n2kMsg.src}`)
+      device.debug(`registering device ${n2kMsg.src}`)
       device.devices[n2kMsg.src!] = { addressClaim: n2kMsg }
       if (device.cansend) {
         //sendISORequest(device, 126996, undefined, n2kMsg.src)
@@ -303,7 +358,7 @@ function handleISOAddressClaim(device: N2kDevice, n2kMsg: PGN_60928) {
     return
   }
 
-  debug('Checking ISO address claim. %j', n2kMsg)
+  device.debug('Checking ISO address claim. %j', n2kMsg)
 
   const uint64ValueFromReceivedClaim = getISOAddressClaimAsUint64(n2kMsg)
   const uint64ValueFromOurOwnClaim = getISOAddressClaimAsUint64(
@@ -311,12 +366,16 @@ function handleISOAddressClaim(device: N2kDevice, n2kMsg: PGN_60928) {
   )
 
   if (uint64ValueFromOurOwnClaim < uint64ValueFromReceivedClaim) {
-    debug(`Address conflict detected! Kept our address as ${device.address}.`)
+    device.debug(
+      `Address conflict detected! Kept our address as ${device.address}.`
+    )
     sendAddressClaim(device) // We have smaller address claim data -> we can keep our address -> re-claim it
   } else if (uint64ValueFromOurOwnClaim > uint64ValueFromReceivedClaim) {
     device.foundConflict = true
     increaseOwnAddress(device) // We have bigger address claim data -> we have to change our address
-    debug(`Address conflict detected!  trying address ${device.address}.`)
+    device.debug(
+      `Address conflict detected!  trying address ${device.address}.`
+    )
     sendAddressClaim(device)
   }
 }
@@ -332,7 +391,7 @@ function handleProductInformation(device: N2kDevice, n2kMsg: PGN_126996) {
   if (!device.devices[n2kMsg.src!]) {
     device.devices[n2kMsg.src!] = {}
   }
-  debug('got product information %j', n2kMsg)
+  device.debug('got product information %j', n2kMsg)
   device.devices[n2kMsg.src!].productInformation = n2kMsg
 }
 
@@ -361,7 +420,7 @@ function sendAddressClaim(device: N2kDevice) {
     //someone already has this address, so find a free one
     increaseOwnAddress(device)
   }
-  debug(`Sending address claim ${device.address}`)
+  device.debug(`Sending address claim ${device.address}`)
   device.sendPGN(device.addressClaim)
   device.setStatus(`Claimed address ${device.address}`)
   device.addressClaimSentAt = Date.now()
@@ -372,7 +431,10 @@ function sendAddressClaim(device: N2kDevice) {
   device.addressClaimChecker = setTimeout(() => {
     //if ( Date.now() - device.addressClaimSentAt > 1000 ) {
     //device.addressClaimChecker = null
-    debug('claimed address %d', device.address)
+    device.debug('claimed address %d', device.address)
+
+    device.savePersistedData('lastAddress', device.address)
+
     device.cansend = true
     if (!device.sentAvailable) {
       if (device.options.app) {
@@ -397,9 +459,10 @@ function sendISORequest(
   src: number | undefined = undefined,
   dst = 255
 ) {
-  debug(`Sending iso request for ${pgn} to ${dst}`)
+  device.debug(`Sending iso request for ${pgn} to ${dst}`)
 
   const isoRequest: PGN_59904 = {
+    ...PGN_59904Defaults,
     pgn: 59904,
     dst: dst,
     fields: {
@@ -410,14 +473,14 @@ function sendISORequest(
 }
 
 function sendProductInformation(device: N2kDevice) {
-  debug('Sending product info %j', device.productInfo)
+  device.debug('Sending product info %j', device.productInfo)
 
   device.sendPGN(device.productInfo)
 }
 
 function sendConfigInformation(device: N2kDevice) {
   if (device.configurationInfo) {
-    debug('Sending config info..')
+    device.debug('Sending config info..')
     device.sendPGN(device.configurationInfo)
   }
 }
@@ -428,7 +491,7 @@ function sendNAKAcknowledgement(
   requestedPGN: number
 ) {
   const acknowledgement: PGN_59392 = {
-    pgn: 59392,
+    ...PGN_59392Defaults,
     dst: src,
     fields: {
       control: IsoControl.Ack,
@@ -443,11 +506,13 @@ function sendPGNList(device: N2kDevice, dst: number) {
   //FIXME: for now, adding everything that signalk-to-nmea2000 supports
   //need a way for plugins, etc. to register the pgns they provide
   const pgnList: PGN_126464 = {
-    pgn: 126464,
+    ...PGN_126464Defaults,
     dst,
     fields: {
       functionCode: PgnListFunction.TransmitPgnList,
-      list: device.transmitPGNs
+      list: device.transmitPGNs.map((num: number) => {
+        return { pgn: num }
+      })
     }
   }
   device.sendPGN(pgnList)

package/lib/utilities.ts

@@ -15,12 +15,59 @@
  */
 
 import { debug } from 'debug'
-
 import { CanID } from './canId'
 import { map, padCharsStart, trimChars } from 'lodash/fp'
+import fs from 'fs'
+
+const getDataPath = (options: any) => {
+  if (options.app?.config?.configPath !== undefined) {
+    return `${options.app.config.configPath}/canboatjs-data.json`
+  }
+}
+
+export const getPersistedData = (options: any, id: string, key: string) => {
+  const path = getDataPath(options)
+  if (path !== undefined) {
+    const content = fs.readFileSync(path)
+    const data = JSON.parse(content.toString())
+    return data[id] !== undefined && data[id][key]
+  }
+}
+
+export const savePersistedData = (
+  options: any,
+  id: string,
+  key: string,
+  value: any
+) => {
+  const path = getDataPath(options)
+  if (path !== undefined) {
+    let content: string
 
-export const createDebug = (name: string) => {
-  return debug(name)
+    try {
+      content = fs.readFileSync(path).toString()
+    } catch (err: any) {
+      if (err.code === 'ENOENT') {
+        content = '{}'
+      } else {
+        throw err
+      }
+    }
+    const data = JSON.parse(content.toString())
+    if (data[id] === undefined) {
+      data[id] = {}
+    }
+    data[id][key] = value
+    fs.writeFileSync(path, JSON.stringify(data, null, 2))
+  }
+}
+
+export const createDebug = (name: string, appOptions: any = undefined) => {
+  if (appOptions !== undefined && appOptions.createDebug !== undefined) {
+    return appOptions.createDebug(name)
+  } else {
+    return debug(name)
+  }
 }
 
 export function getPlainPGNs(buffer: Buffer) {

package/lib/w2k01.ts

@@ -26,9 +26,6 @@ import {
 import { readN2KActisense } from './n2k-actisense'
 import util from 'util'
 
-const debug = createDebug('canboatjs:w2k01')
-const debugData = createDebug('canboatjs:w2k01-data')
-
 //const pgnsSent = {}
 
 const N2K_ASCII = 0
@@ -48,6 +45,9 @@ export function W2K01Stream(
     objectMode: true
   })
 
+  this.debug = createDebug('canboatjs:w2k01', options)
+  this.debugData = createDebug('canboatjs:w2k01-data', options)
+
   this.sentAvailable = false
   this.options = options
   this.outEvent = outEvent || 'w2k-1-out'
@@ -72,11 +72,11 @@ export function W2K01Stream(
     }
   }
 
-  debug('started')
+  this.debug('started')
 }
 
 W2K01Stream.prototype.send = function (msg: string | Buffer) {
-  debug('sending %s', msg)
+  this.debug('sending %s', msg)
   this.options.app.emit(this.outEvent, msg)
 }
 
@@ -111,14 +111,14 @@ W2K01Stream.prototype._transform = function (
   done: any
 ) {
   if (!this.sentAvailable && this.format === N2K_ASCII) {
-    debug('emit nmea2000OutAvailable')
+    this.debug('emit nmea2000OutAvailable')
     this.options.app.emit('nmea2000OutAvailable')
     this.sentAvailable = true
   }
 
   if (this.format === N2K_ASCII) {
-    if (debugData.enabled) {
-      debugData('Received: ' + chunk)
+    if (this.debugData.enabled) {
+      this.debugData('Received: ' + chunk)
     }
     this.push(chunk)
   } else {

package/lib/yddevice.ts

@@ -17,16 +17,13 @@
 import { PGN } from '@canboat/ts-pgns'
 import { N2kDevice } from './n2kDevice'
 import { actisenseToYdgwFullRawFormat } from './toPgn'
-import { createDebug } from './utilities'
-
-const debug = createDebug('canboatjs:n2kdevice')
 
 export class YdDevice extends N2kDevice {
   app: any
   n2kOutEvent: string
 
   constructor(options: any) {
-    super(options)
+    super(options, 'canboatjs:yddevice')
     this.app = options.app
     this.n2kOutEvent = options.jsonOutEvent || 'nmea2000JsonOut'
 
@@ -41,7 +38,7 @@ export class YdDevice extends N2kDevice {
     const ppgn = pgn as any //FIXME??
     ppgn.ydFullFormat = true
 
-    debug('Sending PGN %j', pgn)
+    this.debug('Sending PGN %j', pgn)
     this.app.emit(this.n2kOutEvent, pgn)
   }
 

package/lib/ydgw02.ts

@@ -27,8 +27,6 @@ import {
 } from './toPgn'
 import util from 'util'
 
-const debug = createDebug('canboatjs:ydgw02')
-
 //const pgnsSent = {}
 
 export function Ydgw02Stream(this: any, options: any, type: string) {
@@ -40,6 +38,7 @@ export function Ydgw02Stream(this: any, options: any, type: string) {
     objectMode: true
   })
 
+  this.debug = createDebug('canboatjs:ydgw02', options)
   this.sentAvailable = false
   this.options = options
   this.outEvent = options.ydgwOutEvent || 'ydwg02-out'
@@ -52,7 +51,7 @@ export function Ydgw02Stream(this: any, options: any, type: string) {
   })
 
   this.fromPgn.on('error', (pgn: PGN, error: any) => {
-    debug(`[error] ${pgn.pgn} ${error}`)
+    this.debug(`[error] ${pgn.pgn} ${error}`)
   })
 
   if (options.app) {
@@ -87,7 +86,7 @@ export function Ydgw02Stream(this: any, options: any, type: string) {
       this.device.start()
     }
 
-    debug('started')
+    this.debug('started')
   }
 }
 
@@ -97,7 +96,7 @@ Ydgw02Stream.prototype.cansend = function (_msg: any) {
 
 Ydgw02Stream.prototype.sendString = function (msg: string, forceSend: boolean) {
   if (this.cansend() || forceSend === true) {
-    debug('sending %s', msg)
+    this.debug('sending %s', msg)
     this.options.app.emit(this.outEvent, msg)
   }
 }
@@ -176,7 +175,7 @@ Ydgw02Stream.prototype._transform = function (
   //line = line.substring(0, line.length) // take off the \r
 
   if (this.device === undefined && !this.sentAvailable) {
-    debug('emit nmea2000OutAvailable')
+    this.debug('emit nmea2000OutAvailable')
     this.options.app.emit('nmea2000OutAvailable')
     this.sentAvailable = true
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canboat/canboatjs",
-  "version": "3.1.0",
+  "version": "3.2.3",
   "description": "Native javascript version of canboat",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",