@canboat/canboatjs 3.0.0-beta.1 → 3.0.0-beta.10

package/lib/candevice.js

@@ -20,8 +20,9 @@ const _ = require('lodash')
 const Uint64LE = require('int64-buffer').Uint64LE
 const { defaultTransmitPGNs, getIndustryCode, getManufacturerCode, getDeviceClassCode } = require('./codes')
 const { toPgn } = require('./toPgn')
-let packageJson
+const N2kDevice = require('./n2kDevice')
 
+let packageJson
 try
 {
   packageJson = require('../' + 'package.json')
@@ -30,344 +31,21 @@ try
 
 const deviceTransmitPGNs = [ 60928, 59904, 126996, 126464 ]
 
-class CanDevice extends EventEmitter {
+class CanDevice extends N2kDevice {
   constructor (canbus, options) {
-    super()
-
-    if ( options.addressClaim ) {
-      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
-        "Device Class": 25,          // Inter/Intranetwork Device
-        "Device Instance Lower": 0,
-        "Device Instance Upper": 0,
-        "System Instance": 0,
-        "Industry Group": 4,          // Marine
-        "Reserved1": 1,
-        "Reserved2": 2
-      }
-      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
-      this.productInfo.dst = 255
-    } else {
-      this.productInfo = {
-        pgn: 126996,
-        dst: 255,
-        "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",
-        "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
-      }
-    } 
-
+    super(options)
     this.canbus = canbus
-    this.options = _.isUndefined(options) ? {} : options
-
-    this.address = _.isUndefined(options.preferredAddress) ? 100 : options.preferredAddress
-    this.cansend = false
-    this.foundConflict = false
-    this.heartbeatCounter = 0
-    this.devices = {}
-
-    if ( !options.disableDefaultTransmitPGNs ) {
-      this.transmitPGNs = _.union(deviceTransmitPGNs, defaultTransmitPGNs)
-    } else {
-      this.transmitPGNs = [...deviceTransmitPGNs]
-    }
-    
-    if ( this.options.transmitPGNs ) {
-      this.transmitPGNs = _.union(this.transmitPGNs,
-                                  this.options.transmitPGNs)
-    }
 
     if ( options.app ) {
       options.app.on(options.analyzerOutEvent || 'N2KAnalyzerOut', this.n2kMessage.bind(this))
     }
   }
 
-  start() {
-    sendISORequest(this, 60928, 254)
-    setTimeout(() => {
-      sendAddressClaim(this)
-    }, 1000)
-  }
-
-  n2kMessage(pgn) {
-    if ( pgn.dst == 255 || pgn.dst == this.address ) {
-      try {
-        if ( pgn.pgn == 59904 ) {
-          handleISORequest(this, pgn)
-        } else if ( pgn.pgn == 126208 ) {
-          handleGroupFunction(this, pgn)
-        } else if ( pgn.pgn == 60928 ) {
-          handleISOAddressClaim(this, pgn)
-        } else if ( pgn.pgn == 126996 ) {
-          handleProductInformation(this, pgn)
-        }
-      } catch ( err ) {
-        console.error(err)
-        console.error(err.stack)
-      }
-
-      /*
-      var handler = this.handlers[pgn.pgn.toString()]
-      if ( pgn.dst == this.address )
-        debug(`handler ${handler}`)
-      if ( _.isFunction(handler) ) {
-        debug(`got handled PGN %j  ${handled}`, pgn)
-        handler(pgn)
-      }
-      */
-    }
-  }
-}
-
-function sendPGN(device, pgn, src, dest) {
-  pgn.src = src || device.address
-  debug('Sending PGN %j', pgn)
-  device.canbus.sendPGN(pgn)
-}
-
-function handleISORequest(device, n2kMsg) {
-  debug('handleISORequest %j', n2kMsg)
-
-  switch (n2kMsg.fields.PGN) {
-  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;
-  case 126464:
-    sendPGNList(device)
-    break;
-  default:
-    if ( !device.options.disableNAKs ) {
-      debug(`Got unsupported ISO request for PGN ${n2kMsg.fields.PGN}. Sending NAK.`)
-      sendNAKAcknowledgement(device, n2kMsg.src, n2kMsg.fields.PGN)
-    }
-  }
-}
-
-function handleGroupFunction(device, n2kMsg) {
-  debug('handleGroupFunction %j', n2kMsg)
-  if(n2kMsg.fields.functionCodeRequest) {
-    handleRequestGroupFunction(device, n2kMsg)
-  } else if(n2kMsg.fields.functionCodeCommand) {
-    handleCommandGroupFunction(device, n2kMsg)
-  } else {
-    debug('Got unsupported Group Function PGN: %j', n2kMsg)
-  }
-
-  function handleRequestGroupFunction(device, n2kMsg) {
-    if ( !device.options.disableNAKs ) {
-      // We really don't support group function requests for any PGNs yet -> always respond with pgnErrorCode 1 = "PGN not supported"
-      debug("Sending 'PGN Not Supported' Group Function response for requested PGN", n2kMsg.fields.PGN)
-      
-      const acknowledgement = {
-        pgn: 126208,
-        dst: n2kMsg.src,
-        "Function Code": 2,
-        "PGN": n2kMsg.fields.PGN,
-        "PGN error code": 4,
-        "Transmission interval/Priority error code": 0,
-      "# of Parameters": 0
-      }
-      sendPGN(device, acknowledgement)
-    }
-  }
-
-  function handleCommandGroupFunction(device, n2kMsg) {
-    if ( !device.options.disableNAKs ) {
-      // We really don't support group function commands for any PGNs yet -> always respond with pgnErrorCode 1 = "PGN not supported"
-      debug("Sending 'PGN Not Supported' Group Function response for commanded PGN", n2kMsg.fields.PGN)
-      
-      const acknowledgement = {
-        pgn: 126208,
-        dst: n2kMsg.src,
-        "Function Code": 2,
-        "PGN": n2kMsg.fields.PGN,
-        "PGN error code": 4,
-      "Transmission interval/Priority error code": 0,
-        "# of Parameters": 0
-      }
-      sendPGN(device, acknowledgement)
-    }
-  }
-}
-
-function handleISOAddressClaim(device, n2kMsg) {
-  if ( n2kMsg.src != device.address ) {
-    if ( !device.devices[n2kMsg.src] ) {
-      debug(`registering device ${n2kMsg.src}`)
-      device.devices[n2kMsg.src] = { addressClaim: n2kMsg }
-      if ( device.cansend ) {
-        //sendISORequest(device, 126996, undefined, n2kMsg.src)
-      }
-    }
-    return
-  }
-
-  debug('Checking ISO address claim. %j', n2kMsg)
-
-  const uint64ValueFromReceivedClaim = getISOAddressClaimAsUint64(n2kMsg)
-  const uint64ValueFromOurOwnClaim = getISOAddressClaimAsUint64(device.addressClaim)
-
-  if(uint64ValueFromOurOwnClaim < uint64ValueFromReceivedClaim) {
-    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) {
-    this.foundConflict = true
-    increaseOwnAddress(device)    // We have bigger address claim data -> we have to change our address
-    sendAddressClaim(device)
-    debug(`Address conflict detected! Changed our address to ${device.address}.`)
-  }
-}
-
-function increaseOwnAddress(device) {
-  var start = device.address
-  do {
-    device.address = (device.address + 1) % 253
-  } while ( device.address != start && device.devices[device.address] )
-}
-
-function handleProductInformation(device, n2kMsg) {
-  if ( !device.devices[n2kMsg.src] ) {
-    device.devices[n2kMsg.src] = {}
-  }
-  debug('got production information %j', n2kMsg)
-  device.devices[n2kMsg.src].productInformation = n2kMsg
-}
-
-function sendHeartbeat(device)
-{
-  device.heartbeatCounter = device.heartbeatCounter + 1
-  if ( device.heartbeatCounter > 252 )
-  {
-    device.heartbeatCounter = 0
-  }
-  sendPGN(device,{
-    pgn: 126993,
-    dst: 255,
-    prio:7,
-    "Data transmit offset": "00:01:00",
-    "Sequence Counter": device.heartbeatCounter,
-    "Controller 1 State":"Error Active"
-  })
-}
-
-
-function sendAddressClaim(device) {
-  if ( device.devices[device.address] ) {
-    //someone already has this address, so find a free one
-    increaseOwnAddress(device)
-  }
-  debug(`Sending address claim ${device.address}`)
-  sendPGN(device, device.addressClaim)
-  setTimeout(() => {
-    if ( !device.foundConflict ) {
-      debug('no address conflics, enabling send')
-      device.cansend = true
-      if ( device.options.app ) {
-        device.options.app.emit('nmea2000OutAvailable')
-      }
-      sendISORequest(device, 126996)
-      device.heartbeatInterval = setInterval(() => {
-        sendHeartbeat(device)
-      }, 60*1000)
-      /*
-      _.keys(device.devices).forEach((address) => {
-        sendISORequest(device, 126996, undefined, address)
-      })
-      */
-
-    }
-  }, 250)
-}
-
-function sendISORequest(device, pgn, src, dst=255) {
-  debug(`Sending iso request for ${pgn} to ${dst}`)
-
-  const isoRequest = {
-    pgn: 59904,
-    dst: dst,
-    "PGN": pgn
-  }
-  sendPGN(device, isoRequest, src)
-}
-
-
-function sendProductInformation(device) {
-  debug("Sending product info..")
-
-  sendPGN(device, device.productInfo)
-}
-
-function sendConfigInformation(device) {
-  if ( device.configurationInfo ) {
-    debug("Sending config info..")
-    sendPGN(device, device.configurationInfo)
+  sendPGN(pgn, src) {
+    pgn.src = src || this.address
+    debug('Sending PGN %j', pgn)
+    this.canbus.sendPGN(pgn, true)
   }
 }
 
-function sendNAKAcknowledgement(device, src, requestedPGN) {
-  const acknowledgement = {
-    pgn: 59392,
-    dst: src,
-    Control: 1,
-    "Group Function": 255,
-    PGN: requestedPGN
-  }
-  sendPGN(device, acknowledgement)
-}
-
-function sendPGNList(device, src) {
-  //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,
-    dst: src,
-    "Function Code": 0,
-    list: device.transmitPGNs
-  }
-  sendPGN(device, pgnList)
-}
-
-function getISOAddressClaimAsUint64(pgn) {
-  return new Uint64LE(toPgn(pgn))
-}
-
 module.exports = CanDevice

package/lib/fromPgn.js

@@ -635,7 +635,7 @@ function readField(options, runPostProcessor, pgn, field, bs, fields) {
       }
       if ( options.checkForInvalidFields !== false && max !== 'undefined' &&
            field.FieldType !== 'LOOKUP' &&
-           field.FieldType !== 'FIELDTYPE_LOOKUP' &&
+           field.FieldType !== 'DYNAMIC_FIELD_KEY' &&
            field.FieldType !== 'PGN' &&
            field.BitLength > 1 &&
            max - value < 0 ) {
@@ -660,7 +660,7 @@ function readField(options, runPostProcessor, pgn, field, bs, fields) {
       }
 
       if ((field.FieldType === 'LOOKUP' ||
-           field.FieldType === 'FIELDTYPE_LOOKUP') &&
+           field.FieldType === 'DYNAMIC_FIELD_KEY') &&
           runPostProcessor &&
           (_.isUndefined(options.resolveEnums) ||
            options.resolveEnums)) {
@@ -691,7 +691,7 @@ function readField(options, runPostProcessor, pgn, field, bs, fields) {
 function readValue(options, pgn, field, bs, fields, bitLength) {
   var value
   if ( _.isUndefined(bitLength) ) {
-    if ( field.BitLengthVariable && field.FieldType === "KEY_VALUE" ) {
+    if ( field.BitLengthVariable && field.FieldType === "DYNAMIC_FIELD_VALUE" ) {
       bitLength = lookupKeyBitLength(pgn.fields, fields)
     } else {
       bitLength = field.BitLength

package/lib/n2k-actisense.js

@@ -2,6 +2,7 @@ const debug = require('debug')('canboatjs:w2k01')
 const debugData = require('debug')('canboatjs:w2k01-data')
 const { parseCanId, encodeCanId } = require('./canId')
 const BitStream = require('bit-buffer').BitStream
+const { binToActisense } = require('./utilities')
 
 exports.readN2KActisense = function (data, plainText, context, cb) {
   const inBuf = Buffer.from(data)
@@ -105,20 +106,3 @@ exports.encodeN2KActisense  = ({
     
     return bs.view.buffer
   }
-
-
-function binToActisense(pgn, data, length) {
-  return (
-    pgn.timestamp +
-      `,${pgn.prio},${pgn.pgn},${pgn.src},${pgn.dst},${length},` +
-      new Uint32Array(data)
-      .reduce(function(acc, i) {
-        acc.push(i.toString(16));
-        return acc;
-      }, [])
-      .map(x => (x.length === 1 ? "0" + x : x))
-      .join(",")
-  );
-}
-
-