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

package/.github/workflows/publish.yml

@@ -11,13 +11,13 @@ jobs:
       with:
         node-version: '18.x'
         registry-url: 'https://registry.npmjs.org'
-      run: |
+    - run: |
           npm ci && npm cache clean --force
           if [[ "$tag" == *beta* ]];
             then
               npm publish --tag beta
             else
-              npm publish
+              npm publish --access public
           fi    
       env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/bin/analyzerjs

@@ -2,10 +2,7 @@
 
 const argv = require('minimist')(process.argv.slice(2), {
   alias: { h: 'help' },
-  boolean: ['n'],
-  boolean: ['r'],
-  boolean: ['camel'],
-  boolean: ['camel-compat']
+  boolean: ['n', 'r', 'camel', 'camel-compat']
 })
 
 if ( argv['help'] ) {

package/bin/candumpjs

@@ -4,7 +4,7 @@ const canboatjs = require('../index')
 const Parser = require('../index').FromPgn
 const { parseCanId } = require('../lib/canId')
 const socketcan = require('socketcan')
-
+const { binToActisense } = require('../lib/utilities')
 var parser = new canboatjs.FromPgn()
 
 
@@ -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,23 +72,14 @@ 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()
 
 
-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(",")
-  );
-}

package/bin/cansend

@@ -0,0 +1,130 @@
+#!/usr/bin/env node
+
+const canboatjs = require('../index')
+const Parser = require('../index').FromPgn
+const { parseCanId } = require('../lib/canId')
+const { parseActisense } = require('../lib/stringMsg')
+
+const { toPgn } = require('../lib/toPgn')
+const { getPlainPGNs, binToActisense } = require('../lib/utilities')
+const { encodeCanId } = require('../lib/canId')
+
+const argv = require('minimist')(process.argv.slice(2), {
+  boolean: ['test', 'log-output'],
+  string: ['src'],
+  alias: { h: 'help' }
+})
+
+if ( argv['help'] ) {
+  console.error(`Usage: ${process.argv[0]} [options] candevice
+
+Options:
+  --src <src>    use src for all messages
+  --log-output   log messages sent
+  --test         don't connect or send any data
+  -h, --help     output usage information`)
+  process.exit(1)
+}
+
+if ( argv['_'].length === 0 ) {
+  console.error('Please specify a device')
+  process.exit(1)
+}
+
+const canDevice = argv['_'][0]
+const srcArg = argv.src
+const logOut = argv['log-output']
+const test = argv.test
+
+let channel
+
+if ( !test ) {
+  const socketcan = require('socketcan')
+  channel = socketcan.createRawChannel(canDevice);
+  
+  channel.addListener('onStopped', (msg) => {
+    console.error('socketcan stopped')
+  })
+  
+  channel.start()
+}
+
+var readline = require('readline')
+var rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+  terminal: false
+})
+
+var input = []
+
+rl.on('line', function (line) {
+  if ( line.length === 0 ) {
+    return
+  }
+  
+  let msg =  line[0] === '{'  ? JSON.parse(line) : line
+
+  if ( typeof msg === 'string' ) {
+    var split = msg.split(',')
+    if ( srcArg !== undefined ) {
+      split[3] = srcArg
+    }
+    msg = split.join(',')
+  } else {
+    if ( msg.prio === undefined ) {
+      msg.prio = 3
+    }
+    if ( msg.dst === undefined ) {
+      msg.dst = 255
+    }
+    if ( srcArg !== undefined ) {
+      msg.src = srcArg
+    }
+    if ( msg.src === undefined ) {
+      msg.src = 100
+    }
+  }
+
+  var pgn, canid, buffer
+  if ( typeof msg === 'object' ) {
+    canid = encodeCanId(msg)
+    buffer = toPgn(msg)
+    if ( buffer === undefined ) {
+      console.error('invalid input: %s', line)
+      return
+    }
+    pgn = msg
+  } else {
+    pgn = parseActisense(msg)
+
+    if ( isNaN(pgn.prio) || isNaN(pgn.pgn) || isNaN(pgn.dst) || isNaN(pgn.src) ) {
+      console.error('invalid input: ' + line)
+      return
+    }
+    
+    canid = encodeCanId(pgn)
+    buffer = pgn.data
+  }
+  
+  pgn.timestamp = new Date().toISOString()
+  
+  if ( buffer.length > 8 || pgn.pgn == 126720 ) {
+    var pgns = getPlainPGNs(buffer)
+    pgns.forEach(pbuffer => {
+      if ( !test ) {
+        channel.send({id: canid, ext:true, data: pbuffer})
+      }
+      if ( logOut ) {
+        console.log(binToActisense(pgn, pbuffer, pbuffer.length))
+      }
+    })                    
+  } else {
+    if ( !test ) {
+      channel.send({id: canid, ext:true, data: buffer})
+    }
+    if ( logOut ) {
+      console.log(binToActisense(pgn, buffer, buffer.length))
+    }
+  }
+})

package/bin/to-pgn

@@ -4,14 +4,14 @@ const argv = require('minimist')(process.argv.slice(2), {
   string: ['format'],
   alias: { h: 'help' }
 })
-const { pgnToActisenseSerialFormat, pgnToActisenseN2KAsciiFormat, pgnToiKonvertSerialFormat, pgnToYdgwRawFormat, pgnToPCDIN, pgnToMXPGN } = require('../index')
+const { pgnToActisenseSerialFormat, pgnToActisenseN2KAsciiFormat, pgnToiKonvertSerialFormat, pgnToYdgwRawFormat, pgnToYdgwFullRawFormat, pgnToPCDIN, pgnToMXPGN } = require('../index')
 const { toActisenseSerialFormat } = require('../lib/stringMsg')
 
 if ( argv['help'] ) {
   console.error(`Usage: ${process.argv[0]} [options]
 
 Options:
-  --format <format>   actisense, actisensen2kascii, ikconvert, ydgw, pcdin, mxpgn
+  --format <format>   actisense, actisensen2kascii, ikconvert, ydgw, yd-full, pcdin, mxpgn
   -h, --help          output usage information`)
   process.exit(1)
 }
@@ -23,7 +23,8 @@ const formatters = {
   ikconvert: pgnToiKonvertSerialFormat,
   ydgw: pgnToYdgwRawFormat,
   'pcdin': pgnToPCDIN,
-  'mxpgn': pgnToMXPGN
+  'mxpgn': pgnToMXPGN,
+  'yd-full': pgnToYdgwFullRawFormat
 }
 
 const format = argv['format'] || 'actisense'

package/examples/signalk-device-emulator/index.js

@@ -0,0 +1 @@
+module.exports = require('./dist/').default

package/examples/signalk-device-emulator/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "signalk-device-emulator",
+  "version": "1.0.0",
+  "description": "Signal K Plugin which emulates a device",
+  "main": "index.js",
+  "scripts": {
+    "format": "prettier-standard 'src/*.ts'",
+    "build": "tsc",
+    "watch": "npm run build -- -w"
+  },
+  "keywords": [
+    "signalk-node-server-plugin"
+  ],
+  "author": "scott@scottbender.net",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@canboat/canboatjs": "^2.10.0"
+  },
+  "devDependencies": {
+    "@types/node": "^14.14.10",
+    "prettier-standard": "^16.4.1",
+    "typescript": "^4.1.2"
+  }
+}

package/index.js

@@ -28,6 +28,7 @@ module.exports = {
   pgnToActisenseN2KAsciiFormat: require('./lib/toPgn').pgnToActisenseN2KAsciiFormat,
   pgnToiKonvertSerialFormat: require('./lib/toPgn').pgnToiKonvertSerialFormat,
   pgnToYdgwRawFormat: require('./lib/toPgn').pgnToYdgwRawFormat,
+  pgnToYdgwFullRawFormat: require('./lib/toPgn').pgnToYdgwFullRawFormat,
   pgnToPCDIN: require('./lib/toPgn').pgnToPCDIN,
   pgnToMXPGN: require('./lib/toPgn').pgnToMXPGN,
   canbus: require('./lib/canbus'),
@@ -39,6 +40,7 @@ module.exports = {
   VenusMQTT: require('./lib/venus-mqtt'),
   discover: require('./lib/discovery'),
   SimpleCan: require('./lib/simpleCan'),
+  YdDevice: require('./lib/yddevice'),
   addCustomPgns: pgns.addCustomPgns,
   lookupEnumerationValue: pgns.lookupEnumerationValue,
   lookupEnumerationName: pgns.lookupEnumerationName
@@ -48,3 +50,4 @@ try {
   module.exports.serial = require('./lib/serial')
 } catch ( ex ) {
 }
+

package/lib/canbus.js

@@ -23,7 +23,7 @@ const { toPgn } = require('./toPgn')
 const Parser = require('./fromPgn').Parser
 const _ = require('lodash')
 const CanDevice = require('./candevice')
-const { getPlainPGNs } = require('./utilities')
+const { getPlainPGNs, binToActisense } = require('./utilities')
 const { encodeCanId, parseCanId } = require('./canId')
 const { toActisenseSerialFormat, parseActisense } = require('./stringMsg')
 
@@ -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,39 +157,27 @@ 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
   }
 }
 
-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(",")
-  );
-}
-
-
 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 +243,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