@canboat/canboatjs 3.0.0-beta.4 → 3.0.0-beta.6

package/bin/candumpjs

@@ -16,7 +16,8 @@ if ( argv['help'] ) {
   console.error(`Usage: ${process.argv[0]} [options] candevice
 
 Options:
-  -h, --help       output usage information`)
+  --format <format>    json, actisense
+  -h, --help           output usage information`)
   process.exit(1)
 }
 
@@ -25,6 +26,8 @@ if ( argv['_'].length === 0 ) {
   process.exit(1)
 }
 
+const format = argv['format'] || 'json'
+
 /*
 
 let messageCb = (data) => {
@@ -69,8 +72,12 @@ channel.addListener('onMessage', (msg) => {
   pgn.timestamp = new Date().toISOString()
 
   let sourceString = binToActisense(pgn, msg.data, msg.data.length)
-  
-  parser.parse({ pgn, length: msg.data.length, data: msg.data, sourceString })
+
+  if ( format === 'json' ) {
+    parser.parse({ pgn, length: msg.data.length, data: msg.data, sourceString })
+  } else {
+    console.log(sourceString)
+  }
 })
 
 channel.start()

package/lib/canbus.js

@@ -73,7 +73,7 @@ function CanbusStream (options) {
     this.socketcan = require('socketcan')
   } catch ( err ) {
     console.error(err)
-    var msg = 'WARNING unable to load native socketcan interface'
+    var msg = 'unable to load native socketcan interface'
     console.error(msg)
   }
 
@@ -89,62 +89,38 @@ function CanbusStream (options) {
   }
 
   var canDevice = options.canDevice || 'can0'
-  if ( !this.socketcan || this.options.useSocketCanWriter ) {
-    this.socketCanWriter = null
-    const spawn = require('child_process').spawn
-    var hasWriter = spawn('sh', ['-c', 'which socketcan-writer'])
-
-    const setProviderError = this.setProviderError.bind(this)
-    const setProviderStatus = this.setProviderStatus.bind(this)
-
-    hasWriter.on('close', code => {
-      if ( code == 0 ) {
-        debug('found socketcan-writer, starting...')
-        setProviderStatus('Starting')
-        this.socketCanWriter = spawn('sh',
-                                     ['-c', `socketcan-writer ${canDevice}`])
-        setProviderStatus(`Connected to ${canDevice}`)
-        this.socketCanWriter.stderr.on('data', function (data) {
-          console.error(data.toString())
-        })
-        this.socketCanWriter.on('close', function (code) {
-          const msg = 'socketcan-writer process exited with code ' + code
-          setProviderError(msg)
-          console.error(msg)
-          this.socketCanWriter = null
-        })
-        setTimeout(() => {
-          this.candevice = new CanDevice(this, options)
-          this.candevice.start()
-        }, 5000)
-      }
-    })
-  } else {
-    this.connect()
-
-    const noDataReceivedTimeout = typeof options.noDataReceivedTimeout !== 'undefined' ? options.noDataReceivedTimeout : -1
-    if ( noDataReceivedTimeout > 0 ) {
-      this.noDataInterval = setInterval(() => {
-        if ( this.channel && this.lastDataReceived && Date.now() - this.lastDataReceived > noDataReceivedTimeout * 1000 ) {
-          let channel = this.channel
-          delete this.channel
-          try {
-            channel.stop()
-          } catch ( error ) {
-          }
-          this.setProviderError('No data received, retrying...')
-          if ( this.options.app ) {
-            console.error('No data received, retrying...')
-          }
-          this.connect()
+  
+  if ( this.connect() == false ) {
+    return
+  }
+
+  const noDataReceivedTimeout = typeof options.noDataReceivedTimeout !== 'undefined' ? options.noDataReceivedTimeout : -1
+  if ( noDataReceivedTimeout > 0 ) {
+    this.noDataInterval = setInterval(() => {
+      if ( this.channel && this.lastDataReceived && Date.now() - this.lastDataReceived > noDataReceivedTimeout * 1000 ) {
+        let channel = this.channel
+        delete this.channel
+        try {
+          channel.stop()
+        } catch ( error ) {
         }
-      }, noDataReceivedTimeout * 1000)
-    }
+        this.setProviderError('No data received, retrying...')
+        if ( this.options.app ) {
+          console.error('No data received, retrying...')
+        }
+        this.connect()
+      }
+    }, noDataReceivedTimeout * 1000)
   }
 }
 
 CanbusStream.prototype.connect = function() {
   try {
+    if ( this.socketcan === undefined ) {
+      this.setProviderError('unable to load native socketcan interface')
+      return false
+    }
+    
     var that = this
     var canDevice = this.options.canDevice || 'can0'
     this.channel = this.socketcan.createRawChannelWithOptions(canDevice, { non_block_send: true} );
@@ -181,13 +157,15 @@ CanbusStream.prototype.connect = function() {
       }
     })
     this.channel.start()
+    this.setProviderStatus('Connected to socketcan')
     this.candevice = new CanDevice(this, this.options)
     this.candevice.start()
-    this.setProviderStatus('Connected')
+    return true
   } catch (e) {
     console.error(`unable to open canbus ${canDevice}: ${e}`)
     console.error(e.stack)
     this.setProviderError(e.message)
+    return false
   }
 }
 
@@ -211,9 +189,10 @@ require('util').inherits(CanbusStream, Transform)
 CanbusStream.prototype.start = function () {
 }
 
-CanbusStream.prototype.sendPGN = function (msg) {
+CanbusStream.prototype.sendPGN = function (msg, force) {
   if ( this.candevice ) {
-    if ( !this.candevice.cansend && (_.isString(msg) || msg.pgn !== 59904) ) {
+    //if ( !this.candevice.cansend && (_.isString(msg) || msg.pgn !== 59904) ) {
+    if ( !this.candevice.cansend && force !== true ) {
       //we have not completed address claim yet
       return
     }
@@ -279,66 +258,12 @@ CanbusStream.prototype.sendPGN = function (msg) {
   }
 }
 
-function readLine(that, line) {
-  var candump_data_inc = CANDUMP_DATA_INC_3;
-
-  if (line.length == 0 ) {
-    return
-  }
-
-  if ( !that.format ) {
-    //that.s
-    if ( line.charAt(0) == '<' ) {
-      that.format = FMT_1
-    } else if ( line.charAt(0) == '(' ) {
-      that.format = FMT_3
-      console.error("candump format not supported")
-    } else {
-      that.format = FMT_2
-    }
-  }
-
-
-  var canid
-  var data
-  var split = line.trim().split(' ').filter(s => s.length > 0)
-  var len
-  if ( that.format === FMT_3 ) {
-    return
-  } else if ( that.format === FMT_1 ) {
-    canid = parseInt(split[0].substring(1, split[0].length-1), 16)
-    data = split.slice(2)
-    len = split[1].substring(1, split[1].length-1)
-  } else if ( that.format === FMT_2 ) {
-    canid = parseInt(split[1], 16)
-    data = split.slice(3)
-    len = split[2].substring(1, split[2].length-1)
-  }
-
-  //console.log(JSON.stringify(split))
-  var pgn = parseCanId(canid)
-
-  if ( that.candevice && pgn.src == that.candevice.address ) {
-    //this is a message that we sent
-    debug('got a message from me')
-    return
-  }
-
-  pgn.timestamp = new Date().toISOString()
-
-  that.push({ pgn: pgn, length: len, data, sourceString: line })
-}
 
 CanbusStream.prototype._transform = function (chunk, encoding, done) {
-  readLine(this, chunk.toString())
   done()
 }
 
 CanbusStream.prototype.end = function () {
-  if ( this.socketCanWriter ) {
-    debug('end, killing socketcan-writer process')
-    this.socketCanWriter.kill()
-  }
   if ( this.channel ) {
     let channel = this.channel
     delete this.channel

package/lib/candevice.js

@@ -44,7 +44,7 @@ class CanDevice extends N2kDevice {
   sendPGN(pgn, src) {
     pgn.src = src || this.address
     debug('Sending PGN %j', pgn)
-    this.canbus.sendPGN(pgn)
+    this.canbus.sendPGN(pgn, true)
   }
 }
 

package/lib/n2kDevice.js

@@ -97,6 +97,8 @@ class N2kDevice extends EventEmitter {
     this.foundConflict = false
     this.heartbeatCounter = 0
     this.devices = {}
+    this.sentAvailable = false
+    this.addressClaimDetectionTime = options.addressClaimDetectionTime !== undefined ? options.addressClaimDetectionTime : 5000
 
     if ( !options.disableDefaultTransmitPGNs ) {
       this.transmitPGNs = _.union(deviceTransmitPGNs, defaultTransmitPGNs)
@@ -117,6 +119,12 @@ class N2kDevice extends EventEmitter {
     }, 1000)
   }
 
+  setStatus(msg) {
+    if ( this.options.app && this.options.app.setPluginStatus ) {
+      this.options.app.setProviderStatus(this.options.providerId, msg)
+    }
+  }
+
   n2kMessage(pgn) {
     if ( pgn.dst == 255 || pgn.dst == this.address ) {
       try {
@@ -244,8 +252,8 @@ function handleISOAddressClaim(device, n2kMsg) {
   } else if(uint64ValueFromOurOwnClaim > uint64ValueFromReceivedClaim) {
     this.foundConflict = true
     increaseOwnAddress(device)    // We have bigger address claim data -> we have to change our address
+    debug(`Address conflict detected!  trying address ${device.address}.`)
     sendAddressClaim(device)
-    debug(`Address conflict detected! Changed our address to ${device.address}.`)
   }
 }
 
@@ -260,7 +268,7 @@ function handleProductInformation(device, n2kMsg) {
   if ( !device.devices[n2kMsg.src] ) {
     device.devices[n2kMsg.src] = {}
   }
-  debug('got production information %j', n2kMsg)
+  debug('got product information %j', n2kMsg)
   device.devices[n2kMsg.src].productInformation = n2kMsg
 }
 
@@ -289,25 +297,32 @@ function sendAddressClaim(device) {
   }
   debug(`Sending address claim ${device.address}`)
   device.sendPGN(device.addressClaim)
-  setTimeout(() => {
-    if ( !device.foundConflict ) {
-      debug('no address conflics, enabling send')
+  device.setStatus(`Claimed address ${device.address}`)
+  device.addressClaimSentAt = Date.now()
+  if ( device.addressClaimChecker ) {
+    clearTimeout(device.addressClaimChecker)
+  }
+  
+  device.addressClaimChecker = setTimeout(() => {
+    //if ( Date.now() - device.addressClaimSentAt > 1000 ) {
+      //device.addressClaimChecker = null
+      debug('claimed address %d', device.address)
       device.cansend = true
-      if ( device.options.app ) {
-        device.options.app.emit('nmea2000OutAvailable')
+      if ( !device.sentAvailable ) {
+        if ( device.options.app ) {
+          device.options.app.emit('nmea2000OutAvailable')
+        }
+        device.emit('nmea2000OutAvailable')
+          device.sentAvailable = true
       }
       sendISORequest(device, 126996)
-      device.heartbeatInterval = setInterval(() => {
-        sendHeartbeat(device)
-      }, 60*1000)
-      /*
-      _.keys(device.devices).forEach((address) => {
-        sendISORequest(device, 126996, undefined, address)
-      })
-      */
-
-    }
-  }, 250)
+      if ( !device.heartbeatInterval ) {
+        device.heartbeatInterval = setInterval(() => {
+          sendHeartbeat(device)
+        }, 60*1000)
+      }
+    //}
+  }, device.addressClaimDetectionTime)
 }
 
 function sendISORequest(device, pgn, src, dst=255) {
@@ -343,7 +358,7 @@ function sendNAKAcknowledgement(device, src, requestedPGN) {
     "Group Function": 255,
     PGN: requestedPGN
   }
-  device.sendPGN(device, acknowledgement)
+  device.sendPGN(acknowledgement)
 }
 
 function sendPGNList(device, src) {

package/lib/yddevice.js

@@ -33,7 +33,6 @@ class YdDevice extends N2kDevice {
 
   sendPGN(pgn, src) {
     pgn.src = src || this.address
-    pgn.
     pgn.ydFullFormat = true
     debug('Sending PGN %j', pgn)
     this.app.emit(this.n2kOutEvent, pgn)

package/lib/ydgw02.js

@@ -18,11 +18,12 @@ const debug = require('debug')('canboatjs:ydgw02')
 const Transform = require('stream').Transform
 const FromPgn = require('./fromPgn').Parser
 const Parser = require('./fromPgn').Parser
+const YdDevice = require('./yddevice')
 const _ = require('lodash')
 const { defaultTransmitPGNs } = require('./codes')
-const { pgnToYdgwRawFormat, pgnToYdgwFullRawFormat, actisenseToYdgwRawFormat } = require('./toPgn')
+const { pgnToYdgwRawFormat, pgnToYdgwFullRawFormat, actisenseToYdgwRawFormat, actisenseToYdgwFullRawFormat } = require('./toPgn')
 
-const pgnsSent = {}
+//const pgnsSent = {}
 
 function Ydgw02Stream (options, type) {
   if (!(this instanceof Ydgw02Stream)) {
@@ -36,6 +37,7 @@ function Ydgw02Stream (options, type) {
   this.sentAvailable = false
   this.options = options
   this.outEvent = options.ydgwOutEvent || 'ydwg02-out'
+  this.device = undefined
 
   this.fromPgn = new FromPgn(options)
 
@@ -74,29 +76,43 @@ function Ydgw02Stream (options, type) {
       // set ydnu to RAW mode
       options.app.emit(this.outEvent, Buffer.from([0x30, 0x0a]))
     }
+
+    if ( options.createDevice === true || options.createDevice === undefined ) {
+      this.device = new YdDevice(options)
+      this.device.start()
+    }
+    
     debug('started')
   }
 
 }
 
-Ydgw02Stream.prototype.sendString = function (msg) {
-  debug('sending %s', msg)
-  this.options.app.emit(this.outEvent, msg)
+Ydgw02Stream.prototype.cansend = function (msg) {
+  return this.device ? this.device.cansend : true
+}
+
+Ydgw02Stream.prototype.sendString = function (msg, forceSend) {
+  if ( this.cansend() || forceSend === true ) {
+    debug('sending %s', msg)
+    this.options.app.emit(this.outEvent, msg)
+  }
 }
 
 Ydgw02Stream.prototype.sendPGN = function (pgn) {
-  let now = Date.now()
-  let lastSent = pgnsSent[pgn.pgn]
-  let msgs
-  if ( pgn.ydFullFormat === true ) {
-    msgs = pgnToYdgwFullRawFormat(pgn)
-  } else {
-    msgs = pgnToYdgwRawFormat(pgn)
+  if ( this.cansend() || pgn.forceSend === true ) {
+    //let now = Date.now()
+    //let lastSent = pgnsSent[pgn.pgn]
+    let msgs
+    if ( pgn.ydFullFormat === true || this.device !== undefined ) {
+      msgs = pgnToYdgwFullRawFormat(pgn)
+    } else {
+      msgs = pgnToYdgwRawFormat(pgn)
+    }
+    msgs.forEach(raw => {
+      this.sendString(raw + '\r\n', pgn.forceSend)
+    })
+    //pgnsSent[pgn.pgn] = now
   }
-  msgs.forEach(raw => {
-    this.sendString(raw + '\r\n')
-  })
-  pgnsSent[pgn.pgn] = now
 }
 
 Ydgw02Stream.prototype.sendYdgwFullPGN = function (msgs) {
@@ -107,7 +123,15 @@ Ydgw02Stream.prototype.sendYdgwFullPGN = function (msgs) {
 
 Ydgw02Stream.prototype.sendYdgwPGN = function (msg) {
 
-  actisenseToYdgwRawFormat(msg).forEach(raw => {
+  let msgs
+
+  if ( this.device != undefined ) {
+    msgs = actisenseToYdgwFullRawFormat(msg)
+  } else {
+    msgs = actisenseToYdgwRawFormat(msg)
+  }
+
+  msgs.forEach(raw => {
     this.sendString(raw + '\r\n')
   })
 
@@ -143,7 +167,7 @@ Ydgw02Stream.prototype._transform = function (chunk, encoding, done) {
   let line = chunk.toString().trim()
   //line = line.substring(0, line.length) // take off the \r
 
-  if ( !this.sentAvailable ) {
+  if ( this.device === undefined && !this.sentAvailable ) {
     debug('emit nmea2000OutAvailable')
     this.options.app.emit('nmea2000OutAvailable')
     this.sentAvailable = true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canboat/canboatjs",
-  "version": "3.0.0-beta.4",
+  "version": "3.0.0-beta.6",
   "description": "Native javascript version of canboat",
   "main": "index.js",
   "scripts": {
@@ -53,13 +53,14 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@canboat/pgns": "6.0.0-beta.2",
+    "@canboat/pgns": "6.0.0-beta.3",
     "bit-buffer": "0.2.3",
     "debug": "^4.3.4",
     "dnssd": "^0.4.1",
     "int64-buffer": "^0.1.10",
     "lodash": "^4.17.4",
     "minimist": "^1.2.0",
+    "moment": "^2.30.1",
     "mqtt": "^2.18.8",
     "split": "^1.0.1"
   },
@@ -73,7 +74,6 @@
     "chai-things": "^0.2.0",
     "jest": "^24.7.1",
     "mocha": "^5.0.0",
-    "moment": "^2.24.0",
     "nyc": "^15.1.0",
     "webpack-cli": "^5.1.4"
   },